Have test suite use sys.platform to check for Windows

See 88557bc on this change in general as well as the rationale for
making it in the tests. (It is alreay done in the code under test.)

Author: EliahKagan

test/lib/helper.py

@@ -10,6 +10,7 @@
 import logging
 import os
 import os.path as osp
+import sys
 import tempfile
 import textwrap
 import time
@@ -176,7 +177,7 @@ def git_daemon_launched(base_path, ip, port):
 
     gd = None
     try:
-        if os.name == "nt":
+        if sys.platform == "win32":
             # On MINGW-git, daemon exists in Git\mingw64\libexec\git-core\,
             # but if invoked as 'git daemon', it detaches from parent `git` cmd,
             # and then CANNOT DIE!
@@ -200,7 +201,7 @@ def git_daemon_launched(base_path, ip, port):
                 as_process=True,
             )
         # Yes, I know... fortunately, this is always going to work if sleep time is just large enough.
-        time.sleep(1.0 if os.name == "nt" else 0.5)
+        time.sleep(1.0 if sys.platform == "win32" else 0.5)
     except Exception as ex:
         msg = textwrap.dedent(
             """
@@ -404,7 +405,7 @@ class VirtualEnvironment:
     __slots__ = ("_env_dir",)
 
     def __init__(self, env_dir, *, with_pip):
-        if os.name == "nt":
+        if sys.platform == "win32":
             self._env_dir = osp.realpath(env_dir)
             venv.create(self.env_dir, symlinks=False, with_pip=with_pip)
         else:
@@ -432,7 +433,7 @@ def sources(self):
         return os.path.join(self.env_dir, "src")
 
     def _executable(self, basename):
-        if os.name == "nt":
+        if sys.platform == "win32":
             path = osp.join(self.env_dir, "Scripts", basename + ".exe")
         else:
             path = osp.join(self.env_dir, "bin", basename)

test/test_base.py

@@ -130,7 +130,7 @@ def test_add_unicode(self, rw_repo):
         with open(file_path, "wb") as fp:
             fp.write(b"something")
 
-        if os.name == "nt":
+        if sys.platform == "win32":
             # On Windows, there is no way this works, see images on:
             # https://github.com/gitpython-developers/GitPython/issues/147#issuecomment-68881897
             # Therefore, it must be added using the Python implementation.

test/test_config.py

@@ -7,6 +7,7 @@
 import io
 import os
 import os.path as osp
+import sys
 from unittest import mock
 
 import pytest
@@ -238,7 +239,7 @@ def check_test_value(cr, value):
             check_test_value(cr, tv)
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason='Second config._has_includes() assertion fails (for "config is included if path is matching git_dir")',
         raises=AssertionError,
     )

test/test_diff.py

@@ -4,9 +4,9 @@
 # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
 
 import gc
-import os
 import os.path as osp
 import shutil
+import sys
 import tempfile
 
 import ddt
@@ -309,7 +309,7 @@ def test_diff_with_spaces(self):
         self.assertEqual(diff_index[0].b_path, "file with spaces", repr(diff_index[0].b_path))
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason='"Access is denied" when tearDown calls shutil.rmtree',
         raises=PermissionError,
     )

test/test_git.py

@@ -74,7 +74,7 @@ def _fake_git(*version_info):
     fake_output = f"git version {fake_version} (fake)"
 
     with tempfile.TemporaryDirectory() as tdir:
-        if os.name == "nt":
+        if sys.platform == "win32":
             fake_git = Path(tdir, "fake-git.cmd")
             script = f"@echo {fake_output}\n"
             fake_git.write_text(script, encoding="utf-8")
@@ -215,7 +215,7 @@ def test_it_executes_git_not_from_cwd(self, rw_dir, case):
 
         repo = Repo.init(rw_dir)
 
-        if os.name == "nt":
+        if sys.platform == "win32":
             # Copy an actual binary executable that is not git. (On Windows, running
             # "hostname" only displays the hostname, it never tries to change it.)
             other_exe_path = Path(os.environ["SystemRoot"], "system32", "hostname.exe")
@@ -228,7 +228,7 @@ def test_it_executes_git_not_from_cwd(self, rw_dir, case):
             os.chmod(impostor_path, 0o755)
 
         if use_shell_impostor:
-            shell_name = "cmd.exe" if os.name == "nt" else "sh"
+            shell_name = "cmd.exe" if sys.platform == "win32" else "sh"
             shutil.copy(impostor_path, Path(rw_dir, shell_name))
 
         with contextlib.ExitStack() as stack:
@@ -245,7 +245,7 @@ def test_it_executes_git_not_from_cwd(self, rw_dir, case):
         self.assertRegex(output, r"^git version\b")
 
     @skipUnless(
-        os.name == "nt",
+        sys.platform == "win32",
         "The regression only affected Windows, and this test logic is OS-specific.",
     )
     def test_it_avoids_upcasing_unrelated_environment_variable_names(self):
@@ -667,7 +667,7 @@ def test_successful_default_refresh_invalidates_cached_version_info(self):
             stack.enter_context(mock.patch.dict(os.environ, {"PATH": new_path_var}))
             stack.enter_context(_patch_out_env("GIT_PYTHON_GIT_EXECUTABLE"))
 
-            if os.name == "nt":
+            if sys.platform == "win32":
                 # On Windows, use a shell so "git" finds "git.cmd". (In the infrequent
                 # case that this effect is desired in production code, it should not be
                 # done with this technique. USE_SHELL=True is less secure and reliable,

test/test_index.py

@@ -14,6 +14,7 @@
 import shutil
 from stat import S_ISLNK, ST_MODE
 import subprocess
+import sys
 import tempfile
 
 import ddt
@@ -124,7 +125,7 @@ def check(cls):
         in System32; Popen finds it even if a shell would run another one, as on CI.
         (Without WSL, System32 may still have bash.exe; users sometimes put it there.)
         """
-        if os.name != "nt":
+        if sys.platform != "win32":
             return cls.Inapplicable()
 
         try:
@@ -561,7 +562,7 @@ def _count_existing(self, repo, files):
     # END num existing helper
 
     @pytest.mark.xfail(
-        os.name == "nt" and Git().config("core.symlinks") == "true",
+        sys.platform == "win32" and Git().config("core.symlinks") == "true",
         reason="Assumes symlinks are not created on Windows and opens a symlink to a nonexistent target.",
         raises=FileNotFoundError,
     )
@@ -754,7 +755,7 @@ def mixed_iterator():
         self.assertNotEqual(entries[0].hexsha, null_hex_sha)
 
         # Add symlink.
-        if os.name != "nt":
+        if sys.platform != "win32":
             for target in ("/etc/nonexisting", "/etc/passwd", "/etc"):
                 basename = "my_real_symlink"
 
@@ -812,7 +813,7 @@ def mixed_iterator():
         index.checkout(fake_symlink_path)
 
         # On Windows, we currently assume we will never get symlinks.
-        if os.name == "nt":
+        if sys.platform == "win32":
             # Symlinks should contain the link as text (which is what a
             # symlink actually is).
             with open(fake_symlink_path, "rt") as fd:
@@ -1043,7 +1044,7 @@ def test_run_commit_hook(self, rw_repo):
     def test_hook_uses_shell_not_from_cwd(self, rw_dir, case):
         (chdir_to_repo,) = case
 
-        shell_name = "bash.exe" if os.name == "nt" else "sh"
+        shell_name = "bash.exe" if sys.platform == "win32" else "sh"
         maybe_chdir = cwd(rw_dir) if chdir_to_repo else contextlib.nullcontext()
         repo = Repo.init(rw_dir)
 

test/test_remote.py

@@ -4,10 +4,10 @@
 # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
 
 import gc
-import os
 import os.path as osp
 from pathlib import Path
 import random
+import sys
 import tempfile
 from unittest import skipIf
 
@@ -769,7 +769,7 @@ def test_create_remote_unsafe_url(self, rw_repo):
                 assert not tmp_file.exists()
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=R"Multiple '\' instead of '/' in remote.url make it differ from expected value",
         raises=AssertionError,
     )
