mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description Adds `headroom wrap omp` / `headroom unwrap omp` — a one-command wrap for [Oh My Pi](https://www.npmjs.com/package/@oh-my-pi/pi-coding-agent) (`omp`), the pi-mono-lineage coding agent, as proposed in #1149. One honest correction to the issue: #1149 proposed reusing the `ANTHROPIC_BASE_URL` redirect from `wrap claude`. During implementation I probed that empirically and it turned out to be wrong — omp only reads `ANTHROPIC_BASE_URL` in its web-search helper; its **chat** endpoint comes from the model registry (`providers.anthropic.baseUrl` in `~/.omp/agent/models.yml`). With the env var pointed at a local probe server, omp's chat traffic still went straight to the real endpoint (0 probe hits); with a `models.yml` same-ID override, every request arrived at the probe (9/9 hits on `/v1/messages`). A same-ID override keeps omp's bundled Anthropic model catalog and stored credentials (both keyed by provider id `anthropic`), so only the endpoint moves. The wrap therefore injects a marker-fenced `providers.anthropic.baseUrl` override into `models.yml`, snapshotting the pre-wrap file **byte-for-byte** first, and `headroom unwrap omp` restores it exactly (or removes the file when the wrap created it) — the same durable-wrap + backup + unwrap contract `wrap codex` uses for `config.toml`. Closes #1149 ## Type of Change - [ ] Bug fix (non-breaking change that fixes an issue) - [x] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - `headroom/providers/omp/` (new provider slice): `models_yml_path()` (honors `PI_CODING_AGENT_DIR`), `inject_models_override()` (yaml-merge preserving user providers; pristine byte-for-byte backup, never re-snapshotted while managed), `restore_models_override()` (`restored` / `removed` / `noop`; never touches an unmanaged file), `build_launch_env()` - `headroom/cli/wrap.py`: `wrap omp` (mirrors the aider/vibe `_launch_tool` shape; rtk instructions into the project's `AGENTS.md`, which omp reads natively) and `unwrap omp` (restore models.yml + scrub rtk block + stop proxy) - `headroom/telemetry/context.py`: `omp` added to `_KNOWN_WRAP_AGENTS` so the stack slug reports `wrap_omp` instead of `unknown` - `README.md` (agent matrix row + unwrap list), `llms.txt`, `CHANGELOG.md` - `tests/test_cli/test_wrap_omp.py`: 16 tests (injection fresh/merge/re-inject, restore statuses incl. unmanaged-file safety, env passthrough, CLI wiring, unwrap flows) ## Testing - [ ] Unit tests pass (`pytest`) — all new + `test_cli` tests pass; the full suite carries **3 pre-existing failures** that reproduce identically on unmodified `origin/main` (same set, same asserts — see Test Output and the rebase-validation comment) - [x] Linting passes (`ruff check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text $ uv run pytest -q # post-rebase, base4f22cbb03 failed, 7723 passed, 515 skipped in 262.64s FAILED tests/test_cli/test_wrap_claude_base_url.py::test_wrap_marker_is_stale_when_pid_reused FAILED tests/test_rtk_session_savings.py::test_rtk_reader_returns_none_on_nonzero_exit FAILED tests/test_rtk_session_savings.py::test_lean_ctx_reader_returns_none_on_failure_and_logs → all three reproduce identically on unmodified origin/main (4f22cbb0), run the same way (same worktree + venv, sources switched): 3 failed, 7707 passed — this branch = baseline + the 16 new tests, nothing else changes. (The pre-rebase run againste8151f05showed the same shape: one order-dependent flake that also reproduced on its baseline; these are env/order-dependent.) $ uv run pytest tests/test_cli/ -q # post-rebase 542 passed + 1 of the pre-existing failures above # includes the 16 new test_wrap_omp.py tests $ uv run ruff check . ; echo ruff-check-exit:$? All checks passed! ruff-check-exit:0 $ uv run ruff format --check . # post-rebase 1 pre-existing violation: headroom/proxy/handlers/anthropic.py — flagged identically on unmodified origin/main (not touched by this PR); every file this PR touches is clean $ uv run mypy headroom # post-rebase; output redirected to file; exit captured Success: no issues found in 409 source files mypy-exit:0 ``` ## Real Behavior Proof - Environment: macOS 15 (arm64, M1 Pro), Python 3.12.13 (uv venv, editable install incl. Rust `_core`), headroom @ this branch, base extras only (no `[ml]`), Anthropic account signed into omp. Initial proof ran on basee8151f05with omp 16.3.6 (`@oh-my-pi/pi-coding-agent` via bun); re-validated after the rebase onto4f22cbb0with omp 16.3.11 — fresh numbers in the rebase-validation comment. - Exact command / steps: four scenarios, run in this order — 1. Mechanism probe (why models.yml, not env): local HTTP probe server on `127.0.0.1:18999`; ran `omp -p "say ok" --model claude-fable-5 --no-session --no-tools` once with `ANTHROPIC_BASE_URL=http://127.0.0.1:18999`, once with `~/.omp/agent/models.yml` containing `providers.anthropic.baseUrl: http://127.0.0.1:18999`. 2. One-command path: `headroom wrap omp --no-rtk --port 8790 -- -p "Read CHANGELOG.md and count how many '### Fixed' headings it contains. Answer with just the number." --model claude-fable-5 --no-session --max-time 180` 3. Routing stats: separate proxy on :8788, wrap with `--no-proxy`, then `GET /stats`. 4. Restore: `headroom unwrap omp`, plus an isolated `PI_CODING_AGENT_DIR=/tmp/omp-agent-test` run with a pre-existing user `models.yml`, then `cmp` against the original. - Observed result: end-to-end routing through the proxy proven for every scenario — - Probe: env-var run → **0 probe hits**, omp answered normally (bypassed). models.yml run → **9 hits on `/v1/messages?beta=true`** with real Messages bodies. This is the routing mechanism the wrap uses. - One-command run: wrap started the proxy ("Proxy ready on http://127.0.0.1:8790"), wrote the override (`models.yml: providers.anthropic.baseUrl=http://127.0.0.1:8790/p/headroom-wrap-omp`), launched omp, and omp answered **"7"** (correct — real `read` tool work through the proxy). Proxy log for the session (3 requests, `anthropic_messages` path): ``` PERF model=claude-fable-5 msgs=1 tok_before=36 cache_read=0 cache_write=61939 cache_hit_pct=0 PERF model=claude-fable-5 msgs=3 tok_before=796 cache_read=0 cache_write=63308 cache_hit_pct=0 PERF model=claude-fable-5 msgs=5 tok_before=935 cache_read=63308 cache_write=215 cache_hit_pct=100 ``` Prompt caching survives the proxy (100% hit on the follow-up turn). - Routing stats (:8788 session): `requests.total: 2, by_provider: {"anthropic": 2}, by_model: {"claude-fable-5": 2}`, per-project prefix `/p/headroom-wrap-omp` attributed. - Unwrap: `Removed wrap-created models.yml` (file gone); isolated pre-existing-file run: backup created, user's `my-gw` provider preserved in the managed file, and after `unwrap omp` the restored file is **byte-identical** (`cmp` clean). - Compression: **not observed in this environment** — `tok_saved=0`, `transforms=router:noop` / `too_small`. Honest reading: omp minimizes its own tool outputs client-side (a 300-item JSON tool result reached the proxy at only ~657 tokens) and the `[ml]` text compressor wasn't installed; small print-mode payloads sit below crush thresholds, and passthrough-by-default is the documented safety contract. The wrap's value here is proven at the routing/lifecycle/cache layer; compression numbers will match whatever the proxy does for a given content mix. - Not tested: Windows / Linux; lean-ctx mode with omp (`HEADROOM_CONTEXT_TOOL=lean-ctx` — `lean-ctx init --agent omp` depends on lean-ctx recognizing the agent; failure degrades with a warning by design); long interactive (non `-p`) sessions; `--memory` / `--learn` / `--code-graph` flags combined with omp; OAuth-vs-API-key matrix beyond my local account. ## 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 - [x] 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 or that my feature works - [ ] New and existing unit tests pass locally with my changes — all except the 3 documented pre-existing failures, which fail identically on unmodified origin/main - [x] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A — terminal evidence inline above. ## Additional Notes - The models.yml override is regenerated from the pristine backup on every wrap, so re-running with a different `--port` updates the endpoint idempotently and the backup is never clobbered. - Scope note from #1149 stands: this routes omp's **Anthropic** provider family. omp's other providers (OpenAI-direct, Gemini, ...) resolve their endpoints from their own registry entries; users can already point those at Headroom with their own custom provider in `models.yml`. - `headroom/providers/omp/` deliberately contains no install-time / MCP pieces — this is the thin wrap + unwrap slice only. --------- Co-authored-by: JerrettDavis <mxjerrett@gmail.com> Co-authored-by: Tejas Chopra <chopratejas@gmail.com>
324 lines
12 KiB
Python
324 lines
12 KiB
Python
"""Tests for `headroom wrap omp` / `headroom unwrap omp`.
|
|
|
|
Covers the omp runtime override contract (fresh-create vs merge-preserving
|
|
injection, pristine backups, re-injection idempotency, restore statuses) and
|
|
the CLI wiring that drives it. Every test isolates omp's agent directory via
|
|
``PI_CODING_AGENT_DIR`` and runs from a tmp cwd so the real ``~/.omp`` is
|
|
never touched.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
import yaml
|
|
from click.testing import CliRunner
|
|
|
|
from headroom.cli.main import main
|
|
from headroom.cli.wrap import _inject_rtk_instructions
|
|
from headroom.providers.omp import (
|
|
MANAGED_MARKER,
|
|
backup_path,
|
|
build_launch_env,
|
|
inject_models_override,
|
|
models_yml_path,
|
|
restore_models_override,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def runner() -> CliRunner:
|
|
return CliRunner()
|
|
|
|
|
|
@pytest.fixture
|
|
def omp_home(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
|
|
"""Isolate omp's agent dir under tmp_path and run from a tmp cwd.
|
|
|
|
Returns the ``models.yml`` path the runtime resolves to.
|
|
"""
|
|
agent_dir = tmp_path / "omp-agent"
|
|
agent_dir.mkdir()
|
|
monkeypatch.setenv("PI_CODING_AGENT_DIR", str(agent_dir))
|
|
monkeypatch.chdir(tmp_path)
|
|
return agent_dir / "models.yml"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# runtime: path resolution
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_models_yml_path_honors_pi_coding_agent_dir(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
custom = tmp_path / "relocated-agent"
|
|
monkeypatch.setenv("PI_CODING_AGENT_DIR", str(custom))
|
|
monkeypatch.chdir(tmp_path)
|
|
assert models_yml_path() == custom / "models.yml"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# runtime: injection
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_inject_fresh_create_writes_managed_marker_and_no_backup(omp_home: Path) -> None:
|
|
models_file, base_url = inject_models_override(8787, "proj")
|
|
|
|
assert models_file == omp_home
|
|
assert base_url == "http://127.0.0.1:8787/p/proj"
|
|
|
|
text = models_file.read_text(encoding="utf-8")
|
|
assert MANAGED_MARKER in text
|
|
assert yaml.safe_load(text)["providers"]["anthropic"]["baseUrl"] == base_url
|
|
|
|
# Nothing pre-existed, so there is nothing to snapshot.
|
|
assert not backup_path(models_file).exists()
|
|
|
|
|
|
def test_inject_over_existing_backs_up_pristine_and_merges(omp_home: Path) -> None:
|
|
original = (
|
|
"providers:\n"
|
|
" anthropic:\n"
|
|
" apiKey: sk-user-secret\n"
|
|
" openai:\n"
|
|
" baseUrl: https://api.openai.com/v1\n"
|
|
"models:\n"
|
|
" - id: my-custom-model\n"
|
|
)
|
|
omp_home.write_bytes(original.encode("utf-8"))
|
|
|
|
_, base_url = inject_models_override(8787, "proj")
|
|
|
|
# Pre-wrap file is snapshotted byte-for-byte.
|
|
assert backup_path(omp_home).read_bytes() == original.encode("utf-8")
|
|
|
|
merged = yaml.safe_load(omp_home.read_text(encoding="utf-8"))
|
|
assert merged["providers"]["anthropic"]["baseUrl"] == base_url
|
|
# Only anthropic.baseUrl is set; every other user key survives the merge.
|
|
assert merged["providers"]["anthropic"]["apiKey"] == "sk-user-secret"
|
|
assert merged["providers"]["openai"]["baseUrl"] == "https://api.openai.com/v1"
|
|
assert merged["models"] == [{"id": "my-custom-model"}]
|
|
assert MANAGED_MARKER in omp_home.read_text(encoding="utf-8")
|
|
|
|
|
|
def test_reinject_new_port_regenerates_from_pristine_backup(omp_home: Path) -> None:
|
|
original = "providers:\n anthropic:\n apiKey: sk-user-secret\n"
|
|
omp_home.write_bytes(original.encode("utf-8"))
|
|
backup = backup_path(omp_home)
|
|
|
|
inject_models_override(8787, "proj")
|
|
assert backup.read_bytes() == original.encode("utf-8")
|
|
|
|
_, base_url_9999 = inject_models_override(9999, "proj")
|
|
|
|
# Re-injection never clobbers the pristine pre-wrap backup.
|
|
assert backup.read_bytes() == original.encode("utf-8")
|
|
|
|
merged = yaml.safe_load(omp_home.read_text(encoding="utf-8"))
|
|
assert base_url_9999 == "http://127.0.0.1:9999/p/proj"
|
|
assert merged["providers"]["anthropic"]["baseUrl"] == base_url_9999
|
|
# Regenerated from the backup, so user creds still survive the new port.
|
|
assert merged["providers"]["anthropic"]["apiKey"] == "sk-user-secret"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# runtime: restore
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_restore_restores_pristine_and_removes_backup(omp_home: Path) -> None:
|
|
original = "providers:\n anthropic:\n apiKey: sk-user-secret\n"
|
|
omp_home.write_bytes(original.encode("utf-8"))
|
|
inject_models_override(8787, "proj")
|
|
|
|
assert restore_models_override() == "restored"
|
|
assert omp_home.read_bytes() == original.encode("utf-8")
|
|
assert not backup_path(omp_home).exists()
|
|
|
|
|
|
def test_restore_removes_wrap_created_file(omp_home: Path) -> None:
|
|
inject_models_override(8787, "proj") # fresh create → no backup
|
|
assert omp_home.exists()
|
|
|
|
assert restore_models_override() == "removed"
|
|
assert not omp_home.exists()
|
|
assert not backup_path(omp_home).exists()
|
|
|
|
|
|
def test_restore_noop_when_nothing_managed(omp_home: Path) -> None:
|
|
assert restore_models_override() == "noop"
|
|
|
|
|
|
def test_restore_leaves_unmanaged_file_untouched(omp_home: Path) -> None:
|
|
user_content = "providers:\n anthropic:\n apiKey: sk-user-secret\n"
|
|
omp_home.write_bytes(user_content.encode("utf-8"))
|
|
|
|
assert restore_models_override() == "noop"
|
|
# A models.yml the wrap does not manage is never modified or deleted.
|
|
assert omp_home.read_bytes() == user_content.encode("utf-8")
|
|
assert not backup_path(omp_home).exists()
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# runtime: launch env
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_build_launch_env_passes_env_through_and_emits_display(omp_home: Path) -> None:
|
|
source = {"PATH": "/usr/bin", "ANTHROPIC_BASE_URL": "https://api.anthropic.com"}
|
|
env, display = build_launch_env(8787, source, project="proj")
|
|
|
|
# The redirect lives in models.yml, so env is a verbatim copy — notably
|
|
# ANTHROPIC_BASE_URL is NOT rewritten to the proxy.
|
|
assert env == source
|
|
assert env is not source # a copy, so caller's environ can't be mutated
|
|
assert display == ["models.yml: providers.anthropic.baseUrl=http://127.0.0.1:8787/p/proj"]
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# CLI: wrap omp
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_wrap_omp_missing_binary_exits_with_install_hint(runner: CliRunner, omp_home: Path) -> None:
|
|
with patch("headroom.cli.wrap.shutil.which", return_value=None):
|
|
result = runner.invoke(main, ["wrap", "omp", "--no-rtk"])
|
|
|
|
assert result.exit_code == 1
|
|
assert "npm install -g @oh-my-pi/pi-coding-agent" in result.output
|
|
# Fail fast before mutating omp's config.
|
|
assert not omp_home.exists()
|
|
|
|
|
|
def test_wrap_omp_happy_path_injects_before_launch(runner: CliRunner, omp_home: Path) -> None:
|
|
captured: dict[str, object] = {}
|
|
|
|
def fake_launch_tool(**kwargs: object) -> None:
|
|
captured.update(kwargs)
|
|
# Prove models.yml is on disk BEFORE omp is launched.
|
|
captured["models_text_at_launch"] = (
|
|
omp_home.read_text(encoding="utf-8") if omp_home.exists() else None
|
|
)
|
|
|
|
with (
|
|
patch("headroom.cli.wrap.shutil.which", return_value="omp"),
|
|
patch("headroom.cli.wrap._launch_tool", side_effect=fake_launch_tool),
|
|
):
|
|
result = runner.invoke(main, ["wrap", "omp", "--no-rtk", "--", "-p", "fix the bug"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
assert captured["tool_label"] == "OMP"
|
|
assert captured["agent_type"] == "omp"
|
|
assert captured["args"] == ("-p", "fix the bug")
|
|
|
|
text_at_launch = captured["models_text_at_launch"]
|
|
assert isinstance(text_at_launch, str)
|
|
assert MANAGED_MARKER in text_at_launch
|
|
base_url = yaml.safe_load(text_at_launch)["providers"]["anthropic"]["baseUrl"]
|
|
assert base_url.startswith("http://127.0.0.1:8787/p/")
|
|
|
|
display = captured["env_vars_display"]
|
|
assert isinstance(display, list)
|
|
assert f"models.yml: providers.anthropic.baseUrl={base_url}" in display
|
|
|
|
|
|
def test_wrap_omp_no_rtk_skips_agents_md(runner: CliRunner, omp_home: Path, tmp_path: Path) -> None:
|
|
with (
|
|
patch("headroom.cli.wrap.shutil.which", return_value="omp"),
|
|
patch("headroom.cli.wrap._launch_tool"),
|
|
):
|
|
result = runner.invoke(main, ["wrap", "omp", "--no-rtk"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
assert not (tmp_path / "AGENTS.md").exists()
|
|
|
|
|
|
def test_wrap_omp_rtk_injects_into_cwd_agents_md(
|
|
runner: CliRunner, omp_home: Path, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
monkeypatch.setenv("HEADROOM_CONTEXT_TOOL", "rtk")
|
|
with (
|
|
patch("headroom.cli.wrap.shutil.which", return_value="omp"),
|
|
patch("headroom.cli.wrap._launch_tool"),
|
|
patch("headroom.cli.wrap._ensure_rtk_binary", return_value=tmp_path / "rtk"),
|
|
):
|
|
result = runner.invoke(main, ["wrap", "omp"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
agents_md = tmp_path / "AGENTS.md"
|
|
assert agents_md.exists()
|
|
assert "headroom:rtk-instructions" in agents_md.read_text(encoding="utf-8")
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# CLI: unwrap omp
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_unwrap_omp_restored_and_cleans_agents_md(
|
|
runner: CliRunner, omp_home: Path, tmp_path: Path
|
|
) -> None:
|
|
original = "providers:\n anthropic:\n apiKey: sk-user-secret\n"
|
|
omp_home.write_bytes(original.encode("utf-8"))
|
|
inject_models_override(8787, "proj")
|
|
|
|
agents_md = tmp_path / "AGENTS.md"
|
|
agents_md.write_text("# My project rules\n\nBe nice.\n", encoding="utf-8")
|
|
_inject_rtk_instructions(agents_md)
|
|
|
|
stopped: list[int] = []
|
|
with patch(
|
|
"headroom.cli.wrap._stop_local_proxy_for_unwrap",
|
|
side_effect=lambda port: stopped.append(port) or "not_running",
|
|
):
|
|
result = runner.invoke(main, ["unwrap", "omp"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
assert "Restored pre-wrap models.yml" in result.output
|
|
assert omp_home.read_bytes() == original.encode("utf-8")
|
|
assert not backup_path(omp_home).exists()
|
|
|
|
# Only the marker-fenced rtk block is scrubbed; user content survives.
|
|
remaining = agents_md.read_text(encoding="utf-8")
|
|
assert "headroom:rtk-instructions" not in remaining
|
|
assert "Be nice." in remaining
|
|
|
|
# A real restore (not a noop) attempts to stop the proxy on the given port.
|
|
assert stopped == [8787]
|
|
|
|
|
|
def test_unwrap_omp_removes_wrap_created_file(runner: CliRunner, omp_home: Path) -> None:
|
|
inject_models_override(8787, "proj") # fresh create → no backup
|
|
|
|
stopped: list[int] = []
|
|
with patch(
|
|
"headroom.cli.wrap._stop_local_proxy_for_unwrap",
|
|
side_effect=lambda port: stopped.append(port) or "not_running",
|
|
):
|
|
result = runner.invoke(main, ["unwrap", "omp", "--port", "9191"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
assert "Removed wrap-created models.yml" in result.output
|
|
assert not omp_home.exists()
|
|
assert stopped == [9191]
|
|
|
|
|
|
def test_unwrap_omp_noop_leaves_unmanaged_and_skips_proxy_stop(
|
|
runner: CliRunner, omp_home: Path
|
|
) -> None:
|
|
user_content = "providers:\n anthropic:\n apiKey: sk-user-secret\n"
|
|
omp_home.write_bytes(user_content.encode("utf-8"))
|
|
|
|
with patch("headroom.cli.wrap._stop_local_proxy_for_unwrap") as stop_proxy:
|
|
result = runner.invoke(main, ["unwrap", "omp"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
assert "nothing to restore" in result.output
|
|
# Unmanaged file is left exactly as the user had it.
|
|
assert omp_home.read_bytes() == user_content.encode("utf-8")
|
|
# noop status → the proxy is left running (the `status != "noop"` guard).
|
|
stop_proxy.assert_not_called()
|