[commit: ghc] master: testsuite: Work around #12554 (9cb4459)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/9cb4459893c1c56553b413786cea3171b4e665ca/ghc

>---------------------------------------------------------------

commit 9cb4459893c1c56553b413786cea3171b4e665ca
Author: Ben Gamari <ben at well-typed.com>
Date:   Sat Oct 15 18:18:14 2016 +0000

    testsuite: Work around #12554
    
    It seems that Python 2.7.11 and "recent" msys2 releases are broken,
    holding open file locks unexpected. This causes rmtree to intermittently
    fail. Even worse, it would fail silently (since we pass
    ignore_errors=True), causing makedirs to fail later.
    
    We now explicitly check for the existence of the test directory before
    attempting to delete it and disable ignore_errors. Moreover, on Windows
    we now try multiple times to rmtree the testdir, working around the
    apparently msys bug.
    
    This is all just terrible, but Phyx and I spent several hours trying to
    track down the issue to no available. The workaround is better than
    nothing.


>---------------------------------------------------------------

9cb4459893c1c56553b413786cea3171b4e665ca
 testsuite/driver/testlib.py | 44 ++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 42 insertions(+), 2 deletions(-)

diff --git a/testsuite/driver/testlib.py b/testsuite/driver/testlib.py
index a39a2de..f2098d2 100644
--- a/testsuite/driver/testlib.py
+++ b/testsuite/driver/testlib.py
@@ -1850,8 +1850,48 @@ def find_expected_file(name, suff):
 
     return basename
 
-def cleanup():
-    shutil.rmtree(getTestOpts().testdir, ignore_errors=True)
+# Windows seems to exhibit a strange behavior where processes' executables
+# remain locked even after the process itself has died.  When this happens
+# rmtree will fail with either Error 5 or Error 32. It takes some time for this
+# to resolve so we try several times to delete the directory, only eventually
+# failing if things seem really stuck. See #12554.
+if config.msys:
+    try:
+        from exceptions import WindowsError
+    except:
+        pass
+    import stat
+    def cleanup():
+        def on_error(function, path, excinfo):
+            # At least one test (T11489) removes the write bit from a file it
+            # produces. Windows refuses to delete read-only files with a
+            # permission error. Try setting the write bit and try again.
+            if excinfo[1].errno == 13:
+                os.chmod(path, stat.S_IWRITE)
+                os.unlink(path)
+
+        testdir = getTestOpts().testdir
+        attempts = 0
+        max_attempts = 10
+        while attempts < max_attempts and os.path.exists(testdir):
+            try:
+                shutil.rmtree(testdir, ignore_errors=False, onerror=on_error)
+            except WindowsError as e:
+                #print('failed deleting %s: %s' % (testdir, e))
+                if e.winerror in [5, 32]:
+                    attempts += 1
+                    if attempts == max_attempts:
+                        raise e
+                    else:
+                        time.sleep(0.1)
+                else:
+                    raise e
+else:
+    def cleanup():
+        testdir = getTestOpts().testdir
+        if os.path.exists(testdir):
+            shutil.rmtree(testdir, ignore_errors=False)
+
 
 # -----------------------------------------------------------------------------
 # Return a list of all the files ending in '.T' below directories roots.