db_guard.py
python
sha256:f7413c1abec6d6a8e5bdabcd4cc7ad5fcd059ce6a6f50f566e2b0118a0a8b578
tests: make tests/docs_contract/ database-free by directory…
Opus 5.5
10 days ago
| 1 | """Fail-closed pytest plugin for the docs-contract database isolation probes (musehub#273). |
| 2 | |
| 3 | Loaded only by ``test_doc_db_isolation.py``'s subprocess sessions (``-p tests.docs_contract.db_guard``), |
| 4 | never by a normal run. It refuses, and records, every ``sqlalchemy.create_engine`` call (what |
| 5 | ``tests/conftest.py::_db_schema`` uses) and every address lookup of an ``.invalid`` host, so a probe |
| 6 | session can neither reach a database nor reset a schema. The refusal is a ``RuntimeError``, never an |
| 7 | ``AssertionError``, so an ``xfail(raises=AssertionError)`` cannot absorb it. |
| 8 | |
| 9 | Environment: |
| 10 | DOCDB_REPORT path of the JSON report written at session end (required) |
| 11 | DOCDB_STRIP_NO_DB "1": drop ``no_db`` markers set by docs modules (a module that omits the marker) |
| 12 | DOCDB_INJECT "<fixture>=<node id>": add a DB fixture to one item's closure (a docs test that needs the DB) |
| 13 | """ |
| 14 | |
| 15 | from __future__ import annotations |
| 16 | |
| 17 | import json |
| 18 | import os |
| 19 | import socket |
| 20 | from pathlib import Path |
| 21 | |
| 22 | import pytest |
| 23 | import sqlalchemy |
| 24 | from sqlalchemy.engine import make_url |
| 25 | |
| 26 | _DOCS = "tests/docs_contract/" |
| 27 | |
| 28 | |
| 29 | class GuardBlocked(RuntimeError): |
| 30 | """A database engine or connection was attempted inside a guarded probe session.""" |
| 31 | |
| 32 | |
| 33 | _DB_FIXTURES = {"db_session", "session_factory"} |
| 34 | |
| 35 | _attempts: dict[str, list[str]] = {"engine": [], "socket": []} |
| 36 | _no_db: dict[str, bool] = {} |
| 37 | _db_closure: dict[str, list[str]] = {} |
| 38 | _outcomes: dict[str, str] = {} |
| 39 | |
| 40 | _real_getaddrinfo = socket.getaddrinfo |
| 41 | |
| 42 | |
| 43 | def _blocked_create_engine(url: object, *args: object, **kwargs: object) -> object: |
| 44 | host = make_url(str(url)).host or "" |
| 45 | _attempts["engine"].append(host) |
| 46 | raise GuardBlocked(f"docs DB guard: create_engine for host {host!r} refused") |
| 47 | |
| 48 | |
| 49 | def _guarded_getaddrinfo(host: object, *args: object, **kwargs: object) -> object: |
| 50 | name = host.decode() if isinstance(host, bytes) else str(host) |
| 51 | if name.rstrip(".").endswith(".invalid"): |
| 52 | _attempts["socket"].append(name) |
| 53 | raise GuardBlocked(f"docs DB guard: lookup of {name!r} refused") |
| 54 | return _real_getaddrinfo(host, *args, **kwargs) # type: ignore[arg-type] |
| 55 | |
| 56 | |
| 57 | def pytest_configure(config: pytest.Config) -> None: |
| 58 | sqlalchemy.create_engine = _blocked_create_engine # type: ignore[assignment] |
| 59 | socket.getaddrinfo = _guarded_getaddrinfo # type: ignore[assignment] |
| 60 | |
| 61 | |
| 62 | def pytest_itemcollected(item: pytest.Item) -> None: |
| 63 | if not item.nodeid.startswith(_DOCS): |
| 64 | return |
| 65 | if os.environ.get("DOCDB_STRIP_NO_DB") == "1": |
| 66 | for node in item.listchain(): |
| 67 | node.own_markers = [m for m in node.own_markers if m.name != "no_db"] |
| 68 | fixture, _, nodeid = os.environ.get("DOCDB_INJECT", "").partition("=") |
| 69 | if fixture and item.nodeid == nodeid: |
| 70 | item.fixturenames = [*item.fixturenames, fixture] # type: ignore[attr-defined] # own copy: params share the closure list |
| 71 | |
| 72 | |
| 73 | def pytest_collection_finish(session: pytest.Session) -> None: |
| 74 | for item in session.items: |
| 75 | _no_db[item.nodeid] = item.get_closest_marker("no_db") is not None |
| 76 | _db_closure[item.nodeid] = sorted(_DB_FIXTURES.intersection(getattr(item, "fixturenames", ()))) |
| 77 | |
| 78 | |
| 79 | def pytest_runtest_logreport(report: pytest.TestReport) -> None: |
| 80 | if report.when == "teardown" and report.failed: |
| 81 | _outcomes[report.nodeid] = "error" |
| 82 | return |
| 83 | if report.nodeid in _outcomes or (report.when == "setup" and report.passed) or report.when == "teardown": |
| 84 | return |
| 85 | if hasattr(report, "wasxfail"): |
| 86 | _outcomes[report.nodeid] = "xfailed" if report.skipped else "xpassed" |
| 87 | elif report.failed: |
| 88 | _outcomes[report.nodeid] = "failed" if report.when == "call" else "error" |
| 89 | else: |
| 90 | _outcomes[report.nodeid] = report.outcome |
| 91 | |
| 92 | |
| 93 | def pytest_sessionfinish(session: pytest.Session, exitstatus: int) -> None: |
| 94 | report = { |
| 95 | "engine_attempts": _attempts["engine"], |
| 96 | "socket_attempts": _attempts["socket"], |
| 97 | "no_db": _no_db, |
| 98 | "db_closure": _db_closure, |
| 99 | "outcomes": _outcomes, |
| 100 | } |
| 101 | Path(os.environ["DOCDB_REPORT"]).write_text(json.dumps(report, indent=1, sort_keys=True)) |
File History
1 commit
sha256:f7413c1abec6d6a8e5bdabcd4cc7ad5fcd059ce6a6f50f566e2b0118a0a8b578
tests: make tests/docs_contract/ database-free by directory…
Opus 5.5
10 days ago