conftest.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_health/conftest.py
 
"""
Shared fixtures for health dashboard tests.
 
Purpose
-------
Provide reusable test fixtures for health check unit and integration tests.
 
Responsibilities
----------------
- Create temporary Option C projects with required directory structure.
- Provide LinterContext for health check functions.
- Create compliant and non-compliant test files.
 
Diagnostics
-----------
Domain: TESTS.HEALTH
Levels:
    L2 — test lifecycle and setup
    L3 — fixture creation and teardown
    L4 — file operations and structure verification
 
Contracts
---------
- temp_project_root fixture provides a clean, isolated test project.
- LinterContext is properly configured for the temporary project.
"""
 
import pytest
from pathlib import Path
 
from oct.linter.oct_lint import LinterContext
 
 
@pytest.fixture
def temp_project_root(tmp_path: Path) -> Path:
    """
    Create a temporary Option C project root with required directory structure.
 
    Returns the project root path. All required directories are created.
    """
    root = tmp_path / "test-project"
    root.mkdir()
 
    # Create required directories
    (root / "docs").mkdir()
    (root / "tests").mkdir()
    (root / "oc_diagnostics").mkdir()
    (root / "logs").mkdir()
 
    return root
 
 
@pytest.fixture
def linter_ctx(temp_project_root: Path) -> LinterContext:
    """
    Return a LinterContext configured for the temporary test project.
    """
    return LinterContext(
        project_root=temp_project_root,
        project_name=temp_project_root.name,
        diagnostics_dir=temp_project_root / "oc_diagnostics",
        tests_dir=temp_project_root / "tests",
        docs_dir=temp_project_root / "docs",
    )
 
 
def make_compliant_file(filename: str) -> str:
    """Generate a fully compliant Option C file with the given filename."""
    return (
        "#!/usr/bin/env python3\n"
        "# -*- coding: utf-8 -*-\n"
        f"# {filename}\n"
        "\n"
        '"""\n'
        "Example module.\n"
        "\n"
        "Purpose\n"
        "-------\n"
        "Demonstrate a fully compliant Option C file.\n"
        "\n"
        "Responsibilities\n"
        "----------------\n"
        "- Serve as a test fixture.\n"
        "\n"
        "Diagnostics\n"
        "-----------\n"
        "Domain: TEST\n"
        "Levels:\n"
        "    L2 -- lifecycle\n"
        "    L3 -- details\n"
        "    L4 -- tracing\n"
        "\n"
        "Contracts\n"
        "---------\n"
        "- Must be valid Python.\n"
        "\n"
        "Dependencies\n"
        "------------\n"
        "- oc_diagnostics (structured debug logger)\n"
        '"""\n'
        "\n"
        "from oc_diagnostics import _dbg\n"
        "\n"
        "\n"
        "def example():\n"
        '    func = "example"\n'
        '    _dbg("TEST", func, "start", 2)\n'
        "    return 42\n"
    )
 
 
NON_COMPLIANT_FILE = '''\
# Missing header
def broken():
    return 1
'''
 
 
def make_func_pattern_violation_file(filename: str) -> str:
    """Generate a file that is compliant except for a missing func pattern.
 
    The file has a function that calls ``_dbg()`` without first assigning
    ``func = "..."``.  The file is long enough (>= 20 lines) to avoid
    the trivial-file exemption.
    """
    return (
        "#!/usr/bin/env python3\n"
        "# -*- coding: utf-8 -*-\n"
        f"# {filename}\n"
        "\n"
        '"""\n'
        "Example module with func_pattern violation.\n"
        "\n"
        "Purpose\n"
        "-------\n"
        "Test fixture for fixable func_pattern violations.\n"
        "\n"
        "Responsibilities\n"
        "----------------\n"
        "- Serve as a test fixture.\n"
        "\n"
        "Diagnostics\n"
        "-----------\n"
        "Domain: TEST\n"
        "Levels:\n"
        "    L2 -- lifecycle\n"
        "    L3 -- details\n"
        "    L4 -- tracing\n"
        "\n"
        "Contracts\n"
        "---------\n"
        "- Must be valid Python.\n"
        "\n"
        "Dependencies\n"
        "------------\n"
        "- oc_diagnostics (structured debug logger)\n"
        '"""\n'
        "\n"
        "from oc_diagnostics import _dbg\n"
        "\n"
        "\n"
        "def missing_func_var():\n"
        '    _dbg("TEST", "missing_func_var", "start", 2)\n'
        "    return 42\n"
    )