List Java Instru Test Information From JUnit Runner

build/android/pylib/instrumentation/instrumentation_test_instance.py

 # Copyright 2015 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 copy
+import json
 import logging
 import os
 import pickle
 import re
 
 from devil.android import apk_helper
+from devil.android import device_temp_file
 from devil.android import md5sum
 from pylib import constants
 from pylib.base import base_test_result
 from pylib.base import test_exception
 from pylib.base import test_instance
 from pylib.constants import host_paths
 from pylib.instrumentation import test_result
 from pylib.instrumentation import instrumentation_parser
 from pylib.utils import dexdump
 from pylib.utils import proguard
 from pylib.utils import shared_preference_utils
+from py_utils import tempfile_ext
 
 with host_paths.SysPath(host_paths.BUILD_COMMON_PATH):
   import unittest_util # pylint: disable=import-error
 
 # Ref: http://developer.android.com/reference/android/app/Activity.html
 _ACTIVITY_RESULT_CANCELED = 0
 _ACTIVITY_RESULT_OK = -1
 
 _COMMAND_LINE_PARAMETER = 'cmdlinearg-parameter'
 _DEFAULT_ANNOTATIONS = [
     'SmallTest', 'MediumTest', 'LargeTest', 'EnormousTest', 'IntegrationTest']
 _EXCLUDE_UNLESS_REQUESTED_ANNOTATIONS = [
     'DisabledTest', 'FlakyTest']
 _VALID_ANNOTATIONS = set(['Manual'] + _DEFAULT_ANNOTATIONS +
                          _EXCLUDE_UNLESS_REQUESTED_ANNOTATIONS)
 _EXTRA_DRIVER_TEST_LIST = (
     'org.chromium.test.driver.OnDeviceInstrumentationDriver.TestList')
 _EXTRA_DRIVER_TEST_LIST_FILE = (
     'org.chromium.test.driver.OnDeviceInstrumentationDriver.TestListFile')
 _EXTRA_DRIVER_TARGET_PACKAGE = (
     'org.chromium.test.driver.OnDeviceInstrumentationDriver.TargetPackage')
 _EXTRA_DRIVER_TARGET_CLASS = (
     'org.chromium.test.driver.OnDeviceInstrumentationDriver.TargetClass')
 _EXTRA_TIMEOUT_SCALE = (
     'org.chromium.test.driver.OnDeviceInstrumentationDriver.TimeoutScale')
+_EXTRA_TEST_LIST = (
+    'org.chromium.base.test.BaseChromiumAndroidJUnitRunner.TestList')
 
 _SKIP_PARAMETERIZATION = 'SkipCommandLineParameterization'
 _COMMANDLINE_PARAMETERIZATION = 'CommandLineParameter'
 _NATIVE_CRASH_RE = re.compile('(process|native) crash', re.IGNORECASE)
 _CMDLINE_NAME_SEGMENT_RE = re.compile(
     r' with(?:out)? \{[^\}]*\}')
 _PICKLE_FORMAT_VERSION = 12
 
 
 class MissingSizeAnnotationError(test_exception.TestException):
@@ skipping 97 matching lines @@
 
   return results
 
 
 def FilterTests(tests, test_filter=None, annotations=None,
                 excluded_annotations=None):
   """Filter a list of tests
 
   Args:
     tests: a list of tests. e.g. [
-           {'annotations": {}, 'class': 'com.example.TestA', 'methods':[]},
-           {'annotations": {}, 'class': 'com.example.TestB', 'methods':[]}]
+           {'annotations": {}, 'class': 'com.example.TestA', 'method':'test1'},
+           {'annotations": {}, 'class': 'com.example.TestB', 'method':'test2'}]
     test_filter: googletest-style filter string.
     annotations: a dict of wanted annotations for test methods.
     exclude_annotations: a dict of annotations to exclude.
 
   Return:
     A list of filtered tests
   """
   def gtest_filter(t):
     if not test_filter:
       return True
     # Allow fully-qualified name as well as an omitted package.
     unqualified_class_test = {
       'class': t['class'].split('.')[-1],
       'method': t['method']
     }
     names = [
       GetTestName(t, sep='.'),
       GetTestName(unqualified_class_test, sep='.'),
       GetUniqueTestName(t, sep='.')
     ]
 
