Files
repoctl/tests-universal/test_envelope_and_exit_codes.py
T
Alexander BaranovandClaude Opus 5 c483d94f36 fix(cli): report a refused plan as an envelope
Only `apply` had a handler for AdoptionError, which was true when the error
type was introduced. `plan` has since gained two ways to refuse: it validates
the managed block of an existing CLAUDE.md to test idempotence, and it now
decides the knowledge entrypoint by content. Both reached the top-level safety
net in main, which prints a bare line to stderr and exits -- so `--output json`
answered a caller with no envelope at all, breaking the machine-readable
contract precisely when something went wrong and the caller needed the code.

The mapping from finding code to exit code now lives in one place rather than
being spelled out per branch.

- add _adoption_failure and use it from both plan and apply
- cover a refused plan end to end, envelope shape and exit code included

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-24 22:56:58 +03:00

110 lines
4.5 KiB
Python

"""specification.md 4.1, 4.2, 19.2: envelope shape and exit codes."""
from __future__ import annotations
from pathlib import Path
from conftest import RESULT_SCHEMA, git_init, run_repoctl
def test_validate_success_envelope_and_exit_0(repo: Path) -> None:
result = run_repoctl("validate", "--repo", str(repo), "--output", "json")
assert result.returncode == 0, result.stderr
envelope = result.envelope()
assert envelope["schema"] == RESULT_SCHEMA
assert envelope["command"] == "validate"
assert envelope["outcome"] == "success"
assert envelope["findings"] == []
assert "data" in envelope
def test_validate_missing_repository_exits_3(tmp_path: Path) -> None:
empty = tmp_path / "not-a-repo"
empty.mkdir()
# No .git ancestor at all: repository cannot be resolved.
result = run_repoctl("validate", "--repo", str(empty), "--output", "json")
assert result.returncode == 3, (result.returncode, result.stderr)
def test_unknown_command_exits_2() -> None:
result = run_repoctl("not-a-real-command", "--output", "json")
assert result.returncode == 2
def test_validate_broken_contract_exits_1(tmp_path: Path) -> None:
root = tmp_path / "broken-repo"
(root / "ops").mkdir(parents=True)
(root / "ops" / "contract.yaml").write_text("kind: RepositoryContract\n", encoding="utf-8")
git_init(root)
result = run_repoctl("validate", "--repo", str(root), "--output", "json")
assert result.returncode == 1, (result.returncode, result.stdout, result.stderr)
envelope = result.envelope()
assert envelope["outcome"] == "failure"
assert any(f["severity"] == "error" for f in envelope["findings"])
def test_findings_have_required_shape(tmp_path: Path) -> None:
"""4.3 / 19.3: every finding carries severity in {info, warning, error}, a code, a message."""
root = tmp_path / "broken-repo-2"
(root / "ops").mkdir(parents=True)
(root / "ops" / "contract.yaml").write_text("not: a-valid-contract\n", encoding="utf-8")
git_init(root)
result = run_repoctl("validate", "--repo", str(root), "--output", "json")
envelope = result.envelope()
for finding in envelope["findings"]:
assert finding["severity"] in {"info", "warning", "error"}
assert isinstance(finding.get("code"), str) and finding["code"]
assert isinstance(finding.get("message"), str) and finding["message"]
def test_output_modes_yaml_and_json_both_parseable(repo: Path) -> None:
import json
from ruamel.yaml import YAML
json_result = run_repoctl("validate", "--repo", str(repo), "--output", "json")
json.loads(json_result.stdout)
yaml_result = run_repoctl("validate", "--repo", str(repo), "--output", "yaml")
YAML(typ="safe").load(yaml_result.stdout)
def test_human_output_writes_diagnostics_to_stderr_not_stdout(repo: Path) -> None:
"""PLAN.md: 'Machine output идёт только в stdout, диагностика процесса — в stderr.'"""
result = run_repoctl("validate", "--repo", str(repo), "--output", "human")
assert result.returncode == 0
# A clean validate has no findings to print, but stdout must not carry a JSON/YAML
# machine envelope in human mode either.
assert "schema:" not in result.stdout and '"schema"' not in result.stdout
def test_refused_adopt_plan_is_still_an_envelope(tmp_path: Path) -> None:
"""A refused `plan` must fail through the envelope, not the top-level net.
`plan` validates the managed block of an existing entrypoint and decides the
knowledge entrypoint by content, so it can refuse. Reaching the safety net in
`main` would print a bare line to stderr and exit, which breaks the
machine-readable contract `--output json` promises to its callers.
"""
root = tmp_path / "duplicated-markers"
root.mkdir()
(root / "README.md").write_text("# Sample\n", encoding="utf-8")
(root / "CLAUDE.md").write_text(
"# CLAUDE.md\n\n"
"<!-- stewardship:managed:start -->\nfirst\n<!-- stewardship:managed:end -->\n\n"
"<!-- stewardship:managed:start -->\nsecond\n<!-- stewardship:managed:end -->\n",
encoding="utf-8",
)
git_init(root)
result = run_repoctl("adopt", "--repo", str(root), "--mode", "plan", "--output", "json")
assert result.returncode == 1, (result.returncode, result.stderr)
envelope = result.envelope()
assert envelope["schema"] == RESULT_SCHEMA
assert envelope["command"] == "adopt plan"
assert envelope["outcome"] == "failure"
assert [f["code"] for f in envelope["findings"]] == ["ADOPT_MANAGED_BLOCK_MALFORMED"]