Make startup timing independent of host performance

build/android/pylib/android_commands.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.
 
 """Provides an interface to communicate with the device via the adb command.
 
 Assumes adb binary is currently on system path.
 """
 
 import collections
@@ skipping 512 matching lines @@
       elapsed = 0
       wait_period = 0.1
       # Note that this doesn't take into account the time spent in ExtractPid().
       while self.ExtractPid(process) and elapsed < timeout_sec:
         time.sleep(wait_period)
         elapsed += wait_period
       if elapsed >= timeout_sec:
         return 0
     return processes_killed
 
-  def StartActivity(self, package, activity, wait_for_completion=False,
-                    action='android.intent.action.VIEW',
-                    category=None, data=None,
-                    extras=None, trace_file_name=None,
-                    force_stop=False):
-    """Starts |package|'s activity on the device.
+  def _GetActivityCommand(self, package, activity, wait_for_completion, action,
+                          category, data, extras, trace_file_name, force_stop):
+    """Creates command to start |package|'s activity on the device.
 
-    Args:
-      package: Name of package to start (e.g. 'com.google.android.apps.chrome').
-      activity: Name of activity (e.g. '.Main' or
-        'com.google.android.apps.chrome.Main').
-      wait_for_completion: wait for the activity to finish launching (-W flag).
-      action: string (e.g. "android.intent.action.MAIN"). Default is VIEW.
-      category: string (e.g. "android.intent.category.HOME")
-      data: Data string to pass to activity (e.g. 'http://www.example.com/').
-      extras: Dict of extras to pass to activity. Values are significant.
-      trace_file_name: If used, turns on and saves the trace to this file name.
-      force_stop: force stop the target app before starting the activity (-S
-        flag).
+    Args - as for StartActivity
+
+    Returns:
+      the command to run on the target to start the activity
     """
     cmd = 'am start -a %s' % action
     if force_stop:
       cmd += ' -S'
     if wait_for_completion:
       cmd += ' -W'
     if category:
       cmd += ' -c %s' % category
     if package and activity:
       cmd += ' -n %s/%s' % (package, activity)
     if data:
       cmd += ' -d "%s"' % data
     if extras:
       for key in extras:
         value = extras[key]
         if isinstance(value, str):
           cmd += ' --es'
         elif isinstance(value, bool):
           cmd += ' --ez'
         elif isinstance(value, int):
           cmd += ' --ei'
         else:
           raise NotImplementedError(
               'Need to teach StartActivity how to pass %s extras' % type(value))
         cmd += ' %s %s' % (key, value)
     if trace_file_name:
       cmd += ' --start-profiler ' + trace_file_name
+    return cmd
+
+  def StartActivity(self, package, activity, wait_for_completion=False,
+                    action='android.intent.action.VIEW',
+                    category=None, data=None,
+                    extras=None, trace_file_name=None,
+                    force_stop=False):
+    """Starts |package|'s activity on the device.
+
+    Args:
+      package: Name of package to start (e.g. 'com.google.android.apps.chrome').
+      activity: Name of activity (e.g. '.Main' or
+        'com.google.android.apps.chrome.Main').
+      wait_for_completion: wait for the activity to finish launching (-W flag).
+      action: string (e.g. "android.intent.action.MAIN"). Default is VIEW.
+      category: string (e.g. "android.intent.category.HOME")
+      data: Data string to pass to activity (e.g. 'http://www.example.com/').
+      extras: Dict of extras to pass to activity. Values are significant.
+      trace_file_name: If used, turns on and saves the trace to this file name.
+      force_stop: force stop the target app before starting the activity (-S
+        flag).
+    """
+    cmd = self._GetActivityCommand(package, activity, wait_for_completion,
+                                   action, category, data, extras,
+                                   trace_file_name, force_stop)
     self.RunShellCommand(cmd)
 
+  def StartActivityTimed(self, package, activity, wait_for_completion=False,
+                         action='android.intent.action.VIEW',
+                         category=None, data=None,
+                         extras=None, trace_file_name=None,
+                         force_stop=False):
+    """Starts |package|'s activity on the device, returning the start time
+
+    Args - as for StartActivity
+
+    Returns:
+      a timestamp string for the time at which the activity started
+    """
+    cmd = self._GetActivityCommand(package, activity, wait_for_completion,
+                                   action, category, data, extras,
+                                   trace_file_name, force_stop)
+    self.StartMonitoringLogcat()
+    self.RunShellCommand('log starting activity; ' + cmd)
+    activity_started_re = re.compile('.*starting activity.*')
+    m = self.WaitForLogMatch(activity_started_re, None)
+    assert m
+    start_line = m.group(0)
+    return GetLogTimestamp(start_line, self.GetDeviceYear())
+
   def GoHome(self):
     """Tell the device to return to the home screen. Blocks until completion."""
     self.RunShellCommand('am start -W '
         '-a android.intent.action.MAIN -c android.intent.category.HOME')
 
   def CloseApplication(self, package):
     """Attempt to close down the application, using increasing violence.
 
     Args:
       package: Name of the process to kill off, e.g.
@@ skipping 260 matching lines @@
             if error_match:
               return None
           success_match = success_re.search(line)
           if success_match:
             return success_match
           logging.info('<<< Skipped Logcat Line:' + str(line))
       except pexpect.TIMEOUT:
         raise pexpect.TIMEOUT(
             'Timeout (%ds) exceeded waiting for pattern "%s" (tip: use -vv '
             'to debug)' %
-            (self._logcat.timeout, success_re.pattern))
+            (timeout, success_re.pattern))
       except pexpect.EOF:
         # It seems that sometimes logcat can end unexpectedly. This seems
         # to happen during Chrome startup after a reboot followed by a cache
         # clean. I don't understand why this happens, but this code deals with
         # getting EOF in logcat.
         logging.critical('Found EOF in adb logcat. Restarting...')
         # Rerun spawn with original arguments. Note that self._logcat.args[0] is
         # the path of adb, so we don't want it in the arguments.
         self._logcat = pexpect.spawn('adb',
                                      self._logcat.args[1:],
@@ skipping 276 matching lines @@
   """
   def __init__(self, output):
     self._output = output
 
   def write(self, data):
     data = data.replace('\r\r\n', '\n')
     self._output.write(data)
 
   def flush(self):
     self._output.flush()