+    if t['is_junit4']:
+      names += [
+          GetTestNameWithoutParameterPostfix(t, sep='.'),
+          GetTestNameWithoutParameterPostfix(unqualified_class_test, sep='.')
+      ]
+
     pattern_groups = test_filter.split('-')
     if len(pattern_groups) > 1:
       negative_filter = pattern_groups[1]
       if unittest_util.FilterTestNames(names, negative_filter):
         return []
 
     positive_filter = pattern_groups[0]
     return unittest_util.FilterTestNames(names, positive_filter)
 
   def annotation_filter(all_annotations):
@@ skipping 34 matching lines @@
 
     if (not annotation_filter(t['annotations'])
         or not excluded_annotation_filter(t['annotations'])):
       continue
 
     filtered_tests.append(t)
 
   return filtered_tests
 
 
+def GetAllTestsFromRunner(device, test_apk, test_package,
+                          test_runner=None, test_runner_junit4=None):
+  pickle_path = '%s-runner.pickle' % test_apk.path
+  try:
+    tests = _GetTestsFromPickle(pickle_path, test_apk.path)
+  except TestListPickleException as e:
+    logging.info('Could not get tests from pickle: %s', e)
+    logging.info('Getting tests by print tests in instrumentation runner')
+    tests = _GetAllTestsFromRunner(device, test_package, test_runner,
+                                   test_runner_junit4)
+    _SaveTestsToPickle(pickle_path, test_apk.path, tests)
+  return tests
+
+
+# TODO(yolandyan): remove this once the tests are converted to junit4
 def GetAllTestsFromJar(test_jar):
   pickle_path = '%s-proguard.pickle' % test_jar
   try:
     tests = _GetTestsFromPickle(pickle_path, test_jar)
   except TestListPickleException as e:
     logging.info('Could not get tests from pickle: %s', e)
     logging.info('Getting tests from JAR via proguard.')
     tests = _GetTestsFromProguard(test_jar)
     _SaveTestsToPickle(pickle_path, test_jar, tests)
   return tests
@@ skipping 77 matching lines @@
     for class_name, class_info in package_info['classes'].iteritems():
       if class_name.endswith('Test'):
         tests.append({
             'class': '%s.%s' % (package_name, class_name),
             'annotations': {},
             'methods': get_test_methods(class_info['methods']),
             'superclass': class_info['superclass'],
         })
   return tests
 
+def _GetAllTestsFromRunner(device, test_package, test_runner=None,
+                           test_runner_junit4=None):
+  with device_temp_file.DeviceTempFile(
+      device.adb, suffix='.json', dir=device.GetExternalStoragePath()) as f:
+    if test_runner is None and test_runner_junit4 is None:

[mikecase (-- gone --), 2017/07/18 23:59:12]

test_runner basically unused here.

[the real yoland, 2017/07/19 00:12:49]

Removed

+      raise Exception('Test runner does NOT exist for this test apk')
+    if test_runner_junit4:
+      extras = {}
+      extras[_EXTRA_TEST_LIST] = f.name
+      extras['log'] = 'true'
+      extras['package'] = 'org.chromium'

[mikecase (-- gone --), 2017/07/18 23:59:12]

so this won't work downstream right? I think some of the tests have
com.google.android package.

[the real yoland, 2017/07/19 00:12:49]

Changed
This is just for the sake of speed up java class lookup

