[Android] Implement perf tests to platform mode.

build/android/pylib/local/device/local_device_perf_test_run.py

Index: build/android/pylib/local/device/local_device_perf_test_run.py
diff --git a/build/android/pylib/local/device/local_device_perf_test_run.py b/build/android/pylib/local/device/local_device_perf_test_run.py
new file mode 100644
index 0000000000000000000000000000000000000000..45e336ce9fc51afca20acef03b2a4b67889be642
--- /dev/null
+++ b/build/android/pylib/local/device/local_device_perf_test_run.py
@@ -0,0 +1,373 @@
+# Copyright 2016 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.
+
+import io
+import itertools
+import json
+import logging
+import os
+import pickle
+import shutil
+import tempfile
+import time
+import zipfile
+
+from devil.android import battery_utils
+from devil.android import device_blacklist
+from devil.android import device_errors
+from devil.android import device_list
+from devil.android import device_utils
+from devil.android import forwarder
+from devil.android.tools import device_recovery
+from devil.android.tools import device_status
+from devil.utils import cmd_helper
+from devil.utils import parallelizer
+from pylib import constants
+from pylib.base import base_test_result
+from pylib.constants import host_paths
+from pylib.local.device import local_device_test_run
+
+
+class TestShard(object):
+  def __init__(
+      self, env, test_instance, device, index, tests, retries=3, timeout=None):
+    logging.info('Create shard %s for device %s to run the following tests:',
+                 index, device)
+    for t in tests:
+      logging.info('  %s', t)
+    self._battery = battery_utils.BatteryUtils(device)
+    self._device = device
+    self._env = env
+    self._index = index
+    self._output_dir = None
+    self._results = []
+    self._retries = retries
+    self._test_instance = test_instance
+    self._tests = tests
+    self._timeout = timeout
+
+  @local_device_test_run.handle_shard_failures
+  def RunTestsOnShard(self):
+    for test in self._tests:
+      tries_left = self._retries
+      result_type = None
+      while (result_type != base_test_result.ResultType.PASS
+             and tries_left > 0):
+        try:
+          self._TestSetUp(test)
+          result_type = self._RunSingleTest(test)
+        except device_errors.CommandFailedError:

[jbudorick, 2016/07/06 19:12:10]

We should either:
 - have this catch device_errors.BaseError
 - add another exception handler for device_errors.CommandTimeoutError that sets
result_type = ResultType.TIMEOUT

I'm leaning toward the second.

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+          logging.exception('Exception when executing %s.', test)
+          result_type = base_test_result.ResultType.FAIL
+        finally:
+          self._TestTearDown()
+          if result_type != base_test_result.ResultType.PASS:
+            try:
+              device_recovery.RecoverDevice(self._device, self._env.blacklist)
+            except device_errors.CommandTimeoutError:
+              logging.exception(
+                  'Device failed to recover after failing %s.', test)
+          tries_left = tries_left - 1
+      result = base_test_result.TestRunResults()

[jbudorick, 2016/07/06 19:12:10]

nit: blank line before this one

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+      result.AddResult(base_test_result.BaseTestResult(test, result_type))
+      self._results.append(result)

[jbudorick, 2016/07/06 19:12:10]

A list of single-result TestRunResults objects seems a bit weird.

Also, why is self._results an instance variable? It looks like it can be local
to this function.

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+    return self._results
+
+  def _TestSetUp(self, test):
+    if not self._device.IsOnline():
+      msg = 'Device %s is unresponsive.' % str(self._device)
+      raise device_errors.DeviceUnreachableError(msg)
+
+    logging.info('Charge level: %s%%',
+                 str(self._battery.GetBatteryInfo().get('level')))
+    if self._test_instance.min_battery_level:
+      self._battery.ChargeDeviceToLevel(self._test_instance.min_battery_level)
+
+    logging.info('temperature: %s (0.1 C)',
+                 str(self._battery.GetBatteryInfo().get('temperature')))
+    if self._test_instance.max_battery_temp:
+      self._battery.LetBatteryCoolToTemperature(
+          self._test_instance.max_battery_temp)
+
+    if not self._device.IsScreenOn():
+      self._device.SetScreen(True)
+
+    if (self._test_instance.collect_chartjson_data
+        or self._tests[test].get('archive_output_dir')):
+      self._output_dir = tempfile.mkdtemp()
+
+  def _RunSingleTest(self, test):

[jbudorick, 2016/07/06 19:12:10]

The sequencing in this function is a bit odd. I think it should be

buildbot json
stuff used by the GetCmdStatusAndOutputWithTimeout call
log stuff used by the GetCmdStatusAndOutputWithTimeout call
try:
  start time
  run
  end time
  json output
except:

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+
+    logging.info('Running %s on shard %d', test, self._index)
+    timeout = self._tests[test].get('timeout', self._timeout)

[jbudorick, 2016/07/06 19:12:10]

timeout is created here but not used (beyond logging) until the
GetCmdStatusAndOutputWithTimeout call below

+    logging.info('Timeout for %s test: %d', test, timeout)
+
+    cmd = self._CreateCmd(test)

