test_git_status.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_git_status.py
 
"""
Purpose
-------
Integration tests for ``oct git status`` (Phase 4B / G-B2).
Validates terminal output, ``--json`` schema, ``--no-check`` mode,
and edge cases (detached HEAD, no remote, clean repo).
 
Responsibilities
----------------
- Verify ``[OK]`` / ``[!!]`` / ``---`` badge rendering for staged,
  modified, and untracked files.
- Verify ``--json`` output is valid JSON with the expected schema.
- Verify ``--no-check`` suppresses compliance annotations.
- Verify clean repo produces empty sections.
- Verify detached HEAD and no-remote edge cases.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- Every test uses the ``temp_git_project`` fixture (real git repo).
- Tests never modify the system git config.
"""
 
import json
import subprocess
from pathlib import Path
 
import pytest
 
from tests.tests_git.conftest import _git, commit_file
 
 
# =====================================================================
# Helpers
# =====================================================================
 
 
def _run_status(root: Path, *extra_args: str) -> subprocess.CompletedProcess:
    """Run ``oct git status`` in a subprocess and return the result."""
    import sys
    return subprocess.run(
        [sys.executable, "-m", "oct.cli", "git", "status", *extra_args],
        cwd=root,
        capture_output=True,
        text=True,
    )
 
 
# =====================================================================
# Tests: Clean repo
# =====================================================================
 
 
class TestCleanRepo:
    def test_clean_repo_shows_branch(self, temp_git_project):
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        assert "On branch main" in result.stdout
 
    def test_clean_repo_no_files(self, temp_git_project):
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        # No staged/modified/untracked sections should have files.
        assert "Staged" not in result.stdout
        assert "Modified" not in result.stdout
 
    def test_clean_repo_json(self, temp_git_project):
        result = _run_status(temp_git_project, "--json")
        assert result.returncode == 0
        data = json.loads(result.stdout)
        assert data["branch"] == "main"
        assert data["staged"] == []
        assert data["modified"] == []
        assert data["untracked"] == []
 
 
# =====================================================================
# Tests: Badges
# =====================================================================
 
 
class TestBadges:
    def test_staged_compliant_py_shows_ok(
        self, temp_git_project, make_compliant_py
    ):
        path = make_compliant_py("src/good.py")
        _git(temp_git_project, "add", "src/good.py")
 
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        assert "[OK]" in result.stdout
        assert "src/good.py" in result.stdout
 
    def test_staged_noncompliant_py_shows_violation(
        self, temp_git_project, make_noncompliant_py
    ):
        make_noncompliant_py("src/bad.py", "missing_header")
        _git(temp_git_project, "add", "src/bad.py")
 
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        assert "[!!]" in result.stdout
        assert "src/bad.py" in result.stdout
 
    def test_staged_non_python_shows_dash(self, temp_git_project):
        readme = temp_git_project / "src" / "notes.txt"
        readme.write_text("hello", encoding="utf-8")
        _git(temp_git_project, "add", "src/notes.txt")
 
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        assert "---" in result.stdout
        assert "notes.txt" in result.stdout
 
    def test_modified_file_shows_badge(
        self, temp_git_project, make_compliant_py
    ):
        # Commit a file first, then modify it (unstaged).
        path = make_compliant_py("src/modme.py")
        commit_file(
            temp_git_project, "src/modme.py",
            path.read_text(encoding="utf-8"), "add modme",
        )
        path.write_text(
            path.read_text(encoding="utf-8") + "\n# modified\n",
            encoding="utf-8",
        )
 
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        assert "Modified" in result.stdout
        assert "modme.py" in result.stdout
 
 
# =====================================================================
# Tests: --no-check
# =====================================================================
 
 
class TestNoCheck:
    def test_no_check_suppresses_badges(
        self, temp_git_project, make_noncompliant_py
    ):
        make_noncompliant_py("src/bad.py", "missing_header")
        _git(temp_git_project, "add", "src/bad.py")
 
        result = _run_status(temp_git_project, "--no-check")
        assert result.returncode == 0
        assert "[!!]" not in result.stdout
        assert "[OK]" not in result.stdout
        assert "bad.py" in result.stdout
 
 
# =====================================================================
# Tests: --json
# =====================================================================
 
 
class TestJsonOutput:
    def test_json_schema(self, temp_git_project, make_compliant_py):
        make_compliant_py("src/a.py")
        _git(temp_git_project, "add", "src/a.py")
 
        result = _run_status(temp_git_project, "--json")
        assert result.returncode == 0
        data = json.loads(result.stdout)
 
        # Required top-level keys.
        for key in ("branch", "detached", "ahead", "behind",
                    "staged", "modified", "untracked"):
            assert key in data, f"missing key: {key}"
 
        # Staged entry schema.
        assert len(data["staged"]) == 1
        entry = data["staged"][0]
        assert "path" in entry
        assert "status" in entry
        assert "issues" in entry
        assert entry["status"] in ("ok", "violations", "non_python", "unchecked")
 
    def test_json_violation_includes_issues(
        self, temp_git_project, make_noncompliant_py
    ):
        make_noncompliant_py("src/bad.py", "missing_header")
        _git(temp_git_project, "add", "src/bad.py")
 
        result = _run_status(temp_git_project, "--json")
        data = json.loads(result.stdout)
        entry = data["staged"][0]
        assert entry["status"] == "violations"
        assert len(entry["issues"]) > 0
 
    def test_json_no_check(self, temp_git_project, make_compliant_py):
        make_compliant_py("src/a.py")
        _git(temp_git_project, "add", "src/a.py")
 
        result = _run_status(temp_git_project, "--json", "--no-check")
        data = json.loads(result.stdout)
        entry = data["staged"][0]
        assert entry["status"] == "unchecked"
 
 
# =====================================================================
# Tests: Edge cases
# =====================================================================
 
 
class TestEdgeCases:
    def test_detached_head(self, temp_git_project):
        sha = _git(temp_git_project, "rev-parse", "HEAD").stdout.strip()
        _git(temp_git_project, "checkout", "--detach", sha)
 
        result = _run_status(temp_git_project)
        assert result.returncode == 0
        assert "HEAD detached" in result.stdout
 
    def test_detached_head_json(self, temp_git_project):
        sha = _git(temp_git_project, "rev-parse", "HEAD").stdout.strip()
        _git(temp_git_project, "checkout", "--detach", sha)
 
        result = _run_status(temp_git_project, "--json")
        data = json.loads(result.stdout)
        assert data["detached"] is True
        assert data["branch"] is None
 
    def test_no_remote_ahead_behind_zero(self, temp_git_project):
        # No remote configured — ahead/behind should be 0/0.
        result = _run_status(temp_git_project, "--json")
        data = json.loads(result.stdout)
        assert data["ahead"] == 0
        assert data["behind"] == 0
 
    def test_untracked_file_appears(self, temp_git_project):
        (temp_git_project / "stray.txt").write_text("x", encoding="utf-8")
 
        result = _run_status(temp_git_project, "--json")
        data = json.loads(result.stdout)
        paths = [e["path"] for e in data["untracked"]]
        assert "stray.txt" in paths