Bug 1318091 - Add android support for gtest; r= draft
authorGeoff Brown <gbrown@mozilla.com>
Mon, 25 Feb 2019 16:40:11 -0700
changeset 1859133 23fe2439d827297f6e8ea04ec5f3d00150dda028
parent 1858678 78601cacfe69dc8659c3fe7cd3eb94366aa3d680
child 1859134 00fb2318d6ab625f0db81186255ea0687ac29f5e
push id339244
push usergbrown@mozilla.com
push dateTue, 05 Mar 2019 18:35:05 +0000
treeherdertry@00fb2318d6ab [default view] [failures only]
bugs1318091
milestone67.0a1
Bug 1318091 - Add android support for gtest; r=
moz.configure
taskcluster/ci/test/compiled.yml
taskcluster/ci/test/test-sets.yml
testing/gtest/remotegtests.py
testing/mozharness/configs/android/android_common.py
testing/mozharness/scripts/android_emulator_unittest.py
--- a/moz.configure
+++ b/moz.configure
@@ -312,17 +312,17 @@ option('--disable-gtest-in-build',
 # Determine whether to build the gtest xul. This happens in automation
 # on Desktop platforms with the exception of Windows PGO, where linking
 # xul-gtest.dll takes too long.
 @depends('MOZ_PGO', build_project, target, 'MOZ_AUTOMATION', '--disable-gtest-in-build',
          enable_tests, when='--enable-compile-environment')
 def build_gtest(pgo, build_project, target, automation, enabled, enable_tests):
     if not enable_tests or not enabled:
         return None
-    if (automation and build_project == 'browser' and
+    if (automation and build_project in ('browser', 'mobile/android') and
         not (pgo and target.os == 'WINNT')):
         return True
 
 set_config('LINK_GTEST_DURING_COMPILE', build_gtest)
 
 # Localization
 # ==============================================================
 option('--enable-ui-locale', default='en-US',
--- a/taskcluster/ci/test/compiled.yml
+++ b/taskcluster/ci/test/compiled.yml
@@ -3,19 +3,22 @@ job-defaults:
     mozharness:
         script:
             by-test-platform:
                 android-em.*: android_emulator_unittest.py
                 android-hw.*: android_hardware_unittest.py
                 default: desktop_unittest.py
         config:
             by-test-platform:
-                android-em.*:
+                android-em-4.*:
                     - android/android_common.py
                     - android/androidarm_4_3.py
+                android-em-7.*:
+                    - android/android_common.py
+                    - android/androidx86_7_0.py
                 android-hw.*:
                     - android/android_common.py
                     - android/android_hw.py
                 linux.*:
                     - unittests/linux_unittest.py
                     - remove_executables.py
                 macosx.*:
                     - unittests/mac_unittest.py
--- a/taskcluster/ci/test/test-sets.yml
+++ b/taskcluster/ci/test/test-sets.yml
@@ -374,16 +374,17 @@ android-opt-tests:
 android-x86_64-opt-tests:
     # crashtests failing on debug; bug 1524493
     - crashtest
     # geckoview-junit perma-fail on opt and debug; bug 1521195
     # - geckoview-junit
     - mochitest
 
 android-x86_64-tests:
+    - gtest
     - jsreftest
     - mochitest-clipboard
     - mochitest-gpu
     # various reftest (plain) failures; bug 1501582
     # - reftest
 
 android-x86-tests:
     - web-platform-tests
new file mode 100644
--- /dev/null
+++ b/testing/gtest/remotegtests.py
@@ -0,0 +1,180 @@
+#!/usr/bin/env python
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from __future__ import with_statement
+
+from optparse import OptionParser
+import os
+import sys
+
+import mozcrash
+import mozinfo
+import mozlog
+import mozprocess
+from mozrunner.utils import get_stack_fixer_function
+
+import rungtests as gtests
+
+log = mozlog.unstructured.getLogger('gtest')
+
+
+class RemoteGTests(gtests):
+    # Time (seconds) to wait for test process to complete
+    TEST_PROC_TIMEOUT = 1200
+    # Time (seconds) in which process will be killed if it produces no output.
+    TEST_PROC_NO_OUTPUT_TIMEOUT = 300
+
+    def run_gtest(self, prog, xre_path, cwd, symbols_path=None,
+                  utility_path=None):
+        """
+        Run a single C++ unit test program.
+
+        Arguments:
+        * prog: The path to the test program to run.
+        * env: The environment to use for running the program.
+        * cwd: The directory to run tests from (support files will be found
+               in this direcotry).
+        * symbols_path: A path to a directory containing Breakpad-formatted
+                        symbol files for producing stack traces on crash.
+        * utility_path: A path to a directory containing utility programs.
+                        currently used to locate a stack fixer to provide
+                        symbols symbols for assertion stacks.
+
+        Return True if the program exits with a zero status, False otherwise.
+        """
+        self.xre_path = xre_path
+        env = self.build_environment()
+        log.info("Running gtest")
+
+        if cwd and not os.path.isdir(cwd):
+            os.makedirs(cwd)
+
+        stream_output = mozprocess.StreamOutput(sys.stdout)
+        process_output = stream_output
+        if utility_path:
+            stack_fixer = get_stack_fixer_function(utility_path, symbols_path)
+            if stack_fixer:
+                def f(line): return stream_output(stack_fixer(line))
+                process_output = f
+
+        proc = mozprocess.ProcessHandler([prog, "-unittest",
+                                         "--gtest_death_test_style=threadsafe"],
+                                         cwd=cwd,
+                                         env=env,
+                                         processOutputLine=process_output)
+        # TODO: After bug 811320 is fixed, don't let .run() kill the process,
+        # instead use a timeout in .wait() and then kill to get a stack.
+        proc.run(timeout=GTests.TEST_PROC_TIMEOUT,
+                 outputTimeout=GTests.TEST_PROC_NO_OUTPUT_TIMEOUT)
+        proc.wait()
+        if proc.timedOut:
+            if proc.outputTimedOut:
+                log.testFail("gtest | timed out after %d seconds without output",
+                             GTests.TEST_PROC_NO_OUTPUT_TIMEOUT)
+            else:
+                log.testFail("gtest | timed out after %d seconds",
+                             GTests.TEST_PROC_TIMEOUT)
+            return False
+        if mozcrash.check_for_crashes(cwd, symbols_path, test_name="gtest"):
+            # mozcrash will output the log failure line for us.
+            return False
+        result = proc.proc.returncode == 0
+        if not result:
+            log.testFail("gtest | test failed with return code %d", proc.proc.returncode)
+        return result
+
+    def build_core_environment(self, env={}):
+        """
+        Add environment variables likely to be used across all platforms, including remote systems.
+        """
+        env["MOZ_XRE_DIR"] = self.xre_path
+        env["MOZ_GMP_PATH"] = os.pathsep.join(
+            os.path.join(self.xre_path, p, "1.0")
+            for p in ('gmp-fake', 'gmp-fakeopenh264')
+        )
+        env["XPCOM_DEBUG_BREAK"] = "stack-and-abort"
+        env["MOZ_CRASHREPORTER_NO_REPORT"] = "1"
+        env["MOZ_CRASHREPORTER"] = "1"
+        env["MOZ_RUN_GTEST"] = "1"
+        # Normally we run with GTest default output, override this to use the TBPL test format.
+        env["MOZ_TBPL_PARSER"] = "1"
+
+        if not mozinfo.has_sandbox:
+            # Bug 1082193 - This is horrible. Our linux build boxes run CentOS 6,
+            # which is too old to support sandboxing. Disable sandbox for gtests
+            # on machines which don't support sandboxing until they can be
+            # upgraded, or gtests are run on test machines instead.
+            env["MOZ_DISABLE_GMP_SANDBOX"] = "1"
+
+        return env
+
+    def build_environment(self):
+        """
+        Create and return a dictionary of all the appropriate env variables
+        and values. On a remote system, we overload this to set different
+        values and are missing things like os.environ and PATH.
+        """
+        if not os.path.isdir(self.xre_path):
+            raise Exception("xre_path does not exist: %s", self.xre_path)
+        env = dict(os.environ)
+        env = self.build_core_environment(env)
+        env["PERFHERDER_ALERTING_ENABLED"] = "1"
+        pathvar = ""
+        if mozinfo.os == "linux":
+            pathvar = "LD_LIBRARY_PATH"
+            # disable alerts for unstable tests (Bug 1369807)
+            del env["PERFHERDER_ALERTING_ENABLED"]
+        elif mozinfo.os == "mac":
+            pathvar = "DYLD_LIBRARY_PATH"
+        elif mozinfo.os == "win":
+            pathvar = "PATH"
+        if pathvar:
+            if pathvar in env:
+                env[pathvar] = "%s%s%s" % (self.xre_path, os.pathsep, env[pathvar])
+            else:
+                env[pathvar] = self.xre_path
+
+        return env
+
+
+class remoteGtestOptions(gtests.gtestOptions):
+    def __init__(self):
+        gtests.gtestOptions.__init__(self)
+        self.add_option("--package",
+                        dest="package",
+                        default="org.mozilla.geckoview.test",
+                        help="package name of test app")
+
+
+def main():
+    parser = remoteGtestOptions()
+    options, args = parser.parse_args()
+    if not options.package:
+        print >>sys.stderr, """Error: --package is required"""
+        sys.exit(1)
+    if not options.xre_path:
+        print >>sys.stderr, """Error: --xre-path is required"""
+        sys.exit(1)
+    if not options.utility_path:
+        print >>sys.stderr, """Warning: --utility-path is required to process assertion stacks"""
+
+    gtests.update_mozinfo()
+    prog = os.path.abspath(args[0])
+    options.xre_path = os.path.abspath(options.xre_path)
+    tester = RemoteGTests()
+    try:
+        result = tester.run_gtest(prog, options.xre_path,
+                                  options.cwd,
+                                  symbols_path=options.symbols_path,
+                                  utility_path=options.utility_path)
+    except Exception, e:
+        log.error(str(e))
+        result = False
+    sys.exit(0 if result else 1)
+
+
+if __name__ == '__main__':
+    main()
--- a/testing/mozharness/configs/android/android_common.py
+++ b/testing/mozharness/configs/android/android_common.py
@@ -344,11 +344,24 @@ config = {
                 "--remote-webserver=%(remote_webserver)s",
                 "--symbols-path=%(symbols_path)s",
                 "--utility-path=%(utility_path)s",
                 "--deviceSerial=%(device_serial)s",
                 "--log-raw=%(raw_log_file)s",
                 "--log-raw-level=%(log_raw_level)s",
             ],
         },
+        "gtest": {
+            "run_filename": "remotegtests.py",
+            "testsdir": "gtest",
+            "install": False,
+            "options": [
+                "--symbols-path=%(symbols_path)s",
+                "--utility-path=%(utility_path)s",
+                "--xre-path=%(xre_path)s",
+                "--cwd=%(gtest_dir)s",
+                "--package=%(app)s",
+                # "--deviceSerial=%(device_serial)s",
+            ],
+        },
 
     },  # end suite_definitions
 }
--- a/testing/mozharness/scripts/android_emulator_unittest.py
+++ b/testing/mozharness/scripts/android_emulator_unittest.py
@@ -220,16 +220,17 @@ class AndroidEmulatorTest(TestingMixin, 
             # marionette options
             'address': c.get('marionette_address'),
             'marionette_extra': c.get('marionette_extra', ''),
             'xpcshell_extra': c.get('xpcshell_extra', ''),
             'test_manifest': os.path.join(
                 dirs['abs_marionette_tests_dir'],
                 self.config.get('marionette_test_manifest', '')
             ),
+            'gtest_dir': os.path.join(dirs['abs_test_install_dir'], 'gtest'),
         }
 
         user_paths = json.loads(os.environ.get('MOZHARNESS_TEST_PATHS', '""'))
 
         for option in self.config["suite_definitions"][self.test_suite]["options"]:
             opt = option.split('=')[0]
             # override configured chunk options with script args, if specified
             if opt in ('--this-chunk', '--total-chunks'):