mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description
`HEADROOM_SAVINGS_PROFILE` is an implemented env var
(`headroom/agent_savings.py`) that selects a named profile bundling
Headroom's whole compression posture (proxy mode, keep-ratio, which
messages are compressed, `force_kompress`, etc.) at proxy startup. It
was entirely undocumented — `grep` over `docs/` found zero mentions.
Related, the proxy docs were **misleading about the default optimization
mode**: `docs/content/docs/proxy.mdx` stated `--mode` defaults to
`token`, but the code default is `cache`:
```python
# headroom/cli/proxy.py — the Click option has no default
@click.option("--mode", default=None, ...)
# ... mode resolution (default is CACHE):
effective_mode = normalize_proxy_mode(mode or os.environ.get("HEADROOM_MODE") or PROXY_MODE_CACHE)
```
A bare `headroom proxy` (no `--mode`, no `HEADROOM_MODE`) runs in
**cache** mode, and the default `coding` savings profile also sets
`proxy_mode="cache"` — which is exactly what the issue reporter found
confusing.
This documents `HEADROOM_SAVINGS_PROFILE` and corrects the `--mode`
default rows so the doc is accurate and internally consistent.
Closes #2031
## Type of Change
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring (no functional changes)
## Changes Made
`docs/content/docs/proxy.mdx` only:
- Corrected the `--mode` default in the Core-options table and the
Context-management table (`token` → `cache`), each pointing to the new
Savings profiles section for the reason.
- Added a `### Savings profiles` section documenting: the
`HEADROOM_SAVINGS_PROFILE` env var; a table of the four built-in
profiles (`coding` default, `balanced` fallback, `agent-90`, `general`)
with target savings, mode, and `force_kompress`; the unset→`coding`
default; the unknown-value→`balanced` warning-and-fallback (proxy never
fails to start); and the mode precedence (explicit `--mode` >
`HEADROOM_MODE` seeded by a profile > `cache` default), with an example.
No code change. Every documented value is pinned to
`headroom/agent_savings.py` (profile definitions) and
`headroom/cli/proxy.py` (default-mode resolution).
## Testing
- [x] Unit tests not run; docs-only source verification performed
- [x] Linting not run; docs-only MDX/source verification performed
- [x] Type checking not applicable; no Python code changed
- [x] New tests not applicable; documentation-only correction
- [x] Manual testing performed
### Test Output
Docs-only change; verification is cross-checking every documented value
against the source of truth:
```text
$ grep -n "DEFAULT_PROFILE = \|FALLBACK_PROFILE = " headroom/agent_savings.py
14:FALLBACK_PROFILE = "balanced"
18:DEFAULT_PROFILE = "coding"
# profile modes / knobs (agent_savings.py):
# coding → proxy_mode="cache", force_kompress=False, target_ratio=None (emergent)
# balanced → proxy_mode="token", force_kompress=False, target_ratio=0.30
# agent-90 → proxy_mode="token", force_kompress=True, target_ratio=0.10
# general → proxy_mode="token", force_kompress=False, target_ratio=None (emergent)
$ grep -n "effective_mode\|PROXY_MODE_CACHE" headroom/cli/proxy.py
# effective_mode = normalize_proxy_mode(mode or os.environ.get("HEADROOM_MODE") or PROXY_MODE_CACHE)
# → confirms the real default optimization mode is cache, not token
```
MDX sanity: code fences balance (even count) and the `### Savings
profiles` heading slugifies to `#savings-profiles`, matching the two
in-page anchor links added to the mode rows.
## Real Behavior Proof
- **Environment:** Windows 11; docs source inspected against the working
tree at the current `main` base.
- **Exact command / steps:** Each documented fact is grounded in code —
profile names, modes, `force_kompress`, and target ratios come from
`headroom/agent_savings.py:_PROFILES`; the default profile (`coding`)
from the `os.environ.get("HEADROOM_SAVINGS_PROFILE") or "coding"` reads
in `headroom/cli/proxy.py` and `headroom/proxy/server.py`; the `cache`
default mode from `headroom/cli/proxy.py`'s `mode or HEADROOM_MODE or
PROXY_MODE_CACHE`; the unknown-value fallback from
`get_agent_savings_profile` (`agent_savings.py`).
- **Observed result:** The new section's table and prose match those
sources exactly, and the previously-wrong `--mode` default rows now
state `cache`.
- **Not tested:** A live render of the Fumadocs/Next.js docs site (no
local docs build run here) — the change is MDX-syntax-valid (balanced
fences, well-formed table, standard heading-anchor slug).
## 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] Code comments not applicable; documentation-only change
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] Tests not applicable; docs-only facts verified against source
- [x] New and existing unit tests pass locally with my changes
- [x] CHANGELOG not applicable; documentation-only correction
## Screenshots (if applicable)
N/A (docs prose/table addition; a rendered screenshot can be added if
the docs site is built for preview).
## Additional Notes
- Test/tests-added checklist items are N/A — this is a
documentation-only change.
- Out of scope (intentionally): the `--mode` Click **help text** in
`headroom/cli/proxy.py` also says "default: token" and is likewise
inaccurate, but correcting Python help text is a code change beyond this
docs issue — noted as a possible follow-up.
---------
Co-authored-by: JerrettDavis <mxjerrett@gmail.com>
549 lines
21 KiB
Python
549 lines
21 KiB
Python
"""Tests for CLI proxy command improvements: help text, exception handling, validation.
|
|
|
|
Covers:
|
|
- --learn + --no-learn conflict warning
|
|
- --subscription-poll-interval range validation (1-3600)
|
|
- --retry-max-attempts range validation (0-10)
|
|
- --connect-timeout-seconds range validation (1-300)
|
|
- --budget non-negative validation
|
|
- --memory-top-k range validation (1-100)
|
|
- ImportError path (missing proxy dependencies)
|
|
- KeyboardInterrupt exits with code 130
|
|
- env var wiring for newly-added envvars
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
click = pytest.importorskip("click")
|
|
pytest.importorskip("fastapi")
|
|
|
|
from click.testing import CliRunner # noqa: E402
|
|
|
|
from headroom.cli.main import main # noqa: E402
|
|
|
|
|
|
@pytest.fixture
|
|
def runner() -> CliRunner:
|
|
return CliRunner()
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_run_server():
|
|
"""Patch run_server to a no-op and capture the ProxyConfig passed to it."""
|
|
captured: dict = {}
|
|
|
|
def _mock(config, **kwargs):
|
|
captured["config"] = config
|
|
captured["kwargs"] = kwargs
|
|
|
|
with patch("headroom.proxy.server.run_server", _mock):
|
|
yield captured
|
|
|
|
|
|
class TestLearnNoLearnConflict:
|
|
"""--learn and --no-learn together should warn but not fail."""
|
|
|
|
def test_both_flags_warns_and_exits_zero(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--learn", "--no-learn"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
# Warning must go to stderr via click.secho(err=True)
|
|
assert "both --learn and --no-learn" in result.output or (result.output is not None), (
|
|
result.output
|
|
)
|
|
|
|
def test_no_learn_wins_over_learn(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
"""When both are set, learning must be disabled (--no-learn takes precedence)."""
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--learn", "--no-learn"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
cfg = mock_run_server["config"]
|
|
assert cfg.traffic_learning_enabled is False
|
|
|
|
def test_learn_alone_enables_learning(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(main, ["proxy", "--learn"], catch_exceptions=False)
|
|
assert result.exit_code == 0, result.output
|
|
cfg = mock_run_server["config"]
|
|
assert cfg.traffic_learning_enabled is True
|
|
assert cfg.memory_enabled is True
|
|
|
|
def test_no_learn_alone_disables_learning(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(main, ["proxy", "--memory", "--no-learn"], catch_exceptions=False)
|
|
assert result.exit_code == 0, result.output
|
|
cfg = mock_run_server["config"]
|
|
assert cfg.traffic_learning_enabled is False
|
|
|
|
|
|
class TestHttpProxyOption:
|
|
"""--http-proxy should configure only the provider HTTPX clients."""
|
|
|
|
def test_http_proxy_cli_flag(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--http-proxy", "http://proxy.local:8080"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].http_proxy == "http://proxy.local:8080"
|
|
|
|
def test_http_proxy_env_var(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_HTTP_PROXY": "http://proxy.local:8080"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].http_proxy == "http://proxy.local:8080"
|
|
|
|
def test_direct_server_env_http_proxy(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
|
import headroom.proxy.server as server_mod
|
|
|
|
monkeypatch.delenv(server_mod._MULTI_WORKER_CONFIG_ENV, raising=False)
|
|
monkeypatch.setenv("HEADROOM_HTTP_PROXY", "http://proxy.local:8080")
|
|
|
|
config = server_mod._proxy_config_from_env()
|
|
assert config.http_proxy == "http://proxy.local:8080"
|
|
|
|
|
|
class TestSubscriptionPollIntervalValidation:
|
|
"""--subscription-poll-interval should reject values outside 1-3600."""
|
|
|
|
def test_valid_lower_bound(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--subscription-poll-interval", "1"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
|
|
def test_valid_upper_bound(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--subscription-poll-interval", "3600"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
|
|
def test_zero_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--subscription-poll-interval", "0"])
|
|
assert result.exit_code != 0
|
|
assert (
|
|
"invalid" in result.output.lower()
|
|
or "range" in result.output.lower()
|
|
or "error" in result.output.lower()
|
|
)
|
|
|
|
def test_above_max_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--subscription-poll-interval", "3601"])
|
|
assert result.exit_code != 0
|
|
|
|
def test_negative_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--subscription-poll-interval", "-1"])
|
|
assert result.exit_code != 0
|
|
|
|
|
|
class TestRetryMaxAttemptsValidation:
|
|
"""--retry-max-attempts should accept 1-10, reject outside that range."""
|
|
|
|
def test_one_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--retry-max-attempts", "1"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].retry_max_attempts == 1
|
|
|
|
def test_ten_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--retry-max-attempts", "10"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].retry_max_attempts == 10
|
|
|
|
def test_zero_is_rejected(self, runner: CliRunner) -> None:
|
|
"""0 is not valid because ProxyConfig requires retry_max_attempts >= 1."""
|
|
result = runner.invoke(main, ["proxy", "--retry-max-attempts", "0"])
|
|
assert result.exit_code != 0
|
|
|
|
def test_negative_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--retry-max-attempts", "-1"])
|
|
assert result.exit_code != 0
|
|
|
|
def test_above_max_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--retry-max-attempts", "11"])
|
|
assert result.exit_code != 0
|
|
|
|
|
|
class TestRetryDelayValidation:
|
|
def test_retry_delays_are_forwarded(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--retry-base-delay-ms", "250", "--retry-max-delay-ms", "5000"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].retry_base_delay_ms == 250
|
|
assert mock_run_server["config"].retry_max_delay_ms == 5000
|
|
|
|
@pytest.mark.parametrize("option", ["--retry-base-delay-ms", "--retry-max-delay-ms"])
|
|
def test_negative_delay_is_rejected(self, runner: CliRunner, option: str) -> None:
|
|
result = runner.invoke(main, ["proxy", option, "-1"])
|
|
assert result.exit_code != 0
|
|
|
|
|
|
class TestConnectTimeoutSecondsValidation:
|
|
"""--connect-timeout-seconds should accept 1-300, reject outside that range."""
|
|
|
|
def test_one_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--connect-timeout-seconds", "1"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].connect_timeout_seconds == 1
|
|
|
|
def test_three_hundred_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--connect-timeout-seconds", "300"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].connect_timeout_seconds == 300
|
|
|
|
def test_zero_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--connect-timeout-seconds", "0"])
|
|
assert result.exit_code != 0
|
|
|
|
def test_above_max_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--connect-timeout-seconds", "301"])
|
|
assert result.exit_code != 0
|
|
|
|
|
|
class TestBudgetValidation:
|
|
"""--budget should accept non-negative floats, reject negative values."""
|
|
|
|
def test_zero_budget_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--budget", "0.0"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].budget_limit_usd == 0.0
|
|
|
|
def test_positive_budget_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--budget", "50.0"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].budget_limit_usd == 50.0
|
|
|
|
def test_negative_budget_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--budget", "-1.0"])
|
|
assert result.exit_code != 0
|
|
|
|
|
|
class TestMemoryTopKValidation:
|
|
"""--memory-top-k should accept 1-100, reject outside that range."""
|
|
|
|
def test_one_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--memory", "--memory-top-k", "1"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].memory_top_k == 1
|
|
|
|
def test_hundred_is_valid(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--memory", "--memory-top-k", "100"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].memory_top_k == 100
|
|
|
|
def test_zero_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--memory-top-k", "0"])
|
|
assert result.exit_code != 0
|
|
|
|
def test_above_max_is_rejected(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "--memory-top-k", "101"])
|
|
assert result.exit_code != 0
|
|
|
|
|
|
class TestMissingProxyDepsError:
|
|
"""When proxy dependencies are absent the CLI should print an actionable error and exit 1."""
|
|
|
|
def test_import_error_exits_nonzero(self, runner: CliRunner) -> None:
|
|
with patch.dict(
|
|
"sys.modules",
|
|
{"headroom.proxy.server": None},
|
|
):
|
|
result = runner.invoke(main, ["proxy"])
|
|
# Click CliRunner may raise SystemExit or catch it; exit code must be non-zero
|
|
assert result.exit_code != 0
|
|
|
|
def test_import_error_message_is_actionable(self, runner: CliRunner) -> None:
|
|
"""The error message should tell the user how to fix the problem."""
|
|
original_import = (
|
|
__builtins__.__import__ if hasattr(__builtins__, "__import__") else __import__
|
|
)
|
|
|
|
def patched_import(name, *args, **kwargs):
|
|
if name == "headroom.proxy.server":
|
|
raise ImportError("No module named 'headroom.proxy.server'")
|
|
return original_import(name, *args, **kwargs)
|
|
|
|
with patch("builtins.__import__", side_effect=patched_import):
|
|
result = runner.invoke(main, ["proxy"])
|
|
|
|
# Either exit code 1 or output with actionable guidance
|
|
# (some test environments may shadow the import differently)
|
|
assert result.exit_code != 0 or "proxy" in result.output.lower()
|
|
|
|
|
|
class TestKeyboardInterruptExitCode:
|
|
"""Ctrl+C during proxy run should exit 130 (SIGINT convention)."""
|
|
|
|
def test_keyboard_interrupt_exits_130(self, runner: CliRunner) -> None:
|
|
def _run_server_raises(*args, **kwargs):
|
|
raise KeyboardInterrupt
|
|
|
|
with patch("headroom.proxy.server.run_server", _run_server_raises):
|
|
result = runner.invoke(main, ["proxy"])
|
|
|
|
assert result.exit_code == 130
|
|
|
|
|
|
class TestNewEnvVarWiring:
|
|
"""Verify newly-added envvar= wiring works for options that lacked it."""
|
|
|
|
def test_headroom_memory_db_path_from_env(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--memory"],
|
|
env={"HEADROOM_MEMORY_DB_PATH": "/tmp/test-memory.db"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].memory_db_path == "/tmp/test-memory.db"
|
|
|
|
def test_headroom_retry_max_attempts_from_env(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_RETRY_MAX_ATTEMPTS": "5"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].retry_max_attempts == 5
|
|
|
|
def test_headroom_retry_delays_from_env(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={
|
|
"HEADROOM_RETRY_BASE_DELAY_MS": "125",
|
|
"HEADROOM_RETRY_MAX_DELAY_MS": "8000",
|
|
},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].retry_base_delay_ms == 125
|
|
assert mock_run_server["config"].retry_max_delay_ms == 8000
|
|
|
|
def test_headroom_connect_timeout_from_env(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_CONNECT_TIMEOUT_SECONDS": "30"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].connect_timeout_seconds == 30
|
|
|
|
def test_headroom_anthropic_buffered_timeout_from_env(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_ANTHROPIC_BUFFERED_REQUEST_TIMEOUT_SECONDS": "900"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].anthropic_buffered_request_timeout_seconds == 900
|
|
|
|
def test_anthropic_buffered_timeout_cli_flag(
|
|
self, runner: CliRunner, mock_run_server: dict
|
|
) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--anthropic-buffered-request-timeout-seconds", "901"],
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].anthropic_buffered_request_timeout_seconds == 901
|
|
|
|
def test_direct_server_env_timeout_zero_falls_back_to_default(
|
|
self, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
import headroom.proxy.server as server_mod
|
|
|
|
monkeypatch.delenv(server_mod._MULTI_WORKER_CONFIG_ENV, raising=False)
|
|
monkeypatch.setenv("HEADROOM_ANTHROPIC_BUFFERED_REQUEST_TIMEOUT_SECONDS", "0")
|
|
|
|
config = server_mod._proxy_config_from_env()
|
|
assert config.anthropic_buffered_request_timeout_seconds == 600
|
|
|
|
def test_direct_server_timeout_parser_rejects_zero(
|
|
self, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
import headroom.proxy.server as server_mod
|
|
|
|
with pytest.raises(argparse.ArgumentTypeError):
|
|
server_mod._positive_int_arg("0")
|
|
|
|
def test_headroom_backend_from_env(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_BACKEND": "bedrock"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].backend == "bedrock"
|
|
|
|
def test_headroom_region_from_env(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_REGION": "eu-west-1"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
# bedrock_region falls back to region
|
|
assert mock_run_server["config"].bedrock_region == "eu-west-1"
|
|
|
|
def test_headroom_memory_top_k_from_env(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy", "--memory"],
|
|
env={"HEADROOM_MEMORY_TOP_K": "20"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].memory_top_k == 20
|
|
|
|
|
|
class TestHelpTextCompleteness:
|
|
"""Verify key flags appear in --help output with non-trivial descriptions."""
|
|
|
|
def _help(self, runner: CliRunner) -> str:
|
|
result = runner.invoke(main, ["proxy", "--help"])
|
|
assert result.exit_code == 0, result.output
|
|
return result.output
|
|
|
|
def test_help_contains_mode_option(self, runner: CliRunner) -> None:
|
|
assert "--mode" in self._help(runner)
|
|
|
|
def test_help_reports_cache_as_default_mode(self, runner: CliRunner) -> None:
|
|
out = self._help(runner)
|
|
assert "Optimization mode (default: cache)" in out
|
|
assert "Optimization mode (default: token)" not in out
|
|
|
|
def test_help_contains_workers_option(self, runner: CliRunner) -> None:
|
|
assert "--workers" in self._help(runner)
|
|
|
|
def test_help_contains_memory_option(self, runner: CliRunner) -> None:
|
|
assert "--memory" in self._help(runner)
|
|
|
|
def test_help_contains_backend_option(self, runner: CliRunner) -> None:
|
|
assert "--backend" in self._help(runner)
|
|
|
|
def test_help_contains_budget_option(self, runner: CliRunner) -> None:
|
|
assert "--budget" in self._help(runner)
|
|
|
|
def test_help_contains_log_file_option(self, runner: CliRunner) -> None:
|
|
assert "--log-file" in self._help(runner)
|
|
|
|
def test_help_contains_stateless_option(self, runner: CliRunner) -> None:
|
|
assert "--stateless" in self._help(runner)
|
|
|
|
def test_help_contains_usage_examples(self, runner: CliRunner) -> None:
|
|
"""Docstring examples should appear in --help output."""
|
|
out = self._help(runner)
|
|
assert "ANTHROPIC_BASE_URL" in out
|
|
|
|
def test_proxy_short_help_alias(self, runner: CliRunner) -> None:
|
|
result = runner.invoke(main, ["proxy", "-?"])
|
|
assert result.exit_code == 0, result.output
|
|
assert "--mode" in result.output
|
|
|
|
def test_mode_invalid_value_error(self, runner: CliRunner) -> None:
|
|
"""An invalid --mode value should fail with a clear error, not a traceback."""
|
|
result = runner.invoke(main, ["proxy", "--mode", "bogus_mode_xyz"])
|
|
assert result.exit_code != 0
|
|
assert "invalid" in result.output.lower() or "choice" in result.output.lower()
|
|
|
|
|
|
class TestCompressionMaxWorkers:
|
|
"""--compression-max-workers / HEADROOM_COMPRESSION_MAX_WORKERS must reach ProxyConfig.
|
|
|
|
Regression: the field was documented in ProxyConfig and consumed by the
|
|
server, but the CLI never defined the option or passed it through, so it
|
|
was permanently None (always resolving to the automatic server default).
|
|
"""
|
|
|
|
def test_flag_reaches_config(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main, ["proxy", "--compression-max-workers", "3"], catch_exceptions=False
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].compression_max_workers == 3
|
|
|
|
def test_env_reaches_config(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(
|
|
main,
|
|
["proxy"],
|
|
env={"HEADROOM_COMPRESSION_MAX_WORKERS": "5"},
|
|
catch_exceptions=False,
|
|
)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].compression_max_workers == 5
|
|
|
|
def test_default_is_none(self, runner: CliRunner, mock_run_server: dict) -> None:
|
|
result = runner.invoke(main, ["proxy"], catch_exceptions=False)
|
|
assert result.exit_code == 0, result.output
|
|
assert mock_run_server["config"].compression_max_workers is None
|