mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
299 lines
11 KiB
Python
299 lines
11 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/.
|
|
|
|
from __future__ import unicode_literals
|
|
|
|
import logging
|
|
import mozpack.path
|
|
import os
|
|
import platform
|
|
import sys
|
|
|
|
from mozbuild.base import (
|
|
MachCommandBase,
|
|
MozbuildObject,
|
|
)
|
|
|
|
from mach.decorators import (
|
|
CommandArgument,
|
|
CommandProvider,
|
|
Command,
|
|
)
|
|
|
|
from mach.logging import StructuredHumanFormatter
|
|
|
|
|
|
class UnexpectedFilter(logging.Filter):
|
|
def filter(self, record):
|
|
msg = getattr(record, 'params', {}).get('msg', '')
|
|
return 'TEST-UNEXPECTED-' in msg
|
|
|
|
|
|
class MochitestRunner(MozbuildObject):
|
|
"""Easily run mochitests.
|
|
|
|
This currently contains just the basics for running mochitests. We may want
|
|
to hook up result parsing, etc.
|
|
"""
|
|
def run_mochitest_test(self, suite=None, test_file=None, debugger=None,
|
|
debugger_args=None, shuffle=False, keep_open=False, rerun_failures=False,
|
|
no_autorun=False, repeat=0, run_until_failure=False, slow=False):
|
|
"""Runs a mochitest.
|
|
|
|
test_file is a path to a test file. It can be a relative path from the
|
|
top source directory, an absolute filename, or a directory containing
|
|
test files.
|
|
|
|
suite is the type of mochitest to run. It can be one of ('plain',
|
|
'chrome', 'browser', 'metro', 'a11y').
|
|
|
|
debugger is a program name or path to a binary (presumably a debugger)
|
|
to run the test in. e.g. 'gdb'
|
|
|
|
debugger_args are the arguments passed to the debugger.
|
|
|
|
shuffle is whether test order should be shuffled (defaults to false).
|
|
|
|
keep_open denotes whether to keep the browser open after tests
|
|
complete.
|
|
"""
|
|
# 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 rerun_failures and test_file:
|
|
print('Cannot specify both --rerun-failures and a test path.')
|
|
return 1
|
|
|
|
# Need to call relpath before os.chdir() below.
|
|
test_path = ''
|
|
if test_file:
|
|
test_path = self._wrap_path_argument(test_file).relpath()
|
|
|
|
tests_dir = os.path.join(self.topobjdir, '_tests')
|
|
mochitest_dir = os.path.join(tests_dir, 'testing', 'mochitest')
|
|
|
|
failure_file_path = os.path.join(self.statedir, 'mochitest_failures.json')
|
|
|
|
if rerun_failures and not os.path.exists(failure_file_path):
|
|
print('No failure file present. Did you run mochitests before?')
|
|
return 1
|
|
|
|
from StringIO import StringIO
|
|
from automation import Automation
|
|
|
|
# runtests.py is ambiguous, so we load the file/module manually.
|
|
if 'mochitest' not in sys.modules:
|
|
import imp
|
|
path = os.path.join(mochitest_dir, 'runtests.py')
|
|
with open(path, 'r') as fh:
|
|
imp.load_module('mochitest', fh, path,
|
|
('.py', 'r', imp.PY_SOURCE))
|
|
|
|
import mochitest
|
|
|
|
# This is required to make other components happy. Sad, isn't it?
|
|
os.chdir(self.topobjdir)
|
|
|
|
automation = Automation()
|
|
|
|
# Automation installs its own stream handler to stdout. Since we want
|
|
# all logging to go through us, we just remove their handler.
|
|
remove_handlers = [l for l in logging.getLogger().handlers
|
|
if isinstance(l, logging.StreamHandler)]
|
|
for handler in remove_handlers:
|
|
logging.getLogger().removeHandler(handler)
|
|
|
|
runner = mochitest.Mochitest(automation)
|
|
|
|
opts = mochitest.MochitestOptions(automation)
|
|
options, args = opts.parse_args([])
|
|
|
|
# Need to set the suite options before verifyOptions below.
|
|
if suite == 'plain':
|
|
# Don't need additional options for plain.
|
|
pass
|
|
elif suite == 'chrome':
|
|
options.chrome = True
|
|
elif suite == 'browser':
|
|
options.browserChrome = True
|
|
elif suite == 'metro':
|
|
options.immersiveMode = True
|
|
options.browserChrome = True
|
|
elif suite == 'a11y':
|
|
options.a11y = True
|
|
else:
|
|
raise Exception('None or unrecognized mochitest suite type.')
|
|
|
|
options.autorun = not no_autorun
|
|
options.closeWhenDone = not keep_open
|
|
options.shuffle = shuffle
|
|
options.consoleLevel = 'INFO'
|
|
options.repeat = repeat
|
|
options.runUntilFailure = run_until_failure
|
|
options.runSlower = slow
|
|
options.testingModulesDir = os.path.join(tests_dir, 'modules')
|
|
options.extraProfileFiles.append(os.path.join(self.distdir, 'plugins'))
|
|
options.symbolsPath = os.path.join(self.distdir, 'crashreporter-symbols')
|
|
|
|
options.failureFile = failure_file_path
|
|
|
|
if test_path:
|
|
test_root = runner.getTestRoot(options)
|
|
test_root_file = mozpack.path.join(mochitest_dir, test_root, test_path)
|
|
if not os.path.exists(test_root_file):
|
|
print('Specified test path does not exist: %s' % test_root_file)
|
|
print('You may need to run |mach build| to build the test files.')
|
|
return 1
|
|
|
|
options.testPath = test_path
|
|
|
|
if rerun_failures:
|
|
options.testManifest = failure_file_path
|
|
|
|
if debugger:
|
|
options.debugger = debugger
|
|
|
|
if debugger_args:
|
|
if options.debugger == None:
|
|
print("--debugger-args passed, but no debugger specified.")
|
|
return 1
|
|
options.debuggerArgs = debugger_args
|
|
|
|
options = opts.verifyOptions(options, runner)
|
|
|
|
if options is None:
|
|
raise Exception('mochitest option validator failed.')
|
|
|
|
automation.setServerInfo(options.webServer, options.httpPort,
|
|
options.sslPort, options.webSocketPort)
|
|
|
|
|
|
# We need this to enable colorization of output.
|
|
self.log_manager.enable_unstructured()
|
|
|
|
# Output processing is a little funky here. The old make targets
|
|
# grepped the log output from TEST-UNEXPECTED-* and printed these lines
|
|
# after test execution. Ideally the test runner would expose a Python
|
|
# API for obtaining test results and we could just format failures
|
|
# appropriately. Unfortunately, it doesn't yet do that. So, we capture
|
|
# all output to a buffer then "grep" the buffer after test execution.
|
|
# Bug 858197 tracks a Python API that would facilitate this.
|
|
test_output = StringIO()
|
|
handler = logging.StreamHandler(test_output)
|
|
handler.addFilter(UnexpectedFilter())
|
|
handler.setFormatter(StructuredHumanFormatter(0, write_times=False))
|
|
logging.getLogger().addHandler(handler)
|
|
|
|
result = runner.runTests(options)
|
|
|
|
# Need to remove our buffering handler before we echo failures or else
|
|
# it will catch them again!
|
|
logging.getLogger().removeHandler(handler)
|
|
self.log_manager.disable_unstructured()
|
|
|
|
if test_output.getvalue():
|
|
result = 1
|
|
for line in test_output.getvalue().splitlines():
|
|
self.log(logging.INFO, 'unexpected', {'msg': line}, '{msg}')
|
|
|
|
return result
|
|
|
|
|
|
def MochitestCommand(func):
|
|
"""Decorator that adds shared command arguments to mochitest commands."""
|
|
|
|
# This employs light Python magic. Keep in mind a decorator is just a
|
|
# function that takes a function, does something with it, then returns a
|
|
# (modified) function. Here, we chain decorators onto the passed in
|
|
# function.
|
|
|
|
debugger = CommandArgument('--debugger', '-d', metavar='DEBUGGER',
|
|
help='Debugger binary to run test in. Program name or path.')
|
|
func = debugger(func)
|
|
|
|
debugger_args = CommandArgument('--debugger-args',
|
|
metavar='DEBUGGER_ARGS', help='Arguments to pass to the debugger.')
|
|
func = debugger_args(func)
|
|
|
|
shuffle = CommandArgument('--shuffle', action='store_true',
|
|
help='Shuffle execution order.')
|
|
func = shuffle(func)
|
|
|
|
keep_open = CommandArgument('--keep-open', action='store_true',
|
|
help='Keep the browser open after tests complete.')
|
|
func = keep_open(func)
|
|
|
|
rerun = CommandArgument('--rerun-failures', action='store_true',
|
|
help='Run only the tests that filed during the last test run.')
|
|
func = rerun(func)
|
|
|
|
autorun = CommandArgument('--no-autorun', action='store_true',
|
|
help='Do not starting running tests automatically.')
|
|
func = autorun(func)
|
|
|
|
repeat = CommandArgument('--repeat', type=int, default=0,
|
|
help='Repeat the test the given number of times.')
|
|
func = repeat(func)
|
|
|
|
runUntilFailure = CommandArgument("--run-until-failure", action='store_true',
|
|
help='Run a test repeatedly and stops on the first time the test fails. ' \
|
|
'Only available when running a single test. Default cap is 30 runs, ' \
|
|
'which can be overwritten with the --repeat parameter.')
|
|
func = runUntilFailure(func)
|
|
|
|
slow = CommandArgument('--slow', action='store_true',
|
|
help='Delay execution between tests.')
|
|
func = slow(func)
|
|
|
|
path = CommandArgument('test_file', default=None, nargs='?',
|
|
metavar='TEST',
|
|
help='Test to run. Can be specified as a single file, a ' \
|
|
'directory, or omitted. If omitted, the entire test suite is ' \
|
|
'executed.')
|
|
func = path(func)
|
|
|
|
return func
|
|
|
|
|
|
@CommandProvider
|
|
class MachCommands(MachCommandBase):
|
|
@Command('mochitest-plain', category='testing',
|
|
description='Run a plain mochitest.')
|
|
@MochitestCommand
|
|
def run_mochitest_plain(self, test_file, **kwargs):
|
|
return self.run_mochitest(test_file, 'plain', **kwargs)
|
|
|
|
@Command('mochitest-chrome', category='testing',
|
|
description='Run a chrome mochitest.')
|
|
@MochitestCommand
|
|
def run_mochitest_chrome(self, test_file, **kwargs):
|
|
return self.run_mochitest(test_file, 'chrome', **kwargs)
|
|
|
|
@Command('mochitest-browser', category='testing',
|
|
description='Run a mochitest with browser chrome.')
|
|
@MochitestCommand
|
|
def run_mochitest_browser(self, test_file, **kwargs):
|
|
return self.run_mochitest(test_file, 'browser', **kwargs)
|
|
|
|
@Command('mochitest-metro', category='testing',
|
|
description='Run a mochitest with metro browser chrome.')
|
|
@MochitestCommand
|
|
def run_mochitest_metro(self, test_file, **kwargs):
|
|
return self.run_mochitest(test_file, 'metro', **kwargs)
|
|
|
|
@Command('mochitest-a11y', category='testing',
|
|
description='Run an a11y mochitest.')
|
|
@MochitestCommand
|
|
def run_mochitest_a11y(self, test_file, **kwargs):
|
|
return self.run_mochitest(test_file, 'a11y', **kwargs)
|
|
|
|
def run_mochitest(self, test_file, flavor, **kwargs):
|
|
self._ensure_state_subdir_exists('.')
|
|
|
|
mochitest = self._spawn(MochitestRunner)
|
|
return mochitest.run_mochitest_test(test_file=test_file, suite=flavor,
|
|
**kwargs)
|