test_profile_matrix_optional.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_profile_matrix_optional.py
 
"""
Purpose
-------
OI-531 regression coverage — the ``"optional"`` tier in
:data:`oct.git.policy.PROFILE_MATRIX` must be truly non-blocking:
the check runs and its failures are reported, but the CLI exit code
stays at 0 for that tier alone.
 
Before OI-531 the policy layer treated ``"optional"`` identically to
``"blocking"`` at [oct/oct/git/policy.py:381](oct/oct/git/policy.py#L381),
which meant ``oct git commit`` under the compact profile would exit 4
on any test failure. The user confirmed the intended semantics: compact
should flag test failures but let the commit through.
 
Responsibilities
----------------
- ``compact`` profile + test failures → exit code 0.
- ``strict`` profile + test failures → exit code 4 (still blocking).
- :data:`PROFILE_MATRIX` docstring documents all three tier values.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- Tests use in-memory mock objects; no subprocess or filesystem writes.
"""
 
from __future__ import annotations
 
from types import SimpleNamespace
 
from oct.git import policy
from oct.git.policy import PROFILE_MATRIX, apply_profile_policy
 
 
def _gate_result(**overrides) -> SimpleNamespace:
    defaults = dict(
        lint_violations=0,
        format_violations=0,
        secrets_findings=[],
        test_failures=0,
    )
    defaults.update(overrides)
    return SimpleNamespace(**defaults)
 
 
def test_compact_tests_optional_does_not_block_exit():
    assert PROFILE_MATRIX["compact"]["tests"] == "optional"
    result = _gate_result(test_failures=5)
 
    assert apply_profile_policy("compact", result) == 0
 
 
def test_strict_tests_blocking_still_exits_four():
    assert PROFILE_MATRIX["strict"]["tests"] == "blocking"
    result = _gate_result(test_failures=1)
 
    assert apply_profile_policy("strict", result) == 4
 
 
def test_profile_matrix_docstring_documents_three_tiers():
    # The PROFILE_MATRIX module-level docstring must spell out every
    # legal tier value so future contributors know what "optional"
    # actually means.
    src = policy.__doc__ or ""
    source_text = __import__("inspect").getsource(policy)
    for tier in ("blocking", "optional", "skip"):
        assert tier in source_text