test_git_hooks.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_git_hooks.py
 
"""
Purpose
-------
Integration tests for ``oct git hooks`` subgroup (Phase 4D — G-D8..G-D11).
 
Responsibilities
----------------
- Verify ``oct git hooks install`` creates .pre-commit-config.yaml.
- Verify ``oct git hooks status`` reports correct hook states.
- Verify ``oct git hooks remove`` removes OCT hooks.
- Verify deprecation shim for ``oct install-hooks``.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- All tests use subprocess invocation and tmp_path fixtures.
"""
 
import json
import shutil
import subprocess
import sys
from pathlib import Path
 
import pytest
 
 
# =====================================================================
# Helpers
# =====================================================================
 
 
def _git_available() -> bool:
    return shutil.which("git") is not None
 
 
def _git(repo: Path, *args: str, check: bool = True):
    return subprocess.run(
        ["git", *args],
        cwd=repo,
        check=check,
        capture_output=True,
        text=True,
    )
 
 
def _run_hooks(root: Path, *extra_args: str) -> subprocess.CompletedProcess:
    """Run ``oct git hooks <subcmd>`` in a subprocess."""
    return subprocess.run(
        [sys.executable, "-m", "oct.cli", "git", "hooks", *extra_args],
        cwd=root,
        capture_output=True,
        text=True,
    )
 
 
def _run_install_hooks(root: Path, *extra_args: str) -> subprocess.CompletedProcess:
    """Run the deprecated ``oct install-hooks``."""
    return subprocess.run(
        [sys.executable, "-m", "oct.cli", "install-hooks", *extra_args],
        cwd=root,
        capture_output=True,
        text=True,
    )
 
 
def _make_option_c_git_project(tmp_path: Path, name: str = "hookproj") -> Path:
    """Create a git repo with Option C project structure."""
    root = tmp_path / name
    root.mkdir()
    (root / "docs").mkdir()
    (root / "tests").mkdir()
    (root / "oc_diagnostics").mkdir()
    (root / "logs").mkdir()
    (root / "src").mkdir()
    (root / "pyproject.toml").write_text(
        f'[project]\nname = "{name}"\n', encoding="utf-8",
    )
    _git(root, "init", "--quiet", "-b", "main")
    _git(root, "config", "user.email", "test@example.com")
    _git(root, "config", "user.name", "Test")
    _git(root, "config", "commit.gpgsign", "false")
    _git(root, "add", "-A")
    _git(root, "commit", "-m", "initial", "--quiet")
    return root
 
 
