-
Notifications
You must be signed in to change notification settings - Fork 44
/
pytest.py
181 lines (162 loc) · 7.36 KB
/
pytest.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# Copyright 2016-2018 Dirk Thomas
# Licensed under the Apache License, Version 2.0
import os
from pathlib import Path
from pathlib import PurePosixPath
import sys
from colcon_core.event.test import TestFailure
from colcon_core.plugin_system import satisfies_version
from colcon_core.plugin_system import SkipExtensionException
from colcon_core.task import check_call
from colcon_core.task.python.test import has_test_dependency
from colcon_core.task.python.test import PythonTestingStepExtensionPoint
from colcon_core.verb.test import logger
from pkg_resources import parse_version
class PytestPythonTestingStep(PythonTestingStepExtensionPoint):
"""Use `pytest` to test Python packages."""
# use a higher priority than the default priority
# in order to become the default
PRIORITY = 200
def __init__(self): # noqa: D107
super().__init__()
satisfies_version(
PythonTestingStepExtensionPoint.EXTENSION_POINT_VERSION, '^1.0')
try:
import pytest # noqa: F401
except ImportError:
raise SkipExtensionException("'pytest' not found")
def add_arguments(self, *, parser): # noqa: D102
parser.add_argument(
'--pytest-args',
nargs='*', metavar='*', type=str.lstrip,
help='Pass arguments to pytests. '
'Arguments matching other options must be prefixed by a space,\n'
'e.g. --pytest-args " --help"')
parser.add_argument(
'--pytest-with-coverage',
action='store_true',
help='Generate coverage information')
def match(self, context, env, setup_py_data): # noqa: D102
return has_test_dependency(setup_py_data, 'pytest')
async def step(self, context, env, setup_py_data): # noqa: D102
cmd = [sys.executable, '-m', 'pytest']
junit_xml_path = Path(
context.args.test_result_base
if context.args.test_result_base
else context.args.build_base) / 'pytest.xml'
# avoid using backslashes in the PYTEST_ADDOPTS env var on Windows
args = [
'--tb=short',
'--junit-xml=' + str(PurePosixPath(*junit_xml_path.parts)),
'--junit-prefix=' + context.pkg.name,
]
# use -o option only when available
# https://github.com/pytest-dev/pytest/blob/3.3.0/CHANGELOG.rst
from pytest import __version__ as pytest_version
if parse_version(pytest_version) >= parse_version('3.3.0'):
args += [
'-o', 'cache_dir=' + str(PurePosixPath(
*(Path(context.args.build_base).parts)) / '.pytest_cache'),
]
env = dict(env)
if (
context.args.pytest_with_coverage or
has_test_dependency(setup_py_data, 'pytest-cov')
):
try:
from pytest_cov import __version__ as pytest_cov_version
except ImportError:
logger.warning(
'Test coverage will not be produced for package '
"'{context.pkg.name}' since the pytest extension 'cov' "
'was not found'.format_map(locals()))
else:
args += [
'--cov=' + str(PurePosixPath(
*(Path(context.args.path).parts))),
'--cov-report=html:' + str(PurePosixPath(
*(Path(context.args.build_base).parts)) /
'coverage.html'),
'--cov-report=xml:' + str(PurePosixPath(
*(Path(context.args.build_base).parts)) /
'coverage.xml'),
]
# use --cov-branch option only when available
# https://github.com/pytest-dev/pytest-cov/blob/v2.5.0/CHANGELOG.rst
if parse_version(pytest_cov_version) >= parse_version('2.5.0'):
args += [
'--cov-branch',
]
else:
logger.warning(
'Test coverage will be produced but will not contain '
'branch coverage information because the pytest '
"extension 'cov' does not support it (need 2.5.0, "
'have {pytest_cov_version})'.format_map(locals()))
env['COVERAGE_FILE'] = os.path.join(
context.args.build_base, '.coverage')
if context.args.retest_until_fail:
try:
import pytest_repeat # noqa: F401
except ImportError:
logger.warning(
"Ignored '--retest-until-fail' for package "
"'{context.pkg.name}' since the pytest extension 'repeat' "
'was not found'.format_map(locals()))
else:
count = context.args.retest_until_fail + 1
args += [
'--count={count}'.format_map(locals()),
]
if context.args.retest_until_pass:
try:
import pytest_rerunfailures # noqa: F401
except ImportError:
logger.warning(
"Ignored '--retest-until-pass' for package "
"'{context.pkg.name}' since pytest extension "
"'rerunfailures' was not found".format_map(locals()))
else:
args += [
'--reruns={context.args.retest_until_pass}'
.format_map(locals()),
]
if context.args.pytest_args is not None:
args += context.args.pytest_args
if args:
env['PYTEST_ADDOPTS'] = ' '.join(
a if ' ' not in a else '"{a}"'.format_map(locals())
for a in args)
# create dummy result in case the invocation fails early
# and doesn't generate a result file at all
junit_xml_path.parent.mkdir(parents=True, exist_ok=True)
junit_xml_path.write_text("""<?xml version="1.0" encoding="UTF-8"?>
<testsuite name="{context.pkg.name}" tests="1" failures="0" time="0" errors="1" skipped="0">
<testcase classname="{context.pkg.name}" name="pytest.missing_result" time="0">
<failure message="The test invocation failed without generating a result file."/>
</testcase>
</testsuite>
""".format_map(locals())) # noqa: E501
rc = await check_call(context, cmd, cwd=context.args.path, env=env)
# use local import to avoid a dependency on pytest
try:
from _pytest.main import ExitCode
EXIT_CODE_TESTS_FAILED = ExitCode.TESTS_FAILED # noqa: N806
except ImportError:
# support pytest < 5.0
from _pytest.main import EXIT_TESTSFAILED
EXIT_CODE_TESTS_FAILED = EXIT_TESTSFAILED # noqa: N806
if rc and rc.returncode == EXIT_CODE_TESTS_FAILED:
context.put_event_into_queue(
TestFailure(context.pkg.name))
try:
from _pytest.main import ExitCode
EXIT_CODE_NO_TESTS = ExitCode.NO_TESTS_COLLECTED # noqa: N806
except ImportError:
# support pytest < 5.0
from _pytest.main import EXIT_NOTESTSCOLLECTED
EXIT_CODE_NO_TESTS = EXIT_NOTESTSCOLLECTED # noqa: N806
if rc and rc.returncode not in (
EXIT_CODE_NO_TESTS, EXIT_CODE_TESTS_FAILED
):
return rc.returncode