gsutil: Parallel-safe, specify target, add clean.

gsutil.py

 #!/usr/bin/env python
 # Copyright 2014 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.
 
 """Run a pinned gsutil."""
 
 
 import argparse
 import base64
 import hashlib
 import json
 import os
 import shutil
 import subprocess
 import sys
+import time
 import urllib2
 import zipfile
 
 
 GSUTIL_URL = 'https://storage.googleapis.com/pub/'
 API_URL = 'https://www.googleapis.com/storage/v1/b/pub/o/'
 
 THIS_DIR = os.path.dirname(os.path.abspath(__file__))
 DEFAULT_BIN_DIR = os.path.join(THIS_DIR, 'external_bin', 'gsutil')
 DEFAULT_FALLBACK_GSUTIL = os.path.join(
     THIS_DIR, 'third_party', 'gsutil', 'gsutil')
 
-
 class InvalidGsutilError(Exception):
   pass
 
 
 def download_gsutil(version, target_dir):
   """Downloads gsutil into the target_dir."""
   filename = 'gsutil_%s.zip' % version
   target_filename = os.path.join(target_dir, filename)
 
   # Check if the target exists already.
@@ skipping 26 matching lines @@
       f.write(buf)
   return target_filename
 
 
 def check_gsutil(gsutil_bin):
   """Run gsutil version and make sure it runs."""
   return subprocess.call(
       [sys.executable, gsutil_bin, 'version'],
       stdout=subprocess.PIPE, stderr=subprocess.STDOUT) == 0
 
-def ensure_gsutil(version, target):
+def ensure_gsutil(version, target, clean):
   bin_dir = os.path.join(target, 'gsutil_%s' % version)
   gsutil_bin = os.path.join(bin_dir, 'gsutil', 'gsutil')
-  if os.path.isfile(gsutil_bin) and check_gsutil(gsutil_bin):
+  if not clean and os.path.isfile(gsutil_bin) and check_gsutil(gsutil_bin):
     # Everything is awesome! we're all done here.
     return gsutil_bin
 
-  if os.path.isdir(bin_dir):
-    # Clean up if we're redownloading a corrupted gsutil.
-    shutil.rmtree(bin_dir)
-  cache_dir = os.path.join(target, '.cache_dir')
+  # Clean up if we're redownloading a corrupted gsutil.
+  suffix = '%d_%d' % (time.time(), os.getpid())

[vapier, 2015/09/17 19:31:00]

this isn't parallel safe.  you cannot rely on PID's being unique (pid namespaces
for example).  if you need a tempdir, then use a proper library like
tempfile.NamedTemporaryFile().

[dnj, 2015/09/17 19:51:47]

Using "tempfile.mkdtemp" now.

+  try:
+    cleanup_path = '%s.%s' % (bin_dir, suffix)
+    shutil.move(bin_dir, cleanup_path)
+    shutil.rmtree(cleanup_path)
+  except IOError:
+    # Directory was not present.
+    pass
+
+  cache_dir = os.path.join(target, '.cache_dir.%s' % (suffix,))

[Ryan Tseng, 2015/09/17 19:26:45]

this would be more aptly called "tempdir" now?

maybe also clean up lingering cache_dirs older than 1 hour.

[dnj, 2015/09/17 19:51:46]

Acknowledged.

   if not os.path.isdir(cache_dir):
     os.makedirs(cache_dir)
   target_zip_filename = download_gsutil(version, cache_dir)
   with zipfile.ZipFile(target_zip_filename, 'r') as target_zip:
-    target_zip.extractall(bin_dir)
+    target_zip.extractall(cache_dir)
+
+  try:
+    shutil.move(cache_dir, bin_dir)
+  except IOError:
+    # Something else did this in parallel.
+    pass
 
   # Final check that the gsutil bin is okay.  This should never fail.
   if not check_gsutil(gsutil_bin):
     raise InvalidGsutilError()
 
   return gsutil_bin
 
 
-def run_gsutil(force_version, fallback, target, args):
+def run_gsutil(force_version, fallback, target, args, clean=False):
   if force_version:
-    gsutil_bin = ensure_gsutil(force_version, target)
+    gsutil_bin = ensure_gsutil(force_version, target, clean)
   else:
     gsutil_bin = fallback
   cmd = [sys.executable, gsutil_bin] + args
   return subprocess.call(cmd)
 
 
 def parse_args():
+  bin_dir = os.environ.get('DEPOT_TOOLS_GSUTIL_BIN_DIR')

[Ryan Tseng, 2015/09/17 19:26:45]

get(key, default)

[dnj, 2015/09/17 19:51:47]

Done.

+  if not bin_dir:
+    bin_dir = DEFAULT_BIN_DIR
+
   parser = argparse.ArgumentParser()
   parser.add_argument('--force-version', default='4.13')
+  parser.add_argument('--clean', action='store_true',

[Ryan Tseng, 2015/09/17 19:26:45]

What do you see the use case for this being?

[dnj, 2015/09/17 19:51:47]

Useful for testing massively in parallel.

+      help='Clear any existing gsutil package, forcing a new download.')
   parser.add_argument('--fallback', default=DEFAULT_FALLBACK_GSUTIL)
-  parser.add_argument('--target', default=DEFAULT_BIN_DIR)
+  parser.add_argument('--target', default=bin_dir,
+      help='The target directory to download/store a gsutil version in. '
+           '(default is %(default)s).')
   parser.add_argument('args', nargs=argparse.REMAINDER)
 
   args, extras = parser.parse_known_args()
   if args.args and args.args[0] == '--':
     args.args.pop(0)
   if extras:
     args.args = extras + args.args
-  return args.force_version, args.fallback, args.target, args.args
+  return args
 
 
 def main():
-  force_version, fallback, target, args = parse_args()
-  return run_gsutil(force_version, fallback, target, args)
+  args = parse_args()
+  return run_gsutil(args.force_version, args.fallback, args.target, args.args,
+                    clean=args.clean)
 
 if __name__ == '__main__':
   sys.exit(main())