"""Supercharge tests for ``muse code invariants`` — agent-usability gaps. Existing tests (test_cmd_invariants.py) cover rule types, violation detection, --strict, --rule filter, no-rules file default, JSON schema basics. This file targets only the gaps those tests leave open: Coverage matrix --------------- - --json / -j: -j alias works identically to --json - exit_code: JSON output includes exit_code reflecting violation status (0 = all pass / warnings only; 1 = errors or strict+warnings) - duration_ms: JSON output includes non-negative float duration_ms - TypedDicts: _InvariantsOutputJson carries exit_code and duration_ms - Docstrings: run() docstring mentions exit_code and duration_ms - ANSI: JSON output never contains terminal escape sequences - Performance: duration_ms stays under 2000 ms for a small repo - Early-exit paths: no-match --rule filter emits exit_code and duration_ms - HEAD~N ref syntax: --commit HEAD~1 must not crash (was raising ValueError) """ from __future__ import annotations from collections.abc import Mapping import argparse import json import pathlib import textwrap import pytest from tests.cli_test_helper import CliRunner, InvokeResult runner = CliRunner() # --------------------------------------------------------------------------- # Helpers # --------------------------------------------------------------------------- def _env(root: pathlib.Path) -> Mapping[str, str]: return {"MUSE_REPO_ROOT": str(root)} def _run(root: pathlib.Path, *args: str) -> InvokeResult: return runner.invoke(None, list(args), env=_env(root)) # --------------------------------------------------------------------------- # Fixture — minimal Python repo (no invariants violations) # --------------------------------------------------------------------------- @pytest.fixture() def inv_repo( tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch ) -> pathlib.Path: """Minimal repo — clean Python files, no circular imports.""" monkeypatch.chdir(tmp_path) r = _run(tmp_path, "init", "--domain", "code") assert r.exit_code == 0, r.output (tmp_path / "core.py").write_text(textwrap.dedent("""\ def compute(x): return x * 2 """)) (tmp_path / "service.py").write_text(textwrap.dedent("""\ from core import compute def process(x): return compute(x) """)) r = _run(tmp_path, "code", "add", ".") assert r.exit_code == 0, r.output r = _run(tmp_path, "commit", "-m", "seed invariants repo") assert r.exit_code == 0, r.output return tmp_path # --------------------------------------------------------------------------- # TestJsonAlias — -j works identically to --json # --------------------------------------------------------------------------- class TestJsonAlias: """-j shorthand must behave identically to --json.""" def test_j_alias_exits_zero(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") assert r.exit_code == 0, r.output def test_j_alias_valid_json(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") json.loads(r.output) # must not raise def test_j_alias_has_violations_key(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") assert "violations" in json.loads(r.output) def test_j_alias_has_errors_key(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") assert "errors" in json.loads(r.output) def test_j_alias_same_top_level_keys_as_json_flag( self, inv_repo: pathlib.Path ) -> None: r1 = _run(inv_repo, "code", "invariants", "--json") r2 = _run(inv_repo, "code", "invariants", "-j") d1 = json.loads(r1.output) d2 = json.loads(r2.output) d1.pop("duration_ms", None) d2.pop("duration_ms", None) assert set(d1.keys()) == set(d2.keys()) def test_j_alias_violations_is_list(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") data = json.loads(r.output) assert isinstance(data["violations"], list) def test_j_alias_rules_checked_positive(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") data = json.loads(r.output) assert data["rules_checked"] >= 0 # --------------------------------------------------------------------------- # TestDurationMs — JSON output must include duration_ms # --------------------------------------------------------------------------- class TestDurationMs: """JSON output must include a non-negative float duration_ms.""" def test_json_has_duration_ms(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert "duration_ms" in json.loads(r.output) def test_json_duration_ms_nonnegative(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert json.loads(r.output)["duration_ms"] >= 0 def test_json_duration_ms_is_float(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert isinstance(json.loads(r.output)["duration_ms"], float) def test_j_alias_duration_ms_present(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") assert "duration_ms" in json.loads(r.output) def test_duration_ms_under_2000ms(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert json.loads(r.output)["duration_ms"] < 2000 # --------------------------------------------------------------------------- # TestExitCode — JSON includes exit_code reflecting violation status # --------------------------------------------------------------------------- class TestExitCode: """JSON exit_code must mirror the process exit code.""" def test_json_has_exit_code(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert "exit_code" in json.loads(r.output) def test_json_exit_code_zero_clean_repo(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert r.exit_code == 0 assert json.loads(r.output)["exit_code"] == 0 def test_json_exit_code_is_int(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert isinstance(json.loads(r.output)["exit_code"], int) def test_j_alias_exit_code_present(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") assert "exit_code" in json.loads(r.output) def test_exit_code_mirrors_process_exit(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert json.loads(r.output)["exit_code"] == r.exit_code # --------------------------------------------------------------------------- # TestTypedDicts — _InvariantsOutputJson carries exit_code and duration_ms # --------------------------------------------------------------------------- class TestTypedDicts: """_InvariantsOutputJson must carry exit_code and duration_ms annotations.""" def test_invariants_output_json_typeddict_exists(self) -> None: from muse.cli.commands.invariants import _InvariantsOutputJson # noqa: F401 def test_has_exit_code_annotation(self) -> None: from muse.cli.commands.invariants import _InvariantsOutputJson assert "exit_code" in _InvariantsOutputJson.__annotations__ def test_has_duration_ms_annotation(self) -> None: from muse.cli.commands.invariants import _InvariantsOutputJson assert "duration_ms" in _InvariantsOutputJson.__annotations__ def test_has_violations_annotation(self) -> None: from muse.cli.commands.invariants import _InvariantsOutputJson assert "violations" in _InvariantsOutputJson.__annotations__ def test_has_errors_annotation(self) -> None: from muse.cli.commands.invariants import _InvariantsOutputJson assert "errors" in _InvariantsOutputJson.__annotations__ def test_has_warnings_annotation(self) -> None: from muse.cli.commands.invariants import _InvariantsOutputJson assert "warnings" in _InvariantsOutputJson.__annotations__ # --------------------------------------------------------------------------- # TestDocstrings — run() docstring documents exit_code and duration_ms # --------------------------------------------------------------------------- # --------------------------------------------------------------------------- # TestAnsiSanitization — no escape codes in JSON output # --------------------------------------------------------------------------- class TestAnsiSanitization: """No ANSI escape sequences anywhere in the JSON output.""" def test_json_output_no_ansi(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert "\x1b" not in r.output def test_j_alias_output_no_ansi(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "-j") assert "\x1b" not in r.output # --------------------------------------------------------------------------- # TestPerformance — duration_ms under 2000 ms for small repo # --------------------------------------------------------------------------- class TestPerformance: """duration_ms must stay under 2000 ms for small repos.""" def test_json_duration_under_2000ms(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert json.loads(r.output)["duration_ms"] < 2000 def test_duration_ms_is_float_not_int(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--json") assert isinstance(json.loads(r.output)["duration_ms"], float) # --------------------------------------------------------------------------- # TestEarlyExitPaths — no-match and no-rules paths must include envelope fields # --------------------------------------------------------------------------- class TestEarlyExitPaths: """Every JSON-emitting code path must include exit_code and duration_ms.""" def test_no_match_rule_filter_has_exit_code(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--rule", "zzz_no_such_rule", "-j") assert r.exit_code == 0, r.output data = json.loads(r.output) assert "exit_code" in data assert data["exit_code"] == 0 def test_no_match_rule_filter_has_duration_ms(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--rule", "zzz_no_such_rule", "-j") data = json.loads(r.output) assert "duration_ms" in data assert isinstance(data["duration_ms"], float) assert data["duration_ms"] >= 0 def test_no_match_rule_filter_has_error_field(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--rule", "zzz_no_such_rule", "-j") data = json.loads(r.output) assert data.get("error") == "no_matching_rules" def test_no_match_rule_filter_no_ansi(self, inv_repo: pathlib.Path) -> None: r = _run(inv_repo, "code", "invariants", "--rule", "zzz_no_such_rule", "-j") assert "\x1b" not in r.output # --------------------------------------------------------------------------- # TestRelativeRefSyntax — HEAD~N must not crash # --------------------------------------------------------------------------- class TestRelativeRefSyntax: """--commit HEAD~N and similar relative refs must not raise ValueError.""" @pytest.fixture() def two_commit_repo( self, tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch ) -> pathlib.Path: """Repo with two commits so HEAD~1 resolves to a real commit.""" monkeypatch.chdir(tmp_path) r = _run(tmp_path, "init", "--domain", "code") assert r.exit_code == 0, r.output (tmp_path / "core.py").write_text("def compute(x):\n return x * 2\n") r = _run(tmp_path, "code", "add", ".") assert r.exit_code == 0, r.output r = _run(tmp_path, "commit", "-m", "first") assert r.exit_code == 0, r.output (tmp_path / "service.py").write_text("def process(x):\n return x\n") r = _run(tmp_path, "code", "add", ".") assert r.exit_code == 0, r.output r = _run(tmp_path, "commit", "-m", "second") assert r.exit_code == 0, r.output return tmp_path def test_head_tilde_1_does_not_crash(self, two_commit_repo: pathlib.Path) -> None: r = _run(two_commit_repo, "code", "invariants", "--commit", "HEAD~1", "-j") # Must not crash with ValueError — exit 0 or 1 (depending on violations) assert r.exit_code in (0, 1), r.output def test_head_tilde_1_emits_valid_json(self, two_commit_repo: pathlib.Path) -> None: r = _run(two_commit_repo, "code", "invariants", "--commit", "HEAD~1", "-j") assert r.exit_code in (0, 1), r.output json.loads(r.output) # must not raise def test_head_tilde_1_has_exit_code(self, two_commit_repo: pathlib.Path) -> None: r = _run(two_commit_repo, "code", "invariants", "--commit", "HEAD~1", "-j") assert "exit_code" in json.loads(r.output) def test_head_tilde_1_has_duration_ms(self, two_commit_repo: pathlib.Path) -> None: r = _run(two_commit_repo, "code", "invariants", "--commit", "HEAD~1", "-j") data = json.loads(r.output) assert "duration_ms" in data assert isinstance(data["duration_ms"], float) # --------------------------------------------------------------------------- # TestRegisterFlags — argparse-level verification # --------------------------------------------------------------------------- class TestRegisterFlags: """Verify that register() wires --json / -j correctly.""" def _make_parser(self) -> "argparse.ArgumentParser": import argparse from muse.cli.commands.invariants import register ap = argparse.ArgumentParser() subs = ap.add_subparsers() register(subs) return ap def test_json_flag_long(self) -> None: ns = self._make_parser().parse_args(["invariants", "--json"]) assert ns.json_out is True def test_j_alias(self) -> None: ns = self._make_parser().parse_args(["invariants", "-j"]) assert ns.json_out is True def test_default_is_text(self) -> None: ns = self._make_parser().parse_args(["invariants"]) assert ns.json_out is False def test_dest_is_json_out(self) -> None: ns = self._make_parser().parse_args(["invariants", "-j"]) assert hasattr(ns, "json_out") assert not hasattr(ns, "fmt")