mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-29 03:44:37 +00:00
348 lines
14 KiB
Python
348 lines
14 KiB
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/.
|
|
|
|
# Integrates the xpcshell test runner with mach.
|
|
|
|
from __future__ import unicode_literals, print_function
|
|
|
|
import mozpack.path
|
|
import logging
|
|
import os
|
|
import shutil
|
|
import sys
|
|
|
|
from StringIO import StringIO
|
|
|
|
from mozbuild.base import (
|
|
MachCommandBase,
|
|
MozbuildObject,
|
|
MachCommandConditions as conditions,
|
|
)
|
|
|
|
from mach.decorators import (
|
|
CommandArgument,
|
|
CommandProvider,
|
|
Command,
|
|
)
|
|
|
|
|
|
if sys.version_info[0] < 3:
|
|
unicode_type = unicode
|
|
else:
|
|
unicode_type = str
|
|
|
|
# Simple filter to omit the message emitted as a test file begins.
|
|
class TestStartFilter(logging.Filter):
|
|
def filter(self, record):
|
|
return not record.params['msg'].endswith("running test ...")
|
|
|
|
# This should probably be consolidated with similar classes in other test
|
|
# runners.
|
|
class InvalidTestPathError(Exception):
|
|
"""Exception raised when the test path is not valid."""
|
|
|
|
|
|
class XPCShellRunner(MozbuildObject):
|
|
"""Run xpcshell tests."""
|
|
def run_suite(self, **kwargs):
|
|
manifest = os.path.join(self.topobjdir, '_tests', 'xpcshell',
|
|
'xpcshell.ini')
|
|
|
|
return self._run_xpcshell_harness(manifest=manifest, **kwargs)
|
|
|
|
def run_test(self, test_file, interactive=False,
|
|
keep_going=False, sequential=False, shuffle=False,
|
|
debugger=None, debuggerArgs=None, debuggerInteractive=None,
|
|
rerun_failures=False,
|
|
# ignore parameters from other platforms' options
|
|
**kwargs):
|
|
"""Runs an individual xpcshell test."""
|
|
# TODO Bug 794506 remove once mach integrates with virtualenv.
|
|
build_path = os.path.join(self.topobjdir, 'build')
|
|
if build_path not in sys.path:
|
|
sys.path.append(build_path)
|
|
|
|
if test_file == 'all':
|
|
self.run_suite(interactive=interactive,
|
|
keep_going=keep_going, shuffle=shuffle, sequential=sequential,
|
|
debugger=debugger, debuggerArgs=debuggerArgs,
|
|
debuggerInteractive=debuggerInteractive,
|
|
rerun_failures=rerun_failures)
|
|
return
|
|
|
|
path_arg = self._wrap_path_argument(test_file)
|
|
|
|
test_obj_dir = os.path.join(self.topobjdir, '_tests', 'xpcshell',
|
|
path_arg.relpath())
|
|
if os.path.isfile(test_obj_dir):
|
|
test_obj_dir = mozpack.path.dirname(test_obj_dir)
|
|
|
|
xpcshell_dirs = []
|
|
for base, dirs, files in os.walk(test_obj_dir):
|
|
if os.path.exists(mozpack.path.join(base, 'xpcshell.ini')):
|
|
xpcshell_dirs.append(base)
|
|
|
|
if not xpcshell_dirs:
|
|
raise InvalidTestPathError('An xpcshell.ini could not be found '
|
|
'for the passed test path. Please select a path whose '
|
|
'directory or subdirectories contain an xpcshell.ini file. '
|
|
'It is possible you received this error because the tree is '
|
|
'not built or tests are not enabled.')
|
|
|
|
args = {
|
|
'interactive': interactive,
|
|
'keep_going': keep_going,
|
|
'shuffle': shuffle,
|
|
'sequential': sequential,
|
|
'test_dirs': xpcshell_dirs,
|
|
'debugger': debugger,
|
|
'debuggerArgs': debuggerArgs,
|
|
'debuggerInteractive': debuggerInteractive,
|
|
'rerun_failures': rerun_failures
|
|
}
|
|
|
|
if os.path.isfile(path_arg.srcdir_path()):
|
|
args['test_path'] = mozpack.path.basename(path_arg.srcdir_path())
|
|
|
|
return self._run_xpcshell_harness(**args)
|
|
|
|
def _run_xpcshell_harness(self, test_dirs=None, manifest=None,
|
|
test_path=None, shuffle=False, interactive=False,
|
|
keep_going=False, sequential=False,
|
|
debugger=None, debuggerArgs=None, debuggerInteractive=None,
|
|
rerun_failures=False):
|
|
|
|
# Obtain a reference to the xpcshell test runner.
|
|
import runxpcshelltests
|
|
|
|
dummy_log = StringIO()
|
|
xpcshell = runxpcshelltests.XPCShellTests(log=dummy_log)
|
|
self.log_manager.enable_unstructured()
|
|
|
|
xpcshell_filter = TestStartFilter()
|
|
self.log_manager.terminal_handler.addFilter(xpcshell_filter)
|
|
|
|
tests_dir = os.path.join(self.topobjdir, '_tests', 'xpcshell')
|
|
modules_dir = os.path.join(self.topobjdir, '_tests', 'modules')
|
|
|
|
args = {
|
|
'xpcshell': os.path.join(self.bindir, 'xpcshell'),
|
|
'mozInfo': os.path.join(self.topobjdir, 'mozinfo.json'),
|
|
'symbolsPath': os.path.join(self.distdir, 'crashreporter-symbols'),
|
|
'interactive': interactive,
|
|
'keepGoing': keep_going,
|
|
'logfiles': False,
|
|
'sequential': sequential,
|
|
'shuffle': shuffle,
|
|
'testsRootDir': tests_dir,
|
|
'testingModulesDir': modules_dir,
|
|
'profileName': 'firefox',
|
|
'verbose': test_path is not None,
|
|
'xunitFilename': os.path.join(self.statedir, 'xpchsell.xunit.xml'),
|
|
'xunitName': 'xpcshell',
|
|
'pluginsPath': os.path.join(self.distdir, 'plugins'),
|
|
'debugger': debugger,
|
|
'debuggerArgs': debuggerArgs,
|
|
'debuggerInteractive': debuggerInteractive,
|
|
'on_message': (lambda obj, msg: xpcshell.log.info(msg.decode('utf-8', 'replace'))) \
|
|
if test_path is not None else None,
|
|
}
|
|
|
|
if manifest is not None:
|
|
args['manifest'] = manifest
|
|
elif test_dirs is not None:
|
|
if isinstance(test_dirs, list):
|
|
args['testdirs'] = test_dirs
|
|
else:
|
|
args['testdirs'] = [test_dirs]
|
|
else:
|
|
raise Exception('One of test_dirs or manifest must be provided.')
|
|
|
|
if test_path is not None:
|
|
args['testPath'] = test_path
|
|
|
|
# A failure manifest is written by default. If --rerun-failures is
|
|
# specified and a prior failure manifest is found, the prior manifest
|
|
# will be run. A new failure manifest is always written over any
|
|
# prior failure manifest.
|
|
failure_manifest_path = os.path.join(self.statedir, 'xpcshell.failures.ini')
|
|
rerun_manifest_path = os.path.join(self.statedir, 'xpcshell.rerun.ini')
|
|
if os.path.exists(failure_manifest_path) and rerun_failures:
|
|
shutil.move(failure_manifest_path, rerun_manifest_path)
|
|
args['manifest'] = rerun_manifest_path
|
|
elif os.path.exists(failure_manifest_path):
|
|
os.remove(failure_manifest_path)
|
|
elif rerun_failures:
|
|
print("No failures were found to re-run.")
|
|
return 0
|
|
args['failureManifest'] = failure_manifest_path
|
|
|
|
# Python through 2.7.2 has issues with unicode in some of the
|
|
# arguments. Work around that.
|
|
filtered_args = {}
|
|
for k, v in args.items():
|
|
if isinstance(v, unicode_type):
|
|
v = v.encode('utf-8')
|
|
|
|
if isinstance(k, unicode_type):
|
|
k = k.encode('utf-8')
|
|
|
|
filtered_args[k] = v
|
|
|
|
result = xpcshell.runTests(**filtered_args)
|
|
|
|
self.log_manager.terminal_handler.removeFilter(xpcshell_filter)
|
|
self.log_manager.disable_unstructured()
|
|
|
|
if not result and not xpcshell.sequential:
|
|
print("Tests were run in parallel. Try running with --sequential "
|
|
"to make sure the failures were not caused by this.")
|
|
return int(not result)
|
|
|
|
class AndroidXPCShellRunner(MozbuildObject):
|
|
"""Get specified DeviceManager"""
|
|
def get_devicemanager(self, devicemanager, ip, port, remote_test_root):
|
|
from mozdevice import devicemanagerADB, devicemanagerSUT
|
|
dm = None
|
|
if devicemanager == "adb":
|
|
if ip:
|
|
dm = devicemanagerADB.DeviceManagerADB(ip, port, packageName=None, deviceRoot=remote_test_root)
|
|
else:
|
|
dm = devicemanagerADB.DeviceManagerADB(packageName=None, deviceRoot=remote_test_root)
|
|
else:
|
|
if ip:
|
|
dm = devicemanagerSUT.DeviceManagerSUT(ip, port, deviceRoot=remote_test_root)
|
|
else:
|
|
raise Exception("You must provide a device IP to connect to via the --ip option")
|
|
return dm
|
|
|
|
"""Run Android xpcshell tests."""
|
|
def run_test(self,
|
|
test_file, keep_going,
|
|
devicemanager, ip, port, remote_test_root, no_setup, local_apk,
|
|
# ignore parameters from other platforms' options
|
|
**kwargs):
|
|
# TODO Bug 794506 remove once mach integrates with virtualenv.
|
|
build_path = os.path.join(self.topobjdir, 'build')
|
|
if build_path not in sys.path:
|
|
sys.path.append(build_path)
|
|
|
|
import remotexpcshelltests
|
|
|
|
dm = self.get_devicemanager(devicemanager, ip, port, remote_test_root)
|
|
|
|
options = remotexpcshelltests.RemoteXPCShellOptions()
|
|
options.shuffle = False
|
|
options.sequential = True
|
|
options.interactive = False
|
|
options.debugger = None
|
|
options.debuggerArgs = None
|
|
options.setup = not no_setup
|
|
options.keepGoing = keep_going
|
|
options.objdir = self.topobjdir
|
|
options.localLib = os.path.join(self.topobjdir, 'dist/fennec')
|
|
options.localBin = os.path.join(self.topobjdir, 'dist/bin')
|
|
options.testingModulesDir = os.path.join(self.topobjdir, '_tests/modules')
|
|
options.mozInfo = os.path.join(self.topobjdir, 'mozinfo.json')
|
|
options.manifest = os.path.join(self.topobjdir, '_tests/xpcshell/xpcshell_android.ini')
|
|
options.symbolsPath = os.path.join(self.distdir, 'crashreporter-symbols')
|
|
if local_apk:
|
|
options.localAPK = local_apk
|
|
else:
|
|
for file in os.listdir(os.path.join(options.objdir, "dist")):
|
|
if file.endswith(".apk") and file.startswith("fennec"):
|
|
options.localAPK = os.path.join(options.objdir, "dist")
|
|
options.localAPK = os.path.join(options.localAPK, file)
|
|
print ("using APK: " + options.localAPK)
|
|
break
|
|
else:
|
|
raise Exception("You must specify an APK")
|
|
|
|
if test_file == 'all':
|
|
testdirs = []
|
|
options.testPath = None
|
|
options.verbose = False
|
|
else:
|
|
testdirs = test_file
|
|
options.testPath = test_file
|
|
options.verbose = True
|
|
dummy_log = StringIO()
|
|
xpcshell = remotexpcshelltests.XPCShellRemote(dm, options, args=testdirs, log=dummy_log)
|
|
self.log_manager.enable_unstructured()
|
|
|
|
xpcshell_filter = TestStartFilter()
|
|
self.log_manager.terminal_handler.addFilter(xpcshell_filter)
|
|
|
|
result = xpcshell.runTests(xpcshell='xpcshell',
|
|
testClass=remotexpcshelltests.RemoteXPCShellTestThread,
|
|
testdirs=testdirs,
|
|
mobileArgs=xpcshell.mobileArgs,
|
|
**options.__dict__)
|
|
|
|
self.log_manager.terminal_handler.removeFilter(xpcshell_filter)
|
|
self.log_manager.disable_unstructured()
|
|
|
|
return int(not result)
|
|
|
|
@CommandProvider
|
|
class MachCommands(MachCommandBase):
|
|
@Command('xpcshell-test', category='testing',
|
|
description='Run XPCOM Shell tests.')
|
|
@CommandArgument('test_file', default='all', nargs='?', metavar='TEST',
|
|
help='Test to run. Can be specified as a single JS file, a directory, '
|
|
'or omitted. If omitted, the entire test suite is executed.')
|
|
@CommandArgument("--debugger", default=None, metavar='DEBUGGER',
|
|
help = "Run xpcshell under the given debugger.")
|
|
@CommandArgument("--debugger-args", default=None, metavar='ARGS', type=str,
|
|
dest = "debuggerArgs",
|
|
help = "pass the given args to the debugger _before_ "
|
|
"the application on the command line")
|
|
@CommandArgument("--debugger-interactive", action = "store_true",
|
|
dest = "debuggerInteractive",
|
|
help = "prevents the test harness from redirecting "
|
|
"stdout and stderr for interactive debuggers")
|
|
@CommandArgument('--interactive', '-i', action='store_true',
|
|
help='Open an xpcshell prompt before running tests.')
|
|
@CommandArgument('--keep-going', '-k', action='store_true',
|
|
help='Continue running tests after a SIGINT is received.')
|
|
@CommandArgument('--sequential', action='store_true',
|
|
help='Run the tests sequentially.')
|
|
@CommandArgument('--shuffle', '-s', action='store_true',
|
|
help='Randomize the execution order of tests.')
|
|
@CommandArgument('--rerun-failures', action='store_true',
|
|
help='Reruns failures from last time.')
|
|
@CommandArgument('--devicemanager', default='adb', type=str,
|
|
help='(Android) Type of devicemanager to use for communication: adb or sut')
|
|
@CommandArgument('--ip', type=str, default=None,
|
|
help='(Android) IP address of device')
|
|
@CommandArgument('--port', type=int, default=20701,
|
|
help='(Android) Port of device')
|
|
@CommandArgument('--remote_test_root', type=str, default=None,
|
|
help='(Android) Remote test root such as /mnt/sdcard or /data/local')
|
|
@CommandArgument('--no-setup', action='store_true',
|
|
help='(Android) Do not copy files to device')
|
|
@CommandArgument('--local-apk', type=str, default=None,
|
|
help='(Android) Use specified Fennec APK')
|
|
def run_xpcshell_test(self, **params):
|
|
from mozbuild.controller.building import BuildDriver
|
|
|
|
# We should probably have a utility function to ensure the tree is
|
|
# ready to run tests. Until then, we just create the state dir (in
|
|
# case the tree wasn't built with mach).
|
|
self._ensure_state_subdir_exists('.')
|
|
|
|
driver = self._spawn(BuildDriver)
|
|
driver.install_tests(remove=False)
|
|
|
|
if conditions.is_android(self):
|
|
xpcshell = self._spawn(AndroidXPCShellRunner)
|
|
else:
|
|
xpcshell = self._spawn(XPCShellRunner)
|
|
|
|
try:
|
|
return xpcshell.run_test(**params)
|
|
except InvalidTestPathError as e:
|
|
print(e.message)
|
|
return 1
|