gsutil: Pass proxy information via Boto options.

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 urllib2
+import urlparse
 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')
@@ skipping 86 matching lines @@
   with zipfile.ZipFile(target_zip_filename, 'r') as target_zip:
     target_zip.extractall(bin_dir)
 
   # Final check that the gsutil bin is okay.  This should never fail.
   if not check_gsutil(gsutil_bin):
     raise InvalidGsutilError()
 
   return gsutil_bin
 
 
+def get_boto_proxy_options_from_environment():

[Ryan Tseng, 2015/01/07 22:21:58]

for completeness sake (since I've seen all these permutations before) lets also
look for ['http_proxy', 'HTTP_PROXY', 'HTTPS_PROXY', 'https_proxy']

+  """Converts the contents of the 'http_proxy' environment variable into the

[Ryan Tseng, 2015/01/07 22:21:58]

"""One line

More lines
...
"""

So rewrite this as:
"""Derive proxy options for gsutil from the environment.

<more description if needed>
"""

+  corresponding Boto options that gsutil accepts."""
+  if 'http_proxy' not in os.environ:
+    return []
+  proxy_url = urlparse.urlsplit(os.environ['http_proxy'])
+  if proxy_url.hostname is None or proxy_url.port is None:
+    raise EnvironmentError(
+      'The "http_proxy" environment is set, but has an invalid format. Its '

[Ryan Tseng, 2015/01/07 22:21:58]

2 indents

+      'format must be "http://[user[:password]]host:port".')
+  boto_options = ['-o', 'Boto:proxy=%s' % proxy_url.hostname,
+                  '-o', 'Boto:proxy_port=%d' % proxy_url.port]
+  if proxy_url.username:
+    boto_options.extend(['-o', 'Boto:proxy_user=%s' % proxy_url.username])
+  if proxy_url.password:
+    boto_options.extend(['-o', 'Boto:proxy_pass=%s' % proxy_url.password])
+  return boto_options
+
+
 def run_gsutil(force_version, fallback, target, args):
   if force_version:
     gsutil_bin = ensure_gsutil(force_version, target)
   else:
     gsutil_bin = fallback
-  cmd = [sys.executable, gsutil_bin] + args
+  proxy_options = get_boto_proxy_options_from_environment()
+  cmd = [sys.executable, gsutil_bin] + proxy_options + args
   try:
     call(cmd)
   except SubprocessError as e:
     return e.code
   return 0
 
 
 def parse_args():
   parser = argparse.ArgumentParser()
   parser.add_argument('--force-version')
   parser.add_argument('--fallback', default=DEFAULT_FALLBACK_GSUTIL)
   parser.add_argument('--target', default=DEFAULT_BIN_DIR)
   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
 
 
 def main():
   force_version, fallback, target, args = parse_args()
   return run_gsutil(force_version, fallback, target, args)
 
 if __name__ == '__main__':
   sys.exit(main())