import asyncio import logging import secrets import socket import sys from collections.abc import Callable, Generator from pathlib import Path from typing import Any import pytest from mcp_types import SERVER_INFO_META_KEY from opentelemetry import trace from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import SimpleSpanProcessor from opentelemetry.sdk.trace.export.in_memory_span_exporter import InMemorySpanExporter from fastmcp.server.auth.providers.jwt import RSAKeyPair from fastmcp.utilities.tests import temporary_settings from tests.utilities.httpx2_mock import httpx_mock as httpx_mock # Use SelectorEventLoop on Windows to avoid ProactorEventLoop crashes # See: https://github.com/python/cpython/issues/116773 if sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) def user_meta(meta: dict[str, Any] | None) -> dict[str, Any] | None: """Strip the SDK's `serverInfo` stamp from a result's `_meta`. Every 2026-era result carries `io.modelcontextprotocol/serverInfo` (spec #3002), stamped by the SDK runner rather than by the component that produced the result. Tests asserting on the meta a tool or resource set itself use this to ignore the stamp, and get `None` back when the stamp was the only entry. """ if meta is None: return None remaining = {k: v for k, v in meta.items() if k != SERVER_INFO_META_KEY} return remaining or None def make_server_request_context( *, method: str = "tools/list", params: dict[str, Any] | None = None, ) -> Any: """Build a minimal SDK ServerRequestContext for direct handler unit tests. The v2 SDK hands handlers a ``ServerRequestContext`` argument. Tests that invoke FastMCP's ``_on_*`` handlers directly (without a live session) use this to construct a stand-in context that ``bind_request_context`` accepts. """ from unittest.mock import MagicMock from mcp.server.context import ServerRequestContext return ServerRequestContext( session=MagicMock(), lifespan_context={}, protocol_version="2025-06-18", method=method, params=params, request_id=0, meta=None, request=None, ) def pytest_collection_modifyitems(items): """Automatically mark tests in integration_tests folder with 'integration' marker.""" for item in items: # Check if the test is in the integration_tests folder if "integration_tests" in str(item.fspath): item.add_marker(pytest.mark.integration) @pytest.fixture(autouse=True) def import_rich_rule(): # What a hack import rich.rule # noqa: F401 yield @pytest.fixture(autouse=True) def enable_fastmcp_logger_propagation(caplog): """Enable propagation on FastMCP root logger so caplog captures FastMCP log messages. FastMCP loggers have propagate=False by default, which prevents messages from reaching pytest's caplog handler (attached to root logger). This fixture temporarily enables propagation on the FastMCP root logger so FastMCP logs are captured in tests. """ root_logger = logging.getLogger("fastmcp") original_propagate = root_logger.propagate root_logger.propagate = True yield root_logger.propagate = original_propagate @pytest.fixture(scope="session") def _settings_home_root(tmp_path_factory: pytest.TempPathFactory) -> Path: """Session-scoped (i.e. per xdist-worker) base directory for isolated settings.home directories. Created once via ``tmp_path_factory`` so ``isolate_settings_home`` can carve out a per-test subdirectory with a plain, cheap ``mkdir`` instead of requesting a fresh ``tmp_path`` (which every test would otherwise pay for, autouse) on every single test. """ return tmp_path_factory.mktemp("fastmcp-test-home") @pytest.fixture(autouse=True) def isolate_settings_home(_settings_home_root: Path): """Ensure each test uses an isolated settings.home directory. This prevents file locking issues when multiple tests share the same storage directory in settings.home / "oauth-proxy". That collision is not hypothetical: most oauth-proxy tests construct their proxy with the same hardcoded jwt_signing_key ("test-secret"), and the storage directory's name is a fingerprint derived from that key -- so any two tests reusing it resolve to the *same* subdirectory. Reusing a single settings.home across the whole session/worker would let one test's persisted client/token state leak into the next, even though the tests run sequentially within a worker. A fresh subdirectory per test avoids that leakage while a session-scoped root avoids paying tmp_path's per-test overhead (numbering, test-id sanitization, retention-policy bookkeeping) for the ~99% of tests that never touch this directory. Docket settings moved to the fastmcp-tasks package, so they are no longer overridden here. """ test_home = _settings_home_root / secrets.token_hex(8) test_home.mkdir() with temporary_settings( home=test_home, client_disconnect_timeout=1, ): yield def get_fn_name(fn: Callable[..., Any]) -> str: return fn.__name__ # ty: ignore[unresolved-attribute] @pytest.fixture(scope="session") def rsa_key_pair() -> RSAKeyPair: """A shared RSA key pair for tests that just need *some* valid key material. RSA key generation costs tens of milliseconds; hundreds of auth tests generating a fresh key per test adds up to real wall time for no benefit, since almost none of them care that the key is unique. Tests that must prove verification fails against a *different* key should use ``rsa_key_pair_2`` instead of calling ``RSAKeyPair.generate()`` directly. Tests that specifically exercise key generation or rotation should still call ``RSAKeyPair.generate()`` themselves. """ return RSAKeyPair.generate() @pytest.fixture(scope="session") def rsa_key_pair_2() -> RSAKeyPair: """A second shared RSA key pair, distinct from ``rsa_key_pair``. For tests that sign a token with the "wrong" key to prove verification against ``rsa_key_pair`` fails. """ return RSAKeyPair.generate() @pytest.fixture def worker_id(request): """Get the xdist worker ID, or 'master' if not using xdist.""" return getattr(request.config, "workerinput", {}).get("workerid", "master") @pytest.fixture def free_port(): """Get a free port for the test to use.""" with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: s.bind(("127.0.0.1", 0)) s.listen(1) port = s.getsockname()[1] return port @pytest.fixture def free_port_factory(worker_id): """Factory to get free ports that tracks used ports per test session.""" used_ports = set() def get_port(): while True: with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: s.bind(("127.0.0.1", 0)) s.listen(1) port = s.getsockname()[1] if port not in used_ports: used_ports.add(port) return port return get_port @pytest.fixture(scope="session") def otel_trace_provider() -> Generator[ tuple[TracerProvider, InMemorySpanExporter], None, None ]: """Configure OTEL SDK with in-memory span exporter for testing. Session-scoped because TracerProvider can only be set once per process. """ exporter = InMemorySpanExporter() provider = TracerProvider() provider.add_span_processor(SimpleSpanProcessor(exporter)) trace.set_tracer_provider(provider) yield provider, exporter @pytest.fixture def trace_exporter( otel_trace_provider: tuple[TracerProvider, InMemorySpanExporter], ) -> Generator[InMemorySpanExporter, None, None]: """Get the span exporter and clear it between tests.""" _, exporter = otel_trace_provider exporter.clear() yield exporter exporter.clear() @pytest.fixture def fastmcp_server(): """Fixture that creates a FastMCP server with tools, resources, and prompts.""" import asyncio import json from fastmcp import FastMCP server = FastMCP("TestServer") # Add a tool @server.tool def greet(name: str) -> str: """Greet someone by name.""" return f"Hello, {name}!" # Add a second tool @server.tool def add(a: int, b: int) -> int: """Add two numbers together.""" return a + b @server.tool async def sleep(seconds: float) -> str: """Sleep for a given number of seconds.""" await asyncio.sleep(seconds) return f"Slept for {seconds} seconds" # Add a resource (return JSON string for proper typing) @server.resource(uri="data://users") async def get_users() -> str: return json.dumps(["Alice", "Bob", "Charlie"], separators=(",", ":")) # Add a resource template (return JSON string for proper typing) @server.resource(uri="data://user/{user_id}") async def get_user(user_id: str) -> str: return json.dumps( {"id": user_id, "name": f"User {user_id}", "active": True}, separators=(",", ":"), ) # Add a prompt @server.prompt def welcome(name: str) -> str: """Example greeting prompt.""" return f"Welcome to FastMCP, {name}!" return server @pytest.fixture def tool_server(): """Fixture that creates a FastMCP server with comprehensive tool set for provider tests.""" import base64 from mcp_types import ( BlobResourceContents, EmbeddedResource, ImageContent, TextContent, ) from fastmcp import FastMCP from fastmcp.utilities.types import Audio, File, Image mcp = FastMCP() @mcp.tool def add(x: int, y: int) -> int: return x + y @mcp.tool def list_tool() -> list[str | int]: return ["x", 2] @mcp.tool def error_tool() -> None: raise ValueError("Test error") @mcp.tool def image_tool(path: str) -> Image: return Image(path) @mcp.tool def audio_tool(path: str) -> Audio: return Audio(path) @mcp.tool def file_tool(path: str) -> File: return File(path) @mcp.tool def mixed_content_tool() -> list[TextContent | ImageContent | EmbeddedResource]: return [ TextContent(type="text", text="Hello"), ImageContent( type="image", data="abc", mime_type="application/octet-stream" ), EmbeddedResource( type="resource", resource=BlobResourceContents( blob=base64.b64encode(b"abc").decode(), mime_type="application/octet-stream", uri="file:///test.bin", ), ), ] @mcp.tool(output_schema=None) def mixed_list_fn(image_path: str) -> list: return [ "text message", Image(image_path), {"key": "value"}, TextContent(type="text", text="direct content"), ] @mcp.tool(output_schema=None) def mixed_audio_list_fn(audio_path: str) -> list: return [ "text message", Audio(audio_path), {"key": "value"}, TextContent(type="text", text="direct content"), ] @mcp.tool(output_schema=None) def mixed_file_list_fn(file_path: str) -> list: return [ "text message", File(file_path), {"key": "value"}, TextContent(type="text", text="direct content"), ] @mcp.tool def file_text_tool() -> File: return File(data=b"hello world", format="plain") return mcp @pytest.fixture def tagged_resources_server(): """Fixture that creates a FastMCP server with tagged resources and templates.""" import json from fastmcp import FastMCP server = FastMCP("TaggedResourcesServer") # Add a resource with tags @server.resource( uri="data://tagged", tags={"test", "metadata"}, description="A tagged resource" ) async def get_tagged_data() -> str: return json.dumps({"type": "tagged_data"}, separators=(",", ":")) # Add a resource template with tags @server.resource( uri="template://{id}", tags={"template", "parameterized"}, description="A tagged template", ) async def get_template_data(id: str) -> str: return json.dumps({"id": id, "type": "template_data"}, separators=(",", ":")) return server