mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-19 08:15:31 +00:00
6a6ba62ba2
The build system's TestResolver does a pretty good job of getting the right manifestparser based tests to run, but it isn't perfect. Notably, it ignores the 'disabled' key. We filter the tests through manifestparser here to make sure the build system didn't miss anything. For context, this is also what the other test harnesses (e.g mochitest) do as well. MozReview-Commit-ID: FaHb4nvuoK9 --HG-- extra : rebase_source : 476b7068c3ddf7d9757d605de5843e21547c6c33
208 lines
7.4 KiB
Python
208 lines
7.4 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 absolute_import, print_function, unicode_literals
|
|
|
|
import argparse
|
|
import logging
|
|
import mozpack.path as mozpath
|
|
import os
|
|
|
|
from concurrent.futures import (
|
|
ThreadPoolExecutor,
|
|
as_completed,
|
|
thread,
|
|
)
|
|
|
|
import mozinfo
|
|
from manifestparser import TestManifest
|
|
|
|
from mozbuild.base import (
|
|
MachCommandBase,
|
|
)
|
|
|
|
from mach.decorators import (
|
|
CommandArgument,
|
|
CommandProvider,
|
|
Command,
|
|
)
|
|
|
|
|
|
@CommandProvider
|
|
class MachCommands(MachCommandBase):
|
|
@Command('python', category='devenv',
|
|
description='Run Python.')
|
|
@CommandArgument('args', nargs=argparse.REMAINDER)
|
|
def python(self, args):
|
|
# Avoid logging the command
|
|
self.log_manager.terminal_handler.setLevel(logging.CRITICAL)
|
|
|
|
self._activate_virtualenv()
|
|
|
|
return self.run_process([self.virtualenv_manager.python_path] + args,
|
|
pass_thru=True, # Allow user to run Python interactively.
|
|
ensure_exit_code=False, # Don't throw on non-zero exit code.
|
|
# Note: subprocess requires native strings in os.environ on Windows
|
|
append_env={b'PYTHONDONTWRITEBYTECODE': str('1')})
|
|
|
|
@Command('python-test', category='testing',
|
|
description='Run Python unit tests with an appropriate test runner.')
|
|
@CommandArgument('--verbose',
|
|
default=False,
|
|
action='store_true',
|
|
help='Verbose output.')
|
|
@CommandArgument('--stop',
|
|
default=False,
|
|
action='store_true',
|
|
help='Stop running tests after the first error or failure.')
|
|
@CommandArgument('--path-only',
|
|
default=False,
|
|
action='store_true',
|
|
help=('Collect all tests under given path instead of default '
|
|
'test resolution. Supports pytest-style tests.'))
|
|
@CommandArgument('-j', '--jobs',
|
|
default=1,
|
|
type=int,
|
|
help='Number of concurrent jobs to run. Default is 1.')
|
|
@CommandArgument('tests', nargs='*',
|
|
metavar='TEST',
|
|
help=('Tests to run. Each test can be a single file or a directory. '
|
|
'Default test resolution relies on PYTHON_UNITTEST_MANIFESTS.'))
|
|
def python_test(self,
|
|
tests=[],
|
|
test_objects=None,
|
|
subsuite=None,
|
|
verbose=False,
|
|
path_only=False,
|
|
stop=False,
|
|
jobs=1):
|
|
self._activate_virtualenv()
|
|
|
|
def find_tests_by_path():
|
|
import glob
|
|
files = []
|
|
for t in tests:
|
|
if t.endswith('.py') and os.path.isfile(t):
|
|
files.append(t)
|
|
elif os.path.isdir(t):
|
|
for root, _, _ in os.walk(t):
|
|
files += glob.glob(mozpath.join(root, 'test*.py'))
|
|
files += glob.glob(mozpath.join(root, 'unit*.py'))
|
|
else:
|
|
self.log(logging.WARN, 'python-test',
|
|
{'test': t},
|
|
'TEST-UNEXPECTED-FAIL | Invalid test: {test}')
|
|
if stop:
|
|
break
|
|
return files
|
|
|
|
# Python's unittest, and in particular discover, has problems with
|
|
# clashing namespaces when importing multiple test modules. What follows
|
|
# is a simple way to keep environments separate, at the price of
|
|
# launching Python multiple times. Most tests are run via mozunit,
|
|
# which produces output in the format Mozilla infrastructure expects.
|
|
# Some tests are run via pytest.
|
|
if test_objects is None:
|
|
# If we're not being called from `mach test`, do our own
|
|
# test resolution.
|
|
if path_only:
|
|
if tests:
|
|
test_objects = [{'path': p} for p in find_tests_by_path()]
|
|
else:
|
|
self.log(logging.WARN, 'python-test', {},
|
|
'TEST-UNEXPECTED-FAIL | No tests specified')
|
|
test_objects = []
|
|
else:
|
|
from mozbuild.testing import TestResolver
|
|
resolver = self._spawn(TestResolver)
|
|
if tests:
|
|
# If we were given test paths, try to find tests matching them.
|
|
test_objects = resolver.resolve_tests(paths=tests,
|
|
flavor='python')
|
|
else:
|
|
# Otherwise just run everything in PYTHON_UNITTEST_MANIFESTS
|
|
test_objects = resolver.resolve_tests(flavor='python')
|
|
|
|
if not test_objects:
|
|
message = 'TEST-UNEXPECTED-FAIL | No tests collected'
|
|
if not path_only:
|
|
message += ' (Not in PYTHON_UNITTEST_MANIFESTS? Try --path-only?)'
|
|
self.log(logging.WARN, 'python-test', {}, message)
|
|
return 1
|
|
|
|
mp = TestManifest()
|
|
mp.tests.extend(test_objects)
|
|
tests = mp.active_tests(disabled=False, **mozinfo.info)
|
|
|
|
self.jobs = jobs
|
|
self.terminate = False
|
|
self.verbose = verbose
|
|
|
|
return_code = 0
|
|
with ThreadPoolExecutor(max_workers=self.jobs) as executor:
|
|
futures = [executor.submit(self._run_python_test, test['path'])
|
|
for test in tests]
|
|
|
|
try:
|
|
for future in as_completed(futures):
|
|
output, ret = future.result()
|
|
|
|
for line in output:
|
|
self.log(logging.INFO, 'python-test', {'line': line.rstrip()}, '{line}')
|
|
|
|
return_code = return_code or ret
|
|
except KeyboardInterrupt:
|
|
# Hack to force stop currently running threads.
|
|
# https://gist.github.com/clchiou/f2608cbe54403edb0b13
|
|
executor._threads.clear()
|
|
thread._threads_queues.clear()
|
|
raise
|
|
|
|
return return_code
|
|
|
|
def _run_python_test(self, test_path):
|
|
from mozprocess import ProcessHandler
|
|
|
|
output = []
|
|
|
|
def _log(line):
|
|
# Buffer messages if more than one worker to avoid interleaving
|
|
if self.jobs > 1:
|
|
output.append(line)
|
|
else:
|
|
self.log(logging.INFO, 'python-test', {'line': line.rstrip()}, '{line}')
|
|
|
|
file_displayed_test = [] # used as boolean
|
|
|
|
def _line_handler(line):
|
|
if not file_displayed_test:
|
|
output = ('Ran' in line or 'collected' in line or
|
|
line.startswith('TEST-'))
|
|
if output:
|
|
file_displayed_test.append(True)
|
|
|
|
_log(line)
|
|
|
|
_log(test_path)
|
|
cmd = [self.virtualenv_manager.python_path, test_path]
|
|
env = os.environ.copy()
|
|
env[b'PYTHONDONTWRITEBYTECODE'] = b'1'
|
|
|
|
proc = ProcessHandler(cmd, env=env, processOutputLine=_line_handler, storeOutput=False)
|
|
proc.run()
|
|
|
|
return_code = proc.wait()
|
|
|
|
if not file_displayed_test:
|
|
_log('TEST-UNEXPECTED-FAIL | No test output (missing mozunit.main() '
|
|
'call?): {}'.format(test_path))
|
|
|
|
if self.verbose:
|
|
if return_code != 0:
|
|
_log('Test failed: {}'.format(test_path))
|
|
else:
|
|
_log('Test passed: {}'.format(test_path))
|
|
|
|
return output, return_code
|