mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-10 14:27:00 -04:00
## Description Fixes the OpenCode config corruption reported in #1380 for wrap, MCP registration, and provider-scope install paths. OpenCode MCP entries are local stdio servers, not remote HTTP endpoints. This changes Headroom's OpenCode MCP serialization to write `type: "local"` with `command: ["headroom", "mcp", "serve"]`, uses OpenCode's `environment` field for MCP env vars, and still reads the older `env` key for compatibility. This also stops provider-only OpenCode config injection from creating a fake `http://127.0.0.1:<port>/mcp` entry, so `headroom wrap opencode --no-mcp` no longer leaves `mcp.headroom` behind. Finally, the install CLI/docs now accept and document `--target opencode` with provider scope. This does not change the broader `headroom mcp status/uninstall` behavior from #1380; that looks like a separate follow-up. ## 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) - [x] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - Write OpenCode MCP entries as local stdio config instead of remote `/mcp` config. - Use `environment` for OpenCode MCP env vars while continuing to read legacy `env` entries. - Stop OpenCode provider injection/persistent provider install from adding MCP config. - Keep `--no-mcp` from writing `mcp.headroom` while preserving other MCP entries such as Serena. - Allow `headroom install apply --target opencode` at the CLI layer. - Update OpenCode docs and changelog. ## Testing - [x] Focused unit tests pass - [x] Linting passes (`ruff check .`) - [x] Formatting passes (`ruff format --check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for the fixed behavior - [x] Manual testing performed ### Test Output ```text $ pytest tests/test_mcp_registry_opencode.py tests/test_cli/test_wrap_opencode.py tests/test_providers_opencode_config.py tests/test_providers_opencode_install.py tests/test_cli/test_install_cli.py tests/test_install/test_providers.py Pytest: 164 passed $ uvx ruff check . All checks passed! $ uvx ruff format --check . 986 files already formatted $ uvx mypy --config-file pyproject.toml headroom Success: no issues found in 398 source files ``` ## Real Behavior Proof - Environment: macOS local worktree at `/Users/vinaygupta/Desktop/git/headroom-fix-opencode-mcp-config`; branch `fix-opencode-mcp-config`; commit `aea96208`. - Exact command / steps: ran the focused OpenCode/installer regression suite plus Ruff lint/format checks and mypy commands shown above. - Observed result: the focused tests pass and cover OpenCode MCP serialization as `type: "local"`, `command: ["headroom", "mcp", "serve"]`, `environment` env vars, `--no-mcp` not writing `mcp.headroom`, provider-scope install not adding MCP config, and `install apply --target opencode` being accepted. - Not tested: full `pytest` locally, because collection requires the native `headroom._core` extension in this worktree. Attempting the project runner hit a local native build failure first: `esaxx-rs` failed compiling `src/esaxx.cpp` with `fatal error: 'cstdint' file not found`. The broader generic `headroom mcp status/uninstall` behavior from #1380 is intentionally left for a follow-up. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review Scope note: generic `mcp status/uninstall` support from #1380 is intentionally left as a separate follow-up PR.
116 lines
3.5 KiB
Python
116 lines
3.5 KiB
Python
"""Tests for OpenCode install-time helpers."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from headroom.install.models import ConfigScope, DeploymentManifest
|
|
from headroom.providers.opencode.install import (
|
|
apply_provider_scope,
|
|
build_install_env,
|
|
revert_provider_scope,
|
|
)
|
|
|
|
|
|
def _manifest(port: int = 8787) -> DeploymentManifest:
|
|
return DeploymentManifest(
|
|
profile="test",
|
|
preset="persistent-task",
|
|
runtime_kind="python",
|
|
supervisor_kind="none",
|
|
scope=ConfigScope.PROVIDER.value,
|
|
provider_mode="auto",
|
|
targets=[],
|
|
port=port,
|
|
host="127.0.0.1",
|
|
backend="anthropic",
|
|
proxy_args=[],
|
|
base_env={},
|
|
tool_envs={},
|
|
)
|
|
|
|
|
|
def test_build_install_env() -> None:
|
|
"""build_install_env leaves OpenCode provider env vars untouched."""
|
|
env = build_install_env(port=8787, backend="anthropic")
|
|
assert env == {}
|
|
|
|
|
|
def test_apply_provider_scope_creates_config(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
"""apply_provider_scope creates the opencode config with headroom provider."""
|
|
home = str(tmp_path)
|
|
monkeypatch.setenv("HOME", home)
|
|
monkeypatch.setenv("USERPROFILE", home)
|
|
monkeypatch.delenv("OPENCODE_HOME", raising=False)
|
|
monkeypatch.delenv("OPENCODE_CONFIG", raising=False)
|
|
|
|
manifest = _manifest(port=8787)
|
|
mutation = apply_provider_scope(manifest)
|
|
assert mutation is not None
|
|
assert mutation.target == "opencode"
|
|
assert mutation.kind == "json-block"
|
|
|
|
config_file = tmp_path / ".config" / "opencode" / "opencode.json"
|
|
assert config_file.exists()
|
|
import json
|
|
|
|
config = json.loads(config_file.read_text())
|
|
assert config["provider"]["headroom"]["options"]["baseURL"] == "http://127.0.0.1:8787/v1"
|
|
assert "mcp" not in config
|
|
|
|
|
|
def test_apply_provider_scope_skips_when_scope_is_not_provider(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
"""apply_provider_scope returns None when scope is not PROVIDER."""
|
|
manifest = _manifest()
|
|
manifest.scope = ConfigScope.USER.value
|
|
result = apply_provider_scope(manifest)
|
|
assert result is None
|
|
|
|
|
|
def test_revert_provider_scope_restores_file(
|
|
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
"""revert_provider_scope strips the Headroom block from the config."""
|
|
home = str(tmp_path)
|
|
monkeypatch.setenv("HOME", home)
|
|
monkeypatch.setenv("USERPROFILE", home)
|
|
monkeypatch.delenv("OPENCODE_HOME", raising=False)
|
|
monkeypatch.delenv("OPENCODE_CONFIG", raising=False)
|
|
|
|
config_file = tmp_path / ".config" / "opencode" / "opencode.json"
|
|
config_file.parent.mkdir(parents=True, exist_ok=True)
|
|
config_file.write_text('{"model": "openai/gpt-4o"}')
|
|
|
|
from headroom.install.models import ManagedMutation
|
|
|
|
mutation = ManagedMutation(
|
|
target="opencode",
|
|
kind="json-block",
|
|
path=str(config_file),
|
|
)
|
|
manifest = _manifest()
|
|
revert_provider_scope(mutation, manifest)
|
|
assert config_file.exists()
|
|
assert config_file.read_text().strip() == '{"model": "openai/gpt-4o"}'
|
|
|
|
|
|
def test_revert_provider_scope_noop_when_file_missing(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
"""revert_provider_scope is a safe no-op when the config file is gone."""
|
|
from headroom.install.models import ManagedMutation
|
|
|
|
mutation = ManagedMutation(
|
|
target="opencode",
|
|
kind="json-block",
|
|
path=str(tmp_path / "nonexistent.json"),
|
|
)
|
|
manifest = _manifest()
|
|
revert_provider_scope(mutation, manifest)
|
|
# Should not raise
|