[Android] Add an action to check/record attached devices

build/android/gyp/util/build_device.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 simple device interface for build steps.

[shashi, 2013/06/20 03:16:19]

Nit new line between file comment and copyright notice.

[cjhopman, 2013/06/25 16:43:11]

Done.

+
+"""
+
+import logging
+import os
+import re
+import sys
+
+import build_utils
+
+BUILD_ANDROID_DIR = os.path.join(os.path.dirname(__file__), '..', '..')
+sys.path.append(BUILD_ANDROID_DIR)
+
+from pylib import android_commands
+
+from pylib.android_commands import GetAttachedDevices
+
+
+class BuildDevice(object):
+  def __init__(self, configuration):
+    self.id = configuration['id']
+    self.description = configuration['description']
+    self.install_metadata = configuration['install_metadata']
+    self.adb = android_commands.AndroidCommands(self.id)
+
+  def RunShellCommand(self, *args, **kwargs):
+    return self.adb.RunShellCommand(*args, **kwargs)
+
+  def PushIfNeeded(self, *args, **kwargs):
+    return self.adb.PushIfNeeded(*args, **kwargs)
+
+  def GetSerialNumber(self):
+    return self.id
+
+  def Install(self, *args, **kwargs):
+    return self.adb.Install(*args, **kwargs)
+
+  def GetInstallMetadata(self, apk_package):
+    """Gets the metadata on the device for the apk_package apk."""
+    # Matches lines like:
+    # -rw-r--r-- system   system    7376582 2013-04-19 16:34 org.chromium.chrome.testshell.apk
+    # -rw-r--r-- system   system    7376582 2013-04-19 16:34 org.chromium.chrome.testshell-1.apk
+    apk_matcher = lambda s: re.match('.*%s(-[0-9]*)?.apk$' % apk_package, s)
+    matches = filter(apk_matcher, self.install_metadata)
+    return matches[0] if matches else None
+
+
+def GetConfigurationForDevice(id):
+  adb = android_commands.AndroidCommands(id)
+  configuration = None
+  has_root = False
+  is_online = adb.IsOnline()
+  if is_online:
+    cmd = 'ls -l /data/app; getprop ro.build.description'
+    cmd_output = adb.RunShellCommand(cmd)
+    has_root = not 'Permission denied' in cmd_output[0]
+    if not has_root:
+      # Disable warning log messages from EnableAdbRoot()
+      logging.getLogger().disabled = True
+      has_root = adb.EnableAdbRoot()

[shashi, 2013/06/20 03:16:19]

Can we move this to before and always try to enable adb root ? I know it is
redundant, but does it add significantly more overhead?

[cjhopman, 2013/06/25 16:43:11]

It is ~200ms per device for every build. A no-op build is normally 600-700ms and
so that is a rather significant cost.

[shashi, 2013/06/25 17:23:31]

OK, did not realise it was this slow.
On 2013/06/25 16:43:11, cjhopman wrote:

+      logging.getLogger().disabled = False
+      cmd_output = adb.RunShellCommand(cmd)
+
+    configuration = {
+        'id': id,
+        'description': cmd_output[-1],
+        'install_metadata': cmd_output[:-1],
+      }
+  return configuration, is_online, has_root
+
+
+def WriteConfigurations(configurations, path):
+  # Currently we only support installing to the first device.
+  build_utils.WriteJson(configurations[:1], path, only_if_changed=True)
+
+
+def ReadConfigurations(path):
+  configurations = build_utils.ReadJson(path)

[shashi, 2013/06/20 03:16:19]

nit: return build_utils.ReadJson(path)

[cjhopman, 2013/06/25 16:43:11]

Done.

+  return configurations
+
+
+def GetBuildDevice(configurations):
+  assert len(configurations) == 1

[shashi, 2013/06/20 03:16:19]

nit: pass a single element of the list instead of the entire list.
assert configuration
return BuildDevice(configuration)

[cjhopman, 2013/06/25 16:43:11]

It is actually important that the list of configurations only contain a single
entry. That is, we treat the list of configurations as the list of devices that
are actually installed to, and, since we only support installing to a single
device, the list of devices should only contain a single device.

It makes more sense for GetBuildDevice to enforce the restriction on
configurations than to have the caller do it.

In the future it may be the case that this is changed to support multiple
devices (I'm thinking a bit about how to handle that).

wdyt?

[shashi, 2013/06/25 17:23:31]

If there is plan in future to support multiple devices then redundancy is ok.
On 2013/06/25 16:43:11, cjhopman wrote:

+  return BuildDevice(configurations[0])
+
+
+def GetBuildDeviceFromPath(path):
+  configurations = ReadConfigurations(path)
+  if len(configurations) > 0:
+    return GetBuildDevice(ReadConfigurations(path))

[shashi, 2013/06/20 03:16:19]

nit: pass configurations[0] here.
return GetBuildDevice(configurations[0])

+  return None
+