[jbudorick, 2016/07/06 19:12:10]

cmd is created here but not used at all until the try block

+    self._test_instance.WriteBuildBotJson(self._output_dir)
+    cwd = os.path.abspath(host_paths.DIR_SOURCE_ROOT)
+
+    try:
+      logging.debug("Running test with command '%s'", cmd)

[jbudorick, 2016/07/06 19:12:10]

Why is this in the try block?

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+      start_time = time.time()
+      exit_code, output = cmd_helper.GetCmdStatusAndOutputWithTimeout(
+          cmd, timeout, cwd=cwd, shell=True)
+      end_time = time.time()
+      json_output = self._test_instance.ReadChartjsonOutput(self._output_dir)
+      timed_out = False
+    except cmd_helper.TimeoutError as e:
+      end_time = time.time()
+      exit_code = -1
+      output = e.output
+      json_output = ''
+      timed_out = True

[jbudorick, 2016/07/06 19:12:10]

Can we just deal with the ResultType explicitly?

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+
+    return self._ProcessTestResult(test, cmd, start_time, end_time, exit_code,
+                                   output, json_output, timed_out)
+
+  def _CreateCmd(self, test):
+    cmd = '%s --device %s' % (self._tests[test]['cmd'], str(self._device))
+    if self._output_dir:
+      cmd = cmd + ' --output-dir=%s' % self._output_dir
+    if self._test_instance.dry_run:
+      cmd = 'echo %s' % cmd
+    return cmd
+
+  def _ProcessTestResult(self, test, cmd, start_time, end_time, exit_code,
+                         output, json_output, timed_out):
+    if exit_code is None:
+      exit_code = -1
+    logging.info('%s : exit_code=%d in %d secs on device %s',
+                 test, exit_code, end_time - start_time,
+                 str(self._device))
+    if timed_out:
+      result_type = base_test_result.ResultType.TIMEOUT
+    elif exit_code == 0:
+      result_type = base_test_result.ResultType.PASS
+    else:
+      result_type = base_test_result.ResultType.FAIL
+    actual_exit_code = exit_code
+    if (self._test_instance.flaky_steps
+        and test in self._test_instance.flaky_steps):
+      exit_code = 0
+    archive_bytes = (self._ArchiveOutputDir()
+                     if self._tests[test].get('archive_output_dir')
+                     else None)
+    persisted_result = {
+        'name': test,
+        'output': [output],
+        'chartjson': json_output,
+        'archive_bytes': archive_bytes,
+        'exit_code': exit_code,
+        'actual_exit_code': actual_exit_code,
+        'result_type': result_type,
+        'start_time': start_time,
+        'end_time': end_time,
+        'total_time': end_time - start_time,
+        'device': str(self._device),
+        'cmd': cmd,
+    }
+    self._SaveResult(persisted_result)
+    return result_type
+
+  def _ArchiveOutputDir(self):
+    """Archive all files in the output dir, and return as compressed bytes."""
+    with io.BytesIO() as archive:
+      with zipfile.ZipFile(archive, 'w', zipfile.ZIP_DEFLATED) as contents:
+        num_files = 0
+        for absdir, _, files in os.walk(self._output_dir):
+          reldir = os.path.relpath(absdir, self._output_dir)
+          for filename in files:
+            src_path = os.path.join(absdir, filename)
+            # We use normpath to turn './file.txt' into just 'file.txt'.
+            dst_path = os.path.normpath(os.path.join(reldir, filename))
+            contents.write(src_path, dst_path)
+            num_files += 1
+      if num_files:
+        logging.info('%d files in the output dir were archived.', num_files)
+      else:
+        logging.warning('No files in the output dir. Archive is empty.')
+      return archive.getvalue()
+
+  @staticmethod
+  def _SaveResult(result):
+    pickled = os.path.join(constants.PERF_OUTPUT_DIR, result['name'])
+    if os.path.exists(pickled):
+      with file(pickled, 'r') as f:
+        previous = pickle.loads(f.read())
+        result['output'] = previous['output'] + result['output']
+    with file(pickled, 'w') as f:
+      f.write(pickle.dumps(result))
+
+  def _TestTearDown(self):
+    if self._output_dir:
+      shutil.rmtree(self._output_dir, ignore_errors=True)
+      self._output_dir = None
+    try:
+      logging.info('Unmapping device ports for %s.', self._device)
+      forwarder.Forwarder.UnmapAllDevicePorts(self._device)
+    except Exception: # pylint: disable=broad-except
+      logging.exception('Exception when resetting ports.')
+
+
+class LocalDevicePerfTestRun(local_device_test_run.LocalDeviceTestRun):
+  def __init__(self, env, test_instance):
+    super(LocalDevicePerfTestRun, self).__init__(env, test_instance)
+    self._devices = None
+    self._env = env
+    self._test_buckets = []
+    self._test_instance = test_instance
+    self._timeout = None if test_instance.no_timeout else 60 * 60
+
+  def SetUp(self):
+    self._devices = self._GetAllDevices(self._env.devices,
+                                        self._test_instance.known_devices_file)
+
+    if os.path.exists(constants.PERF_OUTPUT_DIR):
+      shutil.rmtree(constants.PERF_OUTPUT_DIR)
+    os.makedirs(constants.PERF_OUTPUT_DIR)
+
+  def TearDown(self):
+    pass
+
+  def _GetStepsFromDict(self):
+    # From where this is called one of these two must be set.
+    if not (self._test_instance.single_step or self._test_instance.steps):
+      raise PerfTestRunGetStepsError(

[jbudorick, 2016/07/06 19:12:10]

Just raise this at the end of the function w/o the if guard.

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+          'Neither single_step or steps set in test_instance.')
+    if self._test_instance.single_step:
+      return {
+          'version': 1,
+          'steps': {
+              'single_step': {
+                'device_affinity': 0,
+                'cmd': self._test_instance.single_step
+              },
+          }
+      }
+    if self._test_instance.steps:
+      with file(self._test_instance.steps, 'r') as f:
+        steps = json.load(f)
+        if steps['version'] != 1:
+          raise TestDictVersionError(
+              'Version is expected to be %d but was %d' % (1, steps['version']))
+        return steps
+
+  def _SplitTestsByAffinity(self):
+    # This splits tests by their device affinity; so that the same tests always
+    # run on the same devices. This is important for perf tests since different
+    # devices might yield slightly different performance results.
+    test_dict = self._GetStepsFromDict()
+    for test, test_config in test_dict['steps'].iteritems():
+      try:
+        affinity = test_config['device_affinity']
+        if len(self._test_buckets) < affinity + 1:
+          while len(self._test_buckets) != affinity + 1:
+            self._test_buckets.append({})
+        self._test_buckets[affinity][test] = test_config
+      except KeyError:
+        logging.exception(
+            'Test config for %s is bad.\n Config:%s', test, str(test_config))
+    return self._test_buckets

