Public Access
DEVX-134: feat: add I/O function isolation check and skip integration tests
This commit was merged in pull request #201.
This commit is contained in:
@@ -30,7 +30,10 @@ Patterns detected:
|
||||
without patching it.
|
||||
3. **Unpatched known-subprocess-helpers** — functions known to spawn
|
||||
subprocesses (e.g. ``update_doc_versions``) called without patching.
|
||||
4. **Excessive iteration loops** — ``for _ in range(N)`` where N > 100.
|
||||
4. **Unpatched I/O functions** — functions known to do filesystem or
|
||||
network I/O (e.g. ``get_pat``, ``load_secrets``, ``requests.get``)
|
||||
called without patching.
|
||||
5. **Excessive iteration loops** — ``for _ in range(N)`` where N > 100.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
@@ -57,6 +60,23 @@ KNOWN_SUBPROCESS_HELPERS: dict[str, str] = {
|
||||
"run_cmd": "calls subprocess.run for shell commands",
|
||||
}
|
||||
|
||||
# Functions known to do filesystem or network I/O that should be mocked in tests.
|
||||
# Maps function name → description of what I/O it does.
|
||||
# If a test calls one of these without a corresponding @patch, it's a violation.
|
||||
KNOWN_IO_FUNCTIONS: dict[str, str] = { # nosec B105 — descriptions, not passwords
|
||||
"get_pat": "reads ZITADEL PAT from filesystem/env (ZitadelAuth._iter_sources)",
|
||||
"load_secrets": "reads YAML config file from disk",
|
||||
"get_customer_secret": "reads customer-specific config from disk",
|
||||
"requests.get": "performs HTTP GET to a real server",
|
||||
"requests.post": "performs HTTP POST to a real server",
|
||||
"requests.put": "performs HTTP PUT to a real server",
|
||||
"requests.patch": "performs HTTP PATCH to a real server",
|
||||
"requests.delete": "performs HTTP DELETE to a real server",
|
||||
"urlopen": "performs HTTP request to a real server",
|
||||
"httpx.get": "performs HTTP GET to a real server",
|
||||
"httpx.post": "performs HTTP POST to a real server",
|
||||
}
|
||||
|
||||
# Transitive dependencies: if a helper calls another helper that is patched,
|
||||
# the call is safe. Maps helper → set of function names it internally calls.
|
||||
# If ANY of these are in the test's patches, the helper call is safe.
|
||||
@@ -126,6 +146,20 @@ def _is_test_function(node: ast.FunctionDef | ast.AsyncFunctionDef) -> bool:
|
||||
return node.name.startswith("test_")
|
||||
|
||||
|
||||
def _has_integration_marker(node: ast.FunctionDef | ast.AsyncFunctionDef) -> bool:
|
||||
"""Check if a test function has @pytest.mark.integration decorator."""
|
||||
for decorator in node.decorator_list:
|
||||
# @pytest.mark.integration → ast.Attribute(attr='integration')
|
||||
if isinstance(decorator, ast.Attribute) and decorator.attr == "integration":
|
||||
return True
|
||||
# @pytest.mark.integration(...) → ast.Call(func=ast.Attribute(attr='integration'))
|
||||
if isinstance(decorator, ast.Call):
|
||||
func = decorator.func
|
||||
if isinstance(func, ast.Attribute) and func.attr == "integration":
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def _get_called_name(node: ast.Call) -> str | None:
|
||||
func = node.func
|
||||
if isinstance(func, ast.Name):
|
||||
@@ -208,6 +242,11 @@ class TestIsolationVisitor(ast.NodeVisitor):
|
||||
self.generic_visit(node)
|
||||
return
|
||||
|
||||
# Skip integration tests — they intentionally do real I/O
|
||||
if _has_integration_marker(node):
|
||||
self.generic_visit(node)
|
||||
return
|
||||
|
||||
patches = _extract_patch_targets(node)
|
||||
info = TestFunctionInfo(
|
||||
name=node.name,
|
||||
@@ -299,6 +338,34 @@ class TestIsolationVisitor(ast.NodeVisitor):
|
||||
)
|
||||
)
|
||||
|
||||
# Check 4: Known I/O functions (filesystem/network)
|
||||
# Match by short name (e.g. "get_pat") or full name (e.g. "requests.get")
|
||||
sn = short_name or ""
|
||||
io_key = sn if sn in KNOWN_IO_FUNCTIONS else None
|
||||
if io_key is None and full_name and full_name in KNOWN_IO_FUNCTIONS:
|
||||
io_key = full_name
|
||||
if io_key and not (
|
||||
io_key in all_patches
|
||||
or sn in all_patches
|
||||
or any(io_key in p or sn in p for p in all_patches)
|
||||
or any(p.endswith(f".{sn}") for p in all_patches)
|
||||
):
|
||||
self.violations.append(
|
||||
Violation(
|
||||
file=self.file_path,
|
||||
line=node.lineno,
|
||||
col=node.col_offset,
|
||||
category="unpatched-io",
|
||||
message=_(
|
||||
"{func} called in test '{test}' without @patch — "
|
||||
'this function {desc}. Add @patch("<module>.{func}").',
|
||||
func=io_key,
|
||||
test=self._current_function.name,
|
||||
desc=KNOWN_IO_FUNCTIONS[io_key],
|
||||
),
|
||||
)
|
||||
)
|
||||
|
||||
self.generic_visit(node)
|
||||
|
||||
def visit_For(self, node: ast.For) -> None:
|
||||
@@ -334,7 +401,13 @@ def find_test_files(test_path: Path) -> list[Path]:
|
||||
|
||||
|
||||
def analyze_file(file_path: Path, max_loop_iterations: int = DEFAULT_MAX_LOOP_ITERATIONS) -> list[Violation]:
|
||||
"""Analyze a single test file for isolation violations."""
|
||||
"""Analyze a single test file for isolation violations.
|
||||
|
||||
Files in ``integration/`` directories are skipped — integration tests
|
||||
intentionally do real I/O (subprocess, network, filesystem).
|
||||
"""
|
||||
if "integration" in file_path.parts:
|
||||
return []
|
||||
try:
|
||||
source = file_path.read_text()
|
||||
tree = ast.parse(source, filename=str(file_path))
|
||||
|
||||
Reference in New Issue
Block a user