test_git_health.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_git_health.py
 
"""
Purpose
-------
Tests for the git health section in ``oct health`` (Phase 4E — G-E5, G-E10).
 
Responsibilities
----------------
- Validate ``check_git_health`` returns correct statuses.
- Verify graceful degradation when git is absent or not a repo.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — test details
    L4 — deep tracing
 
Contracts
---------
- Uses ``temp_git_project`` fixture for real git repo scenarios.
- Non-repo scenarios use bare tmp_path.
"""
 
import json
import shutil
from pathlib import Path
 
import pytest
 
from tests_git.conftest import _git, _git_available, commit_file
 
 
pytestmark = pytest.mark.skipif(
    not _git_available(), reason="git binary not available on PATH",
)
 
 
# =====================================================================
# TestGitHealth
# =====================================================================
 
 
class TestGitHealth:
    """Tests for check_git_health()."""
 
    def test_is_repo_ok(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        result = check_git_health(temp_git_project)
        assert result["is_repo"]["status"] == "OK"
 
    def test_not_a_repo(self, tmp_path: Path) -> None:
        from oct.health.oct_health import check_git_health
        result = check_git_health(tmp_path)
        assert result["is_repo"]["status"] == "FAIL"
        # All other checks should be SKIP.
        for key in ("branch", "naming_conformant", "clean_worktree",
                     "ahead_behind", "hooks_installed", "last_commit_conventional"):
            assert result[key]["status"] == "SKIP"
 
    def test_clean_worktree_ok(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        result = check_git_health(temp_git_project)
        assert result["clean_worktree"]["status"] == "OK"
 
    def test_dirty_worktree_warn(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        # Create an unstaged change.
        (temp_git_project / "src" / "dirty.py").write_text("# dirty\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/dirty.py")
        result = check_git_health(temp_git_project)
        assert result["clean_worktree"]["status"] == "WARN"
 
    def test_conventional_last_commit_ok(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        _git(temp_git_project, "checkout", "-b", "feature/conv")
        commit_file(temp_git_project, "src/conv.py", "# conv\n", "feat: conventional commit")
        result = check_git_health(temp_git_project)
        assert result["last_commit_conventional"]["status"] == "OK"
 
    def test_non_conventional_last_commit_warn(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        # The initial commit is "initial: project structure" which is conventional-ish
        # but type "initial" is not in COMMIT_TYPES. Let's make a non-conventional one.
        _git(temp_git_project, "checkout", "-b", "feature/nonconv")
        commit_file(temp_git_project, "src/nc.py", "# nc\n", "just a random commit")
        result = check_git_health(temp_git_project)
        assert result["last_commit_conventional"]["status"] == "WARN"
 
    def test_valid_branch_name_ok(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        _git(temp_git_project, "checkout", "-b", "feature/valid-name")
        result = check_git_health(temp_git_project)
        assert result["naming_conformant"]["status"] == "OK"
 
    def test_invalid_branch_name_warn(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        _git(temp_git_project, "checkout", "-b", "bad-name")
        result = check_git_health(temp_git_project)
        assert result["naming_conformant"]["status"] == "WARN"
 
    def test_hooks_missing_warn(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        # No .pre-commit-config.yaml by default.
        result = check_git_health(temp_git_project)
        assert result["hooks_installed"]["status"] == "WARN"
 
    def test_branch_present(self, temp_git_project: Path) -> None:
        from oct.health.oct_health import check_git_health
        result = check_git_health(temp_git_project)
        assert result["branch"]["status"] == "OK"
        assert result["branch"]["detail"] == "main"
 
    def test_run_health_includes_git(self, temp_git_project: Path) -> None:
        """Integration: run_health report includes git section."""
        from oct.health.oct_health import run_health
        import io
        import contextlib
 
        # Capture output — run_health prints to stdout.
        f = io.StringIO()
        with contextlib.redirect_stdout(f):
            run_health(temp_git_project, json_mode=True)
 
        output = f.getvalue()
        data = json.loads(output)
        assert "git" in data
        assert "is_repo" in data["git"]