test_mcp_validator.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_mcp/test_mcp_validator.py
 
"""
Purpose
-------
Regression tests for :mod:`oct.mcp.validator` — Pydantic input models
and ``validate_tool_args()`` entry point.
 
Responsibilities
----------------
- Verify all 9 Pydantic tool-argument models.
- Verify path traversal rejection (T-01, T-02) and shell metacharacter
  rejection (T-04).
- Verify unknown field rejection, integer clamping, and enum allowlists.
 
Diagnostics
-----------
Domain: MCP-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- Tests are in-memory validation checks; no subprocess or filesystem
  writes.
"""
 
from __future__ import annotations
 
from pathlib import Path
 
import pytest
from pydantic import ValidationError
 
from oct.mcp.validator import (
    DiagArgs,
    DepsArgs,
    GitCheckArgs,
    GitStatusArgs,
    HealthArgs,
    LintArgs,
    OctTestArgs,
    SkeletonArgs,
    TypecheckArgs,
    check_shell_metacharacters,
    validate_path_in_project,
    validate_tool_args,
)
 
 
# -------------------------------------------------------------------
# Shell metacharacter guard
# -------------------------------------------------------------------
 
class TestCheckShellMetacharacters:
    def test_clean_string_passes(self):
        assert check_shell_metacharacters("src/module.py") == "src/module.py"
 
    def test_semicolon_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("file; rm -rf /")
 
    def test_pipe_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("file | cat /etc/passwd")
 
    def test_backtick_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("`id`")
 
    def test_dollar_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("$HOME")
 
    def test_ampersand_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("file & background")
 
    def test_angle_bracket_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("file > output")
 
    def test_single_quote_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("it's a file")
 
    def test_backslash_rejected(self):
        with pytest.raises(ValueError, match="metacharacters"):
            check_shell_metacharacters("C:\\path\\file")
 
    def test_empty_string_passes(self):
        assert check_shell_metacharacters("") == ""
 
 
# -------------------------------------------------------------------
# Path containment helper
# -------------------------------------------------------------------
 
class TestValidatePathInProject:
    def test_path_inside_project_allowed(self, tmp_path: Path):
        (tmp_path / "src").mkdir()
        validate_path_in_project("src", tmp_path)  # should not raise
 
    def test_path_traversal_rejected(self, tmp_path: Path):
        with pytest.raises(ValueError, match="outside the project root"):
            validate_path_in_project("../../../etc/passwd", tmp_path)
 
    def test_absolute_path_outside_rejected(self, tmp_path: Path):
        import sys
        if sys.platform == "win32":
            outside = "C:\\Windows\\System32"
        else:
            outside = "/etc/passwd"
        with pytest.raises(ValueError, match="outside the project root"):
            validate_path_in_project(outside, tmp_path)
 
    def test_none_project_root_skips_check(self):
        # When project_root is None, containment check is skipped.
        result = validate_path_in_project("../../../etc/passwd", None)
        assert result == "../../../etc/passwd"
 
 
# -------------------------------------------------------------------
# LintArgs
# -------------------------------------------------------------------
 
class TestLintArgs:
    def test_defaults(self):
        m = LintArgs.model_validate({})
        assert m.paths == []
        assert m.json_output is True
        assert m.jobs == 1
        assert m.changed is False
        assert m.fix_headers is False
        assert m.profile is None
 
    def test_valid_profile(self):
        m = LintArgs.model_validate({"profile": "strict"})
        assert m.profile == "strict"
 
    def test_invalid_profile_rejected(self):
        with pytest.raises(ValidationError):
            LintArgs.model_validate({"profile": "admin"})
 
    def test_jobs_out_of_range_rejected(self):
        with pytest.raises(ValidationError):
            LintArgs.model_validate({"jobs": 99})
 
    def test_jobs_min_boundary(self):
        m = LintArgs.model_validate({"jobs": 1})
        assert m.jobs == 1
 
    def test_jobs_max_boundary(self):
        m = LintArgs.model_validate({"jobs": 8})
        assert m.jobs == 8
 
    def test_unknown_field_rejected(self):
        with pytest.raises(ValidationError):
            LintArgs.model_validate({"evil_flag": True})
 
    def test_path_traversal_rejected(self, tmp_path: Path):
        with pytest.raises(ValidationError):
            LintArgs.model_validate(
                {"paths": ["../../../etc/passwd"]},
                context={"project_root": tmp_path},
            )
 
    def test_shell_metachar_in_path_rejected(self, tmp_path: Path):
        with pytest.raises(ValidationError):
            LintArgs.model_validate(
                {"paths": ["src; rm -rf /"]},
                context={"project_root": tmp_path},
            )
 
    def test_valid_path_accepted(self, tmp_path: Path):
        (tmp_path / "src").mkdir()
        m = LintArgs.model_validate(
            {"paths": ["src"]},
            context={"project_root": tmp_path},
        )
        assert m.paths == ["src"]
 
 
# -------------------------------------------------------------------
# HealthArgs
# -------------------------------------------------------------------
 
class TestHealthArgs:
    def test_defaults(self):
        m = HealthArgs.model_validate({})
        assert m.json_output is True
        assert m.verbose is False
 
    def test_unknown_field_rejected(self):
        with pytest.raises(ValidationError):
            HealthArgs.model_validate({"secret_flag": True})
 
 
