Add timeout parameters to 4 subprocess.run() calls that could hang indefinitely if the child process blocks (e.g., unresponsive docker daemon, systemctl waiting for D-Bus): - doctor.py: docker info (timeout=10), ssh check (timeout=15) - status.py: systemctl is-active (timeout=5), launchctl list (timeout=5) Each call site now catches subprocess.TimeoutExpired and treats it as a failure, consistent with how non-zero return codes are already handled. Add AST-based regression test that verifies every subprocess.run() call in CLI modules specifies a timeout keyword argument. Co-authored-by: dieutx <dangtc94@gmail.com>
45 lines
1.5 KiB
Python
45 lines
1.5 KiB
Python
"""Tests for subprocess.run() timeout coverage in CLI utilities."""
|
|
import ast
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
|
|
# Parameterise over every CLI module that calls subprocess.run
|
|
_CLI_MODULES = [
|
|
"hermes_cli/doctor.py",
|
|
"hermes_cli/status.py",
|
|
"hermes_cli/clipboard.py",
|
|
"hermes_cli/banner.py",
|
|
]
|
|
|
|
|
|
def _subprocess_run_calls(filepath: str) -> list[dict]:
|
|
"""Parse a Python file and return info about subprocess.run() calls."""
|
|
source = Path(filepath).read_text()
|
|
tree = ast.parse(source, filename=filepath)
|
|
calls = []
|
|
for node in ast.walk(tree):
|
|
if not isinstance(node, ast.Call):
|
|
continue
|
|
func = node.func
|
|
if (isinstance(func, ast.Attribute) and func.attr == "run"
|
|
and isinstance(func.value, ast.Name)
|
|
and func.value.id == "subprocess"):
|
|
has_timeout = any(kw.arg == "timeout" for kw in node.keywords)
|
|
calls.append({"line": node.lineno, "has_timeout": has_timeout})
|
|
return calls
|
|
|
|
|
|
@pytest.mark.parametrize("filepath", _CLI_MODULES)
|
|
def test_all_subprocess_run_calls_have_timeout(filepath):
|
|
"""Every subprocess.run() call in CLI modules must specify a timeout."""
|
|
if not Path(filepath).exists():
|
|
pytest.skip(f"{filepath} not found")
|
|
calls = _subprocess_run_calls(filepath)
|
|
missing = [c for c in calls if not c["has_timeout"]]
|
|
assert not missing, (
|
|
f"{filepath} has subprocess.run() without timeout at "
|
|
f"line(s): {[c['line'] for c in missing]}"
|
|
)
|