2013-07-03 04:33:48 +04:00
|
|
|
# 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/.
|
|
|
|
|
2015-06-22 03:39:09 +03:00
|
|
|
from __future__ import absolute_import, print_function, unicode_literals
|
2013-07-03 04:33:48 +04:00
|
|
|
|
|
|
|
import argparse
|
|
|
|
import logging
|
2015-03-25 09:05:28 +03:00
|
|
|
import mozpack.path as mozpath
|
2013-07-03 04:33:48 +04:00
|
|
|
import os
|
|
|
|
|
2016-10-11 19:29:09 +03:00
|
|
|
from concurrent.futures import (
|
|
|
|
ThreadPoolExecutor,
|
|
|
|
as_completed,
|
|
|
|
thread,
|
|
|
|
)
|
|
|
|
|
2016-11-18 00:30:27 +03:00
|
|
|
import mozinfo
|
|
|
|
from manifestparser import TestManifest
|
2016-11-18 00:30:33 +03:00
|
|
|
from manifestparser import filters as mpf
|
2016-11-18 00:30:27 +03:00
|
|
|
|
2013-07-03 04:33:48 +04:00
|
|
|
from mozbuild.base import (
|
|
|
|
MachCommandBase,
|
|
|
|
)
|
|
|
|
|
|
|
|
from mach.decorators import (
|
|
|
|
CommandArgument,
|
|
|
|
CommandProvider,
|
|
|
|
Command,
|
|
|
|
)
|
|
|
|
|
2015-07-02 22:18:52 +03:00
|
|
|
|
2013-07-03 04:33:48 +04:00
|
|
|
@CommandProvider
|
|
|
|
class MachCommands(MachCommandBase):
|
|
|
|
@Command('python', category='devenv',
|
|
|
|
description='Run Python.')
|
|
|
|
@CommandArgument('args', nargs=argparse.REMAINDER)
|
|
|
|
def python(self, args):
|
2013-08-15 18:45:09 +04:00
|
|
|
# Avoid logging the command
|
|
|
|
self.log_manager.terminal_handler.setLevel(logging.CRITICAL)
|
2013-12-20 01:48:37 +04:00
|
|
|
|
|
|
|
self._activate_virtualenv()
|
|
|
|
|
|
|
|
return self.run_process([self.virtualenv_manager.python_path] + args,
|
2015-07-02 22:18:52 +03:00
|
|
|
pass_thru=True, # Allow user to run Python interactively.
|
|
|
|
ensure_exit_code=False, # Don't throw on non-zero exit code.
|
2013-08-08 19:06:02 +04:00
|
|
|
# Note: subprocess requires native strings in os.environ on Windows
|
|
|
|
append_env={b'PYTHONDONTWRITEBYTECODE': str('1')})
|
2013-07-03 04:33:48 +04:00
|
|
|
|
|
|
|
@Command('python-test', category='testing',
|
2016-04-18 17:21:56 +03:00
|
|
|
description='Run Python unit tests with an appropriate test runner.')
|
2013-07-03 04:33:48 +04:00
|
|
|
@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.')
|
2016-10-11 19:29:09 +03:00
|
|
|
@CommandArgument('-j', '--jobs',
|
|
|
|
default=1,
|
|
|
|
type=int,
|
|
|
|
help='Number of concurrent jobs to run. Default is 1.')
|
2016-11-18 00:30:33 +03:00
|
|
|
@CommandArgument('--subsuite',
|
|
|
|
default=None,
|
|
|
|
help=('Python subsuite to run. If not specified, all subsuites are run. '
|
|
|
|
'Use the string `default` to only run tests without a subsuite.'))
|
2016-03-10 20:30:10 +03:00
|
|
|
@CommandArgument('tests', nargs='*',
|
2013-07-03 04:33:48 +04:00
|
|
|
metavar='TEST',
|
2016-03-23 01:53:57 +03:00
|
|
|
help=('Tests to run. Each test can be a single file or a directory. '
|
2016-11-16 17:59:22 +03:00
|
|
|
'Default test resolution relies on PYTHON_UNITTEST_MANIFESTS.'))
|
2016-03-10 20:30:10 +03:00
|
|
|
def python_test(self,
|
|
|
|
tests=[],
|
|
|
|
test_objects=None,
|
|
|
|
subsuite=None,
|
|
|
|
verbose=False,
|
2016-10-11 19:29:09 +03:00
|
|
|
stop=False,
|
|
|
|
jobs=1):
|
2013-12-20 01:48:37 +04:00
|
|
|
self._activate_virtualenv()
|
2013-07-03 04:33:48 +04:00
|
|
|
|
2016-04-18 17:21:56 +03:00
|
|
|
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
|
|
|
|
|
2013-07-03 04:33:48 +04:00
|
|
|
# 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
|
2016-04-18 17:21:56 +03:00
|
|
|
# launching Python multiple times. Most tests are run via mozunit,
|
2013-07-03 04:33:48 +04:00
|
|
|
# which produces output in the format Mozilla infrastructure expects.
|
2016-08-05 21:10:09 +03:00
|
|
|
# Some tests are run via pytest.
|
2016-03-10 20:30:10 +03:00
|
|
|
if test_objects is None:
|
2017-02-16 00:38:45 +03:00
|
|
|
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')
|
2016-03-10 20:30:10 +03:00
|
|
|
else:
|
2017-02-16 00:38:45 +03:00
|
|
|
# Otherwise just run everything in PYTHON_UNITTEST_MANIFESTS
|
|
|
|
test_objects = resolver.resolve_tests(flavor='python')
|
2016-03-10 20:30:10 +03:00
|
|
|
|
2017-03-07 18:55:07 +03:00
|
|
|
mp = TestManifest()
|
|
|
|
mp.tests.extend(test_objects)
|
|
|
|
|
|
|
|
if not mp.tests:
|
2017-02-16 00:38:45 +03:00
|
|
|
message = 'TEST-UNEXPECTED-FAIL | No tests collected ' + \
|
|
|
|
'(Not in PYTHON_UNITTEST_MANIFESTS?)'
|
2016-04-18 17:21:56 +03:00
|
|
|
self.log(logging.WARN, 'python-test', {}, message)
|
2016-03-23 01:53:57 +03:00
|
|
|
return 1
|
|
|
|
|
2016-11-18 00:30:33 +03:00
|
|
|
filters = []
|
|
|
|
if subsuite == 'default':
|
|
|
|
filters.append(mpf.subsuite(None))
|
|
|
|
elif subsuite:
|
|
|
|
filters.append(mpf.subsuite(subsuite))
|
|
|
|
|
|
|
|
tests = mp.active_tests(filters=filters, disabled=False, **mozinfo.info)
|
2016-11-18 00:30:27 +03:00
|
|
|
|
2016-10-11 19:29:09 +03:00
|
|
|
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'])
|
2016-11-18 00:30:27 +03:00
|
|
|
for test in tests]
|
2016-10-11 19:29:09 +03:00
|
|
|
|
|
|
|
try:
|
|
|
|
for future in as_completed(futures):
|
2016-12-21 19:12:55 +03:00
|
|
|
output, ret, test_path = future.result()
|
2016-10-11 19:29:09 +03:00
|
|
|
|
|
|
|
for line in output:
|
|
|
|
self.log(logging.INFO, 'python-test', {'line': line.rstrip()}, '{line}')
|
|
|
|
|
2016-12-21 19:12:55 +03:00
|
|
|
if ret and not return_code:
|
|
|
|
self.log(logging.ERROR, 'python-test', {'test_path': test_path, 'ret': ret}, 'Setting retcode to {ret} from {test_path}')
|
2016-10-11 19:29:09 +03:00
|
|
|
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
|
|
|
|
|
2016-12-21 19:12:55 +03:00
|
|
|
self.log(logging.INFO, 'python-test', {'return_code': return_code}, 'Return code from mach python-test: {return_code}')
|
2016-10-11 19:29:09 +03:00
|
|
|
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))
|
|
|
|
|
2016-12-21 19:12:55 +03:00
|
|
|
return output, return_code, test_path
|