conftest.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_mcp/conftest.py
 
"""
Purpose
-------
Shared fixtures for the oct-mcp test suite.
 
Responsibilities
----------------
- Provide ``tmp_project_root`` with minimal project skeleton.
- Provide pre-configured instances of ``McpConfig``, ``McpPolicy``,
  ``SafetyGate``, ``Redactor``, ``McpMetrics``, ``McpAuditLogger``,
  ``SandboxExecutor``, ``ToolExecutor``, and ``ServerState``.
 
Diagnostics
-----------
Domain: MCP-TESTS
L2: fixture lifecycle
L3: fixture details
L4: deep tracing
 
Contracts
---------
- All project roots use ``tmp_path``; no real project files are touched.
"""
 
from __future__ import annotations
 
import json
from pathlib import Path
from unittest.mock import MagicMock, patch
 
import pytest
 
from oct.mcp.audit import McpAuditLogger
from oct.mcp.config import McpConfig
from oct.mcp.executor import ToolExecutor
from oct.mcp.metrics import McpMetrics
from oct.mcp.policy import McpPolicy
from oct.mcp.redactor import Redactor
from oct.mcp.safety import SafetyGate
from oct.mcp.sandbox import SandboxExecutor, SandboxResult
from oct.mcp.server import RateLimiter, ServerState
 
 
@pytest.fixture
def tmp_project_root(tmp_path: Path) -> Path:
    """A minimal Option C project root in a temp directory."""
    (tmp_path / "pyproject.toml").write_text(
        '[project]\nname = "test"\nversion = "0.1.0"\n'
    )
    (tmp_path / ".octrc.json").write_text('{"profile": "default"}')
    return tmp_path
 
 
@pytest.fixture
def default_config() -> McpConfig:
    """A default McpConfig with safe defaults."""
    return McpConfig()
 
 
@pytest.fixture
def mock_sandbox() -> MagicMock:
    """A mock SandboxExecutor that returns a success result."""
    sandbox = MagicMock(spec=SandboxExecutor)
    sandbox.run.return_value = SandboxResult(
        exit_code=0,
        stdout='{"tool": "lint", "violations": [], "exit_code": 0}',
        stderr="",
    )
    return sandbox
 
 
@pytest.fixture
def mock_executor(mock_sandbox: MagicMock) -> ToolExecutor:
    """A ToolExecutor backed by the mock sandbox."""
    return ToolExecutor(sandbox=mock_sandbox)
 
 
@pytest.fixture
def default_redactor() -> Redactor:
    """A Redactor with no custom patterns."""
    return Redactor()
 
 
@pytest.fixture
def mcp_audit_logger(tmp_path: Path) -> McpAuditLogger:
    """An McpAuditLogger writing to a temp directory."""
    return McpAuditLogger(audit_log_path=tmp_path / "audit.log")
 
 
@pytest.fixture
def default_policy() -> McpPolicy:
    """A McpPolicy in 'default' profile with safe_mode=False."""
    return McpPolicy(profile="default", safe_mode=False)
 
 
@pytest.fixture
def isolated_metrics() -> McpMetrics:
    """An :class:`McpMetrics` backed by a private ``CollectorRegistry``.
 
    Prevents ``Duplicated timeseries in CollectorRegistry`` collisions
    when multiple tests instantiate ``McpMetrics`` in the same process
    and ``prometheus_client`` is installed. When ``prometheus_client`` is
    absent, returns the default no-op stub (the ``registry`` argument is
    inert in that case).
    """
    from oct.mcp.metrics import PROMETHEUS_AVAILABLE
    if not PROMETHEUS_AVAILABLE:
        return McpMetrics()
    from prometheus_client import CollectorRegistry
    return McpMetrics(registry=CollectorRegistry())
 
 
@pytest.fixture
def server_state(
    tmp_project_root: Path,
    default_config: McpConfig,
    default_policy: McpPolicy,
    mock_executor: ToolExecutor,
    default_redactor: Redactor,
    mcp_audit_logger: McpAuditLogger,
    isolated_metrics: McpMetrics,
) -> ServerState:
    """A fully wired ServerState for integration tests."""
    return ServerState(
        project_root=tmp_project_root,
        config=default_config,
        policy=default_policy,
        executor=mock_executor,
        redactor=default_redactor,
        audit_logger=mcp_audit_logger,
        rate_limiter=RateLimiter(limit_per_minute=30),
        safety=SafetyGate(default_config),
        metrics=isolated_metrics,
        session_id="test-session-id",
    )