mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description `headroom doctor` reports the `claude` check as a pass whenever `~/.claude/settings.json` carries an `ANTHROPIC_BASE_URL` pointing at the proxy. That is correct for the terminal Claude Code CLI. But Claude Desktop (`com.anthropic.claudefordesktop`) unconditionally overwrites that variable when spawning agent sessions (#869), so on a Desktop-primary machine `doctor` asserts routing that is in fact discarded, and nothing in the output hints that Desktop sessions are unrouted (#2925). ## Fix Add a per-surface `claude desktop` check that warns about the bypass when Claude Desktop's config directory is detected, pointing at #869. Following the issue's suggestion, it models per-surface reporting like the existing `wrap_marker` / `shell env` rows: it is a separate row emitted only when Desktop is present, so it never contradicts a genuinely routed CLI, and the existing `claude` check is left unchanged. Detection uses Claude Desktop's per-user config directory (distinct from the CLI's `~/.claude`): - macOS: `~/Library/Application Support/Claude` - Windows: `%APPDATA%\Claude` - Linux: `$XDG_CONFIG_HOME/Claude` (or `~/.config/Claude`) Fixes #2925 ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) - [ ] New feature - [ ] Breaking change - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - `headroom/cli/doctor.py`: add `claude_desktop_config_dir()` (cross-platform) and `check_claude_desktop()` (WARN when the dir exists, `None` otherwise); append it to the `doctor()` check list when present. - `tests/test_cli_doctor.py`: `TestClaudeDesktop` -- no row when absent; WARN naming the bypass and #869 when present; the `doctor --json` entrypoint appends the row only when Desktop is detected. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check`) - [x] Type checking passes (`mypy`) - [x] New tests added ### Test Output ```text tests/test_cli_doctor.py 78 passed # uvx ruff@0.15.22 check -> All checks passed! # uvx mypy@1.20.2 headroom/cli/doctor.py -> Success: no issues found in 1 source file ``` ## Real Behavior Proof - Environment: Windows 11, Python 3.12.11, project venv, pytest 9.1.1, ruff 0.15.22 and mypy 1.20.2 via uvx. - Exact command / steps: `uvx ruff@0.15.22 check headroom/cli/doctor.py tests/test_cli_doctor.py`; `uvx mypy@1.20.2 headroom/cli/doctor.py`; `python -m pytest tests/test_cli_doctor.py -q`; then drove the check directly and through the `doctor --json` entrypoint with `claude_desktop_config_dir` pointed at a tmp dir (created the dir, ran `doctor --json`, then removed it and reran). - Observed result: with the dir present, a `claude desktop` row appears with status `warn` and a `#869` hint; with the dir absent, no such row is emitted and the rest of the report is unchanged. A Desktop-primary machine now gets an explicit warning that Desktop agent sessions bypass the proxy, instead of a bare `claude: pass` that reads as though all Claude routing is live. - Not tested: a live Claude Desktop install (detection is directory-existence, exercised against a tmp dir). ## Runtime Rollout Safety - Rollout-managed feature(s): none. This adds a read-only diagnostic row to `headroom doctor`; it is not behind any rollout channel or feature flag. - Minimum rollout channel: N/A (no rollout-managed behavior). - Stable/default behavior changed: no. The existing `claude` check and all other rows are unchanged; the new `claude desktop` row is additive and only appears when Claude Desktop's config directory is detected. - Kill switch / disable path: N/A. The row self-suppresses (returns `None`) on any machine without the Desktop config directory. - Unsafe override required: no. - Qualification impact: none. No proxy request path, routing, or token accounting is touched; the change is confined to the doctor diagnostic surface. - Rollback path: revert this PR; the doctor output returns to its prior set of rows with no state or migration to undo. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective - [x] New and existing unit tests pass locally with my changes - [x] I did **not** edit `CHANGELOG.md`: it is generated by release-please from my Conventional Commit PR title ## Additional Notes Scope: this warns whenever Claude Desktop is present, which is accurate (Desktop agent sessions always bypass per #869) and matches the precedent for doctor-accuracy fixes (#2618/#2614 Codex, #2566 ollama). The issue's stronger refinement -- suppress the warning when a `client=claude-code` request has recently reached the proxy -- would need per-client traffic observation the doctor does not have today; I left that as a follow-up rather than build new traffic-tracking infra into this fix. Happy to add it if you'd prefer the conditional form. Rebased onto current `main` to resolve an overlap with the newly merged `check_claude_auth_conflict` in `doctor.py`; both checks now coexist. Co-authored-by: JD Davis <mxjerrett@gmail.com>
700 lines
27 KiB
Python
700 lines
27 KiB
Python
"""Tests for `headroom doctor`."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from dataclasses import dataclass
|
|
|
|
import pytest
|
|
from click.testing import CliRunner
|
|
|
|
import headroom.cli.doctor as doctor_mod
|
|
from headroom.cli.doctor import (
|
|
FAIL,
|
|
PASS,
|
|
SKIP,
|
|
WARN,
|
|
check_budget,
|
|
check_claude_desktop,
|
|
check_claude_remote_control_gate,
|
|
check_claude_routing,
|
|
check_codex_routing,
|
|
check_deployments,
|
|
check_proxy_liveness,
|
|
check_savings,
|
|
check_shell_env,
|
|
check_version_drift,
|
|
)
|
|
from headroom.cli.main import main
|
|
from headroom.providers.claude.runtime import remote_control_gate_message
|
|
|
|
LIVEZ_OK = {
|
|
"service": "headroom-proxy",
|
|
"status": "healthy",
|
|
"alive": True,
|
|
"version": "0.26.0",
|
|
"uptime_seconds": 260135.0,
|
|
}
|
|
|
|
STATS_OK = {
|
|
"persistent_savings": {
|
|
"lifetime": {"tokens_saved": 17_583_102, "compression_savings_usd": 7.81701},
|
|
"display_session": {"last_activity_at": "2026-06-12T12:00:00Z"},
|
|
},
|
|
"cost": {"budget_limit_usd": 10.0, "budget_period": "daily"},
|
|
}
|
|
|
|
|
|
class TestProxyLiveness:
|
|
def test_down_is_fail_with_hint(self):
|
|
result = check_proxy_liveness(None, "http://127.0.0.1:8787")
|
|
assert result.status == FAIL
|
|
assert "headroom proxy" in (result.hint or "")
|
|
|
|
def test_up_mentions_version_and_uptime(self):
|
|
result = check_proxy_liveness(LIVEZ_OK, "http://127.0.0.1:8787")
|
|
assert result.status == PASS
|
|
assert "v0.26.0" in result.summary
|
|
assert "3d" in result.summary
|
|
|
|
def test_up_leaves_source_label_unprefixed(self):
|
|
livez = {**LIVEZ_OK, "version": "source-build+sha.abcdef123456"}
|
|
result = check_proxy_liveness(livez, "http://127.0.0.1:8787")
|
|
assert result.status == PASS
|
|
assert "source-build+sha.abcdef123456" in result.summary
|
|
assert "vsource-build" not in result.summary
|
|
|
|
|
|
class TestVersionDrift:
|
|
def test_match_passes(self):
|
|
assert check_version_drift(LIVEZ_OK, "0.26.0").status == PASS
|
|
|
|
def test_mismatch_warns_with_restart_hint(self):
|
|
result = check_version_drift(LIVEZ_OK, "0.27.0")
|
|
assert result.status == WARN
|
|
assert "drift" in result.summary
|
|
assert "restart" in (result.hint or "")
|
|
|
|
def test_proxy_down_skips(self):
|
|
assert check_version_drift(None, "0.26.0").status == SKIP
|
|
|
|
def test_unknown_version_warns(self):
|
|
assert check_version_drift({"version": "unknown"}, "0.26.0").status == WARN
|
|
assert check_version_drift(LIVEZ_OK, "unknown").status == WARN
|
|
|
|
@pytest.mark.parametrize(
|
|
("running", "installed"),
|
|
[
|
|
("source-build+g6266a1d774b5", "0.26.0"),
|
|
("source-build+sha.abcdef123456", "0.26.0"),
|
|
("6266a1d", "0.26.0"),
|
|
("0.26.0+gabcdef0", "0.26.0"),
|
|
("0.26.0", "source-build+sha.abcdef123456"),
|
|
],
|
|
)
|
|
def test_non_release_version_labels_skip_drift_comparison(self, running, installed):
|
|
result = check_version_drift({"version": running}, installed)
|
|
assert result.status == SKIP
|
|
assert "drift" not in result.summary
|
|
|
|
|
|
class TestClaudeRouting:
|
|
def test_missing_file_warns(self, tmp_path):
|
|
result = check_claude_routing(tmp_path / "settings.json", 8787)
|
|
assert result.status == WARN
|
|
assert "wrap claude" in (result.hint or "")
|
|
|
|
def test_malformed_json_warns(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text("{not json", encoding="utf-8")
|
|
assert check_claude_routing(path, 8787).status == WARN
|
|
|
|
@pytest.mark.parametrize("body", ["[]", "null", "42", '"a string"'])
|
|
def test_non_object_json_warns(self, tmp_path, body):
|
|
# Valid JSON that isn't an object parses cleanly, so it slips past the
|
|
# JSONDecodeError guard; the later payload.get("env") must not crash the
|
|
# diagnostic command that is being run precisely because the config is
|
|
# suspect.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(body, encoding="utf-8")
|
|
assert check_claude_routing(path, 8787).status == WARN
|
|
|
|
def test_no_env_key_warns(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(json.dumps({"env": {}}), encoding="utf-8")
|
|
assert check_claude_routing(path, 8787).status == WARN
|
|
|
|
def test_correct_url_passes(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
assert check_claude_routing(path, 8787).status == PASS
|
|
|
|
def test_port_mismatch_warns(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8788"}}),
|
|
encoding="utf-8",
|
|
)
|
|
result = check_claude_routing(path, 8787)
|
|
assert result.status == WARN
|
|
assert "8788" in result.summary
|
|
|
|
def test_non_headroom_url_warns(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "https://gateway.corp.example/v1"}}),
|
|
encoding="utf-8",
|
|
)
|
|
result = check_claude_routing(path, 8787)
|
|
assert result.status == WARN
|
|
assert "gateway.corp.example" in result.summary
|
|
|
|
|
|
class TestClaudeDesktop:
|
|
def test_no_desktop_dir_produces_no_row(self, tmp_path):
|
|
# #2925: absent Desktop -> no row, so it never contradicts a routed CLI.
|
|
assert check_claude_desktop(tmp_path / "Claude") is None
|
|
|
|
def test_desktop_present_warns_about_bypass(self, tmp_path):
|
|
desktop = tmp_path / "Claude"
|
|
desktop.mkdir()
|
|
result = check_claude_desktop(desktop)
|
|
assert result is not None
|
|
assert result.name == "claude desktop"
|
|
assert result.status == WARN
|
|
assert "bypass" in result.summary
|
|
assert "#869" in (result.hint or "")
|
|
|
|
def test_doctor_appends_desktop_row_when_present(self, tmp_path, monkeypatch):
|
|
# Integration: the entrypoint surfaces the Desktop row when detected.
|
|
desktop = tmp_path / "Claude"
|
|
desktop.mkdir()
|
|
monkeypatch.setattr(doctor_mod, "claude_desktop_config_dir", lambda: desktop)
|
|
monkeypatch.setattr(doctor_mod, "probe_json", lambda *a, **k: None)
|
|
monkeypatch.setattr(doctor_mod, "list_manifests", lambda: [])
|
|
result = CliRunner().invoke(main, ["doctor", "--json"])
|
|
payload = json.loads(result.output)
|
|
rows = {c["name"]: c for c in payload["checks"]}
|
|
assert "claude desktop" in rows
|
|
assert rows["claude desktop"]["status"] == WARN
|
|
|
|
def test_doctor_omits_desktop_row_when_absent(self, tmp_path, monkeypatch):
|
|
monkeypatch.setattr(doctor_mod, "claude_desktop_config_dir", lambda: tmp_path / "Claude")
|
|
monkeypatch.setattr(doctor_mod, "probe_json", lambda *a, **k: None)
|
|
monkeypatch.setattr(doctor_mod, "list_manifests", lambda: [])
|
|
result = CliRunner().invoke(main, ["doctor", "--json"])
|
|
payload = json.loads(result.output)
|
|
assert "claude desktop" not in {c["name"] for c in payload["checks"]}
|
|
|
|
|
|
class TestClaudeRemoteControlGate:
|
|
def test_settings_custom_base_warns(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
result = check_claude_remote_control_gate(path, {})
|
|
assert result is not None
|
|
assert result.status == WARN
|
|
assert remote_control_gate_message("ANTHROPIC_BASE_URL from settings") in result.summary
|
|
|
|
def test_shell_env_custom_base_warns(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text("{}", encoding="utf-8")
|
|
result = check_claude_remote_control_gate(
|
|
path, {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}
|
|
)
|
|
assert result is not None
|
|
assert result.status == WARN
|
|
assert remote_control_gate_message("ANTHROPIC_BASE_URL in shell") in result.summary
|
|
|
|
def test_no_custom_base_no_warning(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "https://api.anthropic.com"}}),
|
|
encoding="utf-8",
|
|
)
|
|
assert check_claude_remote_control_gate(path, {}) is None
|
|
|
|
@pytest.mark.parametrize("body", ["[]", "null", "42"])
|
|
def test_non_object_settings_does_not_crash(self, tmp_path, body):
|
|
# A valid-but-non-object settings file parses past the JSONDecodeError
|
|
# guard; payload.get("env") must not raise AttributeError. The shell env
|
|
# still drives the gate, so a custom base there still warns.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(body, encoding="utf-8")
|
|
result = check_claude_remote_control_gate(
|
|
path, {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}
|
|
)
|
|
assert result is not None
|
|
assert result.status == WARN
|
|
|
|
def test_api_key_auth_suppresses_warning(self, tmp_path):
|
|
# Issue #1779: a PAYG / API-key session never had Remote Control, so the
|
|
# gate warning must not fire even behind a custom base URL.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
assert check_claude_remote_control_gate(path, {"ANTHROPIC_API_KEY": "sk-ant-api-x"}) is None
|
|
|
|
def test_settings_api_key_suppresses_warning(self, tmp_path):
|
|
# An API key configured in settings.json (not just the shell) also means
|
|
# a non-subscription session — stay silent.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps(
|
|
{
|
|
"env": {
|
|
"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787",
|
|
"ANTHROPIC_API_KEY": "sk-ant-api-x",
|
|
}
|
|
}
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
assert check_claude_remote_control_gate(path, {}) is None
|
|
|
|
def test_version_resolver_not_called_without_custom_base(self, tmp_path):
|
|
# The `claude --version` subprocess is expensive (Node CLI cold start);
|
|
# the check must not invoke the resolver when no custom base URL exists.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "https://api.anthropic.com"}}),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
def boom() -> tuple[int, int, int]:
|
|
raise AssertionError("resolver must not run when no custom base URL")
|
|
|
|
assert check_claude_remote_control_gate(path, {}, version_resolver=boom) is None
|
|
|
|
def test_version_resolver_not_called_for_api_key_auth(self, tmp_path):
|
|
# PAYG sessions are suppressed before version matters — no subprocess.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
def boom() -> tuple[int, int, int]:
|
|
raise AssertionError("resolver must not run for API-key auth")
|
|
|
|
assert (
|
|
check_claude_remote_control_gate(
|
|
path, {"ANTHROPIC_API_KEY": "sk-ant-api-x"}, version_resolver=boom
|
|
)
|
|
is None
|
|
)
|
|
|
|
def test_version_resolver_called_once_and_honored(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
calls: list[int] = []
|
|
|
|
def resolver() -> tuple[int, int, int]:
|
|
calls.append(1)
|
|
return (2, 1, 196)
|
|
|
|
# Shell env ALSO custom so both loop sources are live — still one call.
|
|
result = check_claude_remote_control_gate(
|
|
path,
|
|
{"ANTHROPIC_BASE_URL": "http://127.0.0.1:9999"},
|
|
version_resolver=resolver,
|
|
)
|
|
assert result is not None
|
|
assert "2.1.196" in result.summary
|
|
assert calls == [1]
|
|
|
|
def test_version_resolver_pre_gate_version_suppresses(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
assert (
|
|
check_claude_remote_control_gate(path, {}, version_resolver=lambda: (2, 1, 195)) is None
|
|
)
|
|
|
|
def test_malformed_settings_base_url_does_not_crash(self, tmp_path):
|
|
# Issue #1779: settings.json is user-edited; a typo'd IPv6 literal made
|
|
# urlparse raise ValueError("Invalid IPv6 URL") and crashed doctor.
|
|
# Malformed values degrade to "no host" and the check stays silent —
|
|
# check_claude_routing separately flags unusable URLs.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://[::1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
assert check_claude_remote_control_gate(path, {}) is None
|
|
|
|
def test_malformed_shell_base_url_does_not_crash(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text("{}", encoding="utf-8")
|
|
assert check_claude_remote_control_gate(path, {"ANTHROPIC_BASE_URL": "http://["}) is None
|
|
|
|
def test_pre_gate_version_suppresses_warning(self, tmp_path):
|
|
# Older Claude Code does not gate RC on the base URL — no false alarm.
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
assert check_claude_remote_control_gate(path, {}, version=(2, 1, 195)) is None
|
|
|
|
def test_gated_version_warns_with_exact_version(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
result = check_claude_remote_control_gate(path, {}, version=(2, 1, 196))
|
|
assert result is not None
|
|
assert result.status == WARN
|
|
assert "2.1.196" in result.summary
|
|
assert "disables" in result.summary
|
|
# Sibling gates are co-reported in the hint (#746 / #1158).
|
|
assert "#746" in (result.hint or "")
|
|
assert "#1158" in (result.hint or "")
|
|
|
|
def test_settings_check_still_routes(self, tmp_path):
|
|
path = tmp_path / "settings.json"
|
|
path.write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
result = check_claude_routing(path, 8787)
|
|
assert result.status == PASS
|
|
|
|
|
|
class TestCodexRouting:
|
|
def test_missing_file_warns(self, tmp_path):
|
|
assert check_codex_routing(tmp_path / "config.toml", 8787).status == WARN
|
|
|
|
def test_marker_block_right_port_passes(self, tmp_path):
|
|
path = tmp_path / "config.toml"
|
|
path.write_text(
|
|
'model_provider = "headroom"\n'
|
|
"[model_providers.headroom]\n"
|
|
'base_url = "http://127.0.0.1:8787/v1"\n',
|
|
encoding="utf-8",
|
|
)
|
|
assert check_codex_routing(path, 8787).status == PASS
|
|
|
|
def test_port_mismatch_warns(self, tmp_path):
|
|
path = tmp_path / "config.toml"
|
|
path.write_text(
|
|
'[model_providers.headroom]\nbase_url = "http://127.0.0.1:9999/v1"\n',
|
|
encoding="utf-8",
|
|
)
|
|
result = check_codex_routing(path, 8787)
|
|
assert result.status == WARN
|
|
assert "9999" in result.summary
|
|
|
|
def test_no_marker_warns(self, tmp_path):
|
|
path = tmp_path / "config.toml"
|
|
path.write_text('model = "gpt-5"\n', encoding="utf-8")
|
|
assert check_codex_routing(path, 8787).status == WARN
|
|
|
|
def test_garbage_bytes_warn_not_crash(self, tmp_path):
|
|
path = tmp_path / "config.toml"
|
|
path.write_bytes(b"\xff\xfe garbage \x00")
|
|
assert check_codex_routing(path, 8787).status == WARN
|
|
|
|
|
|
class TestShellEnv:
|
|
def test_unset_warns(self):
|
|
result = check_shell_env({}, 8787)
|
|
assert result.status == WARN
|
|
assert "bypasses" in result.summary
|
|
|
|
def test_matching_anthropic_url_passes(self):
|
|
env = {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}
|
|
assert check_shell_env(env, 8787).status == PASS
|
|
|
|
def test_localhost_also_passes(self):
|
|
env = {"OPENAI_BASE_URL": "http://localhost:8787/v1"}
|
|
assert check_shell_env(env, 8787).status == PASS
|
|
|
|
def test_other_url_warns(self):
|
|
env = {"ANTHROPIC_BASE_URL": "https://api.anthropic.com"}
|
|
assert check_shell_env(env, 8787).status == WARN
|
|
|
|
def test_ollama_launch_url_names_the_collision(self):
|
|
# `ollama launch claude` points Claude Code at Ollama's :11434, which
|
|
# outranks the persistent Headroom route (issue #2199). The diagnostic
|
|
# must name Ollama, not tell the user to re-probe port 11434.
|
|
env = {"ANTHROPIC_BASE_URL": "http://127.0.0.1:11434"}
|
|
result = check_shell_env(env, 8787)
|
|
assert result.status == WARN
|
|
assert "Ollama" in result.summary
|
|
assert "#2199" in (result.hint or "")
|
|
assert "--port 11434" not in (result.hint or "")
|
|
|
|
|
|
class TestSavings:
|
|
def test_from_stats_passes_with_totals(self, tmp_path):
|
|
result = check_savings(STATS_OK, tmp_path / "missing.json")
|
|
assert result.status == PASS
|
|
assert "17,583,102" in result.summary
|
|
assert "$7.82" in result.summary
|
|
|
|
def test_falls_back_to_file_when_proxy_down(self, tmp_path):
|
|
savings_file = tmp_path / "proxy_savings.json"
|
|
savings_file.write_text(
|
|
json.dumps(
|
|
{
|
|
"lifetime": {"tokens_saved": 500, "compression_savings_usd": 0.01},
|
|
"display_session": {"last_activity_at": "2026-06-12T11:00:00Z"},
|
|
}
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
result = check_savings(None, savings_file)
|
|
assert result.status == PASS
|
|
assert "500" in result.summary
|
|
assert str(savings_file) in result.summary
|
|
|
|
def test_no_data_warns(self, tmp_path):
|
|
assert check_savings(None, tmp_path / "missing.json").status == WARN
|
|
|
|
def test_zero_tokens_warns(self, tmp_path):
|
|
stats = {"persistent_savings": {"lifetime": {"tokens_saved": 0}}}
|
|
assert check_savings(stats, tmp_path / "missing.json").status == WARN
|
|
|
|
|
|
class TestBudget:
|
|
def test_proxy_down_skips(self):
|
|
assert check_budget(None).status == SKIP
|
|
|
|
def test_cost_tracking_disabled_warns(self):
|
|
assert check_budget({"cost": None}).status == WARN
|
|
|
|
def test_old_proxy_without_keys_warns(self):
|
|
result = check_budget({"cost": {"savings_usd": 1.0}})
|
|
assert result.status == WARN
|
|
assert "older version" in result.summary
|
|
|
|
def test_unset_budget_warns_with_hint(self):
|
|
result = check_budget({"cost": {"budget_limit_usd": None}})
|
|
assert result.status == WARN
|
|
assert "--budget" in (result.hint or "")
|
|
|
|
def test_configured_budget_passes(self):
|
|
result = check_budget(STATS_OK)
|
|
assert result.status == PASS
|
|
assert "$10.0/daily" in result.summary
|
|
|
|
def test_estimated_basis_share_is_reported_without_warning(self):
|
|
"""#2713: spend booked from a token estimate is surfaced, not warned on.
|
|
|
|
A provider that never reports a usage breakdown would otherwise sit at a
|
|
permanent WARN, so this stays informational.
|
|
"""
|
|
result = check_budget(
|
|
{
|
|
"cost": {
|
|
"budget_limit_usd": 10.0,
|
|
"budget_period": "daily",
|
|
"budget_estimated_basis": "count",
|
|
"budget_basis": {"estimated_usd": 1.24, "estimated_pct": 62.3},
|
|
}
|
|
}
|
|
)
|
|
assert result.status == PASS
|
|
assert "62% of period spend ($1.2400)" in result.summary
|
|
assert "Headroom token estimates" in result.summary
|
|
|
|
def test_all_measured_spend_adds_no_note(self):
|
|
result = check_budget(
|
|
{
|
|
"cost": {
|
|
"budget_limit_usd": 10.0,
|
|
"budget_period": "daily",
|
|
"budget_estimated_basis": "count",
|
|
"budget_basis": {"estimated_usd": 0.0, "estimated_pct": 0.0},
|
|
}
|
|
}
|
|
)
|
|
assert result.summary == "$10.0/daily budget enforced"
|
|
|
|
def test_non_default_basis_policy_is_named(self):
|
|
result = check_budget(
|
|
{
|
|
"cost": {
|
|
"budget_limit_usd": 10.0,
|
|
"budget_period": "daily",
|
|
"budget_estimated_basis": "block",
|
|
}
|
|
}
|
|
)
|
|
assert "estimated-basis policy: block" in result.summary
|
|
|
|
def test_missing_basis_fields_degrade_quietly(self):
|
|
"""`doctor` must still work against a proxy predating these fields."""
|
|
result = check_budget({"cost": {"budget_limit_usd": 10.0, "budget_period": "daily"}})
|
|
assert result.status == PASS
|
|
assert result.summary == "$10.0/daily budget enforced"
|
|
|
|
malformed = check_budget(
|
|
{"cost": {"budget_limit_usd": 10.0, "budget_period": "daily", "budget_basis": "nope"}}
|
|
)
|
|
assert malformed.status == PASS
|
|
|
|
|
|
@dataclass
|
|
class _FakeManifest:
|
|
profile: str
|
|
health_url: str
|
|
|
|
|
|
class TestDeployments:
|
|
def test_no_manifests_omits_section(self):
|
|
assert check_deployments([]) is None
|
|
|
|
def test_all_healthy_passes(self):
|
|
manifests = [_FakeManifest("default", "http://127.0.0.1:8787/readyz")]
|
|
result = check_deployments(manifests, probe=lambda url: {"ready": True})
|
|
assert result is not None and result.status == PASS
|
|
|
|
def test_unhealthy_fails_naming_profile(self):
|
|
manifests = [_FakeManifest("prod", "http://127.0.0.1:9999/readyz")]
|
|
result = check_deployments(manifests, probe=lambda url: None)
|
|
assert result is not None and result.status == FAIL
|
|
assert "prod" in result.summary
|
|
|
|
|
|
class TestDoctorCommand:
|
|
@pytest.fixture
|
|
def runner(self):
|
|
return CliRunner()
|
|
|
|
@pytest.fixture
|
|
def isolated(self, tmp_path, monkeypatch):
|
|
"""Point all filesystem/network surfaces at controlled fakes."""
|
|
monkeypatch.setattr(doctor_mod, "claude_settings_path", lambda: tmp_path / "settings.json")
|
|
monkeypatch.setattr(doctor_mod, "codex_config_path", lambda: tmp_path / "config.toml")
|
|
monkeypatch.setattr(doctor_mod, "savings_path", lambda: tmp_path / "savings.json")
|
|
monkeypatch.setattr(doctor_mod, "list_manifests", lambda: [])
|
|
for var in (
|
|
"ANTHROPIC_API_KEY",
|
|
"ANTHROPIC_AUTH_TOKEN",
|
|
"ANTHROPIC_BASE_URL",
|
|
"CLAUDE_CODE_USE_BEDROCK",
|
|
"CLAUDE_CODE_USE_FOUNDRY",
|
|
"CLAUDE_CODE_USE_VERTEX",
|
|
"OPENAI_BASE_URL",
|
|
"HEADROOM_PORT",
|
|
):
|
|
monkeypatch.delenv(var, raising=False)
|
|
return tmp_path
|
|
|
|
def _probe(self, livez, stats):
|
|
def fake_probe(url, timeout=2.0):
|
|
if url.endswith("/livez"):
|
|
return livez
|
|
if url.endswith("/stats"):
|
|
return stats
|
|
return None
|
|
|
|
return fake_probe
|
|
|
|
def test_proxy_down_exits_2(self, runner, isolated, monkeypatch):
|
|
monkeypatch.setattr(doctor_mod, "probe_json", self._probe(None, None))
|
|
result = runner.invoke(main, ["doctor"])
|
|
assert result.exit_code == 2
|
|
assert "not reachable" in result.output
|
|
|
|
def test_conflicting_claude_auth_is_a_redacted_failure(self, runner, isolated, monkeypatch):
|
|
settings = isolated / "settings.json"
|
|
settings.write_text('{"env":{"ANTHROPIC_AUTH_TOKEN":"token-value"}}', encoding="utf-8")
|
|
monkeypatch.setenv("ANTHROPIC_API_KEY", "api-value")
|
|
monkeypatch.setattr(doctor_mod, "probe_json", self._probe(None, None))
|
|
|
|
result = runner.invoke(main, ["doctor", "--json"])
|
|
|
|
assert result.exit_code == 2
|
|
payload = json.loads(result.output)
|
|
auth = next(check for check in payload["checks"] if check["name"] == "claude auth")
|
|
assert auth["status"] == "fail"
|
|
assert "shell environment" in auth["summary"]
|
|
assert str(settings) in auth["summary"]
|
|
assert "api-value" not in result.output
|
|
assert "token-value" not in result.output
|
|
|
|
def test_warnings_only_exits_1(self, runner, isolated, monkeypatch):
|
|
monkeypatch.setattr(doctor_mod, "probe_json", self._probe(LIVEZ_OK, STATS_OK))
|
|
monkeypatch.setattr(doctor_mod, "get_version", lambda: "0.26.0")
|
|
# proxy healthy, but clients unwrapped + shell env unset -> warns
|
|
result = runner.invoke(main, ["doctor"])
|
|
assert result.exit_code == 1
|
|
|
|
def test_remote_control_warning_exits_1(self, runner, isolated, monkeypatch):
|
|
monkeypatch.setattr(doctor_mod, "probe_json", self._probe(LIVEZ_OK, STATS_OK))
|
|
monkeypatch.setattr(doctor_mod, "get_version", lambda: "0.26.0")
|
|
monkeypatch.setattr(doctor_mod, "detect_claude_code_version", lambda: None)
|
|
(isolated / "settings.json").write_text(
|
|
json.dumps({"env": {"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}}),
|
|
encoding="utf-8",
|
|
)
|
|
(isolated / "config.toml").write_text(
|
|
'[model_providers.headroom]\nbase_url = "http://127.0.0.1:8787/v1"\n',
|
|
encoding="utf-8",
|
|
)
|
|
result = runner.invoke(
|
|
main, ["doctor"], env={"ANTHROPIC_BASE_URL": "http://127.0.0.1:8787"}
|
|
)
|
|
assert result.exit_code == 1, result.output
|
|
assert "Remote Control" in result.output
|
|
|
|
def test_json_output_parses(self, runner, isolated, monkeypatch):
|
|
monkeypatch.setattr(doctor_mod, "probe_json", self._probe(LIVEZ_OK, STATS_OK))
|
|
result = runner.invoke(main, ["doctor", "--json"])
|
|
payload = json.loads(result.output)
|
|
assert payload["port"] == 8787
|
|
assert {c["name"] for c in payload["checks"]} >= {"proxy", "version", "budget"}
|
|
assert all(c["status"] in ("pass", "warn", "fail", "skip") for c in payload["checks"])
|
|
|
|
def test_port_option_changes_probe_url(self, runner, isolated, monkeypatch):
|
|
seen: list[str] = []
|
|
|
|
def recording_probe(url, timeout=2.0):
|
|
seen.append(url)
|
|
return None
|
|
|
|
monkeypatch.setattr(doctor_mod, "probe_json", recording_probe)
|
|
runner.invoke(main, ["doctor", "--port", "9999"])
|
|
assert "http://127.0.0.1:9999/livez" in seen
|
|
|
|
def test_port_env_var_respected(self, runner, isolated, monkeypatch):
|
|
seen: list[str] = []
|
|
|
|
def recording_probe(url, timeout=2.0):
|
|
seen.append(url)
|
|
return None
|
|
|
|
monkeypatch.setattr(doctor_mod, "probe_json", recording_probe)
|
|
runner.invoke(main, ["doctor"], env={"HEADROOM_PORT": "9999"})
|
|
assert "http://127.0.0.1:9999/livez" in seen
|
|
|
|
|
|
class TestCostTrackerBudgetKeys:
|
|
def test_stats_exposes_budget_config(self):
|
|
from headroom.proxy.cost import CostTracker
|
|
|
|
stats = CostTracker(budget_limit_usd=5.0, budget_period="monthly").stats()
|
|
assert stats["budget_limit_usd"] == 5.0
|
|
assert stats["budget_period"] == "monthly"
|
|
|
|
def test_stats_budget_none_when_unset(self):
|
|
from headroom.proxy.cost import CostTracker
|
|
|
|
assert CostTracker().stats()["budget_limit_usd"] is None
|