[Android] Sets up a coverage system for java using EMMA

build/android/pylib/instrumentation/test_runner.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.
 
 """Class for running instrumentation tests on a single device."""
 
 import logging
 import os
 import re
 import shutil
@@ skipping 29 matching lines @@
     test_files += [
         'net/data/ssl/certificates/',
     ]
   return test_files
 
 
 class TestRunner(base_test_runner.BaseTestRunner):
   """Responsible for running a series of tests connected to a single device."""
 
   _DEVICE_DATA_DIR = 'chrome/test/data'
+  _DEVICE_COVERAGE_DIR = 'chrome/test/coverage'
   _HOSTMACHINE_PERF_OUTPUT_FILE = '/tmp/chrome-profile'
   _DEVICE_PERF_OUTPUT_SEARCH_PREFIX = (constants.DEVICE_PERF_OUTPUT_DIR +
                                        '/chrome-profile*')
   _DEVICE_HAS_TEST_FILES = {}
 
   def __init__(self, build_type, test_data, save_perf_json, screenshot_failures,
                tool, wait_for_debugger, disable_assertions, push_deps,
                cleanup_test_files, device, shard_index, test_pkg,
-               ports_to_forward):
+               ports_to_forward, coverage_dir):
     """Create a new TestRunner.
 
     Args:
       build_type: 'Release' or 'Debug'.
       test_data: Location of the test data.
       save_perf_json: Whether or not to save the JSON file from UI perf tests.
       screenshot_failures: Take a screenshot for a test failure
       tool: Name of the Valgrind tool.
       wait_for_debugger: Blocks until the debugger is connected.
       disable_assertions: Whether to disable java assertions on the device.
       push_deps: If True, push all dependencies to the device.
       cleanup_test_files: Whether or not to cleanup test files on device.
       device: Attached android device.
       shard_index: Shard index.
       test_pkg: A TestPackage object.
       ports_to_forward: A list of port numbers for which to set up forwarders.
                         Can be optionally requested by a test case.
+      coverage_dir: Directory to pull all EMMA coverage files into, or None if
+          coverage is not being used.
     """
     super(TestRunner, self).__init__(device, tool, build_type, push_deps,
                                      cleanup_test_files)
     self._lighttp_port = constants.LIGHTTPD_RANDOM_PORT_FIRST + shard_index
 
     self.build_type = build_type
     self.test_data = test_data
     self.save_perf_json = save_perf_json
     self.screenshot_failures = screenshot_failures
     self.wait_for_debugger = wait_for_debugger
     self.disable_assertions = disable_assertions
     self.test_pkg = test_pkg
     self.ports_to_forward = ports_to_forward
+    self.coverage_dir = coverage_dir
 
   #override
   def InstallTestPackage(self):
     self.test_pkg.Install(self.adb)
 
   #override
   def PushDataDeps(self):
     # TODO(frankf): Implement a general approach for copying/installing
     # once across test runners.
     if TestRunner._DEVICE_HAS_TEST_FILES.get(self.device, False):
       logging.warning('Already copied test files to device %s, skipping.',
                       self.device)
       return
 
     test_data = _GetDataFilesForTestSuite(self.test_pkg.GetApkName())
     if test_data:
       # Make sure SD card is ready.
       self.adb.WaitForSdCardReady(20)
       for p in test_data:
         self.adb.PushIfNeeded(
             os.path.join(constants.DIR_SOURCE_ROOT, p),
             os.path.join(self.adb.GetExternalStorage(), p))
 
     # TODO(frankf): Specify test data in this file as opposed to passing
     # as command-line.
     for dest_host_pair in self.test_data:
       dst_src = dest_host_pair.split(':',1)
       dst_layer = dst_src[0]
       host_src = dst_src[1]
-      host_test_files_path = constants.DIR_SOURCE_ROOT + '/' + host_src
+      host_test_files_path = '%s/%s' % (constants.DIR_SOURCE_ROOT, host_src)
       if os.path.exists(host_test_files_path):
