[Android] Switch to DeviceUtils version of RunShellCommand.

build/android/pylib/device/device_utils.py

 # 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.
 
 """Provides a variety of device interactions based on adb.
 
 Eventually, this will be based on adb_wrapper.
 """
 # pylint: disable=W0613
 
@@ skipping 81 matching lines @@
   @decorators.WithTimeoutAndRetriesFromInstance()
   def HasRoot(self, timeout=None, retries=None):
     """Checks whether or not adbd has root privileges.
 
     Args:
       timeout: Same as for |IsOnline|.
       retries: Same as for |IsOnline|.
     Returns:
       True if adbd has root privileges, False otherwise.
     """
+    return self._HasRootImpl()
+
+  def _HasRootImpl(self):
+    """ Implementation of HasRoot.
+
+    This is split from HasRoot to allow other DeviceUtils methods to call
+    HasRoot without spawning a new timeout thread.
+
+    Returns:
+      Same as for |HasRoot|.
+    """
     return self.old_interface.IsRootEnabled()
 
   @decorators.WithTimeoutAndRetriesFromInstance()
   def EnableRoot(self, timeout=None, retries=None):
     """Restarts adbd with root privileges.
 
     Args:
       timeout: Same as for |IsOnline|.
       retries: Same as for |IsOnline|.
     Raises:
@@ skipping 52 matching lines @@
     Raises:
       Same as for |WaitUntilFullyBooted|.
     """
     if timeout is None:
       timeout = self._default_timeout
     self.old_interface.WaitForSystemBootCompleted(timeout)
     self.old_interface.WaitForDevicePm()
     self.old_interface.WaitForSdCardReady(timeout)
     if wifi:
       while not 'Wi-Fi is enabled' in (
-          self.old_interface.RunShellCommand('dumpsys wifi')):
+          self._RunShellCommandImpl('dumpsys wifi')):
         time.sleep(0.1)
 
   @decorators.WithTimeoutAndRetriesDefaults(
       10 * _DEFAULT_TIMEOUT, _DEFAULT_RETRIES)
   def Reboot(self, block=True, timeout=None, retries=None):
     """Reboot the device.
 
     Args:
       block: A boolean indicating if we should wait for the reboot to complete.
       timeout: Same as for |IsOnline|.
@@ skipping 40 matching lines @@
       try:
         out = self.old_interface.Install(apk_path, reinstall=reinstall)
         for line in out.splitlines():
           if 'Failure' in line:
             raise device_errors.CommandFailedError(
                 ['adb', 'install', apk_path], line.strip())
       except AssertionError as e:
         raise device_errors.CommandFailedError(
             ['adb', 'install', apk_path], str(e))
 
+  @decorators.WithTimeoutAndRetriesFromInstance()
+  def RunShellCommand(self, cmd, check_return=False, root=False, timeout=None,
+                      retries=None):
+    """ Run an ADB shell command.

[frankf, 2014/06/13 23:16:10]

no space before Run

+
+    Args:
+      cmd: A list containing the command to run on the device and any arguments.
+      check_return: A boolean indicating whether or not the return code should

[frankf, 2014/06/13 23:16:10]

can you add a TODO to flip this to True? (In spirit of finding failures as soon
as possible)

+                    be checked.
+      timeout: Same as for |IsOnline|.
+      retries: Same as for |IsOnline|.
+    Raises:
+      CommandFailedError if check_return is True and the return code is nozero.
+    Returns:
+      The output of the command.
+    """
+    return self._RunShellCommandImpl(cmd, check_return=check_return, root=root,
+                                     timeout=timeout)
+
+  def _RunShellCommandImpl(self, cmd, check_return=False, root=False,
+                           timeout=None):
+    """ Implementation of RunShellCommand.
+
+    This is split from RunShellCommand to allow other DeviceUtils methods to
+    call RunShellCommand without spawning a new timeout thread.
+
+    TODO(jbudorick) Remove the timeout parameter once this is no longer
+    implemented via AndroidCommands.
+
+    Args:
+      cmd: Same as for |RunShellCommand|.
+      check_return: Same as for |RunShellCommand|.
+      timeout: Same as for |IsOnline|.
+    Raises:
+      Same as for |RunShellCommand|.
+    Returns:
+      Same as for |RunShellCommand|.
+    """
+    if isinstance(cmd, list):
+      cmd = ' '.join(cmd)
+    if root and not self.HasRoot():
+      cmd = 'su -c %s' % cmd
+    if check_return:
+      code, output = self.old_interface.GetShellCommandStatusAndOutput(
+          cmd, timeout_time=timeout)
+      if int(code) != 0:
+        raise device_errors.CommandFailedError(
+            cmd, 'Nonzero exit code (%d)' % code)
+    else:
+      output = self.old_interface.RunShellCommand(cmd, timeout_time=timeout)
+    return output
+
   def __str__(self):
     """Returns the device serial."""
     return self.old_interface.GetDevice()
 
   @staticmethod
   def parallel(devices=None, async=False):
     """Creates a Parallelizer to operate over the provided list of devices.
 
     If |devices| is either |None| or an empty list, the Parallelizer will
     operate over all attached devices.
 
     Args:
       devices: A list of either DeviceUtils instances or objects from
                from which DeviceUtils instances can be constructed. If None,
                all attached devices will be used.
       async: If true, returns a Parallelizer that runs operations
              asynchronously.
     Returns:
       A Parallelizer operating over |devices|.
     """
     if not devices or len(devices) == 0:
       devices = pylib.android_commands.GetAttachedDevices()
     parallelizer_type = (parallelizer.Parallelizer if async
                          else parallelizer.SyncParallelizer)
     return parallelizer_type([
         d if isinstance(d, DeviceUtils) else DeviceUtils(d)
         for d in devices])