Use shutil.rmtree's 'onerror' error handling parameter to catch and handle th...

scripts/common/chromium_utils.py

 # Copyright (c) 2010 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """ Set of basic operations/utilities that are used by the build. """
 
 import copy
 import errno
 import fnmatch
 import glob
@@ skipping 248 matching lines @@
     try:
       win32api = __import__('win32api')
       win32con = __import__('win32con')
       win32_api_avail = True
     except ImportError:
       pass
     remove_with_retry = RemoveWithRetry_win
   else:
     remove_with_retry = RemoveWithRetry_non_win
 
+  def RmTreeOnError(function, path, excinfo):
+    """This works around a problem whereby python 2.x on Windows has no ability
+    to check for symbolic links.  os.path.islink always returns False.  But
+    shutil.rmtree will fail if invoked on a symbolic link whose target was
+    deleted before the link.  E.g., reproduce like this:
+    > mkdir test
+    > mkdir test\1
+    > mklink /D test\current test\1
+    > python -c "import chromium_utils; chromium_utils.RemoveDirectory('test')"
+    To avoid this issue, we pass this error-handling function to rmtree.  If
+    we see the exact sort of failure, we ignore it.  All other failures we re-
+    raise.
+    """
+ 
+    exception_type = excinfo[0]
+    exception_value = excinfo[1]
+    # If shutil.rmtree encounters a symbolic link on Windows, os.listdir will
+    # fail with a WindowsError exception with an ENOENT errno (i.e., file not
+    # found).  We'll ignore that error.  Note that WindowsError is not defined
+    # for non-Windows platforms, so we use OSError (of which it is a subclass)
+    # to avoid lint complaints about an undefined global on non-Windows
+    # platforms.
+    if (function is os.listdir) and issubclass(exception_type, OSError):
+      if exception_value.errno == errno.ENOENT:
+        # File does not exist, and we're trying to delete, so we can ignore the
+        # failure.
+        print "WARNING:  Failed to list %s during rmtree.  Ignoring.\n" % path
+      else:
+        raise
+    else:
+      raise
+
   for root, dirs, files in os.walk(file_path, topdown=False):
     # For POSIX:  making the directory writable guarantees removability.
     # Windows will ignore the non-read-only bits in the chmod value.
     os.chmod(root, 0770)
     for name in files:
       remove_with_retry(os.remove, os.path.join(root, name))
     for name in dirs:
-      remove_with_retry(shutil.rmtree, os.path.join(root, name))
+      remove_with_retry(lambda p: shutil.rmtree(p, onerror=RmTreeOnError),
+                        os.path.join(root, name))
 
   remove_with_retry(os.rmdir, file_path)
 
 
 def CopyFileToDir(src_path, dest_dir):
   """Copies the file found at src_path to the same filename within the
   dest_dir directory.
 
   Raises PathNotFound if either the file or the directory is not found.
   """
@@ skipping 429 matching lines @@
 
 def ListMasters():
   """Returns all the masters found."""
   # Look for "internal" masters first.
   path_internal = os.path.join(os.path.dirname(__file__), '..', '..', '..',
       'build_internal', 'masters/*/master.cfg')
   path = os.path.join(os.path.dirname(__file__), '..', '..',
       'masters/*/master.cfg')
   filenames = glob.glob(path_internal) + glob.glob(path)
   return [os.path.abspath(os.path.dirname(f)) for f in filenames]