@@ -832,7 +832,7 @@ def test_fetch_unsafe_options(self, rw_repo):
                 assert not tmp_file.exists()
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=(
             "File not created. A separate Windows command may be needed. This and the "
             "currently passing test test_fetch_unsafe_options must be adjusted in the "
@@ -900,7 +900,7 @@ def test_pull_unsafe_options(self, rw_repo):
                 assert not tmp_file.exists()
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=(
             "File not created. A separate Windows command may be needed. This and the "
             "currently passing test test_pull_unsafe_options must be adjusted in the "
@@ -974,7 +974,7 @@ def test_push_unsafe_options(self, rw_repo):
                 assert not tmp_file.exists()
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=(
             "File not created. A separate Windows command may be needed. This and the "
             "currently passing test test_push_unsafe_options must be adjusted in the "

test/test_repo.py

@@ -309,7 +309,7 @@ def test_clone_unsafe_options(self, rw_repo):
                 assert not tmp_file.exists()
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=(
             "File not created. A separate Windows command may be needed. This and the "
             "currently passing test test_clone_unsafe_options must be adjusted in the "
@@ -388,7 +388,7 @@ def test_clone_from_unsafe_options(self, rw_repo):
                 assert not tmp_file.exists()
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=(
             "File not created. A separate Windows command may be needed. This and the "
             "currently passing test test_clone_from_unsafe_options must be adjusted in the "
@@ -1389,7 +1389,7 @@ def test_do_not_strip_newline_in_stdout(self, rw_dir):
         self.assertEqual(r.git.show("HEAD:hello.txt", strip_newline_in_stdout=False), "hello\n")
 
     @pytest.mark.xfail(
-        os.name == "nt",
+        sys.platform == "win32",
         reason=R"fatal: could not create leading directories of '--upload-pack=touch C:\Users\ek\AppData\Local\Temp\tmpnantqizc\pwn': Invalid argument",  # noqa: E501
         raises=GitCommandError,
     )

test/test_submodule.py

@@ -987,7 +987,7 @@ def test_rename(self, rwdir):
         # This is needed to work around a PermissionError on Windows, resembling others,
         # except new in Python 3.12. (*Maybe* this could be due to changes in CPython's
         # garbage collector detailed in https://github.com/python/cpython/issues/97922.)
-        if os.name == "nt" and sys.version_info >= (3, 12):
+        if sys.platform == "win32" and sys.version_info >= (3, 12):
             gc.collect()
 
         new_path = "renamed/myname"
@@ -1071,7 +1071,7 @@ def test_branch_renames(self, rw_dir):
         assert sm_mod.commit() == sm_pfb.commit, "Now head should have been reset"
         assert sm_mod.head.ref.name == sm_pfb.name
 
-    @skipUnless(os.name == "nt", "Specifically for Windows.")
+    @skipUnless(sys.platform == "win32", "Specifically for Windows.")
     def test_to_relative_path_with_super_at_root_drive(self):
         class Repo:
             working_tree_dir = "D:\\"

test/test_util.py

@@ -149,7 +149,7 @@ def _patch_for_wrapping_test(self, mocker, hide_windows_known_errors):
         mocker.patch.object(pathlib.Path, "chmod")
 
     @pytest.mark.skipif(
-        os.name != "nt",
+        sys.platform != "win32",
         reason="PermissionError is only ever wrapped on Windows",
     )
     def test_wraps_perm_error_if_enabled(self, mocker, permission_error_tmpdir):
@@ -168,7 +168,7 @@ def test_wraps_perm_error_if_enabled(self, mocker, permission_error_tmpdir):
         "hide_windows_known_errors",
         [
             pytest.param(False),
-            pytest.param(True, marks=pytest.mark.skipif(os.name == "nt", reason="We would wrap on Windows")),
+            pytest.param(True, marks=pytest.mark.skipif(sys.platform == "win32", reason="We would wrap on Windows")),
         ],
     )
     def test_does_not_wrap_perm_error_unless_enabled(self, mocker, permission_error_tmpdir, hide_windows_known_errors):
@@ -214,7 +214,7 @@ def _run_parse(name, value):
         return ast.literal_eval(output)
 
     @pytest.mark.skipif(
-        os.name != "nt",
+        sys.platform != "win32",
         reason="These environment variables are only used on Windows.",
     )
     @pytest.mark.parametrize(
@@ -410,7 +410,7 @@ def test_blocking_lock_file(self):
             elapsed = time.time() - start
 
         extra_time = 0.02
-        if os.name == "nt" or sys.platform == "cygwin":
+        if sys.platform in {"win32", "cygwin"}:
             extra_time *= 6  # Without this, we get indeterministic failures on Windows.
         elif sys.platform == "darwin":
             extra_time *= 18  # The situation on macOS is similar, but with more delay.