-        self.adb.PushIfNeeded(host_test_files_path,
-                              self.adb.GetExternalStorage() + '/' +
-                              TestRunner._DEVICE_DATA_DIR + '/' + dst_layer)
+        self.adb.PushIfNeeded(host_test_files_path, '%s/%s/%s' % (
+            self.adb.GetExternalStorage(), TestRunner._DEVICE_DATA_DIR,
+            dst_layer))
     self.tool.CopyFiles()
     TestRunner._DEVICE_HAS_TEST_FILES[self.device] = True
 
   def _GetInstrumentationArgs(self):
     ret = {}
     if self.wait_for_debugger:
       ret['debug'] = 'true'
+    if self.coverage_dir:
+      ret['coverage'] = 'true'
+      ret['coverageFile'] = self.coverage_device_file
+
     return ret
 
   def _TakeScreenshot(self, test):
     """Takes a screenshot from the device."""
-    screenshot_name = os.path.join(constants.SCREENSHOTS_DIR, test + '.png')
+    screenshot_name = os.path.join(constants.SCREENSHOTS_DIR, '%s.png' % test)
     logging.info('Taking screenshot named %s', screenshot_name)
     self.adb.TakeScreenshot(screenshot_name)
 
   def SetUp(self):
     """Sets up the test harness and device before all tests are run."""
     super(TestRunner, self).SetUp()
     if not self.adb.IsRootEnabled():
       logging.warning('Unable to enable java asserts for %s, non rooted device',
                       self.device)
     else:
@@ skipping 19 matching lines @@
     Args:
       test: The name of the test that will be run.
     """
     self.SetupPerfMonitoringIfNeeded(test)
     self._SetupIndividualTestTimeoutScale(test)
     self.tool.SetupEnvironment()
 
     # Make sure the forwarder is still running.
     self.RestartHttpServerForwarderIfNecessary()
 
+    if self.coverage_dir:
+      coverage_basename = '%s.ec' % test
+      self.coverage_device_file = '%s/%s/%s' % (self.adb.GetExternalStorage(),
+                                                TestRunner._DEVICE_COVERAGE_DIR,
+                                                coverage_basename)
+      self.coverage_host_file = os.path.join(
+          self.coverage_dir, coverage_basename)
+
   def _IsPerfTest(self, test):
     """Determines whether a test is a performance test.
 
     Args:
       test: The name of the test to be checked.
 
     Returns:
       Whether the test is annotated as a performance test.
     """
     return _PERF_TEST_ANNOTATION in self.test_pkg.GetTestAnnotations(test)
@@ skipping 22 matching lines @@
     """
 
     self.tool.CleanUpEnvironment()
 
     # The logic below relies on the test passing.
     if not raw_result or raw_result.GetStatusCode():
       return
 
     self.TearDownPerfMonitoring(test)
 
+    if self.coverage_dir:
+      self.adb.Adb().Pull(self.coverage_device_file, self.coverage_host_file)
+      self.adb.RunShellCommand('rm %s' % self.coverage_device_file)

[frankf, 2013/08/01 19:57:41]

rm -f

[gkanwar1, 2013/08/07 19:24:56]

Done.

+
   def TearDownPerfMonitoring(self, test):
     """Cleans up performance monitoring if the specified test required it.
 
     Args:
       test: The name of the test that was just run.
     Raises:
       Exception: if there's anything wrong with the perf data.
     """
     if not self._IsPerfTest(test):
       return
@@ skipping 123 matching lines @@
         duration_ms = 0
       message = str(e)
       if not message:
         message = 'No information.'
       results.AddResult(test_result.InstrumentationTestResult(
           test, base_test_result.ResultType.CRASH, start_date_ms, duration_ms,
           log=message))
       raw_result = None
     self.TestTeardown(test, raw_result)
     return (results, None if results.DidRunPass() else test)