test_integration.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_health/test_integration.py
 
"""
Integration tests for the health dashboard.
 
Purpose
-------
Verify end-to-end health report generation with complete projects.
 
Responsibilities
----------------
- Test terminal output format.
- Test JSON output format and schema.
- Test verbose output mode.
- Test health report with various project states.
 
Diagnostics
-----------
Domain: TESTS.HEALTH
Levels:
    L2 — test lifecycle
    L3 — full report generation
    L4 — output validation and schema verification
 
Contracts
---------
- JSON output is valid JSON with correct schema.
- Terminal output includes all sections.
- Verbose mode shows per-file breakdown.
"""
 
import json
import pytest
from pathlib import Path
 
from oct.health.oct_health import run_health, check_compat_health, check_fixable_health
from oct.linter.oct_lint import LinterContext
from tests.tests_health.conftest import make_compliant_file, make_func_pattern_violation_file
 
 
def test_health_terminal_output(temp_project_root: Path, capsys):
    """Test that terminal output includes all sections."""
    (temp_project_root / "good.py").write_text(make_compliant_file("good.py"), encoding="utf-8")
 
    run_health(temp_project_root)
 
    captured = capsys.readouterr()
    output = captured.out
 
    assert "OCT HEALTH REPORT" in output
    assert "Lint Compliance:" in output
    assert "Fixable Violations:" in output
    assert "Documentation:" in output
    assert "Tests:" in output
    assert "oc_diagnostics:" in output
 
 
def test_health_json_output(temp_project_root: Path, capsys):
    """Test that JSON output is valid and has correct schema."""
    (temp_project_root / "good.py").write_text(make_compliant_file("good.py"), encoding="utf-8")
 
    run_health(temp_project_root, json_mode=True)
 
    captured = capsys.readouterr()
    data = json.loads(captured.out)
 
    assert "project" in data
    assert "oct_version" in data
    assert "timestamp" in data
    assert "lint" in data
    assert "fixable" in data
    assert "docs" in data
    assert "tests" in data
    assert "compat" in data
 
 
def test_health_json_lint_schema(temp_project_root: Path, capsys):
    """Test that JSON lint section has correct schema."""
    (temp_project_root / "good.py").write_text(make_compliant_file("good.py"), encoding="utf-8")
 
    run_health(temp_project_root, json_mode=True)
 
    captured = capsys.readouterr()
    data = json.loads(captured.out)
 
    lint = data["lint"]
    assert "total_files" in lint
    assert "fully_compliant" in lint
    assert "compliance_pct" in lint
    assert "checks" in lint
 
 
def test_health_json_fixable_schema(temp_project_root: Path, capsys):
    """Test that JSON fixable section has correct schema."""
    (temp_project_root / "good.py").write_text(make_compliant_file("good.py"), encoding="utf-8")
 
    run_health(temp_project_root, json_mode=True)
 
    captured = capsys.readouterr()
    data = json.loads(captured.out)
 
    fixable = data["fixable"]
    assert "total" in fixable
    assert "header" in fixable
    assert "docstring" in fixable
    assert "dbg_import" in fixable
    assert "func_pattern" in fixable
 
 
def test_health_verbose_output(temp_project_root: Path, capsys):
    """Test that verbose mode shows per-file breakdown."""
    (temp_project_root / "good.py").write_text(make_compliant_file("good.py"), encoding="utf-8")
 
    run_health(temp_project_root, verbose=True)
 
    captured = capsys.readouterr()
    output = captured.out
 
    assert "OCT HEALTH REPORT" in output
 
 
def test_health_empty_project(temp_project_root: Path, capsys):
    """Test health report on empty project."""
    run_health(temp_project_root, json_mode=True)
 
    captured = capsys.readouterr()
    data = json.loads(captured.out)
 
    assert data["lint"]["total_files"] == 0
    assert data["lint"]["compliance_pct"] == 0.0
    assert data["fixable"]["total"] == 0
 
 
def test_health_test_status_no_tests_dir(temp_project_root: Path, capsys):
    """Test that missing tests/ directory is handled."""
    import shutil
    shutil.rmtree(temp_project_root / "tests")
 
    run_health(temp_project_root, json_mode=True)
 
    captured = capsys.readouterr()
    data = json.loads(captured.out)
 
    assert data["tests"]["status"] == "not_run"
 
 
def test_health_compat_check():
    """Test that compat check returns valid structure."""
    result = check_compat_health()
 
    assert "installed" in result
    assert "version" in result
    assert "compatible" in result
    assert "message" in result
    assert isinstance(result["installed"], bool)
 
 
