test_log_handle_encapsulation.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_linter/test_log_handle_encapsulation.py
 
"""
Purpose
-------
OI-513 regression coverage — ``LOG_HANDLE`` must not exist as a
module-level global on :mod:`oct.linter.oct_lint`. All log state lives
on :class:`LinterContext` so that concurrent linter invocations (MCP,
parallel ``--jobs``, health dashboard) never share mutable state.
 
Responsibilities
----------------
- Verify ``oct.linter.oct_lint`` exposes no ``LOG_HANDLE`` attribute.
- Verify ``log()`` writes through ``ctx.log_handle`` only.
- Verify two concurrent contexts never cross-pollute handles.
 
Diagnostics
-----------
Domain: LINTER-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- ``oct.linter.oct_lint`` exposes no ``LOG_HANDLE`` attribute.
- :func:`log` writes through ``ctx.log_handle`` only; silent when None.
- Two contexts in flight never cross-pollute handles.
"""
 
from __future__ import annotations
 
import io
import threading
from pathlib import Path
 
from oct.linter import oct_lint
from oct.linter.oct_lint import LinterContext, log
 
 
def _make_ctx(tmp_path: Path, handle) -> LinterContext:
    return LinterContext(
        project_root=tmp_path,
        project_name="demo",
        diagnostics_dir=tmp_path / "oc_diagnostics",
        tests_dir=tmp_path / "tests",
        docs_dir=tmp_path / "docs",
        log_handle=handle,
        log_lock=threading.Lock(),
    )
 
 
def test_no_module_level_log_handle():
    """OI-513: the deprecated module global is gone."""
    assert not hasattr(oct_lint, "LOG_HANDLE")
 
 
def test_log_writes_through_ctx_handle(tmp_path: Path):
    """OI-513: ``log()`` routes through ``ctx.log_handle``."""
    buf = io.StringIO()
    ctx = _make_ctx(tmp_path, buf)
    log("hello", ctx)
    assert buf.getvalue() == "hello\n"
 
 
def test_log_is_silent_without_ctx_or_handle(tmp_path: Path):
    """OI-513: ``log()`` is a no-op when ctx is None or handle is None."""
    # No ctx at all — must not raise.
    log("dropped", None)
    # ctx with no handle — still silent.
    ctx = _make_ctx(tmp_path, None)
    log("also dropped", ctx)  # no exception, nothing written.
 
 
def test_two_contexts_isolate_handles(tmp_path: Path):
    """OI-513: parallel runs do not share a global handle."""
    buf_a = io.StringIO()
    buf_b = io.StringIO()
    ctx_a = _make_ctx(tmp_path, buf_a)
    ctx_b = _make_ctx(tmp_path, buf_b)
    log("A1", ctx_a)
    log("B1", ctx_b)
    log("A2", ctx_a)
    assert buf_a.getvalue() == "A1\nA2\n"
    assert buf_b.getvalue() == "B1\n"