test_pre_commit_checks.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_pre_commit_checks.py
 
"""
Purpose
-------
OI-527 regression coverage — :func:`oct.git.quality_gate.pre_commit_checks`
replaces the four sequential early-return blocks that previously lived
in ``git_commit_cmd`` with a single :class:`PreCommitResult` dataclass.
These tests pin the contract: the helper surfaces the same exit codes
(3 / 4 / 1) and the same advisory messages the CLI used to emit inline.
 
Responsibilities
----------------
- Invalid commit message → ``ok=False``, ``exit_code=3``.
- ``force_commit=True`` bypasses the commit-message check.
- No staged files → ``ok=False``, ``exit_code=4``.
- Protected-branch block → ``ok=False``, ``exit_code=1`` with advisory.
- Happy path → ``ok=True``, ``staged_files`` populated, exit_code 0.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- Tests create a real git repository in ``tmp_path`` via subprocess;
  no global git state is modified.
"""
 
from __future__ import annotations
 
import subprocess
from pathlib import Path
 
from oct.git.quality_gate import PreCommitResult, pre_commit_checks
 
 
def _git(repo: Path, *args: str) -> subprocess.CompletedProcess:
    return subprocess.run(
        ["git", *args], cwd=repo, check=True, capture_output=True, text=True,
    )
 
 
def test_invalid_commit_message_yields_exit_3(temp_git_project, make_compliant_py):
    make_compliant_py("src/good.py")
    _git(temp_git_project, "add", "src/good.py")
 
    result = pre_commit_checks(
        project_root=temp_git_project,
        branch="feature/x",
        message="no type prefix",
        force_commit=False,
        profile="compact",
        octrc={"linter": {"profile": "compact"}},
    )
 
    assert isinstance(result, PreCommitResult)
    assert result.ok is False
    assert result.exit_code == 3
    assert result.errors
    assert result.staged_files == []
 
 
def test_force_commit_bypasses_message_validation(temp_git_project, make_compliant_py):
    make_compliant_py("src/good.py")
    _git(temp_git_project, "add", "src/good.py")
 
    result = pre_commit_checks(
        project_root=temp_git_project,
        branch="feature/x",
        message="still bad",
        force_commit=True,
        profile="compact",
        octrc={"linter": {"profile": "compact"}},
    )
 
    assert result.ok is True
    assert result.exit_code == 0
    assert len(result.staged_files) >= 1
 
 
def test_no_staged_files_yields_exit_4(temp_git_project):
    result = pre_commit_checks(
        project_root=temp_git_project,
        branch="feature/x",
        message="feat: add widget",
        force_commit=False,
        profile="compact",
        octrc={"linter": {"profile": "compact"}},
    )
 
    assert result.ok is False
    assert result.exit_code == 4
    assert "Nothing to commit." in result.errors
 
 
def test_protected_branch_block_yields_exit_1_with_advisory(
    temp_git_project, make_compliant_py
):
    make_compliant_py("src/good.py")
    _git(temp_git_project, "add", "src/good.py")
    octrc = {
        "linter": {"profile": "compact"},
        "git": {
            "protected_branches": ["main"],
            "branch_profile_map": {"main": "strict"},
        },
    }
 
    result = pre_commit_checks(
        project_root=temp_git_project,
        branch="main",
        message="feat: add widget",
        force_commit=False,
        profile="strict",
        octrc=octrc,
    )
 
    assert result.ok is False
    assert result.exit_code == 1
    assert result.pb_advisory != ""
    assert result.errors
 
 
def test_happy_path_returns_staged_files_and_profile(
    temp_git_project, make_compliant_py
):
    make_compliant_py("src/good.py")
    _git(temp_git_project, "add", "src/good.py")
 
    result = pre_commit_checks(
        project_root=temp_git_project,
        branch="feature/x",
        message="feat(widget): add new thing",
        force_commit=False,
        profile="compact",
        octrc={"linter": {"profile": "compact"}},
    )
 
    assert result.ok is True
    assert result.exit_code == 0
    assert result.errors == []
    assert result.effective_profile == "compact"
    assert any(p.name == "good.py" for p in result.staged_files)