headroom/tests/test_network_diff_capture.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

131 lines
4.4 KiB
Python
Raw Permalink Normal View History

feat: add differential network capture harness (#761) ## Summary - add a containerized differential network capture harness for Claude Code direct vs Claude Code routed through Headroom - capture both Headroom client-side traffic and Headroom upstream traffic with sanitized mitmproxy JSONL output - add `headroom capture network-diff` to compare captures and produce Markdown/JSON reports, including Anthropic tool-count/tool-byte deltas for deferred-tool investigations - add an on-demand GitHub Actions workflow for the harness; it only runs via `workflow_dispatch`, with live Claude Code/Anthropic capture gated on `ANTHROPIC_API_KEY` - document the workflow and ignore generated capture artifacts ## Validation - `C:\git\headroom\.venv\Scripts\python.exe -m pytest tests/test_network_diff_capture.py` - `ruff check headroom/capture headroom/cli/capture.py tests/test_network_diff_capture.py` - `ruff format --check headroom/capture headroom/cli/capture.py tests/test_network_diff_capture.py` - `C:\git\headroom\.venv\Scripts\python.exe -m mypy headroom/capture/network_diff.py headroom/cli/capture.py` - `docker compose -f docker/differential-network-capture/docker-compose.yml --profile run config` - `docker compose -f docker/differential-network-capture/docker-compose.yml --profile run build claude-direct` - `docker run --rm -e CLAUDE_COMMAND="claude --version" headroom-network-diff-claude-direct:latest` - parsed `.github/workflows/network-diff-capture.yml` with PyYAML and confirmed manual-only trigger Live Claude API capture was not run locally because `ANTHROPIC_API_KEY` is not set in this environment. The workflow can run it manually in GitHub Actions when that secret is present; otherwise it emits a visible skip warning and uploads a skipped artifact. ## Notes - Full pre-commit mypy still fails on unrelated Windows `fcntl` attributes in `headroom/subscription/tracker.py`; the feature commit skipped only that hook after narrow mypy passed for the new modules. - `tests/test_release_workflows.py` has two Windows-local failures because it shells out to a missing Unix/Rust command; unrelated workflow checks in that file passed before those failures. - Motivated by https://github.com/chopratejas/headroom/issues/746#issuecomment-4651276818 / Issue #746.
2026-06-09 00:18:31 -05:00
from __future__ import annotations
import base64
import json
from pathlib import Path
from click.testing import CliRunner
from headroom.capture.network_diff import (
compare_captures,
load_capture_file,
render_markdown_report,
)
from headroom.cli.main import main
def _write_jsonl(path: Path, records: list[dict[str, object]]) -> None:
path.write_text("\n".join(json.dumps(record) for record in records) + "\n", encoding="utf-8")
def _body(payload: dict[str, object]) -> str:
return base64.b64encode(json.dumps(payload).encode("utf-8")).decode("ascii")
def test_network_diff_redacts_and_reports_body_json_deltas(tmp_path: Path) -> None:
direct_path = tmp_path / "direct.jsonl"
headroom_path = tmp_path / "headroom.jsonl"
_write_jsonl(
direct_path,
[
{
"lane": "direct",
"method": "POST",
"url": "https://api.anthropic.com/v1/messages?api_key=secret",
"request_headers": {
"authorization": "Bearer secret",
"anthropic-version": "2023-06-01",
"anthropic-beta": "deferred-tools",
},
"request_body_b64": _body(
{"model": "claude", "messages": [{"content": "hi"}], "tools": []}
),
"response_status": 200,
}
],
)
_write_jsonl(
headroom_path,
[
{
"lane": "headroom",
"method": "POST",
"url": "https://api.anthropic.com/v1/messages?api_key=secret",
"request_headers": {
"authorization": "Bearer other",
"anthropic-version": "2023-06-01",
"x-headroom-mode": "optimize",
},
"request_body_b64": _body(
{
"model": "claude",
"messages": [{"content": "hello"}],
"metadata": {},
"tools": [{"name": "ctx_execute", "input_schema": {"type": "object"}}],
}
),
"response_status": 200,
}
],
)
direct = load_capture_file(direct_path, fallback_lane="direct")
headroom = load_capture_file(headroom_path, fallback_lane="headroom")
assert direct[0].url == "https://api.anthropic.com/v1/messages?api_key=%3Credacted%3E"
assert direct[0].request_headers["authorization"] == "<redacted>"
diff = compare_captures(direct, headroom)
assert diff.direct_count == 1
assert diff.headroom_count == 1
paired = diff.paired[0]
assert paired["headers"]["only_headroom"] == ["x-headroom-mode"]
assert "$.metadata" in paired["json"]["only_headroom"]
assert "$.messages[0].content" in paired["json"]["changed"]
assert paired["anthropic"]["direct"]["tools_count"] == 0
assert paired["anthropic"]["headroom"]["tools_count"] == 1
markdown = render_markdown_report(diff)
assert "Differential Network Capture Report" in markdown
assert "POST api.anthropic.com/v1/messages?api_key=%3Credacted%3E" in markdown
assert "tools=0->1" in markdown
def test_network_diff_cli_writes_markdown_and_json(tmp_path: Path) -> None:
direct_path = tmp_path / "direct.jsonl"
headroom_path = tmp_path / "headroom.jsonl"
markdown_path = tmp_path / "report.md"
json_path = tmp_path / "report.json"
record = {
"method": "POST",
"url": "https://api.anthropic.com/v1/messages",
"request_headers": {},
"request_body_b64": _body({"model": "claude"}),
"response_status": 200,
}
_write_jsonl(direct_path, [record])
_write_jsonl(headroom_path, [record])
result = CliRunner().invoke(
main,
[
"capture",
"network-diff",
"--direct",
str(direct_path),
"--headroom",
str(headroom_path),
"--output",
str(markdown_path),
"--json-output",
str(json_path),
],
)
assert result.exit_code == 0, result.output
assert "Wrote Markdown report" in result.output
assert "Differential Network Capture Report" in markdown_path.read_text(encoding="utf-8")
payload = json.loads(json_path.read_text(encoding="utf-8"))
assert payload["direct_count"] == 1
assert payload["headroom_count"] == 1