Make TimeoutRetryThread's stoppable

build/android/pylib/device/adb_wrapper.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.
 
 """This module wraps Android's adb tool.
 
 This is a thin wrapper around the adb interface. Any additional complexity
 should be delegated to a higher level (ex. DeviceUtils).
 """
 
 import errno
 import os
+import time
 
 from pylib import cmd_helper
 from pylib.device import decorators
 from pylib.device import device_errors
+from pylib.utils import timeout_retry
 
 
 _DEFAULT_TIMEOUT = 30
 _DEFAULT_RETRIES = 2
 
 
 def _VerifyLocalFileExists(path):
   """Verifies a local file exists.
 
   Args:
@@ skipping 10 matching lines @@
   """A wrapper around a local Android Debug Bridge executable."""
 
   def __init__(self, device_serial):
     """Initializes the AdbWrapper.
 
     Args:
       device_serial: The device serial number as a string.
     """
     self._device_serial = str(device_serial)
 
+  @classmethod
+  def Wait(cls, secs):
+    """Wait for the specified ammount of seconds.

[jbudorick, 2014/10/30 02:27:03]

nit: ammount -> amount

+
+    A drop-in replacement for time.sleep, which just waits for a number of
+    seconds. After the wait is over, however, the method checks to see whether
+    we're running under a timed-out thread and raises an exception if needed.
+
+    Args:
+      secs: the number of seconds to sleep
+    """
+    timeout_thread = timeout_retry.GetTimeoutThread()
+    if timeout_thread:
+      remaining = timeout_thread.RemainingTime()
+      if remaining is not None and remaining < secs:
+        # no need to wait, we would time out anyway

[jbudorick, 2014/10/30 02:27:02]

nit: Add a log message here (probably at warning) about timing out early. This
is liable to confuse some people otherwise.

[perezju, 2014/10/30 18:44:44]

This is much better now in my new proposal. An exception will be raised with a
message reading something like: "CommandTimeoutError: Early timeout waiting for
'pm_ready', wait of 5.0 secs required but only 2.5 secs left"

+        timeout_thread.RaiseTimeout()
+    time.sleep(secs)
+
   # pylint: disable=W0613
   @classmethod
   @decorators.WithTimeoutAndRetries
   def _RunAdbCmd(cls, arg_list, timeout=None, retries=None, check_error=True):
     cmd = ['adb'] + arg_list
-    exit_code, output = cmd_helper.GetCmdStatusAndOutput(cmd)
+    exit_code, output = cmd_helper.GetCmdStatusAndOutputWithTimeout(
+      cmd, timeout_retry.GetTimeoutThread().RemainingTime())
     if exit_code != 0:
       raise device_errors.AdbCommandFailedError(
-          cmd, 'returned non-zero exit code %s, output: %s' %
+          cmd, 'returned non-zero exit code %d and output %r' %
           (exit_code, output))
     # This catches some errors, including when the device drops offline;
     # unfortunately adb is very inconsistent with error reporting so many
     # command failures present differently.
     if check_error and output[:len('error:')] == 'error:':
       raise device_errors.AdbCommandFailedError(arg_list, output)
     return output
   # pylint: enable=W0613
 
   def _DeviceAdbCmd(self, arg_list, timeout, retries, check_error=True):
@@ skipping 321 matching lines @@
     """Restarts the adbd daemon with root permissions, if possible.
 
     Args:
       timeout: (optional) Timeout per try in seconds.
       retries: (optional) Number of retries to attempt.
     """
     output = self._DeviceAdbCmd(['root'], timeout, retries)
     if 'cannot' in output:
       raise device_errors.AdbCommandFailedError(['root'], output)