Add test case for --git-only option

Author: mdeweerd

codespell_lib/_codespell.py

@@ -23,7 +23,6 @@
 import itertools
 import os
 import re
-import shutil
 import subprocess
 import sys
 import textwrap
@@ -1103,14 +1102,6 @@ def flatten_clean_comma_separated_arguments(
     ]
 
 
-def get_git_executable_path() -> str:
-    # Find the full path to the git executable
-    git_path = shutil.which("git")
-    if git_path is None:
-        raise FileNotFoundError("Git executable not found in PATH")
-    return git_path
-
-
 def get_git_tracked_files(
     root: str, files: Iterable[str], glob_match: GlobMatch, check_hidden: bool
 ) -> Iterable[str]:
@@ -1131,7 +1122,7 @@ def get_git_tracked_files(
     if not check_hidden:
         exclude_patterns.append(":(exclude)**/.*")
 
-    git_executable = get_git_executable_path()
+    git_executable = 'git'
 
     try:
         result = subprocess.run(
@@ -1368,6 +1359,7 @@ def main(*args: str) -> int:
         )
 
     bad_count = 0
+
     # Build the list of all files based on the git_only option
     if options.git_only:
         all_files = get_git_tracked_files(

codespell_lib/tests/test_basic.py

@@ -499,6 +499,7 @@ def test_exclude_file(
     bad_name.write_bytes(
         (combinations + "5 abandonned 5\n6 abandonned 6").encode("utf-8")
     )
+
     assert cs.main(bad_name) == 18
     fname = tmp_path / "tmp.txt"
     fname.write_bytes(
@@ -519,6 +520,87 @@ def test_exclude_file(
     assert cs.main("-x", f"{fname_dummy1},{fname},{fname_dummy2}", bad_name) == 1
 
 
+def test_git_only_exclude_file(
+    tmp_path: Path,
+    capsys: pytest.CaptureFixture[str],
+    monkeypatch: pytest.MonkeyPatch
+) -> None:
+    monkeypatch.chdir(tmp_path)
+    """Test exclude file functionality."""
+    bad_name = tmp_path / "bad.txt"
+    # check all possible combinations of lines to ignore and ignores
+    combinations = "".join(
+        f"{n} abandonned {n}\n"
+        f"{n} abandonned {n}\r\n"
+        f"{n} abandonned {n} \n"
+        f"{n} abandonned {n} \r\n"
+        for n in range(1, 5)
+    )
+    bad_name.write_bytes(
+        (combinations + "5 abandonned 5\n6 abandonned 6").encode("utf-8")
+    )
+
+    subprocess.run(
+            ['git', '-C', tmp_path, 'init'],
+            capture_output=False,
+            check=True,
+            text=True,
+        )
+    subprocess.run(
+            ['git', '-C', tmp_path, 'add', bad_name],
+            capture_output=False,
+            check=True,
+            text=True,
+        )
+
+    assert cs.main(bad_name) == 18
+    fname = tmp_path / "tmp.txt"
+    fname.write_bytes(
+        b"1 abandonned 1\n"
+        b"2 abandonned 2\r\n"
+        b"3 abandonned 3 \n"
+        b"4 abandonned 4 \r\n"
+        b"6 abandonned 6\n"
+    )
+
+    result = subprocess.run(
+            ['git', '-C', tmp_path, 'ls-files'],
+            capture_output=True,
+            check=True,
+            text=True,
+        )
+
+    # Should have 23 total errors (bad_name + fname)
+    assert cs.main(tmp_path) == 23
+
+    # Before adding to git, should not report on fname, only 18 error in bad.txt
+    assert cs.main("--git-only", tmp_path) == 18
+    subprocess.run(
+            ['git', '-C', tmp_path, 'add', fname],
+            capture_output=False,
+            check=True,
+            text=True,
+        )
+    assert cs.main(tmp_path) == 23
+    # After adding to git, should report on fname
+    assert cs.main("--git-only", tmp_path) == 23
+    # After adding to git, should not report on excluded file
+    assert cs.main("--git-only", "-x", fname, tmp_path) == 1
+    # comma-separated list of files
+    fname_dummy1 = tmp_path / "dummy1.txt"
+    fname_dummy1.touch()
+    fname_dummy2 = tmp_path / "dummy2.txt"
+    fname_dummy2.touch()
+    subprocess.run(
+            ['git', '-C', tmp_path, 'add', fname_dummy1, fname_dummy2],
+            capture_output=False,
+            check=True,
+            text=True,
+        )
+    assert cs.main("--git-only", "-x", fname_dummy1, "-x", fname, "-x", fname_dummy2, bad_name) == 1
+    assert cs.main("--git-only", "-x", f"{fname_dummy1},{fname},{fname_dummy2}", bad_name) == 1
+
+
 def test_encoding(
     tmp_path: Path,
     capsys: pytest.CaptureFixture[str],