chore: import upstream snapshot with attribution
Deploy Docs / deploy-docs (push) Failing after 1s
Conformance Tests / client-conformance (push) Failing after 3s
Conformance Tests / server-conformance (push) Failing after 1s
GitHub Actions Security Analysis / zizmor (push) Failing after 1s
CI / checks (push) Failing after 59m20s
CI / all-green (push) Waiting to run
Deploy Docs / deploy-docs (push) Failing after 1s
Conformance Tests / client-conformance (push) Failing after 3s
Conformance Tests / server-conformance (push) Failing after 1s
GitHub Actions Security Analysis / zizmor (push) Failing after 1s
CI / checks (push) Failing after 59m20s
CI / all-green (push) Waiting to run
This commit is contained in:
@@ -0,0 +1,198 @@
|
||||
"""Tests for mcp.cli.claude — Claude Desktop config file generation."""
|
||||
|
||||
import importlib.metadata
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
|
||||
from mcp.cli.claude import get_uv_path, mcp_requirement, update_claude_config
|
||||
|
||||
|
||||
def _set_mcp_version(monkeypatch: pytest.MonkeyPatch, version: str) -> None:
|
||||
real_version = importlib.metadata.version
|
||||
|
||||
def fake_version(distribution_name: str) -> str:
|
||||
return version if distribution_name == "mcp" else real_version(distribution_name)
|
||||
|
||||
monkeypatch.setattr(importlib.metadata, "version", fake_version)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def config_dir(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
|
||||
"""Temp Claude config dir with the config path, uv path, and SDK version mocked."""
|
||||
claude_dir = tmp_path / "Claude"
|
||||
claude_dir.mkdir()
|
||||
monkeypatch.setattr("mcp.cli.claude.get_claude_config_path", lambda: claude_dir)
|
||||
monkeypatch.setattr("mcp.cli.claude.get_uv_path", lambda: "/fake/bin/uv")
|
||||
# The ambient version is a dev build in the repo venv but varies by
|
||||
# environment; pin it so the generated --with requirement is stable.
|
||||
_set_mcp_version(monkeypatch, "1.2.3")
|
||||
return claude_dir
|
||||
|
||||
|
||||
def test_mcp_requirement_pins_release_versions(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Release versions produce an exact pin so spawned environments run the installed SDK version."""
|
||||
_set_mcp_version(monkeypatch, "2.0.0a1")
|
||||
assert mcp_requirement() == "mcp==2.0.0a1"
|
||||
assert mcp_requirement("mcp[cli]") == "mcp[cli]==2.0.0a1"
|
||||
|
||||
|
||||
def test_mcp_requirement_leaves_dev_versions_unpinned(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Dev versions are not published to PyPI, so the requirement falls back to the unpinned package."""
|
||||
_set_mcp_version(monkeypatch, "2.0.0a2.dev3")
|
||||
assert mcp_requirement() == "mcp"
|
||||
assert mcp_requirement("mcp[cli]") == "mcp[cli]"
|
||||
|
||||
|
||||
def test_mcp_requirement_leaves_local_versions_unpinned(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Local version segments (source builds) are not published to PyPI, so no pin is emitted."""
|
||||
_set_mcp_version(monkeypatch, "1.2.3+g0123abc")
|
||||
assert mcp_requirement() == "mcp"
|
||||
|
||||
|
||||
def test_mcp_requirement_falls_back_when_mcp_is_not_installed(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Without distribution metadata there is no version to pin, so the requirement stays unpinned."""
|
||||
|
||||
def raise_not_found(distribution_name: str) -> str:
|
||||
raise importlib.metadata.PackageNotFoundError(distribution_name)
|
||||
|
||||
monkeypatch.setattr(importlib.metadata, "version", raise_not_found)
|
||||
assert mcp_requirement() == "mcp"
|
||||
assert mcp_requirement("mcp[cli]") == "mcp[cli]"
|
||||
|
||||
|
||||
def _read_server(config_dir: Path, name: str) -> dict[str, Any]:
|
||||
config = json.loads((config_dir / "claude_desktop_config.json").read_text())
|
||||
return config["mcpServers"][name]
|
||||
|
||||
|
||||
def test_generates_uv_run_command(config_dir: Path):
|
||||
"""Should write a uv run command that invokes mcp run on the resolved file spec."""
|
||||
assert update_claude_config(file_spec="server.py:app", server_name="my_server")
|
||||
|
||||
resolved = Path("server.py").resolve()
|
||||
assert _read_server(config_dir, "my_server") == {
|
||||
"command": "/fake/bin/uv",
|
||||
"args": ["run", "--frozen", "--with", "mcp[cli]==1.2.3", "mcp", "run", f"{resolved}:app"],
|
||||
}
|
||||
|
||||
|
||||
def test_file_spec_without_object_suffix(config_dir: Path):
|
||||
"""File specs without :object should still resolve to an absolute path."""
|
||||
assert update_claude_config(file_spec="server.py", server_name="s")
|
||||
|
||||
assert _read_server(config_dir, "s")["args"][-1] == str(Path("server.py").resolve())
|
||||
|
||||
|
||||
def test_with_packages_sorted_and_deduplicated(config_dir: Path):
|
||||
"""Extra packages should appear as sorted --with flags with duplicates removed."""
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s", with_packages=["zebra", "aardvark", "zebra"])
|
||||
|
||||
args = _read_server(config_dir, "s")["args"]
|
||||
assert args[:8] == ["run", "--frozen", "--with", "aardvark", "--with", "mcp[cli]==1.2.3", "--with", "zebra"]
|
||||
|
||||
|
||||
def test_explicit_mcp_cli_kept_alongside_pinned_requirement(config_dir: Path):
|
||||
"""A user-supplied mcp[cli] no longer collapses into the pinned requirement; uv resolves both to the pin."""
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s", with_packages=["mcp[cli]"])
|
||||
|
||||
args = _read_server(config_dir, "s")["args"]
|
||||
assert args[:6] == ["run", "--frozen", "--with", "mcp[cli]", "--with", "mcp[cli]==1.2.3"]
|
||||
|
||||
|
||||
def test_with_editable_adds_flag(config_dir: Path, tmp_path: Path):
|
||||
"""with_editable should add --with-editable after the --with flags."""
|
||||
editable = tmp_path / "project"
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s", with_editable=editable)
|
||||
|
||||
args = _read_server(config_dir, "s")["args"]
|
||||
assert args[4:6] == ["--with-editable", str(editable)]
|
||||
|
||||
|
||||
def test_env_vars_written(config_dir: Path):
|
||||
"""env_vars should be written under the server's env key."""
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s", env_vars={"KEY": "val"})
|
||||
|
||||
assert _read_server(config_dir, "s")["env"] == {"KEY": "val"}
|
||||
|
||||
|
||||
def test_existing_env_vars_merged_new_wins(config_dir: Path):
|
||||
"""Re-installing should merge env vars, with new values overriding existing ones."""
|
||||
(config_dir / "claude_desktop_config.json").write_text(
|
||||
json.dumps({"mcpServers": {"s": {"env": {"OLD": "keep", "KEY": "old"}}}})
|
||||
)
|
||||
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s", env_vars={"KEY": "new"})
|
||||
|
||||
assert _read_server(config_dir, "s")["env"] == {"OLD": "keep", "KEY": "new"}
|
||||
|
||||
|
||||
def test_existing_env_vars_preserved_without_new(config_dir: Path):
|
||||
"""Re-installing without env_vars should keep the existing env block intact."""
|
||||
(config_dir / "claude_desktop_config.json").write_text(json.dumps({"mcpServers": {"s": {"env": {"KEEP": "me"}}}}))
|
||||
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s")
|
||||
|
||||
assert _read_server(config_dir, "s")["env"] == {"KEEP": "me"}
|
||||
|
||||
|
||||
def test_other_servers_preserved(config_dir: Path):
|
||||
"""Installing a new server should not clobber existing mcpServers entries."""
|
||||
(config_dir / "claude_desktop_config.json").write_text(json.dumps({"mcpServers": {"other": {"command": "x"}}}))
|
||||
|
||||
assert update_claude_config(file_spec="s.py:app", server_name="s")
|
||||
|
||||
config = json.loads((config_dir / "claude_desktop_config.json").read_text())
|
||||
assert set(config["mcpServers"]) == {"other", "s"}
|
||||
assert config["mcpServers"]["other"] == {"command": "x"}
|
||||
|
||||
|
||||
def test_raises_when_config_dir_missing(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Should raise RuntimeError when Claude Desktop config dir can't be found."""
|
||||
monkeypatch.setattr("mcp.cli.claude.get_claude_config_path", lambda: None)
|
||||
monkeypatch.setattr("mcp.cli.claude.get_uv_path", lambda: "/fake/bin/uv")
|
||||
|
||||
with pytest.raises(RuntimeError, match="Claude Desktop config directory not found"):
|
||||
update_claude_config(file_spec="s.py:app", server_name="s")
|
||||
|
||||
|
||||
@pytest.mark.parametrize("which_result, expected", [("/usr/local/bin/uv", "/usr/local/bin/uv"), (None, "uv")])
|
||||
def test_get_uv_path(monkeypatch: pytest.MonkeyPatch, which_result: str | None, expected: str):
|
||||
"""Should return shutil.which's result, or fall back to bare 'uv' when not on PATH."""
|
||||
|
||||
def fake_which(cmd: str) -> str | None:
|
||||
return which_result
|
||||
|
||||
monkeypatch.setattr("shutil.which", fake_which)
|
||||
assert get_uv_path() == expected
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"file_spec, expected_last_arg",
|
||||
[
|
||||
("C:\\Users\\server.py", "C:\\Users\\server.py"),
|
||||
("C:\\Users\\server.py:app", "C:\\Users\\server.py:app"),
|
||||
],
|
||||
)
|
||||
def test_windows_drive_letter_not_split(
|
||||
config_dir: Path, monkeypatch: pytest.MonkeyPatch, file_spec: str, expected_last_arg: str
|
||||
):
|
||||
"""Drive-letter paths like 'C:\\server.py' must not be split on the drive colon.
|
||||
|
||||
Before the fix, a bare 'C:\\path\\server.py' would hit rsplit(":", 1) and yield
|
||||
("C", "\\path\\server.py"), calling resolve() on Path("C") instead of the full path.
|
||||
"""
|
||||
seen: list[str] = []
|
||||
|
||||
def fake_resolve(self: Path) -> Path:
|
||||
seen.append(str(self))
|
||||
return self
|
||||
|
||||
monkeypatch.setattr(Path, "resolve", fake_resolve)
|
||||
|
||||
assert update_claude_config(file_spec=file_spec, server_name="s")
|
||||
|
||||
assert seen == ["C:\\Users\\server.py"]
|
||||
assert _read_server(config_dir, "s")["args"][-1] == expected_last_arg
|
||||
@@ -0,0 +1,120 @@
|
||||
import importlib.metadata
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
|
||||
from mcp.cli.cli import _build_uv_command, _get_npx_command, _parse_file_path # type: ignore[reportPrivateUsage]
|
||||
|
||||
|
||||
def _set_mcp_version(monkeypatch: pytest.MonkeyPatch, version: str) -> None:
|
||||
real_version = importlib.metadata.version
|
||||
|
||||
def fake_version(distribution_name: str) -> str:
|
||||
return version if distribution_name == "mcp" else real_version(distribution_name)
|
||||
|
||||
monkeypatch.setattr(importlib.metadata, "version", fake_version)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"spec, expected_obj",
|
||||
[
|
||||
("server.py", None),
|
||||
("foo.py:srv_obj", "srv_obj"),
|
||||
],
|
||||
)
|
||||
def test_parse_file_path_accepts_valid_specs(tmp_path: Path, spec: str, expected_obj: str | None):
|
||||
"""Should accept valid file specs."""
|
||||
file = tmp_path / spec.split(":")[0]
|
||||
file.write_text("x = 1")
|
||||
path, obj = _parse_file_path(f"{file}:{expected_obj}" if ":" in spec else str(file))
|
||||
assert path == file.resolve()
|
||||
assert obj == expected_obj
|
||||
|
||||
|
||||
def test_parse_file_path_missing(tmp_path: Path):
|
||||
"""Should system exit if a file is missing."""
|
||||
with pytest.raises(SystemExit):
|
||||
_parse_file_path(str(tmp_path / "missing.py"))
|
||||
|
||||
|
||||
def test_parse_file_exit_on_dir(tmp_path: Path):
|
||||
"""Should system exit if a directory is passed"""
|
||||
dir_path = tmp_path / "dir"
|
||||
dir_path.mkdir()
|
||||
with pytest.raises(SystemExit):
|
||||
_parse_file_path(str(dir_path))
|
||||
|
||||
|
||||
def test_build_uv_command_pins_the_running_mcp_version(monkeypatch: pytest.MonkeyPatch):
|
||||
"""The spawned environment installs the same SDK version that is running, not the latest stable."""
|
||||
_set_mcp_version(monkeypatch, "1.2.3")
|
||||
cmd = _build_uv_command("foo.py")
|
||||
assert cmd == ["uv", "run", "--with", "mcp==1.2.3", "mcp", "run", "foo.py"]
|
||||
|
||||
|
||||
def test_build_uv_command_leaves_source_builds_unpinned(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Source-build versions are not on PyPI, so the requirement stays unpinned."""
|
||||
_set_mcp_version(monkeypatch, "2.0.0a2.dev3+g0123abc")
|
||||
cmd = _build_uv_command("foo.py")
|
||||
assert cmd == ["uv", "run", "--with", "mcp", "mcp", "run", "foo.py"]
|
||||
|
||||
|
||||
def test_build_uv_command_adds_editable_and_packages(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Should include --with-editable and every --with pkg in correct order."""
|
||||
_set_mcp_version(monkeypatch, "1.2.3")
|
||||
test_path = Path("/pkg")
|
||||
cmd = _build_uv_command(
|
||||
"foo.py",
|
||||
with_editable=test_path,
|
||||
with_packages=["package1", "package2"],
|
||||
)
|
||||
assert cmd == [
|
||||
"uv",
|
||||
"run",
|
||||
"--with",
|
||||
"mcp==1.2.3",
|
||||
"--with-editable",
|
||||
str(test_path), # Use str() to match what the function does
|
||||
"--with",
|
||||
"package1",
|
||||
"--with",
|
||||
"package2",
|
||||
"mcp",
|
||||
"run",
|
||||
"foo.py",
|
||||
]
|
||||
|
||||
|
||||
def test_get_npx_unix_like(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Should return "npx" on unix-like systems."""
|
||||
monkeypatch.setattr(sys, "platform", "linux")
|
||||
assert _get_npx_command() == "npx"
|
||||
|
||||
|
||||
def test_get_npx_windows(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Should return one of the npx candidates on Windows."""
|
||||
candidates = ["npx.cmd", "npx.exe", "npx"]
|
||||
|
||||
def fake_run(cmd: list[str], **kw: Any) -> subprocess.CompletedProcess[bytes]:
|
||||
if cmd[0] in candidates:
|
||||
return subprocess.CompletedProcess(cmd, 0)
|
||||
else: # pragma: no cover
|
||||
raise subprocess.CalledProcessError(1, cmd[0])
|
||||
|
||||
monkeypatch.setattr(sys, "platform", "win32")
|
||||
monkeypatch.setattr(subprocess, "run", fake_run)
|
||||
assert _get_npx_command() in candidates
|
||||
|
||||
|
||||
def test_get_npx_returns_none_when_npx_missing(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Should give None if every candidate fails."""
|
||||
monkeypatch.setattr(sys, "platform", "win32", raising=False)
|
||||
|
||||
def always_fail(*args: Any, **kwargs: Any) -> subprocess.CompletedProcess[bytes]:
|
||||
raise subprocess.CalledProcessError(1, args[0])
|
||||
|
||||
monkeypatch.setattr(subprocess, "run", always_fail)
|
||||
assert _get_npx_command() is None
|
||||
Reference in New Issue
Block a user