[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, install_apk, 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, coverage_dir):
     """Create a new TestRunner.
 
     Args:
       build_type: 'Release' or 'Debug'.
       test_data: Location of the test data.
       install_apk: Re-installs the apk if opted.
       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: If True, instrument with EMMA coverage tool.
+      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.install_apk = install_apk
+    self.coverage = coverage
+    self.coverage_dir = coverage_dir
 
   #override
   def InstallTestPackage(self):
     if self.install_apk:
       self.test_pkg.Install(self.adb)
 
   #override
   def PushDataDeps(self):
     # TODO(frankf): Implement a general approach for copying/installing
     # once across test runners.
@@ skipping 18 matching lines @@
       dst_layer = dst_src[0]
       host_src = dst_src[1]
       host_test_files_path = 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.tool.CopyFiles()
     TestRunner._DEVICE_HAS_TEST_FILES[self.device] = True
 
-  def _GetInstrumentationArgs(self):
+  def _GetInstrumentationArgs(self, test):

[frankf, 2013/07/25 18:53:44]

where test used?

[gkanwar1, 2013/07/25 19:06:38]

Oops, this a remnant of something else I was doing here. Removed.

     ret = {}
     if self.wait_for_debugger:
       ret['debug'] = 'true'
+    if self.coverage:
+      ret['coverage'] = 'true'
+      ret['coverageFile'] = self.coverage_file
+
     return ret
 
   def _TakeScreenshot(self, test):
     """Takes a screenshot from the device."""
     screenshot_name = os.path.join(constants.SCREENSHOTS_DIR, test + '.png')
     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."""
@@ skipping 24 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:
+      self.coverage_basename = test + '.ec'

[frankf, 2013/07/25 18:53:44]

Use string formatter: '%s.ec' % test
also below

[gkanwar1, 2013/07/25 19:06:38]

Done. Fixed in several other places in this file also.

+      self.coverage_file = (self.adb.GetExternalStorage() + '/' +

[frankf, 2013/07/25 18:53:44]

-> coverage_device_file

[gkanwar1, 2013/07/25 19:06:38]

Done.

+                            TestRunner._DEVICE_COVERAGE_DIR + '/' +
+                            self.coverage_basename)

[frankf, 2013/07/25 18:53:44]

define coverage_host_file here

[gkanwar1, 2013/07/25 19:06:38]

Done.

+
   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:
+      self.adb.Adb().Pull(self.coverage_file, os.path.join(
+          self.coverage_dir, self.coverage_basename))
+      self.adb.RunShellCommand('rm %s' % self.coverage_file)
+
   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 72 matching lines @@
     if 'LargeTest' in annotations or _PERF_TEST_ANNOTATION in annotations:
       return 5 * 60
     if 'MediumTest' in annotations:
       return 3 * 60
     return 1 * 60
 
   def _RunTest(self, test, timeout):
     try:
       return self.adb.RunInstrumentationTest(
           test, self.test_pkg.GetPackageName(),
-          self._GetInstrumentationArgs(), timeout)
+          self._GetInstrumentationArgs(test), timeout)
     except android_commands.errors.WaitForResponseTimedOutError:
       logging.info('Ran the test with timeout of %ds.' % timeout)
       raise
 
   #override
   def RunTest(self, test):
     raw_result = None
     start_date_ms = None
     results = base_test_result.TestRunResults()
     timeout=(self._GetIndividualTestTimeoutSecs(test) *
@@ skipping 30 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)