conftest.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_linter/conftest.py
 
 
"""
Purpose
-------
Provide pytest fixtures for the OCT linter test suite.
 
Responsibilities
----------------
- Create a temporary, isolated Option C project root.
- Populate the required Option C project structure.
- Copy fixture files into the temporary project.
- Provide a ``LinterContext`` fixture for unit tests that call linter
  functions directly, without triggering ``run_linter()``.
- Ensure each test runs in a clean, deterministic environment.
 
Diagnostics
-----------
Domain: LINTER-TESTS
Levels:
    L2 — lifecycle
    L3 — semantic details
    L4 — deep tracing
 
Contracts
---------
- Must not import or modify the developer's real project.
- Must not modify fixture files.
- Must ensure deterministic test environments.
"""
 
from pathlib import Path
import shutil
import pytest
from oct.linter import oct_lint
 
 
@pytest.fixture
def temp_project_root(tmp_path: Path) -> Path:
    """
    Create a temporary Option C project root with:
    - docs/
    - tests/
    - oc_diagnostics/
    - logs/
    - tests_linter/fixtures copied in
    """
    root = tmp_path / "test-project"
    root.mkdir()
 
    # Required Option C directories
    (root / "docs").mkdir()
    (root / "tests").mkdir()
    (root / "oc_diagnostics").mkdir()
    (root / "logs").mkdir()
    (root / "tests_linter").mkdir()
    (root / "tests_linter" / "fixtures").mkdir(parents=True)
 
    # Required Option C project-level files
    (root / "docs" / "ARCHITECTURE.md").write_text("# Architecture\n", encoding="utf-8")
    (root / "tests" / "run_tests.py").write_text("print('tests')\n", encoding="utf-8")
    (root / "tests" / "Tests_README.md").write_text("Tests\n", encoding="utf-8")
    (root / "oc_diagnostics" / "debug_config.json").write_text(
        '{\n'
        '  "domains": {\n'
        '    "GENERAL": {\n'
        '      "level": 2,\n'
        '      "color": "default"\n'
        '    }\n'
        '  },\n'
        '  "global_settings": {\n'
        '    "silent_mode": false,\n'
        '    "enable_timestamps": true,\n'
        '    "enable_colors": true,\n'
        '    "include_filename": true,\n'
        '    "output_mode": "both",\n'
        '    "instrumentation_enabled": false,\n'
        '    "max_log_files": 10,\n'
        '    "max_log_size_mb": 5.0,\n'
        '    "instrumentation_allow_all": false,\n'
        '    "mode": "dev",\n'
        '    "http_redact_headers": [\n'
        '      "authorization",\n'
        '      "cookie",\n'
        '      "set-cookie",\n'
        '      "x-api-key"\n'
        '    ]\n'
        '  }\n'
        '}\n',
        encoding="utf-8"
    )
 
    # Copy fixtures from the real project
    project_root = Path.cwd()
    fixtures_src = project_root / "tests" / "tests_linter" / "fixtures"
    fixtures_dst = root / "tests_linter" / "fixtures"
 
    for f in fixtures_src.glob("*.py"):
        dst = fixtures_dst / f.name
        shutil.copy2(f, dst)
        # Rewrite line 3 (file-identity comment) to match the temp project path
        rel = dst.relative_to(root).as_posix()
        lines = dst.read_text(encoding="utf-8").splitlines(True)
        if len(lines) >= 3 and lines[2].startswith("# "):
            lines[2] = f"# {rel}\n"
            dst.write_text("".join(lines), encoding="utf-8")
 
    yield root
 
 
@pytest.fixture
def linter_ctx(temp_project_root: Path) -> oct_lint.LinterContext:
    """
    Return a ``LinterContext`` for the temporary project root.
 
    Use this fixture in unit tests that call linter check functions
    (``validate_header_block``, ``fix_header_block``, ``check_tests_exist``)
    directly, rather than going through ``run_linter()``.
    """
    root = temp_project_root
    _oc_diag = root / "oc_diagnostics"
    return oct_lint.LinterContext(
        project_root=root,
        project_name=root.name,
        diagnostics_dir=_oc_diag if _oc_diag.exists() else root / "diagnostics",
        tests_dir=root / "tests",
        docs_dir=root / "docs",
    )