# =====================================================================
# Install
# =====================================================================
 
 
class TestHooksInstall:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_creates_config(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        result = _run_hooks(root, "install")
        assert result.returncode == 0
        config = root / ".pre-commit-config.yaml"
        assert config.is_file()
        content = config.read_text(encoding="utf-8")
        assert "oct-quality-gate" in content
        assert "oct-secrets-check" in content
        assert "oct-commit-msg" in content
        assert "oct-pre-push" in content
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_refuses_overwrite_without_force(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        _run_hooks(root, "install")
        result = _run_hooks(root, "install")
        assert result.returncode == 1
        assert "already exists" in result.stderr
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_force_overwrites(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        _run_hooks(root, "install")
        # Modify the file.
        config = root / ".pre-commit-config.yaml"
        config.write_text("# custom content\n", encoding="utf-8")
        result = _run_hooks(root, "install", "--force")
        assert result.returncode == 0
        content = config.read_text(encoding="utf-8")
        assert "oct-quality-gate" in content
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_yaml_content_valid(self, tmp_path):
        """Config file should have proper YAML structure."""
        root = _make_option_c_git_project(tmp_path)
        _run_hooks(root, "install")
        content = (root / ".pre-commit-config.yaml").read_text(encoding="utf-8")
        assert "repos:" in content
        assert "- repo: local" in content
        assert "hooks:" in content
 
 
# =====================================================================
# Status
# =====================================================================
 
 
class TestHooksStatus:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_all_installed(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        _run_hooks(root, "install")
        result = _run_hooks(root, "status")
        assert result.returncode == 0
        for hook_id in ("oct-quality-gate", "oct-secrets-check",
                        "oct-commit-msg", "oct-pre-push"):
            assert f"[INSTALLED]  {hook_id}" in result.stdout
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_none_installed(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        result = _run_hooks(root, "status")
        assert result.returncode == 0
        for hook_id in ("oct-quality-gate", "oct-secrets-check",
                        "oct-commit-msg", "oct-pre-push"):
            assert f"[MISSING]  {hook_id}" in result.stdout
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_partial_hooks(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        # Write a config with only some hooks.
        config = root / ".pre-commit-config.yaml"
        config.write_text(
            "repos:\n  - repo: local\n    hooks:\n"
            "      - id: oct-quality-gate\n"
            "        name: test\n"
            "        entry: echo\n"
            "        language: system\n",
            encoding="utf-8",
        )
        result = _run_hooks(root, "status")
        assert "[INSTALLED]  oct-quality-gate" in result.stdout
        assert "[MISSING]  oct-secrets-check" in result.stdout
 
 
# =====================================================================
# Remove
# =====================================================================
 
 
class TestHooksRemove:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_remove_deletes_file(self, tmp_path):
        """When only OCT hooks exist, remove deletes the file."""
        root = _make_option_c_git_project(tmp_path)
        _run_hooks(root, "install")
        result = _run_hooks(root, "remove")
        assert result.returncode == 0
        assert not (root / ".pre-commit-config.yaml").is_file()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_remove_no_file(self, tmp_path):
        """Remove when no config file exists → graceful."""
        root = _make_option_c_git_project(tmp_path)
        result = _run_hooks(root, "remove")
        assert result.returncode == 0
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_remove_preserves_non_oct_hooks(self, tmp_path):
        """Non-OCT hooks should survive removal."""
        root = _make_option_c_git_project(tmp_path)
        config = root / ".pre-commit-config.yaml"
        config.write_text(
            "repos:\n  - repo: local\n    hooks:\n"
            "      - id: custom-hook\n"
            "        name: My Custom Hook\n"
            "        entry: echo custom\n"
            "        language: system\n"
            "      - id: oct-quality-gate\n"
            "        name: Option C Quality Gate\n"
            "        entry: oct git check --staged-only\n"
            "        language: system\n",
            encoding="utf-8",
        )
        result = _run_hooks(root, "remove")
        assert result.returncode == 0
        # File should still exist with custom hook.
        assert config.is_file()
        content = config.read_text(encoding="utf-8")
        assert "custom-hook" in content
        assert "oct-quality-gate" not in content
 
 
# =====================================================================
# Deprecation shim (G-D11)
# =====================================================================
 
 
class TestDeprecationShim:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_deprecated_command_works(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        result = _run_install_hooks(root)
        assert result.returncode == 0
        assert "deprecated" in result.stderr.lower()
        # Should still create the config file.
        assert (root / ".pre-commit-config.yaml").is_file()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_deprecated_with_force(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        _run_install_hooks(root)
        result = _run_install_hooks(root, "--force")
        assert result.returncode == 0
        assert "deprecated" in result.stderr.lower()
 
 
# =====================================================================
# Audit trail
# =====================================================================
 
 
class TestAuditTrail:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_install_audit(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        result = _run_hooks(root, "install")
        assert result.returncode == 0
        audit_files = list((root / "logs").glob("oct_git_audit*.jsonl"))
        if audit_files:
            content = audit_files[-1].read_text(encoding="utf-8")
            assert "oct git hooks install" in content
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_remove_audit(self, tmp_path):
        root = _make_option_c_git_project(tmp_path)
        _run_hooks(root, "install")
        result = _run_hooks(root, "remove")
        assert result.returncode == 0
        audit_files = list((root / "logs").glob("oct_git_audit*.jsonl"))
        if audit_files:
            content = audit_files[-1].read_text(encoding="utf-8")
            assert "oct git hooks remove" in content