Test current expected behavior of git.util.rmtree

Author: EliahKagan

test/test_util.py

@@ -5,11 +5,13 @@
 # the BSD License: https://opensource.org/license/bsd-3-clause/
 
 importos
+importpathlib
 importpickle
+importstat
 importsys
 importtempfile
 importtime
-fromunittestimportmock, skipUnless
+fromunittestimportSkipTest, mock, skipIf, skipUnless
 fromdatetimeimportdatetime
 
 importddt
@@ -19,25 +21,26 @@
 fromgit.compatimportis_win
 fromgit.objects.utilimport (
 altz_to_utctz_str,
-utctz_to_altz,
-verify_utctz,
+from_timestamp,
 parse_date,
 tzoffset,
-from_timestamp,
+utctz_to_altz,
+verify_utctz,
 )
 fromtest.libimport (
 TestBase,
 with_rw_repo,
 )
 fromgit.utilimport (
-LockFile,
-BlockingLockFile,
-get_user_id,
 Actor,
+BlockingLockFile,
 IterableList,
+LockFile,
 cygpath,
 decygpath,
+get_user_id,
 remove_password_if_present,
+rmtree,
 )
 
 
@@ -85,6 +88,59 @@ def setup(self):
 "array": [42],
  }
 
+deftest_rmtree_deletes_nested_dir_with_files(self):
+withtempfile.TemporaryDirectory() asparent:
+td=pathlib.Path(parent, "testdir")
+fordintd, td/"q", td/"s":
+d.mkdir()
+forfintd/"p", td/"q"/"w", td/"q"/"x", td/"r", td/"s"/"y", td/"s"/"z":
+f.write_bytes(b"")
+
+try:
+rmtree(td)
+exceptSkipTestasex:
+self.fail(f"rmtree unexpectedly attempts skip: {ex!r}")
+
+self.assertFalse(td.exists())
+
+@skipIf(sys.platform=="cygwin", "Cygwin can't set the permissions that make the test meaningful.")
+deftest_rmtree_deletes_dir_with_readonly_files(self):
+# Automatically works on Unix, but requires special handling on Windows.
+withtempfile.TemporaryDirectory() asparent:
+td=pathlib.Path(parent, "testdir")
+fordintd, td/"sub":
+d.mkdir()
+forfintd/"x", td/"sub"/"y":
+f.write_bytes(b"")
+f.chmod(0)
+
+try:
+rmtree(td)
+exceptSkipTestasex:
+self.fail(f"rmtree unexpectedly attempts skip: {ex!r}")
+
+self.assertFalse(td.exists())
+
+@skipIf(sys.platform=="cygwin", "Cygwin can't set the permissions that make the test meaningful.")
+@skipIf(sys.version_info< (3, 8), "In 3.7, TemporaryDirectory doesn't clean up after weird permissions.")
+deftest_rmtree_can_wrap_exceptions(self):
+withtempfile.TemporaryDirectory() asparent:
+td=pathlib.Path(parent, "testdir")
+td.mkdir()
+ (td/"x").write_bytes(b"")
+ (td/"x").chmod(stat.S_IRUSR) # Set up PermissionError on Windows.
+td.chmod(stat.S_IRUSR|stat.S_IXUSR) # Set up PermissionError on Unix.
+
+# Access the module through sys.modules so it is unambiguous which module's
+# attribute we patch: the original git.util, not git.index.util even though
+# git.index.util "replaces" git.util and is what "import git.util" gives us.
+withmock.patch.object(sys.modules["git.util"], "HIDE_WINDOWS_KNOWN_ERRORS", True):
+# Disable common chmod functions so the callback can't fix the problem.
+withmock.patch.object(os, "chmod"), mock.patch.object(pathlib.Path, "chmod"):
+# Now we can see how an intractable PermissionError is treated.
+withself.assertRaises(SkipTest):
+rmtree(td)
+
 # FIXME: Mark only the /proc-prefixing cases xfail, somehow (or fix them).
 @pytest.mark.xfail(
 reason="Many return paths prefixed /proc/cygdrive instead.",