[jbudorick, 2016/07/06 19:12:10]

Why is this creating an instance variable and returning it?

[rnephew (Reviews Here), 2016/07/06 21:47:06]

Done.

+
+  @staticmethod
+  def _GetAllDevices(active_devices, devices_path):
+    try:
+      if devices_path:
+        devices = [device_utils.DeviceUtils(s)
+                   for s in device_list.GetPersistentDeviceList(devices_path)]
+        if not devices and active_devices:
+          logging.warning('%s is empty. Falling back to active devices.',
+                          devices_path)
+          devices = active_devices
+      else:
+        logging.warning('Known devices file path not being passed. For device '
+                        'affinity to work properly, it must be passed.')
+        devices = active_devices
+    except IOError as e:
+      logging.error('Unable to find %s [%s]', devices_path, e)
+      devices = active_devices
+    return sorted(devices)
+
+  def RunTests(self):
+    # Affinitize the tests.
+    test_buckets = self._SplitTestsByAffinity()
+    if not test_buckets:
+      raise local_device_test_run.NoTestsError()
+
+    blacklist = (device_blacklist.Blacklist(self._env.blacklist)
+                 if self._env.blacklist
+                 else None)
+
+    def run_perf_tests(x):
+      if device_status.IsBlacklisted(str(self._devices[x]), blacklist):
+        logging.warning('Device %s is not active. Will not create shard %s.',
+                        str(self._devices[x]), x)
+        return []
+      s = TestShard(self._env, self._test_instance, self._devices[x], x,
+                    test_buckets[x], retries=self._env.max_tries,
+                    timeout=self._timeout)
+      return s.RunTestsOnShard()
+
+    device_indices = range(min(len(self._devices), len(test_buckets)))
+    shards = parallelizer.Parallelizer(device_indices).pMap(run_perf_tests)
+    return list(itertools.chain.from_iterable(shards.pGet(self._timeout)))
+
+  # override
+  def TestPackage(self):
+    return 'perf'
+
+  # override
+  def _CreateShards(self, _tests):
+    raise NotImplementedError
+
+  # override
+  def _GetTests(self):
+    return self._test_buckets
+
+  # override
+  def _RunTest(self, _device, _test):
+    raise NotImplementedError
+
+  # override
+  def _ShouldShard(self):
+    return False
+
+
+class LocalDevicePerfTestRunOutputJsonList(LocalDevicePerfTestRun):
+  def SetUp(self):
+    pass
+
+  def RunTests(self):
+    return self._test_instance.RunOutputJsonList()
+
+  # override
+  def _CreateShards(self, _tests):
+    raise NotImplementedError
+
+  # override
+  def _RunTest(self, _device, _test):
+    raise NotImplementedError
+
+
+class LocalDevicePerfTestRunPrintStep(LocalDevicePerfTestRun):
+  def SetUp(self):
+    pass
+
+  def RunTests(self):
+    return self._test_instance.RunPrintStep()
+
+  # override
+  def _CreateShards(self, _tests):
+    raise NotImplementedError
+
+  # override
+  def _RunTest(self, _device, _test):
+    raise NotImplementedError
+
+
+class TestDictVersionError(Exception):
+  pass
+
+class PerfTestRunGetStepsError(Exception):
+  pass