test_git_commit_msg.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_git_commit_msg.py
 
"""
Purpose
-------
OI-503 regression tests — verify ``oct git commit-msg <file>`` exists and
validates Conventional Commit messages correctly. Without this command, every
``oct git hooks install`` produces a broken commit-msg hook (the hook template
already references this entry, but the command was missing in v0.16.0).
 
Responsibilities
----------------
- Valid Conventional Commit → exit 0.
- Invalid (no type) → exit 1 + error on stderr.
- --json on valid → exit 0 + JSON with ``"valid": true``.
- --json on invalid → exit 1 + JSON with ``"valid": false`` and errors.
- Scoped breaking-change (``feat!: ...``) is accepted.
- Missing file → Click exits 2 (argument validation).
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- The command must never raise; it must always exit with a numeric code.
"""
 
import json
import sys
import subprocess
from pathlib import Path
 
import pytest
from click.testing import CliRunner
 
from oct.git.oct_git import git_commit_msg_cmd
 
 
def _run(tmp_path: Path, message: str, *extra: str):
    msg_file = tmp_path / "COMMIT_EDITMSG"
    msg_file.write_text(message, encoding="utf-8")
    runner = CliRunner()
    return runner.invoke(
        git_commit_msg_cmd, [str(msg_file), *extra], catch_exceptions=False
    )
 
 
def test_valid_conventional_commit_exits_0(tmp_path: Path):
    result = _run(tmp_path, "feat(core): add widget\n")
    assert result.exit_code == 0
    assert "OK" in result.output
 
 
def test_invalid_commit_no_type_exits_1(tmp_path: Path):
    result = _run(tmp_path, "broken commit without a type\n")
    assert result.exit_code == 1
    # Error message rendered in combined output.
    assert (
        "Conventional Commits" in result.output
        or "validation" in result.output.lower()
    )
 
 
def test_valid_with_json_emits_valid_true(tmp_path: Path):
    result = _run(tmp_path, "fix(git): redact tokens\n", "--json")
    assert result.exit_code == 0
    data = json.loads(result.output)
    assert data["valid"] is True
    assert data["errors"] == []
 
 
def test_invalid_with_json_emits_valid_false(tmp_path: Path):
    result = _run(tmp_path, "no type here\n", "--json")
    assert result.exit_code == 1
    data = json.loads(result.output)
    assert data["valid"] is False
    assert len(data["errors"]) >= 1
 
 
def test_breaking_change_marker_accepted(tmp_path: Path):
    result = _run(tmp_path, "feat!: drop legacy flag\n")
    assert result.exit_code == 0
 
 
def test_missing_file_exits_nonzero(tmp_path: Path):
    # Click's type=Path(exists=True) should reject a missing file via usage error.
    runner = CliRunner()
    missing = tmp_path / "does_not_exist"
    result = runner.invoke(
        git_commit_msg_cmd, [str(missing)], catch_exceptions=False
    )
    assert result.exit_code != 0
 
 
def test_subprocess_roundtrip(tmp_path: Path):
    """Smoke test via ``python -m oct.cli git commit-msg`` as pre-commit would run it."""
    msg_file = tmp_path / "COMMIT_EDITMSG"
    msg_file.write_text("feat: end-to-end test\n", encoding="utf-8")
    proc = subprocess.run(
        [sys.executable, "-m", "oct.cli", "git", "commit-msg", str(msg_file)],
        capture_output=True,
        text=True,
    )
    assert proc.returncode == 0, proc.stderr