test_auto_branch.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_auto_branch.py
 
"""
Purpose
-------
Integration tests for the auto-branching behaviour in ``oct git commit``
(Phase 4F — G-F2): when committing on a protected branch, the command
automatically creates a feature branch instead of blocking.
 
Responsibilities
----------------
- Verify auto-branch creates a correctly named feature branch from the
  commit message.
- Verify the commit lands on the new branch, not on the protected branch.
- Verify stderr reports the auto-branch action.
- Verify ``git.auto_branch_on_protected: false`` disables auto-branching.
- Verify branch name deduplication when the generated name already exists.
 
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_commit(root: Path, *extra_args: str) -> subprocess.CompletedProcess:
    """Run ``oct git commit`` in a subprocess."""
    return subprocess.run(
        [sys.executable, "-m", "oct.cli", "git", "commit", *extra_args],
        cwd=root,
        capture_output=True,
        text=True,
    )
 
 
def _set_octrc(root: Path, octrc: dict) -> None:
    """Overwrite ``.octrc.json`` in *root*."""
    (root / ".octrc.json").write_text(
        json.dumps(octrc, indent=2), encoding="utf-8",
    )
 
 
# =====================================================================
# Auto-branch on protected branch
# =====================================================================
 
 
class TestAutoBranch:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_auto_branch_creates_feature_branch(
        self, temp_git_project: Path, make_compliant_py,
    ) -> None:
        """Commit on main auto-creates feature/... and succeeds."""
        path = make_compliant_py("src/good.py")
        _git(temp_git_project, "add", "src/good.py")
        result = _run_commit(
            temp_git_project, "-m", "feat(auth): add JWT tokens",
        )
        assert result.returncode == 0, f"stderr: {result.stderr}"
        # Verify we moved to the auto-created branch.
        proc = _git(temp_git_project, "rev-parse", "--abbrev-ref", "HEAD")
        branch = proc.stdout.strip()
        assert branch.startswith("feature/"), f"expected feature/..., got {branch!r}"
        assert "auth" in branch
        # Verify main is untouched (still at initial commit).
        assert "auto-created branch" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_auto_branch_commit_lands_on_new_branch(
        self, temp_git_project: Path, make_compliant_py,
    ) -> None:
        """The commit message appears on the new branch, not main."""
        path = make_compliant_py("src/module.py")
        _git(temp_git_project, "add", "src/module.py")
        _run_commit(temp_git_project, "-m", "fix: resolve null pointer")
        # Check commit log on current branch.
        proc = _git(temp_git_project, "log", "--oneline", "-1")
        assert "resolve null pointer" in proc.stdout
        # Verify main does NOT have the commit.
        proc_main = _git(temp_git_project, "log", "main", "--oneline", "-1")
        assert "resolve null pointer" not in proc_main.stdout
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_auto_branch_fix_type(
        self, temp_git_project: Path, make_compliant_py,
    ) -> None:
        """fix: message creates a bugfix/ branch."""
        path = make_compliant_py("src/fix_it.py")
        _git(temp_git_project, "add", "src/fix_it.py")
        _run_commit(temp_git_project, "-m", "fix: patch memory leak")
        proc = _git(temp_git_project, "rev-parse", "--abbrev-ref", "HEAD")
        assert proc.stdout.strip().startswith("bugfix/")
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_auto_branch_sec_type(
        self, temp_git_project: Path, make_compliant_py,
    ) -> None:
        """sec: message creates a hotfix/ branch."""
        path = make_compliant_py("src/sec_fix.py")
        _git(temp_git_project, "add", "src/sec_fix.py")
        _run_commit(temp_git_project, "-m", "sec: patch CVE-2024-9999")
        proc = _git(temp_git_project, "rev-parse", "--abbrev-ref", "HEAD")
        assert proc.stdout.strip().startswith("hotfix/")
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_auto_branch_disabled_blocks(
        self, temp_git_project: Path, make_compliant_py,
    ) -> None:
        """auto_branch_on_protected=false preserves the blocking behaviour."""
        _set_octrc(temp_git_project, {
            "linter": {"profile": "compact"},
            "git": {
                "protected_branches": ["main", "master"],
                "auto_branch_on_protected": False,
            },
        })
        path = make_compliant_py("src/blocked.py")
        _git(temp_git_project, "add", "src/blocked.py")
        result = _run_commit(
            temp_git_project, "-m", "feat: should be blocked",
        )
        assert result.returncode == 1
        assert "protected branch" in result.stderr.lower()
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_auto_branch_deduplication(
        self, temp_git_project: Path, make_compliant_py,
    ) -> None:
        """When the generated branch name already exists, append a counter."""
        # Pre-create the branch that would be generated.
        _git(temp_git_project, "branch", "feature/dup-test-feature")
        path = make_compliant_py("src/dedup.py")
        _git(temp_git_project, "add", "src/dedup.py")
        result = _run_commit(
            temp_git_project, "-m", "feat: dup test feature",
        )
        assert result.returncode == 0, f"stderr: {result.stderr}"
        proc = _git(temp_git_project, "rev-parse", "--abbrev-ref", "HEAD")
        branch = proc.stdout.strip()
        # Should have a -2 suffix.
        assert branch == "feature/dup-test-feature-2"