testing/runcppunittests.py

   1 #!/usr/bin/env python
   2 #
   3 # This Source Code Form is subject to the terms of the Mozilla Public
   4 # License, v. 2.0. If a copy of the MPL was not distributed with this
   5 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   6
   7 from __future__ import with_statement
   8 import sys, os, tempfile, shutil
   9 from optparse import OptionParser
  10 import mozprocess, mozinfo, mozlog, mozcrash, mozfile
  11 from contextlib import contextmanager
  12
  13 log = mozlog.getLogger('cppunittests')
  14
  15 class CPPUnitTests(object):
  16     # Time (seconds) to wait for test process to complete
  17     TEST_PROC_TIMEOUT = 900
  18     # Time (seconds) in which process will be killed if it produces no output.
  19     TEST_PROC_NO_OUTPUT_TIMEOUT = 300
  20
  21     def run_one_test(self, prog, env, symbols_path=None):
  22         """
  23         Run a single C++ unit test program.
  24
  25         Arguments:
  26         * prog: The path to the test program to run.
  27         * env: The environment to use for running the program.
  28         * symbols_path: A path to a directory containing Breakpad-formatted
  29                         symbol files for producing stack traces on crash.
  30
  31         Return True if the program exits with a zero status, False otherwise.
  32         """
  33         basename = os.path.basename(prog)
  34         log.info("Running test %s", basename)
  35         with mozfile.TemporaryDirectory() as tempdir:
  36             proc = mozprocess.ProcessHandler([prog],
  37                                              cwd=tempdir,
  38                                              env=env)
  39             #TODO: After bug 811320 is fixed, don't let .run() kill the process,
  40             # instead use a timeout in .wait() and then kill to get a stack.
  41             proc.run(timeout=CPPUnitTests.TEST_PROC_TIMEOUT,
  42                      outputTimeout=CPPUnitTests.TEST_PROC_NO_OUTPUT_TIMEOUT)
  43             proc.wait()
  44             if proc.timedOut:
  45                 log.testFail("%s | timed out after %d seconds",
  46                              basename, CPPUnitTests.TEST_PROC_TIMEOUT)
  47                 return False
  48             if mozcrash.check_for_crashes(tempdir, symbols_path,
  49                                           test_name=basename):
  50                 log.testFail("%s | test crashed", basename)
  51                 return False
  52             result = proc.proc.returncode == 0
  53             if not result:
  54                 log.testFail("%s | test failed with return code %d",
  55                              basename, proc.proc.returncode)
  56             return result
  57
  58     def build_core_environment(self, env = {}):
  59         """
  60         Add environment variables likely to be used across all platforms, including remote systems.
  61         """
  62         env["MOZILLA_FIVE_HOME"] = self.xre_path
  63         env["MOZ_XRE_DIR"] = self.xre_path
  64         #TODO: switch this to just abort once all C++ unit tests have
  65         # been fixed to enable crash reporting
  66         env["XPCOM_DEBUG_BREAK"] = "stack-and-abort"
  67         env["MOZ_CRASHREPORTER_NO_REPORT"] = "1"
  68         env["MOZ_CRASHREPORTER"] = "1"
  69         return env
  70
  71     def build_environment(self):
  72         """
  73         Create and return a dictionary of all the appropriate env variables and values.
  74         On a remote system, we overload this to set different values and are missing things like os.environ and PATH.
  75         """
  76         if not os.path.isdir(self.xre_path):
  77             raise Exception("xre_path does not exist: %s", self.xre_path)
  78         env = dict(os.environ)
  79         env = self.build_core_environment(env)
  80         pathvar = ""
  81         if mozinfo.os == "linux":
  82             pathvar = "LD_LIBRARY_PATH"
  83         elif mozinfo.os == "mac":
  84             pathvar = "DYLD_LIBRARY_PATH"
  85         elif mozinfo.os == "win":
  86             pathvar = "PATH"
  87         if pathvar:
  88             if pathvar in env:
  89                 env[pathvar] = "%s%s%s" % (self.xre_path, os.pathsep, env[pathvar])
  90             else:
  91                 env[pathvar] = self.xre_path
  92
  93         # Use llvm-symbolizer for ASan if available/required
  94         llvmsym = os.path.join(self.xre_path, "llvm-symbolizer")
  95         if os.path.isfile(llvmsym):
  96             env["ASAN_SYMBOLIZER_PATH"] = llvmsym
  97             log.info("ASan using symbolizer at %s", llvmsym)
  98         else:
  99             log.info("Failed to find ASan symbolizer at %s", llvmsym)
 100
 101         return env
 102
 103     def run_tests(self, programs, xre_path, symbols_path=None):
 104         """
 105         Run a set of C++ unit test programs.
 106
 107         Arguments:
 108         * programs: An iterable containing paths to test programs.
 109         * xre_path: A path to a directory containing a XUL Runtime Environment.
 110         * symbols_path: A path to a directory containing Breakpad-formatted
 111                         symbol files for producing stack traces on crash.
 112
 113         Returns True if all test programs exited with a zero status, False
 114         otherwise.
 115         """
 116         self.xre_path = xre_path
 117         env = self.build_environment()
 118         pass_count = 0
 119         fail_count = 0
 120         for prog in programs:
 121             single_result = self.run_one_test(prog, env, symbols_path)
 122             if single_result:
 123                 pass_count += 1
 124             else:
 125                 fail_count += 1
 126
 127         log.info("Result summary:")
 128         log.info("Passed: %d" % pass_count)
 129         log.info("Failed: %d" % fail_count)
 130         return fail_count == 0
 131
 132 class CPPUnittestOptions(OptionParser):
 133     def __init__(self):
 134         OptionParser.__init__(self)
 135         self.add_option("--xre-path",
 136                         action = "store", type = "string", dest = "xre_path",
 137                         default = None,
 138                         help = "absolute path to directory containing XRE (probably xulrunner)")
 139         self.add_option("--symbols-path",
 140                         action = "store", type = "string", dest = "symbols_path",
 141                         default = None,
 142                         help = "absolute path to directory containing breakpad symbols, or the URL of a zip file containing symbols")
 143         self.add_option("--skip-manifest",
 144                         action = "store", type = "string", dest = "manifest_file",
 145                         default = None,
 146                         help = "absolute path to a manifest file")
 147
 148 def extract_unittests_from_args(args, manifest_file):
 149     """Extract unittests from args, expanding directories as needed"""
 150     progs = []
 151
 152     # Known files commonly packaged with the cppunittests that are not tests
 153     skipped_progs = set(['.mkdir.done', 'remotecppunittests.py', 'runcppunittests.py', 'runcppunittests.pyc'])
 154
 155     if manifest_file:
 156         skipped_progs.add(os.path.basename(manifest_file))
 157         with open(manifest_file) as f:
 158             for line in f:
 159                 # strip out comment, if any
 160                 prog = line.split('#')[0]
 161                 if prog:
 162                     skipped_progs.add(prog.strip())
 163
 164     for p in args:
 165         if os.path.isdir(p):
 166             progs.extend([os.path.abspath(os.path.join(p, x)) for x in os.listdir(p) if not x in skipped_progs])
 167         elif p not in skipped_progs:
 168             progs.append(os.path.abspath(p))
 169
 170     return progs
 171
 172 def main():
 173     parser = CPPUnittestOptions()
 174     options, args = parser.parse_args()
 175     if not args:
 176         print >>sys.stderr, """Usage: %s <test binary> [<test binary>...]""" % sys.argv[0]
 177         sys.exit(1)
 178     if not options.xre_path:
 179         print >>sys.stderr, """Error: --xre-path is required"""
 180         sys.exit(1)
 181
 182     progs = extract_unittests_from_args(args, options.manifest_file)
 183     options.xre_path = os.path.abspath(options.xre_path)
 184     tester = CPPUnitTests()
 185     try:
 186         result = tester.run_tests(progs, options.xre_path, options.symbols_path)
 187     except Exception, e:
 188         log.error(str(e))
 189         result = False
 190     sys.exit(0 if result else 1)
 191
 192 if __name__ == '__main__':
 193     main()
 194