test_audit_stub.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_audit/test_audit_stub.py
 
"""
Purpose
-------
FS-539 / FS-501 (stub) regression coverage — :func:`oct.audit.oct_audit.run_audit`
returns the correct stage + exit code for every ``oc_status.json`` state.
 
Responsibilities
----------------
- Verify compliant project returns stage ``"compliant"`` and exit code 0.
- Verify bootstrap / migrating / missing states return the correct stage
  and exit code.
 
Diagnostics
-----------
Domain: AUDIT-TESTS
    Levels:
        L2 — test lifecycle
        L3 — assertion details
        L4 — deep tracing
 
Contracts
---------
- All operations use ``tmp_path`` as the project root; no real project
  files are touched.
"""
 
from __future__ import annotations
 
import json
from pathlib import Path
 
from oct.audit.oct_audit import AuditResult, run_audit
from oct.core.option_c_dir import OcStatus, write_oc_status
 
 
def test_compliant_project(tmp_path: Path):
    status = OcStatus(
        stage="compliant",
        pillars={
            name: {"enabled": True, "since": "2026-04-17"}
            for name in ("linter", "diagnostics", "git", "docs", "tests", "scaffold")
        },
        migrated_from={},
        oct_version_at_migration="0.19.0",
    )
    write_oc_status(tmp_path, status)
 
    result = run_audit(tmp_path)
    assert result.stage == "compliant"
    assert result.exit_code == 0
    assert isinstance(result, AuditResult)
 
 
def test_migrating_project(tmp_path: Path):
    status = OcStatus(
        stage="migrating",
        pillars={"linter": {"enabled": True, "since": "2026-04-17"}},
        migrated_from={"octrc": ".octrc.json"},
        oct_version_at_migration="0.19.0",
    )
    write_oc_status(tmp_path, status)
 
    result = run_audit(tmp_path)
    assert result.stage == "migrating"
    assert result.exit_code == 1
    assert result.migrated_from["octrc"] == ".octrc.json"
 
 
def test_bootstrap_project(tmp_path: Path):
    status = OcStatus(
        stage="bootstrap",
        pillars={},
        migrated_from={},
        oct_version_at_migration="0.19.0",
    )
    write_oc_status(tmp_path, status)
 
    result = run_audit(tmp_path)
    assert result.stage == "bootstrap"
    assert result.exit_code == 2
 
 
def test_unmigrated_project(tmp_path: Path):
    result = run_audit(tmp_path)
    assert result.stage is None
    assert result.exit_code == 3
 
 
def test_corrupt_status_file(tmp_path: Path):
    (tmp_path / ".option_c").mkdir()
    (tmp_path / ".option_c" / "oc_status.json").write_text(
        "{ not json", encoding="utf-8",
    )
    result = run_audit(tmp_path)
    assert result.stage is None
    assert result.exit_code == 3