mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description `headroom wrap cursor` unconditionally injected an `rtk`-usage instructions block into `.cursorrules`. rtk itself supports a native hook for Cursor (`rtk init --agent cursor`) — the same registration mechanism headroom already uses for Claude Code — which rewrites shell commands transparently with zero custom-instructions text needed. Headroom never tried that path for Cursor, so users got a redundant `.cursorrules` file duplicating guidance the native hook already provides silently. A follow-up commit hardens the switch: `register_agent_hooks` returns `True` on rtk exit 0, but some rtk builds exit 0 without writing `~/.cursor/hooks.json`. headroom now trusts the on-disk hook file, not the exit code, before skipping the `.cursorrules` fallback. Closes #756 ## Type of Change - [x] 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) - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - `headroom/rtk/installer.py`: generalized `register_claude_hooks` into `register_agent_hooks(rtk_path, *, agent="claude")`, which passes `--agent <agent>` to `rtk init` for non-Claude agents. `register_claude_hooks` kept as a thin wrapper for backward compatibility. Added `RTK_NATIVE_HOOK_AGENTS` documenting which agents rtk supports a native hook for. - `headroom/cli/wrap.py`: `wrap cursor` now calls `register_agent_hooks(rtk_path, agent="cursor")` first, and only skips the `.cursorrules` fallback when `~/.cursor/hooks.json` is actually on disk; otherwise it falls back to `_inject_rtk_instructions(...)`. - Tests: `tests/test_rtk_installer.py` and `tests/test_cli/test_wrap_bridge.py` cover the native-hook path, the on-disk verification, and the `.cursorrules` fallback. - `CHANGELOG.md`: added an entry under `## Unreleased` / `### Fixed`. ## Testing - [x] Unit tests pass (`pytest`) - [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 $ python -m ruff format --check headroom/ tests/ e2e/ 953 files already formatted $ python -m ruff check headroom/cli/wrap.py headroom/rtk/installer.py tests/test_cli/test_wrap_bridge.py tests/test_rtk_installer.py All checks passed! $ python -m pytest tests/test_cli/test_wrap_bridge.py -k cursor -q 3 passed ``` ## Real Behavior Proof - Environment: Windows 11, Python 3.13, local checkout; `python -m pytest` / `ruff` run directly. - Exact command / steps: `python -m pytest tests/test_cli/test_wrap_bridge.py -k cursor -q` — the first test mocks `register_agent_hooks` to write `~/.cursor/hooks.json` and asserts `.cursorrules` is NOT created; the second mocks it to write nothing and asserts `.cursorrules` IS created with the `headroom:rtk-instructions` marker; the third exercises the explicit registration-failure fallback. - Observed result: `3 passed`. Native-hook path skips `.cursorrules` only when the hook file exists on disk; every other outcome falls back to `.cursorrules`, so Cursor always gets RTK guidance. - Not tested: real `rtk` binary writing `~/.cursor/hooks.json` end-to-end — that path is covered by the `docker-wrap-e2e` CI job, not locally. ## 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 or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] I have updated the CHANGELOG.md if applicable ## Screenshots (if applicable) N/A — CLI-only change. ## Additional Notes Scope: rtk's native-hook-capable agents include `claude`, `cursor`, `windsurf`, `cline`, `kilocode`, `antigravity`, `pi`, `hermes`, but only `cursor` and `claude` have a corresponding `headroom wrap` subcommand today, so this fix only changes `wrap cursor` behavior. --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
274 lines
9.7 KiB
Python
274 lines
9.7 KiB
Python
"""Tests for Docker-bridge wrap preparation flows."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import subprocess
|
|
from pathlib import Path
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
from click.testing import CliRunner
|
|
|
|
from headroom.cli.main import main
|
|
from headroom.cli.wrap import _setup_lean_ctx_agent
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def _default_context_tool(monkeypatch) -> None:
|
|
monkeypatch.delenv("HEADROOM_CONTEXT_TOOL", raising=False)
|
|
monkeypatch.delenv("LEAN_CTX_AGENT", raising=False)
|
|
monkeypatch.delenv("LEAN_CTX_DATA_DIR", raising=False)
|
|
|
|
|
|
def _set_test_home(monkeypatch, tmp_path: Path) -> None:
|
|
home = str(tmp_path)
|
|
monkeypatch.setenv("HOME", home)
|
|
monkeypatch.setenv("USERPROFILE", home)
|
|
|
|
|
|
def test_wrap_claude_prepare_only_skips_host_binary_lookup() -> None:
|
|
runner = CliRunner()
|
|
|
|
with patch("headroom.cli.wrap._prepare_wrap_rtk") as prepare_rtk:
|
|
with patch("headroom.cli.wrap.shutil.which") as which_mock:
|
|
result = runner.invoke(main, ["wrap", "claude", "--prepare-only"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
prepare_rtk.assert_called_once()
|
|
which_mock.assert_not_called()
|
|
|
|
|
|
def test_wrap_claude_prepare_only_uses_lean_ctx_when_configured(monkeypatch) -> None:
|
|
runner = CliRunner()
|
|
monkeypatch.setenv("HEADROOM_CONTEXT_TOOL", "lean-ctx")
|
|
|
|
with patch("headroom.cli.wrap._prepare_wrap_rtk") as prepare_rtk:
|
|
with patch(
|
|
"headroom.cli.wrap._setup_lean_ctx_agent",
|
|
return_value=Path("lean-ctx"),
|
|
) as setup:
|
|
result = runner.invoke(main, ["wrap", "claude", "--prepare-only"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
prepare_rtk.assert_not_called()
|
|
setup.assert_called_once_with("claude", verbose=False)
|
|
|
|
|
|
def test_setup_lean_ctx_agent_runs_outside_project_root(monkeypatch, tmp_path: Path) -> None:
|
|
project_root = tmp_path / "project"
|
|
project_root.mkdir()
|
|
(project_root / ".git").mkdir()
|
|
lean_ctx = tmp_path / "lean-ctx"
|
|
lean_ctx.write_text("#!/bin/sh\n", encoding="utf-8")
|
|
calls: list[dict] = []
|
|
|
|
def fake_run(*args, **kwargs):
|
|
calls.append({"args": args, "kwargs": kwargs})
|
|
return subprocess.CompletedProcess(args[0], 0, stdout="", stderr="")
|
|
|
|
monkeypatch.chdir(project_root)
|
|
monkeypatch.setattr("headroom.lean_ctx.get_lean_ctx_path", lambda: lean_ctx)
|
|
monkeypatch.setattr("headroom.cli.wrap.subprocess.run", fake_run)
|
|
|
|
assert _setup_lean_ctx_agent("codex") == lean_ctx
|
|
|
|
assert calls
|
|
cwd = Path(calls[0]["kwargs"]["cwd"])
|
|
assert cwd != project_root
|
|
assert project_root not in cwd.parents
|
|
|
|
|
|
def test_wrap_codex_prepare_only_updates_config(monkeypatch, tmp_path: Path) -> None:
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
runner = CliRunner()
|
|
|
|
with patch("headroom.cli.wrap._ensure_rtk_binary", return_value=None):
|
|
result = runner.invoke(main, ["wrap", "codex", "--prepare-only", "--port", "8787"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
config_file = tmp_path / ".codex" / "config.toml"
|
|
assert config_file.exists()
|
|
content = config_file.read_text(encoding="utf-8")
|
|
assert 'model_provider = "headroom"' in content
|
|
assert 'base_url = "http://127.0.0.1:8787/v1"' in content
|
|
|
|
|
|
def test_wrap_codex_prepare_only_uses_lean_ctx_when_configured(monkeypatch, tmp_path: Path) -> None:
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
monkeypatch.setenv("HEADROOM_CONTEXT_TOOL", "lean-ctx")
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem(temp_dir=str(tmp_path)):
|
|
with patch("headroom.cli.wrap._ensure_rtk_binary") as ensure_rtk:
|
|
with patch(
|
|
"headroom.cli.wrap._setup_lean_ctx_agent",
|
|
return_value=Path("lean-ctx"),
|
|
) as setup:
|
|
result = runner.invoke(
|
|
main,
|
|
["wrap", "codex", "--prepare-only", "--no-mcp", "--no-serena"],
|
|
)
|
|
|
|
assert result.exit_code == 0, result.output
|
|
ensure_rtk.assert_not_called()
|
|
setup.assert_called_once_with("codex", verbose=False)
|
|
assert not Path("AGENTS.md").exists()
|
|
|
|
|
|
def test_wrap_codex_prepare_only_accepts_no_context_tool_alias(monkeypatch, tmp_path: Path) -> None:
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
monkeypatch.setenv("HEADROOM_CONTEXT_TOOL", "lean-ctx")
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem(temp_dir=str(tmp_path)):
|
|
with patch("headroom.cli.wrap._ensure_rtk_binary") as ensure_rtk:
|
|
with patch("headroom.cli.wrap._setup_lean_ctx_agent") as setup:
|
|
result = runner.invoke(
|
|
main,
|
|
[
|
|
"wrap",
|
|
"codex",
|
|
"--prepare-only",
|
|
"--no-context-tool",
|
|
"--no-mcp",
|
|
"--no-serena",
|
|
],
|
|
)
|
|
|
|
assert result.exit_code == 0, result.output
|
|
ensure_rtk.assert_not_called()
|
|
setup.assert_not_called()
|
|
|
|
|
|
def test_wrap_aider_prepare_only_injects_conventions(monkeypatch, tmp_path: Path) -> None:
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem(temp_dir=str(tmp_path)):
|
|
with patch("headroom.cli.wrap._ensure_rtk_binary", return_value=Path("rtk")):
|
|
result = runner.invoke(main, ["wrap", "aider", "--prepare-only"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
conventions = Path("CONVENTIONS.md")
|
|
assert conventions.exists()
|
|
assert "headroom:rtk-instructions" in conventions.read_text(encoding="utf-8")
|
|
|
|
|
|
def test_wrap_cursor_prepare_only_registers_native_hook(monkeypatch, tmp_path: Path) -> None:
|
|
# GH #756: when rtk's own `--agent cursor` hook registers successfully,
|
|
# headroom must not also inject RTK_INSTRUCTIONS_BLOCK into .cursorrules.
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
runner = CliRunner()
|
|
|
|
# headroom trusts the on-disk hook, not rtk's exit code, so simulate rtk
|
|
# actually writing ~/.cursor/hooks.json when registration succeeds.
|
|
def _register(_rtk_path, *, agent):
|
|
hooks = tmp_path / ".cursor" / "hooks.json"
|
|
hooks.parent.mkdir(parents=True, exist_ok=True)
|
|
hooks.write_text('{"hooks": {"preToolUse": [{"command": "rtk hook cursor"}]}}')
|
|
return True
|
|
|
|
with runner.isolated_filesystem(temp_dir=str(tmp_path)):
|
|
with (
|
|
patch("headroom.cli.wrap._ensure_rtk_binary", return_value=Path("rtk")),
|
|
patch("headroom.rtk.installer.register_agent_hooks", side_effect=_register) as register,
|
|
):
|
|
result = runner.invoke(main, ["wrap", "cursor", "--prepare-only"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
register.assert_called_once_with(Path("rtk"), agent="cursor")
|
|
assert not Path(".cursorrules").exists()
|
|
|
|
|
|
def test_wrap_cursor_prepare_only_falls_back_to_cursorrules_when_hook_fails(
|
|
monkeypatch, tmp_path: Path
|
|
) -> None:
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem(temp_dir=str(tmp_path)):
|
|
with (
|
|
patch("headroom.cli.wrap._ensure_rtk_binary", return_value=Path("rtk")),
|
|
patch("headroom.rtk.installer.register_agent_hooks", return_value=False),
|
|
):
|
|
result = runner.invoke(main, ["wrap", "cursor", "--prepare-only"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
cursorrules = Path(".cursorrules")
|
|
assert cursorrules.exists()
|
|
assert "headroom:rtk-instructions" in cursorrules.read_text(encoding="utf-8")
|
|
|
|
|
|
def test_wrap_cursor_prepare_only_uses_lean_ctx_when_configured(
|
|
monkeypatch, tmp_path: Path
|
|
) -> None:
|
|
_set_test_home(monkeypatch, tmp_path)
|
|
monkeypatch.setenv("HEADROOM_CONTEXT_TOOL", "lean-ctx")
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem(temp_dir=str(tmp_path)):
|
|
with patch("headroom.cli.wrap._ensure_rtk_binary") as ensure_rtk:
|
|
with patch(
|
|
"headroom.cli.wrap._setup_lean_ctx_agent",
|
|
return_value=Path("lean-ctx"),
|
|
) as setup:
|
|
result = runner.invoke(main, ["wrap", "cursor", "--prepare-only"])
|
|
|
|
assert result.exit_code == 0, result.output
|
|
ensure_rtk.assert_not_called()
|
|
setup.assert_called_once_with("cursor", verbose=False)
|
|
assert not Path(".cursorrules").exists()
|
|
|
|
|
|
def test_wrap_openclaw_prepare_only_emits_config_without_python_default() -> None:
|
|
runner = CliRunner()
|
|
|
|
result = runner.invoke(
|
|
main,
|
|
[
|
|
"wrap",
|
|
"openclaw",
|
|
"--prepare-only",
|
|
"--gateway-provider-id",
|
|
"codex",
|
|
"--gateway-provider-id",
|
|
"anthropic",
|
|
],
|
|
)
|
|
|
|
assert result.exit_code == 0, result.output
|
|
payload = json.loads(result.output)
|
|
assert payload["enabled"] is True
|
|
assert payload["config"]["proxyPort"] == 8787
|
|
assert payload["config"]["gatewayProviderIds"] == ["codex", "anthropic"]
|
|
assert "pythonPath" not in payload["config"]
|
|
|
|
|
|
def test_unwrap_openclaw_prepare_only_preserves_unmanaged_config() -> None:
|
|
runner = CliRunner()
|
|
existing_entry = json.dumps(
|
|
{
|
|
"enabled": True,
|
|
"config": {
|
|
"pythonPath": "C:\\Python312\\python.exe",
|
|
"proxyPort": 8787,
|
|
"customFlag": True,
|
|
},
|
|
}
|
|
)
|
|
|
|
result = runner.invoke(
|
|
main,
|
|
[
|
|
"unwrap",
|
|
"openclaw",
|
|
"--prepare-only",
|
|
"--existing-entry-json",
|
|
existing_entry,
|
|
],
|
|
)
|
|
|
|
assert result.exit_code == 0, result.output
|
|
payload = json.loads(result.output)
|
|
assert payload == {"enabled": False, "config": {"customFlag": True}}
|