Spaces:
Running
Running
File size: 21,417 Bytes
7e4a5c7 ca11c0a d26a0ac ca11c0a dd7600a ca11c0a 6755eff f5b4644 ca11c0a d1d50db f5b4644 d1d50db 4ef7799 d1d50db ca11c0a dd7600a ca11c0a 6755eff ca11c0a 6755eff 798d2ed 6755eff ca11c0a 798d2ed ca11c0a 6755eff 798d2ed 6755eff ca11c0a 6755eff 798d2ed ca11c0a dd7600a 2e1c8b2 cbb550a ca11c0a 7e4a5c7 6755eff 7e4a5c7 6755eff 7e4a5c7 6755eff 7e4a5c7 6755eff 7e4a5c7 6755eff 7e4a5c7 ca11c0a 6755eff ca11c0a 6755eff ca11c0a 6755eff ca11c0a 6755eff ca11c0a 6755eff ca11c0a 6755eff ca11c0a 6755eff ca11c0a 6755eff | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 | import subprocess
from pathlib import Path
from unittest.mock import Mock, patch
import pytest
from fastmcp.cli.cli import _build_uv_command, _parse_env_var, app
class TestMainCLI:
"""Test the main CLI application."""
def test_app_exists(self):
"""Test that the main app is properly configured."""
# app.name is a tuple in cyclopts
assert "fastmcp" in app.name
assert "FastMCP 2.0" in app.help
# Just check that version exists, not the specific value
assert hasattr(app, "version")
def test_parse_env_var_valid(self):
"""Test parsing valid environment variables."""
key, value = _parse_env_var("KEY=value")
assert key == "KEY"
assert value == "value"
key, value = _parse_env_var("COMPLEX_KEY=complex=value=with=equals")
assert key == "COMPLEX_KEY"
assert value == "complex=value=with=equals"
def test_parse_env_var_invalid(self):
"""Test parsing invalid environment variables exits."""
with pytest.raises(SystemExit) as exc_info:
_parse_env_var("INVALID_FORMAT")
assert exc_info.value.code == 1
def test_build_uv_command_basic(self):
"""Test building basic uv command."""
cmd = _build_uv_command("server.py")
expected = ["uv", "run", "--with", "fastmcp", "fastmcp", "run", "server.py"]
assert cmd == expected
def test_build_uv_command_with_editable(self):
"""Test building uv command with editable package."""
editable_path = Path("/path/to/package")
cmd = _build_uv_command("server.py", with_editable=editable_path)
expected = [
"uv",
"run",
"--with",
"fastmcp",
"--with-editable",
str(editable_path),
"fastmcp",
"run",
"server.py",
]
assert cmd == expected
def test_build_uv_command_with_packages(self):
"""Test building uv command with additional packages."""
cmd = _build_uv_command("server.py", with_packages=["pkg1", "pkg2"])
expected = [
"uv",
"run",
"--with",
"fastmcp",
"--with",
"pkg1",
"--with",
"pkg2",
"fastmcp",
"run",
"server.py",
]
assert cmd == expected
def test_build_uv_command_no_banner(self):
"""Test building uv command with no banner flag."""
cmd = _build_uv_command("server.py", no_banner=True)
expected = [
"uv",
"run",
"--with",
"fastmcp",
"fastmcp",
"run",
"server.py",
"--no-banner",
]
assert cmd == expected
def test_build_uv_command_with_python_version(self):
"""Test building uv command with Python version."""
cmd = _build_uv_command("server.py", python_version="3.11")
expected = [
"uv",
"run",
"--python",
"3.11",
"--with",
"fastmcp",
"fastmcp",
"run",
"server.py",
]
assert cmd == expected
def test_build_uv_command_with_project(self):
"""Test building uv command with project directory."""
project_path = Path("/path/to/project")
cmd = _build_uv_command("server.py", project=project_path)
expected = [
"uv",
"run",
"--project",
str(project_path),
"--with",
"fastmcp",
"fastmcp",
"run",
"server.py",
]
assert cmd == expected
def test_build_uv_command_with_requirements(self):
"""Test building uv command with requirements file."""
req_path = Path("requirements.txt")
cmd = _build_uv_command("server.py", with_requirements=req_path)
expected = [
"uv",
"run",
"--with",
"fastmcp",
"--with-requirements",
"requirements.txt",
"fastmcp",
"run",
"server.py",
]
assert cmd == expected
def test_build_uv_command_with_all_options(self):
"""Test building uv command with all options."""
project_path = Path("/my/project")
editable_path = Path("/local/pkg")
requirements_path = Path("reqs.txt")
cmd = _build_uv_command(
"server.py",
python_version="3.10",
project=project_path,
with_packages=["pandas", "numpy"],
with_requirements=requirements_path,
with_editable=editable_path,
no_banner=True,
)
expected = [
"uv",
"run",
"--python",
"3.10",
"--project",
str(project_path),
"--with",
"fastmcp",
"--with-editable",
str(editable_path),
"--with",
"pandas",
"--with",
"numpy",
"--with-requirements",
str(requirements_path),
"fastmcp",
"run",
"server.py",
"--no-banner",
]
assert cmd == expected
class TestVersionCommand:
"""Test the version command."""
def test_version_command_execution(self):
"""Test that version command executes properly."""
# The version command should execute without raising SystemExit
command, bound, _ = app.parse_args(["version"])
command() # Should not raise
def test_version_command_parsing(self):
"""Test that the version command parses arguments correctly."""
command, bound, _ = app.parse_args(["version"])
assert command.__name__ == "version"
# Default arguments aren't included in bound.arguments
assert bound.arguments == {}
def test_version_command_with_copy_flag(self):
"""Test that the version command parses --copy flag correctly."""
command, bound, _ = app.parse_args(["version", "--copy"])
assert command.__name__ == "version"
assert bound.arguments == {"copy": True}
@patch("fastmcp.cli.cli.pyperclip.copy")
@patch("fastmcp.cli.cli.console")
def test_version_command_copy_functionality(
self, mock_console, mock_pyperclip_copy
):
"""Test that the version command copies to clipboard when --copy is used."""
command, bound, _ = app.parse_args(["version", "--copy"])
command(**bound.arguments)
# Verify pyperclip.copy was called with plain text format
mock_pyperclip_copy.assert_called_once()
copied_text = mock_pyperclip_copy.call_args[0][0]
# Verify the copied text contains expected version info keys in plain text
assert "FastMCP version:" in copied_text
assert "MCP version:" in copied_text
assert "Python version:" in copied_text
assert "Platform:" in copied_text
assert "FastMCP root path:" in copied_text
# Verify no ANSI escape codes (terminal control characters)
assert "\x1b[" not in copied_text
mock_console.print.assert_called_with(
"[green]✓[/green] Version information copied to clipboard"
)
class TestDevCommand:
"""Test the dev command."""
def test_dev_command_parsing(self):
"""Test that dev command can be parsed with various options."""
# Test basic parsing
command, bound, _ = app.parse_args(["dev", "server.py"])
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
# Test with options
command, bound, _ = app.parse_args(
[
"dev",
"server.py",
"--with",
"package1",
"--inspector-version",
"1.0.0",
"--ui-port",
"3000",
]
)
assert bound.arguments["with_packages"] == ["package1"]
assert bound.arguments["inspector_version"] == "1.0.0"
assert bound.arguments["ui_port"] == 3000
def test_dev_command_parsing_with_new_options(self):
"""Test dev command parsing with new uv options."""
command, bound, _ = app.parse_args(
[
"dev",
"server.py",
"--python",
"3.10",
"--project",
"/workspace",
"--with-requirements",
"dev-requirements.txt",
"--with",
"pytest",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
assert bound.arguments["python"] == "3.10"
assert bound.arguments["project"] == Path("/workspace")
assert bound.arguments["with_requirements"] == Path("dev-requirements.txt")
assert bound.arguments["with_packages"] == ["pytest"]
class TestRunCommand:
"""Test the run command."""
def test_run_command_parsing_basic(self):
"""Test basic run command parsing."""
command, bound, _ = app.parse_args(["run", "server.py"])
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
# Cyclopts only includes non-default values
assert "transport" not in bound.arguments
assert "host" not in bound.arguments
assert "port" not in bound.arguments
assert "path" not in bound.arguments
assert "log_level" not in bound.arguments
assert "no_banner" not in bound.arguments
def test_run_command_parsing_with_options(self):
"""Test run command parsing with various options."""
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--transport",
"http",
"--host",
"localhost",
"--port",
"8080",
"--path",
"/v1/mcp",
"--log-level",
"DEBUG",
"--no-banner",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
assert bound.arguments["transport"] == "http"
assert bound.arguments["host"] == "localhost"
assert bound.arguments["port"] == 8080
assert bound.arguments["path"] == "/v1/mcp"
assert bound.arguments["log_level"] == "DEBUG"
assert bound.arguments["no_banner"] is True
def test_run_command_parsing_partial_options(self):
"""Test run command parsing with only some options."""
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--transport",
"http",
"--no-banner",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
assert bound.arguments["transport"] == "http"
assert bound.arguments["no_banner"] is True
# Other options should not be present
assert "host" not in bound.arguments
assert "port" not in bound.arguments
assert "log_level" not in bound.arguments
assert "path" not in bound.arguments
def test_run_command_parsing_with_new_options(self):
"""Test run command parsing with new uv options."""
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--python",
"3.11",
"--with",
"pandas",
"--with",
"numpy",
"--project",
"/path/to/project",
"--with-requirements",
"requirements.txt",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
assert bound.arguments["python"] == "3.11"
assert bound.arguments["with_packages"] == ["pandas", "numpy"]
assert bound.arguments["project"] == Path("/path/to/project")
assert bound.arguments["with_requirements"] == Path("requirements.txt")
def test_run_command_transport_aliases(self):
"""Test that both 'http' and 'streamable-http' are accepted as valid transport options."""
# Test with 'http' transport
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--transport",
"http",
]
)
assert command is not None
assert bound.arguments["transport"] == "http"
# Test with 'streamable-http' transport
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--transport",
"streamable-http",
]
)
assert command is not None
assert bound.arguments["transport"] == "streamable-http"
def test_run_command_parsing_with_server_args(self):
"""Test run command parsing with server arguments after --."""
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--",
"--config",
"test.json",
"--debug",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
# Server args after -- are captured as positional arguments in bound.args
assert bound.args == ("server.py", "--config", "test.json", "--debug")
def test_run_command_parsing_with_mixed_args(self):
"""Test run command parsing with both FastMCP options and server args."""
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--transport",
"http",
"--port",
"8080",
"--",
"--server-port",
"9090",
"--debug",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
assert bound.arguments["transport"] == "http"
assert bound.arguments["port"] == 8080
# Server args after -- are captured separately from FastMCP options
assert bound.args == ("server.py", "--server-port", "9090", "--debug")
def test_run_command_parsing_with_positional_server_args(self):
"""Test run command parsing with positional server arguments."""
command, bound, _ = app.parse_args(
[
"run",
"server.py",
"--",
"arg1",
"arg2",
"--flag",
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
# Positional args and flags after -- are all captured
assert bound.args == ("server.py", "arg1", "arg2", "--flag")
def test_run_command_parsing_server_args_require_delimiter(self):
"""Test that server args without -- delimiter are rejected."""
# Should fail because --config is not a recognized FastMCP option
with pytest.raises(SystemExit):
app.parse_args(
[
"run",
"server.py",
"--config",
"test.json",
]
)
class TestWindowsSpecific:
"""Test Windows-specific functionality."""
@patch("subprocess.run")
def test_get_npx_command_windows_cmd(self, mock_run):
"""Test npx command detection on Windows with npx.cmd."""
from fastmcp.cli.cli import _get_npx_command
with patch("sys.platform", "win32"):
# First call succeeds with npx.cmd
mock_run.return_value = Mock(returncode=0)
result = _get_npx_command()
assert result == "npx.cmd"
mock_run.assert_called_once_with(
["npx.cmd", "--version"],
check=True,
capture_output=True,
shell=True,
)
@patch("subprocess.run")
def test_get_npx_command_windows_exe(self, mock_run):
"""Test npx command detection on Windows with npx.exe."""
from fastmcp.cli.cli import _get_npx_command
with patch("sys.platform", "win32"):
# First call fails, second succeeds
mock_run.side_effect = [
subprocess.CalledProcessError(1, "npx.cmd"),
Mock(returncode=0),
]
result = _get_npx_command()
assert result == "npx.exe"
assert mock_run.call_count == 2
@patch("subprocess.run")
def test_get_npx_command_windows_fallback(self, mock_run):
"""Test npx command detection on Windows with plain npx."""
from fastmcp.cli.cli import _get_npx_command
with patch("sys.platform", "win32"):
# First two calls fail, third succeeds
mock_run.side_effect = [
subprocess.CalledProcessError(1, "npx.cmd"),
subprocess.CalledProcessError(1, "npx.exe"),
Mock(returncode=0),
]
result = _get_npx_command()
assert result == "npx"
assert mock_run.call_count == 3
@patch("subprocess.run")
def test_get_npx_command_windows_not_found(self, mock_run):
"""Test npx command detection on Windows when npx is not found."""
from fastmcp.cli.cli import _get_npx_command
with patch("sys.platform", "win32"):
# All calls fail
mock_run.side_effect = subprocess.CalledProcessError(1, "npx")
result = _get_npx_command()
assert result is None
assert mock_run.call_count == 3
@patch("subprocess.run")
def test_get_npx_command_unix(self, mock_run):
"""Test npx command detection on Unix systems."""
from fastmcp.cli.cli import _get_npx_command
with patch("sys.platform", "darwin"):
result = _get_npx_command()
assert result == "npx"
mock_run.assert_not_called()
def test_windows_path_parsing_with_colon(self, tmp_path):
"""Test parsing Windows paths with drive letters and colons."""
from fastmcp.cli.run import parse_file_path
# Create a real test file to test the logic
test_file = tmp_path / "server.py"
test_file.write_text("# test server")
# Test normal file parsing (works on all platforms)
file_path, obj = parse_file_path(str(test_file))
assert obj is None
# Test file:object parsing
file_path, obj = parse_file_path(f"{test_file}:myapp")
assert obj == "myapp"
# Test that the file portion resolves correctly when object is specified
assert file_path == test_file.resolve()
class TestInspectCommand:
"""Test the inspect command."""
def test_inspect_command_parsing_basic(self):
"""Test basic inspect command parsing."""
command, bound, _ = app.parse_args(["inspect", "server.py"])
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
# Only explicitly set parameters are in bound.arguments
assert "output" not in bound.arguments
def test_inspect_command_parsing_with_output(self, tmp_path):
"""Test inspect command parsing with output file."""
output_file = tmp_path / "output.json"
command, bound, _ = app.parse_args(
[
"inspect",
"server.py",
"--output",
str(output_file),
]
)
assert command is not None
assert bound.arguments["server_spec"] == "server.py"
# Output is parsed as a Path object
assert bound.arguments["output"] == output_file
async def test_inspect_command_with_real_server(self, tmp_path):
"""Test inspect command with a real server file."""
# Create a real server file
server_file = tmp_path / "test_server.py"
server_file.write_text("""
import fastmcp
mcp = fastmcp.FastMCP("InspectTestServer")
@mcp.tool
def test_tool(x: int) -> int:
return x * 2
@mcp.prompt
def test_prompt(name: str) -> str:
return f"Hello, {name}!"
""")
output_file = tmp_path / "inspect_output.json"
# Parse and execute the command
command, bound, _ = app.parse_args(
[
"inspect",
str(server_file),
"--output",
str(output_file),
]
)
await command(**bound.arguments)
# Verify the output file was created and contains expected content
assert output_file.exists()
content = output_file.read_text()
# Basic checks that the inspection worked
assert "InspectTestServer" in content
assert "test_tool" in content
assert "test_prompt" in content
|