test_git_branch.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_git_branch.py
 
"""
Purpose
-------
Integration tests for ``oct git branch`` (Phase 4F — G-F1).
 
Responsibilities
----------------
- Verify ``--create`` creates a branch with naming validation.
- Verify ``--switch`` switches to an existing branch.
- Verify mutual exclusivity of ``--create`` and ``--switch``.
- Verify JSON output.
- Verify audit trail.
- Verify error cases (duplicate, non-existent, uncommitted changes).
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 -- test lifecycle
    L3 -- assertion details
    L4 -- deep tracing
 
Contracts
---------
- All tests use subprocess invocation (same pattern as test_git_commit.py).
- All tests use tmp_path fixtures so they are automatically cleaned up.
"""
 
import json
import shutil
import subprocess
import sys
from pathlib import Path
 
import pytest
 
from tests.tests_git.conftest import _git, commit_file
 
 
# =====================================================================
# Helpers
# =====================================================================
 
 
def _git_available() -> bool:
    return shutil.which("git") is not None
 
 
def _run_branch(root: Path, *extra_args: str) -> subprocess.CompletedProcess:
    """Run ``oct git branch`` in a subprocess."""
    return subprocess.run(
        [sys.executable, "-m", "oct.cli", "git", "branch", *extra_args],
        cwd=root,
        capture_output=True,
        text=True,
    )
 
 
def _run_branch_json(root: Path, *extra_args: str) -> dict:
    """Run ``oct git branch --json`` and parse JSON output."""
    result = _run_branch(root, "--json", *extra_args)
    return json.loads(result.stdout)
 
 
# =====================================================================
# --create
# =====================================================================
 
 
class TestBranchCreate:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_create_valid_branch(self, temp_git_project: Path) -> None:
        result = _run_branch(temp_git_project, "--create", "feature/new-thing")
        assert result.returncode == 0
        assert "Created branch" in result.stdout
        # Verify branch exists in git.
        proc = _git(temp_git_project, "branch", "--list", "feature/new-thing")
        assert "feature/new-thing" in proc.stdout
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_create_does_not_switch(self, temp_git_project: Path) -> None:
        _run_branch(temp_git_project, "--create", "feature/stay-here")
        proc = _git(temp_git_project, "rev-parse", "--abbrev-ref", "HEAD")
        assert proc.stdout.strip() == "main"
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_create_invalid_name_rejected(self, temp_git_project: Path) -> None:
        result = _run_branch(temp_git_project, "--create", "bad-name")
        assert result.returncode == 1
        assert "does not match" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_create_duplicate_rejected(self, temp_git_project: Path) -> None:
        _run_branch(temp_git_project, "--create", "feature/dup")
        result = _run_branch(temp_git_project, "--create", "feature/dup")
        assert result.returncode == 1
        assert "already exists" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_create_json_output(self, temp_git_project: Path) -> None:
        data = _run_branch_json(temp_git_project, "--create", "feature/json-test")
        assert data["operation"] == "create"
        assert data["branch"] == "feature/json-test"
        assert data["exit_code"] == 0
        assert data["errors"] == []
 
 
# =====================================================================
# --switch
# =====================================================================
 
 
class TestBranchSwitch:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_switch_to_existing(self, temp_git_project: Path) -> None:
        _git(temp_git_project, "branch", "feature/target")
        result = _run_branch(temp_git_project, "--switch", "feature/target")
        assert result.returncode == 0
        assert "Switched to branch" in result.stdout
        proc = _git(temp_git_project, "rev-parse", "--abbrev-ref", "HEAD")
        assert proc.stdout.strip() == "feature/target"
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_switch_nonexistent_rejected(self, temp_git_project: Path) -> None:
        result = _run_branch(temp_git_project, "--switch", "feature/nope")
        assert result.returncode == 1
        assert "does not exist" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_switch_with_uncommitted_changes(self, temp_git_project: Path) -> None:
        """Switching with dirty working tree is refused."""
        _git(temp_git_project, "branch", "feature/clean-target")
        # Create a tracked file and modify it without committing.
        (temp_git_project / "src" / "dirty.py").write_text("x = 1\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/dirty.py")
        result = _run_branch(temp_git_project, "--switch", "feature/clean-target")
        assert result.returncode == 1
        assert "uncommitted" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_switch_json_output(self, temp_git_project: Path) -> None:
        _git(temp_git_project, "branch", "feature/json-switch")
        data = _run_branch_json(temp_git_project, "--switch", "feature/json-switch")
        assert data["operation"] == "switch"
        assert data["branch"] == "feature/json-switch"
        assert data["exit_code"] == 0
 
 
# =====================================================================
# Mutual exclusivity
# =====================================================================
 
 
class TestMutualExclusivity:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_both_flags_rejected(self, temp_git_project: Path) -> None:
        result = _run_branch(
            temp_git_project,
            "--create", "feature/a",
            "--switch", "feature/b",
        )
        assert result.returncode == 1
        assert "mutually exclusive" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_no_flags_shows_usage(self, temp_git_project: Path) -> None:
        result = _run_branch(temp_git_project)
        assert result.returncode == 1
        assert "--create" in result.stderr or "--switch" in result.stderr