# -------------------------------------------------------------------
# SkeletonArgs
# -------------------------------------------------------------------
 
class TestSkeletonArgs:
    def test_defaults(self):
        m = SkeletonArgs.model_validate({})
        assert m.json_output is True
 
    def test_output_dir_field_removed(self):
        # OI-502: ``output_dir`` was removed because the CLI does not
        # accept ``--output-dir``. The model now rejects it via
        # ``extra="forbid"``.
        with pytest.raises(ValidationError):
            SkeletonArgs.model_validate({"output_dir": "/tmp"})
 
    def test_unknown_field_rejected(self):
        with pytest.raises(ValidationError):
            SkeletonArgs.model_validate({"bad": 1})
 
 
# -------------------------------------------------------------------
# DepsArgs
# -------------------------------------------------------------------
 
class TestDepsArgs:
    def test_defaults(self):
        m = DepsArgs.model_validate({})
        assert m.json_output is True
 
    def test_check_field_removed(self):
        # OI-502: ``check`` was removed because the CLI does not accept
        # ``--check``. Pin auditing uses ``--audit-pins`` instead.
        with pytest.raises(ValidationError):
            DepsArgs.model_validate({"check": True})
 
 
# -------------------------------------------------------------------
# TestArgs
# -------------------------------------------------------------------
 
class TestOctTestArgs:
    def test_defaults(self):
        m = OctTestArgs.model_validate({})
        assert m.json_output is True
        assert m.paths == []
        assert m.changed is False
 
    def test_path_traversal_rejected(self, tmp_path: Path):
        with pytest.raises(ValidationError):
            OctTestArgs.model_validate(
                {"paths": ["../../evil"]},
                context={"project_root": tmp_path},
            )
 
 
# -------------------------------------------------------------------
# TypecheckArgs
# -------------------------------------------------------------------
 
class TestTypecheckArgs:
    def test_defaults(self):
        m = TypecheckArgs.model_validate({})
        assert m.json_output is True
        assert m.paths == []
 
 
# -------------------------------------------------------------------
# DiagArgs
# -------------------------------------------------------------------
 
class TestDiagArgs:
    def test_defaults(self):
        m = DiagArgs.model_validate({})
        assert m.subcommand == "validate-config"
 
    def test_valid_subcommands(self):
        # OI-502: Literal narrowed to subcommands the CLI actually
        # exposes (``show-config`` and ``list-checks`` were removed).
        for sub in ("validate-config", "list-domains"):
            m = DiagArgs.model_validate({"subcommand": sub})
            assert m.subcommand == sub
 
    def test_invalid_subcommand_rejected(self):
        with pytest.raises(ValidationError):
            DiagArgs.model_validate({"subcommand": "evil-command"})
 
    def test_removed_subcommand_rejected(self):
        with pytest.raises(ValidationError):
            DiagArgs.model_validate({"subcommand": "show-config"})
 
 
# -------------------------------------------------------------------
# GitStatusArgs / GitCheckArgs
# -------------------------------------------------------------------
 
class TestGitArgs:
    def test_git_status_defaults(self):
        m = GitStatusArgs.model_validate({})
        assert m.json_output is True
        assert m.verbose is False
 
    def test_git_check_defaults(self):
        m = GitCheckArgs.model_validate({})
        assert m.json_output is True
 
    def test_git_status_unknown_field_rejected(self):
        with pytest.raises(ValidationError):
            GitStatusArgs.model_validate({"inject": "malicious"})
 
 
# -------------------------------------------------------------------
# validate_tool_args() entry point
# -------------------------------------------------------------------
 
class TestValidateToolArgs:
    def test_valid_tool_name_accepted(self):
        result = validate_tool_args("oct_lint", {})
        assert isinstance(result, LintArgs)
 
    def test_unknown_tool_name_raises_value_error(self):
        with pytest.raises(ValueError, match="Unknown MCP tool"):
            validate_tool_args("evil_tool", {})
 
    def test_all_nine_tools_accepted(self):
        tools = [
            "oct_lint", "oct_health", "oct_skeleton", "oct_deps",
            "oct_test", "oct_typecheck", "oct_diag", "oct_git_status",
            "oct_git_check",
        ]
        for tool in tools:
            result = validate_tool_args(tool, {})
            assert result is not None
 
    def test_project_root_threaded_to_validator(self, tmp_path: Path):
        # Traversal attempt should be caught when project_root is provided.
        with pytest.raises(ValidationError):
            validate_tool_args(
                "oct_lint",
                {"paths": ["../../evil"]},
                project_root=tmp_path,
            )
 
    def test_t01_tool_injection_via_unknown_tool(self):
        """T-01: Unknown tool name must be rejected before any execution."""
        with pytest.raises(ValueError):
            validate_tool_args("oct_lint; rm -rf /", {})
 
    def test_t02_path_traversal_via_paths(self, tmp_path: Path):
        """T-02: ../../../ in paths field must be rejected."""
        with pytest.raises(ValidationError):
            validate_tool_args(
                "oct_lint",
                {"paths": ["../../../etc/passwd"]},
                project_root=tmp_path,
            )