test_git_restore.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_git_restore.py
 
"""
Purpose
-------
Integration tests for ``oct git restore`` (L3).
 
Responsibilities
----------------
- Verify ``oct git restore <path>`` reverts unstaged working-tree
  edits.
- Verify ``oct git restore --staged <path>`` unstages from the index
  without touching the working tree.
- Verify ``--all`` enumerates in-scope paths.
- Verify the confirmation prompt for ``--staged --all`` (and
  ``--yes`` bypass).
- Verify path-scope filtering (paths outside the project root are
  skipped) and JSON output.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 -- test lifecycle
    L3 -- assertion details
 
Contracts
---------
- All tests use subprocess invocation against ``oct.cli``.
- 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
 
 
def _git_available() -> bool:
    return shutil.which("git") is not None
 
 
def _run_restore(
    root: Path, *extra_args: str,
) -> subprocess.CompletedProcess:
    return subprocess.run(
        [sys.executable, "-m", "oct.cli", "git", "restore", *extra_args],
        cwd=root, capture_output=True, text=True,
    )
 
 
def _staged_names(repo: Path) -> list[str]:
    result = subprocess.run(
        ["git", "diff", "--cached", "--name-only"],
        cwd=repo, check=True, capture_output=True, text=True,
    )
    return [
        line.strip() for line in result.stdout.splitlines() if line.strip()
    ]
 
 
# =====================================================================
# Restore working-tree edits
# =====================================================================
 
 
class TestRestoreWorkingTree:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_restore_single_file(self, temp_git_project: Path) -> None:
        f = temp_git_project / "src" / "tracked.txt"
        f.write_text("v1\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/tracked.txt")
        _git(temp_git_project, "commit", "-m", "init", "--quiet")
 
        # Modify it (unstaged).
        f.write_text("v2\n", encoding="utf-8")
 
        result = _run_restore(temp_git_project, "src/tracked.txt")
        assert result.returncode == 0, result.stderr
        # Working tree should be back to v1.
        assert f.read_text(encoding="utf-8") == "v1\n"
 
 
# =====================================================================
# --staged: unstage without touching working tree
# =====================================================================
 
 
class TestRestoreStaged:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_unstage_preserves_working_tree(
        self, temp_git_project: Path,
    ) -> None:
        f = temp_git_project / "src" / "tracked.txt"
        f.write_text("v1\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/tracked.txt")
        _git(temp_git_project, "commit", "-m", "init", "--quiet")
 
        # Modify and stage.
        f.write_text("v2\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/tracked.txt")
        assert "src/tracked.txt" in _staged_names(temp_git_project)
 
        result = _run_restore(
            temp_git_project, "--staged", "src/tracked.txt",
        )
        assert result.returncode == 0, result.stderr
        # No longer staged.
        assert "src/tracked.txt" not in _staged_names(temp_git_project)
        # Working tree still v2.
        assert f.read_text(encoding="utf-8") == "v2\n"
 
 
# =====================================================================
# --all and prompt
# =====================================================================
 
 
class TestRestoreAll:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_all_restores_every_modified(
        self, temp_git_project: Path,
    ) -> None:
        a = temp_git_project / "src" / "a.txt"
        b = temp_git_project / "src" / "b.txt"
        a.write_text("v1\n", encoding="utf-8")
        b.write_text("v1\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/a.txt", "src/b.txt")
        _git(temp_git_project, "commit", "-m", "init", "--quiet")
 
        a.write_text("v2\n", encoding="utf-8")
        b.write_text("v2\n", encoding="utf-8")
 
        result = _run_restore(temp_git_project, "--all")
        assert result.returncode == 0, result.stderr
        assert a.read_text(encoding="utf-8") == "v1\n"
        assert b.read_text(encoding="utf-8") == "v1\n"
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_staged_all_with_yes_skips_prompt(
        self, temp_git_project: Path,
    ) -> None:
        f = temp_git_project / "src" / "tracked.txt"
        f.write_text("v1\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/tracked.txt")
        _git(temp_git_project, "commit", "-m", "init", "--quiet")
        f.write_text("v2\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/tracked.txt")
 
        result = _run_restore(
            temp_git_project, "--staged", "--all", "--yes",
        )
        assert result.returncode == 0, result.stderr
        assert "src/tracked.txt" not in _staged_names(temp_git_project)
 
 
# =====================================================================
# Empty input
# =====================================================================
 
 
class TestRestoreEmpty:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_no_paths_no_all_errors(
        self, temp_git_project: Path,
    ) -> None:
        result = _run_restore(temp_git_project)
        assert result.returncode == 1
        assert "provide PATHS" in result.stderr.lower() \
            or "use --all" in result.stderr.lower()
 
 
# =====================================================================
# JSON
# =====================================================================
 
 
class TestRestoreJson:
 
    @pytest.mark.skipif(not _git_available(), reason="git not on PATH")
    def test_json_schema(self, temp_git_project: Path) -> None:
        f = temp_git_project / "src" / "tracked.txt"
        f.write_text("v1\n", encoding="utf-8")
        _git(temp_git_project, "add", "src/tracked.txt")
        _git(temp_git_project, "commit", "-m", "init", "--quiet")
        f.write_text("v2\n", encoding="utf-8")
 
        result = _run_restore(
            temp_git_project, "--json", "src/tracked.txt",
        )
        assert result.returncode == 0, result.stderr
        data = json.loads(result.stdout)
        assert data["operation"] == "restore"
        assert data["staged"] is False
        assert "src/tracked.txt" in data["paths_restored"]
        assert data["exit_code"] == 0