test_venv_warning.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_health/test_venv_warning.py
 
"""
Purpose
-------
FS-504 regression coverage — ``oct health`` must surface a prominent
top-of-report banner when the operator runs the dashboard from outside
a virtual environment. The banner is what upgrades "naked Python" from
an easily-missed per-section ``[WARN]`` into something the operator
cannot overlook before reading the rest of the report.
 
The banner uses ``!`` as the rule character (70 columns) and carries
the literal string "WARNING: not running inside a virtual environment.".
 
Diagnostics
-----------
Domain: HEALTH-TESTS
Levels:
    L2 — test lifecycle
 
Contracts
---------
- ``venv.active == False`` → banner rendered.
- ``venv.active == True``  → banner absent (per-section [OK] still there).
- Banner never appears in JSON output (machine-readable path unchanged).
"""
 
from __future__ import annotations
 
import io
import json
from contextlib import redirect_stdout
 
import pytest
 
from oct.health.oct_health import _print_json_report, _print_terminal_report
 
 
_BANNER_TEXT = "WARNING: not running inside a virtual environment."
 
 
def _minimal_report(*, venv_active: bool) -> dict:
    """Smallest ``report`` dict that satisfies ``_print_terminal_report``."""
    return {
        "project": "demo",
        "oct_version": "0.17.0",
        "timestamp": "2026-04-16T00:00:00",
        "excluded_dirs": [],
        "disabled_rules": [],
        "lint": {
            "total_files": 0,
            "fully_compliant": 0,
            "compliance_pct": 100.0,
            "checks": {},
            "files": [],
        },
        "fixable": {"total": 0},
        "docs": {"total_present": 0, "total_required": 0, "files": []},
        "tests": {"status": "skip", "summary": ""},
        "compat": {
            "installed": True, "compatible": True, "version": "0.0.0", "message": "",
        },
        "venv": {
            "active": venv_active,
            "venv_found": venv_active,
            "own_venv": venv_active,
            "status": "OK" if venv_active else "WARN",
            "message": "Project .venv active" if venv_active else "No venv active.",
            "venv_path": None,
        },
        "git": None,
    }
 
 
def _render(report: dict) -> str:
    buf = io.StringIO()
    with redirect_stdout(buf):
        _print_terminal_report(report, verbose=False)
    return buf.getvalue()
 
 
def test_banner_renders_when_venv_inactive():
    """FS-504: banner appears once and lands above the per-section summary."""
    out = _render(_minimal_report(venv_active=False))
    assert _BANNER_TEXT in out
    banner_pos = out.index(_BANNER_TEXT)
    # Banner precedes the per-section "Virtual Env:" line.
    assert banner_pos < out.index("Virtual Env:")
    # Exactly one banner occurrence.
    assert out.count(_BANNER_TEXT) == 1
 
 
def test_banner_absent_when_venv_active():
    """FS-504: active venv → no banner; [OK] status still visible."""
    out = _render(_minimal_report(venv_active=True))
    assert _BANNER_TEXT not in out
    assert "Virtual Env:" in out
    assert "[OK]" in out
 
 
def test_banner_absent_in_json_output(capsys: pytest.CaptureFixture):
    """FS-504: JSON output is machine-readable — never gains a banner."""
    _print_json_report(_minimal_report(venv_active=False))
    captured = capsys.readouterr().out
    parsed = json.loads(captured)
    assert parsed["venv"]["active"] is False
    assert _BANNER_TEXT not in captured
 
 
def test_banner_copy_instructs_venv_creation():
    """FS-504: banner body mentions the exact ``python -m venv .venv`` remedy."""
    out = _render(_minimal_report(venv_active=False))
    assert "python -m venv .venv" in out