def test_health_diagnostics_dir_fallback(temp_project_root: Path, capsys):
    """Test fallback to diagnostics/ directory."""
    import shutil
    shutil.rmtree(temp_project_root / "oc_diagnostics")
    (temp_project_root / "diagnostics").mkdir()
 
    run_health(temp_project_root, json_mode=True)
 
    captured = capsys.readouterr()
    data = json.loads(captured.out)
 
    # Should still produce a valid report
    assert "lint" in data
    assert "docs" in data
 
 
# ============================================================
# OI-413: configurable test timeout
# ============================================================
 
def test_health_test_timeout_explicit_overrides_default(temp_project_root: Path, monkeypatch):
    """Explicit test_timeout parameter is threaded through to check_test_health (OI-413)."""
    from oct.health import oct_health
 
    captured = {}
 
    def fake_check(project_root, timeout=300, **_kwargs):
        captured["timeout"] = timeout
        return {
            "status": "pass",
            "exit_code": 0,
            "summary": "0 passed",
            "details": [],
            "coverage_pct": None,
            "coverage_threshold": None,
            "coverage_blocking": False,
        }
 
    monkeypatch.setattr(oct_health, "check_test_health", fake_check)
    run_health(temp_project_root, json_mode=True, test_timeout=37)
    assert captured.get("timeout") == 37
 
 
def test_health_test_timeout_from_octrc(temp_project_root: Path, monkeypatch):
    """health.test_timeout in .octrc.json is honored when no explicit value (OI-413)."""
    from oct.health import oct_health
 
    (temp_project_root / ".octrc.json").write_text(
        json.dumps({"health": {"test_timeout": 55}}), encoding="utf-8"
    )
    captured = {}
 
    def fake_check(project_root, timeout=300, **_kwargs):
        captured["timeout"] = timeout
        return {
            "status": "pass", "exit_code": 0,
            "summary": "0 passed", "details": [],
            "coverage_pct": None, "coverage_threshold": None,
            "coverage_blocking": False,
        }
 
    monkeypatch.setattr(oct_health, "check_test_health", fake_check)
    run_health(temp_project_root, json_mode=True)
    assert captured.get("timeout") == 55
 
 
def test_health_explicit_timeout_overrides_octrc(temp_project_root: Path, monkeypatch):
    """Explicit test_timeout wins over .octrc.json health.test_timeout (OI-413)."""
    from oct.health import oct_health
 
    (temp_project_root / ".octrc.json").write_text(
        json.dumps({"health": {"test_timeout": 55}}), encoding="utf-8"
    )
    captured = {}
 
    def fake_check(project_root, timeout=300, **_kwargs):
        captured["timeout"] = timeout
        return {
            "status": "pass", "exit_code": 0,
            "summary": "0 passed", "details": [],
            "coverage_pct": None, "coverage_threshold": None,
            "coverage_blocking": False,
        }
 
    monkeypatch.setattr(oct_health, "check_test_health", fake_check)
    run_health(temp_project_root, json_mode=True, test_timeout=99)
    assert captured.get("timeout") == 99
 
 
# ============================================================
# Fixable violations verbose output
# ============================================================
 
def test_fixable_verbose_lists_violating_files(temp_project_root: Path, linter_ctx: LinterContext):
    """Verbose fixable check must list files with func_pattern violations."""
    (temp_project_root / "bad.py").write_text(
        make_func_pattern_violation_file("bad.py"), encoding="utf-8",
    )
 
    result = check_fixable_health(
        temp_project_root, linter_ctx, verbose=True,
    )
 
    assert result["func_pattern"] == 1
    assert "files" in result
    paths = [f["path"] for f in result["files"]]
    assert any("bad.py" in p for p in paths)
    # Verify the fix type is recorded
    fixes = result["files"][0]["fixes"]
    assert "func_pattern" in fixes
 
 
def test_fixable_non_verbose_omits_files_key(temp_project_root: Path, linter_ctx: LinterContext):
    """Non-verbose fixable check must not include a 'files' key (backward compat)."""
    (temp_project_root / "bad.py").write_text(
        make_func_pattern_violation_file("bad.py"), encoding="utf-8",
    )
 
    result = check_fixable_health(
        temp_project_root, linter_ctx, verbose=False,
    )
 
    assert result["func_pattern"] == 1
    assert "files" not in result
 
 
def test_fixable_verbose_no_violations_empty_files(temp_project_root: Path, linter_ctx: LinterContext):
    """Verbose fixable check with a compliant file must return empty files list."""
    (temp_project_root / "good.py").write_text(
        make_compliant_file("good.py"), encoding="utf-8",
    )
 
    result = check_fixable_health(
        temp_project_root, linter_ctx, verbose=True,
    )
 
    assert result["total"] == 0
    assert result["files"] == []