headroom/e2e/_lib/assertions.py
JerrettDavis 3ca2ce08ae refactor(e2e): extract reusable harness into e2e/_lib
Centralize Docker / CI e2e test helpers so per-command suites can be
declarative and future commands (install, wrap, ...) can reuse the same
shim/PATH/assertion primitives without duplicating infrastructure.

The harness provides:

* Case dataclass describing one test as argv + shims + expected exit /
  stdout / stderr / files / custom callbacks
* make_shim() factory producing cross-platform executable shims (.sh on
  POSIX, .cmd on Windows) with noop / fail / record-args behaviors
* with_clean_path() context manager that isolates PATH to a minimal
  known-good value plus any extras supplied by the case
* agent_settings_path() locator mirroring headroom.cli.init so tests can
  assert the right file was written without touching private init state
* run_cases() for independent cases and run_case_sequence() for cases
  that must share scratch state (e.g. manifest-merge scenarios)

Shell / PowerShell shim-creation scripts are also shipped for CI steps
that need to drop a shim without spinning up Python first.

No behavior change in this commit - pure infrastructure. The init suite
and new subcommand suites consume the harness in follow-up commits.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-23 15:50:12 -05:00

43 lines
1.4 KiB
Python

"""Shared assertion helpers for e2e cases.
Assertions raise ``AssertionError`` with a descriptive message. The harness
catches them and attributes the failure to the owning ``Case``.
"""
from __future__ import annotations
import json
from pathlib import Path
from typing import Any
from .paths import Agent, Scope, agent_settings_path
def assert_exit(actual: int, expected: int, *, context: str = "") -> None:
if actual != expected:
suffix = f" ({context})" if context else ""
raise AssertionError(f"Expected exit code {expected}, got {actual}{suffix}")
def assert_stdout_contains(stdout: str, needle: str) -> None:
if needle not in stdout:
raise AssertionError(f"stdout missing {needle!r}:\n---\n{stdout}\n---")
def assert_stderr_contains(stderr: str, needle: str) -> None:
if needle not in stderr:
raise AssertionError(f"stderr missing {needle!r}:\n---\n{stderr}\n---")
def read_agent_settings(
agent: Agent, *, scope: Scope, home: Path, project: Path
) -> dict[str, Any] | str:
"""Read an agent's settings file, returning dict for JSON and str for TOML/other."""
path = agent_settings_path(agent, scope=scope, home=home, project=project)
if not path.exists():
raise AssertionError(f"Expected settings file at {path}, not found")
text = path.read_text(encoding="utf-8")
if path.suffix == ".json":
return json.loads(text)
return text