Make timeout_retry include the total timeout in the exception error

devil/devil/utils/timeout_retry.py

 # Copyright 2013 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.
 
 """A utility to run functions with timeouts and retries."""
 # pylint: disable=W0702
 
 import logging
 import threading
 import time
@@ skipping 10 matching lines @@
     super(TimeoutRetryThreadGroup, self).__init__(threads)
     self._watcher = watchdog_timer.WatchdogTimer(timeout)
 
   def GetWatcher(self):
     """Returns the watchdog keeping track of this thread's time."""
     return self._watcher
 
   def GetElapsedTime(self):
     return self._watcher.GetElapsed()
 
-  def GetRemainingTime(self, required=0, msg=None):
+  def GetRemainingTime(self, required=0, suffix=None):
     """Get the remaining time before the thread times out.
 
     Useful to send as the |timeout| parameter of async IO operations.
 
     Args:
       required: minimum amount of time that will be required to complete, e.g.,
         some sleep or IO operation.
       msg: error message to show if timing out.
 
     Returns:
       The number of seconds remaining before the thread times out, or None
       if the thread never times out.
 
     Raises:
       reraiser_thread.TimeoutError if the remaining time is less than the
         required time.
     """
     remaining = self._watcher.GetRemaining()
     if remaining is not None and remaining < required:
-      if msg is None:
-        msg = 'Timeout expired'
-      if remaining > 0:
-        msg += (', wait of %.1f secs required but only %.1f secs left'
-                % (required, remaining))
+      msg = 'Timeout of %.1f secs expired' % self._watcher.GetTimeout()
+      if suffix:
+        msg += suffix
       raise reraiser_thread.TimeoutError(msg)
     return remaining
 
 
 def CurrentTimeoutThreadGroup():
   """Returns the thread group that owns or is blocked on the active thread.
 
   Returns:
     Returns None if no TimeoutRetryThreadGroup is tracking the current thread.
   """
@@ skipping 37 matching lines @@
     msg = ['condition', repr(condition_name), 'met' if result else 'not met']
     if timeout_thread_group:
       # pylint: disable=no-member
       msg.append('(%.1fs)' % timeout_thread_group.GetElapsedTime())
     logger.info(' '.join(msg))
     if result:
       return result
     if timeout_thread_group:
       # pylint: disable=no-member
       timeout_thread_group.GetRemainingTime(wait_period,
-          msg='Timed out waiting for %r' % condition_name)
+          suffix=' (waiting for condition %r)' % condition_name)

[perezju, 2017/08/21 08:22:10]

nit: maybe drop the parentheses.

     time.sleep(wait_period)
   return None
 
 
 def AlwaysRetry(_exception):
   return True
 
 
 def Run(func, timeout, retries, args=None, kwargs=None, desc=None,
         error_log_func=logging.critical, retry_if_func=AlwaysRetry):
@@ skipping 42 matching lines @@
       if num_try > retries or not retry_if_func(e):
         raise
       # Do not catch KeyboardInterrupt.
     except Exception as e:  # pylint: disable=broad-except
       if num_try > retries or not retry_if_func(e):
         raise
       error_log_func(
           '(%s) Exception on %s, attempt %d of %d: %r',
           thread_name, desc, num_try, retries + 1, e)
     num_try += 1