From 12bbacee90f3810367a2ce986f42c3172c598c58 Mon Sep 17 00:00:00 2001
From: Eliah Kagan <degeneracypressure@gmail.com>
Date: Thu, 30 Nov 2023 14:38:10 -0500
Subject: [PATCH] Add xfail mark for new test_index_mutation failure

The test assumes symlinks are never created on Windows. This often
turns out to be correct, because core.symlinks defaults to false on
Windows. (On some Windows systems, creating them is a privileged
operation; this can be reconfigured, and unprivileged creation of
symlinks is often enabled on systems used for development.)

However, on a Windows system with core.symlinks set to true, git
will create symlinks if it can, when checking out entries committed
to a repository as symlinks. GitHub Actions runners for Windows do
this ever since https://github.com/actions/runner-images/pull/1186
(the file is now at images/windows/scripts/build/Install-Git.ps1;
the `/o:EnableSymlinks=Enabled` option continues to be passed,
causing Git for Windows to be installed with core.symlinks set to
true in the system scope).

For now, this adds an xfail marking to test_index_mutation, for the
FileNotFoundError raised when a symlink, which is expected not to
be a symlink, is passed to `open`, causing an attempt to open its
nonexistent target. (The check itself might bear refinement: as
written, it reads the core.symlinks variable from any scope,
including the local scope, which at the time of the check will
usually be the cloned GitPython directory, where pytest is run.)

While adding an import, this commit also improves the grouping and
sorting of existing ones.
---
 test/test_index.py | 25 +++++++++++++++++--------
 1 file changed, 17 insertions(+), 8 deletions(-)

diff --git a/test/test_index.py b/test/test_index.py
index 5bf34757a..2f97f0af8 100644
--- a/test/test_index.py
+++ b/test/test_index.py
@@ -17,17 +17,21 @@
 from sumtypes import constructor, sumtype
 
 from git import (
+    BlobFilter,
+    Diff,
+    Git,
     IndexFile,
+    Object,
     Repo,
-    BlobFilter,
-    UnmergedEntriesError,
     Tree,
-    Object,
-    Diff,
-    GitCommandError,
+)
+from git.exc import (
     CheckoutError,
+    GitCommandError,
+    HookExecutionError,
+    InvalidGitRepositoryError,
+    UnmergedEntriesError,
 )
-from git.exc import HookExecutionError, InvalidGitRepositoryError
 from git.index.fun import hook_path
 from git.index.typ import BaseIndexEntry, IndexEntry
 from git.objects import Blob
@@ -530,6 +534,11 @@ def _count_existing(self, repo, files):
 
     # END num existing helper
 
+    @pytest.mark.xfail(
+        os.name == "nt" and Git().config("core.symlinks") == "true",
+        reason="Assumes symlinks are not created on Windows and opens a symlink to a nonexistent target.",
+        raises=FileNotFoundError,
+    )
     @with_rw_repo("0.1.6")
     def test_index_mutation(self, rw_repo):
         index = rw_repo.index
@@ -740,7 +749,7 @@ def mixed_iterator():
             # END for each target
         # END real symlink test
 
-        # Add fake symlink and assure it checks-our as symlink.
+        # Add fake symlink and assure it checks out as a symlink.
         fake_symlink_relapath = "my_fake_symlink"
         link_target = "/etc/that"
         fake_symlink_path = self._make_file(fake_symlink_relapath, link_target, rw_repo)
@@ -774,7 +783,7 @@ def mixed_iterator():
         os.remove(fake_symlink_path)
         index.checkout(fake_symlink_path)
 
-        # On Windows, we will never get symlinks.
+        # On Windows, we currently assume we will never get symlinks.
         if os.name == "nt":
             # Symlinks should contain the link as text (which is what a
             # symlink actually is).