Consolidate subprocess retry logic into gclient_utils.

gclient_utils.py

 # Copyright (c) 2012 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.
 
 """Generic utils."""
 
 import codecs
 import logging
 import os
 import pipes
 import Queue
 import re
 import stat
 import subprocess
 import sys
 import tempfile
 import threading
 import time
 import urlparse
 
 import subprocess2
 
 
+RETRY_MAX = 3
+RETRY_INITIAL_SLEEP = 0.5
+
+
 class Error(Exception):
   """gclient exception class."""
   def __init__(self, msg, *args, **kwargs):
     index = getattr(threading.currentThread(), 'index', 0)
     if index:
       msg = '\n'.join('%d> %s' % (index, l) for l in msg.splitlines())
     super(Error, self).__init__(msg, *args, **kwargs)
 
 def SplitUrlRevision(url):
   """Splits url and returns a two-tuple: url, rev"""
@@ skipping 308 matching lines @@
 
 
 def MakeFileAutoFlush(fileobj, delay=10):
   autoflush = getattr(fileobj, 'autoflush', None)
   if autoflush:
     autoflush.delay = delay
     return fileobj
   return AutoFlush(fileobj, delay)
 
 
-def MakeFileAnnotated(fileobj, include_zero=False):
+def MakeFileAnnotated(fileobj, _include_zero=False):
   if getattr(fileobj, 'annotated', None):
     return fileobj
   return Annotated(fileobj)
 
 
 GCLIENT_CHILDREN = []
 GCLIENT_CHILDREN_LOCK = threading.Lock()
 
 
 class GClientChildren(object):
@@ skipping 37 matching lines @@
 
     with GCLIENT_CHILDREN_LOCK:
       if GCLIENT_CHILDREN:
         print >> sys.stderr, 'Could not kill the following subprocesses:'
         for zombie in GCLIENT_CHILDREN:
           print >> sys.stderr, '  ', zombie.pid
 
 
 def CheckCallAndFilter(args, stdout=None, filter_fn=None,
                        print_stdout=None, call_filter_on_first_line=False,
-                       **kwargs):
+                       retry=False, **kwargs):
   """Runs a command and calls back a filter function if needed.
 
   Accepts all subprocess2.Popen() parameters plus:
     print_stdout: If True, the command's stdout is forwarded to stdout.
     filter_fn: A function taking a single string argument called with each line
                of the subprocess2's output. Each line has the trailing newline
                character trimmed.
     stdout: Can be any bufferable output.
+    retry: If the process exits non-zero, sleep for a brief interval and try
+           again, up to RETRY_MAX times.
 
   stderr is always redirected to stdout.
   """
   assert print_stdout or filter_fn
   stdout = stdout or sys.stdout
   filter_fn = filter_fn or (lambda x: None)
-  kid = subprocess2.Popen(
-      args, bufsize=0, stdout=subprocess2.PIPE, stderr=subprocess2.STDOUT,
-      **kwargs)
 
-  GClientChildren.add(kid)
-
-  # Do a flush of stdout before we begin reading from the subprocess2's stdout
-  stdout.flush()
-
-  # Also, we need to forward stdout to prevent weird re-ordering of output.
-  # This has to be done on a per byte basis to make sure it is not buffered:
-  # normally buffering is done for each line, but if svn requests input, no
-  # end-of-line character is output after the prompt and it would not show up.
-  try:
-    in_byte = kid.stdout.read(1)
-    if in_byte:
-      if call_filter_on_first_line:
-        filter_fn(None)
-      in_line = ''
-      while in_byte:
-        if in_byte != '\r':
-          if print_stdout:
-            stdout.write(in_byte)
-          if in_byte != '\n':
-            in_line += in_byte
+  sleep_interval = RETRY_INITIAL_SLEEP
+  run_cwd = kwargs.get('cwd', os.getcwd())
+  for _ in xrange(RETRY_MAX + 1):
+    kid = subprocess2.Popen(
+        args, bufsize=0, stdout=subprocess2.PIPE, stderr=subprocess2.STDOUT,
+        **kwargs)
+  
+    GClientChildren.add(kid)
+  
+    # Do a flush of stdout before we begin reading from the subprocess2's stdout
+    stdout.flush()
+  
+    # Also, we need to forward stdout to prevent weird re-ordering of output.
+    # This has to be done on a per byte basis to make sure it is not buffered:
+    # normally buffering is done for each line, but if svn requests input, no
+    # end-of-line character is output after the prompt and it would not show up.
+    try:
+      in_byte = kid.stdout.read(1)
+      if in_byte:
+        if call_filter_on_first_line:
+          filter_fn(None)
+        in_line = ''
+        while in_byte:
+          if in_byte != '\r':
+            if print_stdout:
+              stdout.write(in_byte)
+            if in_byte != '\n':
+              in_line += in_byte
+            else:
+              filter_fn(in_line)
+              in_line = ''
           else:
             filter_fn(in_line)
             in_line = ''
-        else:
+          in_byte = kid.stdout.read(1)
+        # Flush the rest of buffered output. This is only an issue with
+        # stdout/stderr not ending with a \n.
+        if len(in_line):
           filter_fn(in_line)
-          in_line = ''
-        in_byte = kid.stdout.read(1)
-      # Flush the rest of buffered output. This is only an issue with
-      # stdout/stderr not ending with a \n.
-      if len(in_line):
-        filter_fn(in_line)
-    rv = kid.wait()
+      rv = kid.wait()
+  
+      # Don't put this in a 'finally,' since the child may still run if we get
+      # an exception.
+      GClientChildren.remove(kid)
+  
+    except KeyboardInterrupt:
+      print >> sys.stderr, 'Failed while running "%s"' % ' '.join(args)
+      raise
 
-    # Don't put this in a 'finally,' since the child may still run if we get an
-    # exception.
-    GClientChildren.remove(kid)
-
-  except KeyboardInterrupt:
-    print >> sys.stderr, 'Failed while running "%s"' % ' '.join(args)
-    raise
-
-  if rv:
-    raise subprocess2.CalledProcessError(
-        rv, args, kwargs.get('cwd', None), None, None)
-  return 0
+    if rv == 0:
+      return 0
+    if not retry:
+      break
+    print ('WARNING: subprocess "%s" in %s failed; will retry after a short '
+           'nap...' % (' '.join(['"%s"' % x for x in args]), run_cwd))

[M-A Ruel, 2013/10/17 01:37:26]

' '.join('"%s"' % x for x in args)
or
' '.join(map(str, args))

as you prefer but the brackets are not necessary..

In practice, the str() is not necessary, if you are concerned about a caller
passing non str there, you can add an assert at the top of the function:
assert all(isinstance(x, str) for x in args), args

+    sys.sleep(sleep_interval)
+    sleep_interval *= 2
+  raise subprocess2.CalledProcessError(
+      rv, args, kwargs.get('cwd', None), None, None)
 
 
 def FindGclientRoot(from_dir, filename='.gclient'):
   """Tries to find the gclient root."""
   real_from_dir = os.path.realpath(from_dir)
   path = real_from_dir
   while not os.path.exists(os.path.join(path, filename)):
     split_path = os.path.split(path)
     if not split_path[1]:
       return None
@@ skipping 393 matching lines @@
 
   Python on OSX 10.6 raises a NotImplementedError exception.
   """
   try:
     import multiprocessing
     return multiprocessing.cpu_count()
   except:  # pylint: disable=W0702
     # Mac OS 10.6 only
     # pylint: disable=E1101
     return int(os.sysconf('SC_NPROCESSORS_ONLN'))