mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-10 14:27:00 -04:00
## Description Fixes OpenCode Headroom MCP configuration across wrap, MCP install/status/uninstall, and persistent install docs/CLI. OpenCode was being configured to use a remote HTTP MCP endpoint at `/mcp`, but the Headroom proxy does not expose MCP there. The correct OpenCode configuration is a local stdio MCP server that runs `headroom mcp serve`. Closes #1380 ## Type of Change - [x] Bug fix - [ ] New feature - [ ] Breaking change - [x] Documentation update - [x] Tests ## Changes Made - Changed OpenCode MCP registration to emit `type: "local"` with `command: ["headroom", "mcp", "serve"]`. - Changed OpenCode MCP environment serialization from `env` to OpenCode's `environment` key, while still reading legacy `env` entries. - Removed generated remote `/mcp` entries from OpenCode wrap/runtime config. - Made `wrap opencode --no-mcp` skip persistent `mcp.headroom` injection. - Kept provider-only OpenCode config injection from writing MCP; MCP persistence is owned by the registrar path. - Made `headroom mcp status` and `headroom mcp uninstall` use the registrar lifecycle so OpenCode is covered. - Added `opencode` to persistent install `--target` choices. - Clarified OpenCode persistent install docs to use `--scope provider` for direct `opencode.json` edits. - Added regression coverage for registrar serialization, wrap behavior, runtime config, provider-scope install, MCP CLI lifecycle, and install target parsing. ## Testing - [x] `rtk .venv/bin/python -m pytest tests/test_mcp_registry tests/test_cli/test_mcp.py tests/test_cli/test_wrap_opencode.py tests/test_providers_opencode_config.py tests/test_providers_opencode_install.py tests/test_install -q` - [x] Result after absorbing #1381 overlap: `263 passed, 1 skipped` - [x] Targeted Ruff check passed for the changed Python/test files. - [x] Targeted Ruff format check passed for the changed Python/test files. - [x] Isolated HOME smoke tests with real `opencode mcp list --pure`. ## Real Behavior Proof - `headroom mcp install --agent opencode --proxy-url http://127.0.0.1:9000 --force` against an isolated HOME wrote a valid local OpenCode MCP entry with `environment.HEADROOM_PROXY_URL`. - `opencode mcp list --pure` against that isolated HOME connected to `headroom mcp serve`. - `headroom wrap opencode --prepare-only --no-rtk --no-serena --port 9001` wrote local MCP plus provider config. - `headroom wrap opencode --prepare-only --no-rtk --no-serena --no-mcp --port 9002` wrote provider config without `mcp.headroom`. - Generated runtime `OPENCODE_CONFIG_CONTENT` was accepted by `opencode mcp list --pure`; `include_mcp=False` reported no MCP servers. - `headroom mcp status` detected the isolated OpenCode config and read the custom proxy URL. - `headroom mcp uninstall` removed `mcp.headroom` from the isolated OpenCode config while leaving provider config intact. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review
314 lines
11 KiB
Python
314 lines
11 KiB
Python
"""Integration tests for MCP CLI commands.
|
|
|
|
These are real tests that:
|
|
- Actually write/read config files
|
|
- Test actual CLI behavior
|
|
- Test MCP server initialization (when MCP SDK is available)
|
|
"""
|
|
|
|
import json
|
|
import sys
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
from click.testing import CliRunner
|
|
|
|
from headroom.cli.main import main
|
|
from headroom.cli.mcp import (
|
|
get_headroom_command,
|
|
load_mcp_config,
|
|
save_mcp_config,
|
|
)
|
|
from headroom.mcp_registry.base import ServerSpec
|
|
|
|
# Check if MCP SDK is available
|
|
try:
|
|
import mcp # noqa: F401
|
|
|
|
MCP_AVAILABLE = True
|
|
except ImportError:
|
|
MCP_AVAILABLE = False
|
|
|
|
|
|
@pytest.fixture
|
|
def temp_claude_dir(tmp_path):
|
|
"""Create a temporary .claude directory for testing."""
|
|
claude_dir = tmp_path / ".claude"
|
|
claude_dir.mkdir()
|
|
return claude_dir
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_claude_config_path(temp_claude_dir):
|
|
"""Patch the MCP config path to use temp directory."""
|
|
config_path = temp_claude_dir / "mcp.json"
|
|
with patch("headroom.cli.mcp.MCP_CONFIG_PATH", config_path):
|
|
with patch("headroom.cli.mcp.CLAUDE_CONFIG_DIR", temp_claude_dir):
|
|
yield config_path
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_mcp_available():
|
|
"""Mock MCP SDK as available for testing install/uninstall commands."""
|
|
mock_mcp = MagicMock()
|
|
with patch.dict(sys.modules, {"mcp": mock_mcp}):
|
|
yield mock_mcp
|
|
|
|
|
|
class FakeRegistrar:
|
|
name = "fake"
|
|
display_name = "Fake Agent"
|
|
|
|
def __init__(self, *, configured: bool = True) -> None:
|
|
self.configured = configured
|
|
self.removed: list[str] = []
|
|
|
|
def detect(self) -> bool:
|
|
return True
|
|
|
|
def get_server(self, server_name: str) -> ServerSpec | None:
|
|
if self.configured and server_name == "headroom":
|
|
return ServerSpec(name="headroom", command="headroom", args=("mcp", "serve"))
|
|
return None
|
|
|
|
def unregister_server(self, server_name: str) -> bool:
|
|
if self.configured and server_name == "headroom":
|
|
self.configured = False
|
|
self.removed.append(server_name)
|
|
return True
|
|
return False
|
|
|
|
|
|
class TestMCPConfigFunctions:
|
|
"""Test config file handling functions."""
|
|
|
|
def test_get_headroom_command_returns_list(self):
|
|
"""Command should be a list suitable for subprocess."""
|
|
cmd = get_headroom_command()
|
|
assert isinstance(cmd, list)
|
|
assert len(cmd) >= 1
|
|
# Should end with mcp serve args
|
|
assert "mcp" in cmd or "-m" in cmd
|
|
|
|
def test_load_mcp_config_empty_when_no_file(self, mock_claude_config_path):
|
|
"""Loading non-existent config returns empty structure."""
|
|
config = load_mcp_config()
|
|
assert config == {"mcpServers": {}}
|
|
|
|
def test_save_and_load_config(self, mock_claude_config_path):
|
|
"""Config can be saved and loaded back."""
|
|
test_config = {
|
|
"mcpServers": {
|
|
"headroom": {
|
|
"command": "headroom",
|
|
"args": ["mcp", "serve"],
|
|
}
|
|
}
|
|
}
|
|
save_mcp_config(test_config)
|
|
|
|
# File should exist
|
|
assert mock_claude_config_path.exists()
|
|
|
|
# Load it back
|
|
loaded = load_mcp_config()
|
|
assert loaded == test_config
|
|
|
|
def test_save_config_creates_directory(self, tmp_path):
|
|
"""save_mcp_config creates parent directory if needed."""
|
|
claude_dir = tmp_path / "new_dir" / ".claude"
|
|
config_path = claude_dir / "mcp.json"
|
|
|
|
with patch("headroom.cli.mcp.MCP_CONFIG_PATH", config_path):
|
|
with patch("headroom.cli.mcp.CLAUDE_CONFIG_DIR", claude_dir):
|
|
save_mcp_config({"mcpServers": {}})
|
|
|
|
assert config_path.exists()
|
|
|
|
def test_load_config_preserves_other_servers(self, mock_claude_config_path):
|
|
"""Loading preserves other MCP servers in config."""
|
|
# Write config with another server
|
|
existing_config = {
|
|
"mcpServers": {
|
|
"other-server": {"command": "other", "args": []},
|
|
}
|
|
}
|
|
mock_claude_config_path.write_text(json.dumps(existing_config))
|
|
|
|
loaded = load_mcp_config()
|
|
assert "other-server" in loaded["mcpServers"]
|
|
|
|
|
|
#
|
|
# Note: Tests for the 'mcp install' command's writes/idempotency/CLI-vs-file
|
|
# fallback used to live here, but they were tightly coupled to private
|
|
# globals (MCP_CONFIG_PATH, shutil.which) and exercised the same surface
|
|
# already covered by:
|
|
# - tests/test_mcp_registry/test_claude_registrar.py (file/CLI behavior
|
|
# with proper constructor injection — no patches)
|
|
# - tests/test_mcp_registry/test_install.py (orchestrator semantics with
|
|
# fake registrars)
|
|
# Removing the duplicates leaves the CLI as glue: argument parsing +
|
|
# output formatting, which is straightforward and not worth its own test
|
|
# layer.
|
|
|
|
|
|
class TestMCPUninstallCommand:
|
|
"""Test 'headroom mcp uninstall' command."""
|
|
|
|
def test_uninstall_removes_headroom(self, mock_mcp_available):
|
|
"""Uninstall removes headroom through detected registrars."""
|
|
registrar = FakeRegistrar()
|
|
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "uninstall"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "removed" in result.output.lower()
|
|
assert registrar.removed == ["headroom"]
|
|
|
|
def test_uninstall_checks_only_headroom_servers(self):
|
|
"""Uninstall only asks registrars to remove Headroom-owned servers."""
|
|
registrar = FakeRegistrar()
|
|
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "uninstall"])
|
|
|
|
assert result.exit_code == 0
|
|
assert registrar.removed == ["headroom"]
|
|
|
|
def test_uninstall_no_config_file(self, mock_claude_config_path):
|
|
"""Uninstall with no config file exits cleanly."""
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[]):
|
|
result = runner.invoke(main, ["mcp", "uninstall"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "nothing to uninstall" in result.output.lower()
|
|
|
|
def test_uninstall_not_configured(self, mock_claude_config_path):
|
|
"""Uninstall when headroom not in config exits cleanly."""
|
|
registrar = FakeRegistrar(configured=False)
|
|
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "uninstall"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "not configured" in result.output.lower()
|
|
|
|
|
|
class TestMCPStatusCommand:
|
|
"""Test 'headroom mcp status' command."""
|
|
|
|
def test_status_not_configured(self, mock_claude_config_path):
|
|
"""Status shows not configured when no config."""
|
|
runner = CliRunner()
|
|
registrar = FakeRegistrar(configured=False)
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "status"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "MCP SDK" in result.output
|
|
# Should show not configured
|
|
assert (
|
|
"✗" in result.output
|
|
or "Not configured" in result.output.lower()
|
|
or "No config" in result.output
|
|
)
|
|
|
|
def test_status_configured(self, mock_claude_config_path, mock_mcp_available):
|
|
"""Status reports configured when a registrar has headroom."""
|
|
registrar = FakeRegistrar(configured=True)
|
|
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "status"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "✓ Configured" in result.output
|
|
|
|
|
|
class TestMCPServeCommand:
|
|
"""Test 'headroom mcp serve' command."""
|
|
|
|
def test_serve_help(self):
|
|
"""Serve command shows help."""
|
|
runner = CliRunner()
|
|
result = runner.invoke(main, ["mcp", "serve", "--help"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "proxy-url" in result.output
|
|
assert "debug" in result.output
|
|
|
|
|
|
@pytest.mark.skipif(not MCP_AVAILABLE, reason="MCP SDK not installed")
|
|
class TestMCPServerInitialization:
|
|
"""Test actual MCP server creation.
|
|
|
|
These tests require the MCP SDK to be installed.
|
|
"""
|
|
|
|
def test_mcp_server_can_be_created(self):
|
|
"""MCP server can be instantiated."""
|
|
from headroom.ccr.mcp_server import create_ccr_mcp_server
|
|
|
|
server = create_ccr_mcp_server()
|
|
assert server is not None
|
|
assert server.proxy_url == "http://127.0.0.1:8787"
|
|
|
|
def test_mcp_server_with_custom_url(self):
|
|
"""MCP server accepts custom proxy URL."""
|
|
from headroom.ccr.mcp_server import create_ccr_mcp_server
|
|
|
|
server = create_ccr_mcp_server(proxy_url="http://custom:9000")
|
|
assert server.proxy_url == "http://custom:9000"
|
|
|
|
def test_mcp_server_has_correct_tool_name(self):
|
|
"""MCP server is configured for headroom_retrieve tool."""
|
|
from headroom.ccr.mcp_server import create_ccr_mcp_server
|
|
from headroom.ccr.tool_injection import CCR_TOOL_NAME
|
|
|
|
server = create_ccr_mcp_server()
|
|
|
|
# Verify the server was created with correct configuration
|
|
assert server.server is not None
|
|
assert server.server.name == "headroom"
|
|
# The tool name should be headroom_retrieve
|
|
assert CCR_TOOL_NAME == "headroom_retrieve"
|
|
|
|
|
|
#
|
|
# Tests for "install via claude CLI" used to live here, exercising
|
|
# subprocess.run patches against the old direct CLI invocation. Equivalent
|
|
# coverage now lives in tests/test_mcp_registry/test_claude_registrar.py
|
|
# using constructor injection (`claude_cli="/path/to/fake"`) and bounded
|
|
# subprocess.run mocks at the registrar boundary — no module-level patches.
|
|
|
|
|
|
class TestMCPUninstallWithRegistrars:
|
|
"""Test mcp_uninstall delegates to registrars."""
|
|
|
|
def test_uninstall_reports_removed_registrar_server(self):
|
|
registrar = FakeRegistrar(configured=True)
|
|
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "uninstall"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "Fake Agent" in result.output
|
|
assert registrar.removed == ["headroom"]
|
|
|
|
def test_uninstall_skips_unconfigured_registrar(self):
|
|
registrar = FakeRegistrar(configured=False)
|
|
|
|
runner = CliRunner()
|
|
with patch("headroom.mcp_registry.get_all_registrars", return_value=[registrar]):
|
|
result = runner.invoke(main, ["mcp", "uninstall"])
|
|
|
|
assert result.exit_code == 0
|
|
assert "nothing to uninstall" in result.output.lower()
|
|
assert registrar.removed == []
|