test_integration.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_linter/test_integration.py
 
"""
Purpose
-------
Perform end-to-end integration tests of the OCT linter.
 
Responsibilities
----------------
- Run the linter via its Python API.
- Validate log file creation.
- Validate summary output.
- Validate behavior in --fix-headers mode.
- Validate machine-readable JSON output (--json mode).
 
Diagnostics
-----------
Domain: LINTER-TESTS
Levels:
    L2 — lifecycle
    L3 — semantic details
    L4 — deep tracing
 
Contracts
---------
- Must simulate a full Option C project.
- Must not depend on the developer's real environment.
- Must ensure deterministic behavior across runs.
"""
 
import io
import json
import sys
from pathlib import Path
import oct.linter.oct_lint as oct_lint
 
 
def test_linter_runs_and_creates_log(temp_project_root: Path):
    """
    Run the linter normally and ensure a log file is created.
    """
    oct_lint.run_linter(temp_project_root, argv=[])
 
    logs = list((temp_project_root / "logs").glob("oct_lint_output-*.txt"))
    assert logs, "Expected at least one log file to be created"
 
 
def test_linter_fix_headers_mode(temp_project_root: Path, linter_ctx: oct_lint.LinterContext):
    """
    Run the linter in --fix-headers mode and ensure the fix is applied.
    """
    oct_lint.run_linter(temp_project_root, argv=["--fix-headers"])
 
    # Validate that minimal_valid.py still passes after fix mode
    fixture = temp_project_root / "tests_linter" / "fixtures" / "minimal_valid.py"
    text = fixture.read_text(encoding="utf-8")
    lines = text.splitlines()
 
    ok, errors = oct_lint.validate_header_block(lines, fixture, linter_ctx)
    assert ok, f"Header block should validate after fix mode, errors: {errors}"
 
 
def test_linter_json_output(temp_project_root: Path):
    """
    Run the linter in --json mode and verify the output is valid JSON with
    the expected top-level structure.
    """
    captured = io.StringIO()
    original_stdout = sys.stdout
    sys.stdout = captured
    try:
        oct_lint.run_linter(temp_project_root, argv=["--json"])
    finally:
        sys.stdout = original_stdout
 
    output = captured.getvalue().strip()
    assert output, "Expected JSON output on stdout"
 
    data = json.loads(output)
 
    assert "project" in data
    assert "oct_version" in data
    assert "timestamp" in data
    assert "summary" in data
    assert "files" in data
 
    summary = data["summary"]
    for key in ("total_files", "fully_compliant", "pass_header", "pass_docstring",
                "pass_diagnostics_profile", "pass_dbg", "pass_func", "pass_tests"):
        assert key in summary
 
    assert isinstance(data["files"], list)
    for file_entry in data["files"]:
        assert "path" in file_entry
        assert "checks" in file_entry
        assert "compliant" in file_entry
        for key in ("header", "docstring", "diagnostics_profile", "dbg_usage", "func_pattern", "tests_exist"):
            assert key in file_entry["checks"]
            assert "pass" in file_entry["checks"][key]
            assert "message" in file_entry["checks"][key]