+      target = '%s/%s' % (test_package, test_runner_junit4)
+      output_string = ''.join(device.StartInstrumentation(
+          target, extras=extras, timeout=30, retries=2))
+      if output_string:
+        raise Exception('Test listing through %s failed on device:\n%s' % (
+            test_runner_junit4, output_string))
+    else:
+      raise Exception('JUnit4 Runner is not present in this apk')
+    with tempfile_ext.NamedTemporaryDirectory() as host_dir:
+      host_file = os.path.join(host_dir, 'list_tests.json')
+      device.PullFile(f.name, host_file)
+      with open(host_file, 'r') as host_file:
+        json_string = host_file.read()
+        return json.loads(json_string)
+
 
 def _SaveTestsToPickle(pickle_path, jar_path, tests):
   jar_md5 = md5sum.CalculateHostMd5Sums(jar_path)[jar_path]
   pickle_data = {
     'VERSION': _PICKLE_FORMAT_VERSION,
     'JAR_MD5SUM': jar_md5,
     'TEST_METHODS': tests,
   }
   with open(pickle_path, 'w') as pickle_file:
     pickle.dump(pickle_data, pickle_file)
@@ skipping 23 matching lines @@
 
   Args:
     test: the instrumentation test dict.
     sep: the character(s) that should join the class name and the method name.
   Returns:
     The test name as a string.
   """
   return '%s%s%s' % (test['class'], sep, test['method'])
 
 
+def GetTestNameWithoutParameterPostfix(
+      test, sep='#', parameter_postfix='__'):

[mikecase (-- gone --), 2017/07/18 23:59:12]

prefix? Or is it more of a parameter_postfix_prefix? jk

[the real yoland, 2017/07/19 00:12:49]

woah troll

+  """Gets the name of the given JUnit4 test withouth parameter postfix.

[mikecase (-- gone --), 2017/07/18 23:59:12]

withouth

[the real yoland, 2017/07/19 00:12:49]

Done

+
+  For most WebView JUnit4 javatests, each test is parameterizatized with
+  "__sandboxed_mode" to run in both non-sandboxed mode and sandboxed mode.
+
+  This function returns the name of the test without parameterization
+  so test filters can match both parameterized and non-parameterized tests.
+
+  Args:
+    test: the instrumentation test dict.
+    sep: the character(s) that should join the class name and the method name.
+    parameterization_sep: the character(s) that seperate method name and method

[mikecase (-- gone --), 2017/07/18 23:59:11]

Update this variable name to what is actually is.

parameterization_sep -> parameter_postfix_prefix

[the real yoland, 2017/07/19 00:12:49]

Done

+                          parameterization postfix.
+  Returns:
+    The test name without parameter postfix as a string.
+  """
+  name = GetTestName(test, sep=sep)
+  return name.split(parameter_postfix)[0]
+
+
 def GetUniqueTestName(test, sep='#'):
   """Gets the unique name of the given test.
 
   This will include text to disambiguate between tests for which GetTestName
   would return the same name.
 
   Args:
     test: the instrumentation test dict.
     sep: the character(s) that should join the class name and the method name.
   Returns:
@@ skipping 369 matching lines @@
     return 'instrumentation'
 
   #override
   def SetUp(self):
     self._data_deps.extend(
         self._data_deps_delegate(self._runtime_deps_path))
 
   def GetDataDependencies(self):
     return self._data_deps
 
-  def GetTests(self):
-    if self.test_jar:
+  def GetTests(self, device=None):
+    if self._test_runner_junit4:
+      tests = GetAllTestsFromRunner(
+          device, self.test_apk, self.test_package,
+          test_runner=self._test_runner,
+          test_runner_junit4=self.test_runner_junit4)
+    elif self.test_jar:
       tests = GetAllTestsFromJar(self.test_jar)
     else:
       tests = GetAllTestsFromApk(self.test_apk.path)
     inflated_tests = self._ParameterizeTestsWithFlags(self._InflateTests(tests))
     if self._test_runner_junit4 is None and any(
         t['is_junit4'] for t in inflated_tests):
       raise MissingJUnit4RunnerException()
     filtered_tests = FilterTests(
         inflated_tests, self._test_filter, self._annotations,
         self._excluded_annotations)
@@ skipping 57 matching lines @@
 
   @staticmethod
   def GenerateTestResults(
       result_code, result_bundle, statuses, start_ms, duration_ms):
     return GenerateTestResults(result_code, result_bundle, statuses,
                                start_ms, duration_ms)
 
   #override
   def TearDown(self):
     pass