/usr/lib/python3/dist-packages/pytest_cov/plugin.py is in python3-pytest-cov 2.4.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | """Coverage plugin for pytest."""
import os
import pytest
import argparse
from coverage.misc import CoverageException
from . import embed
from . import engine
from . import compat
class CoverageError(Exception):
"""Indicates that our coverage is too low"""
def validate_report(arg):
file_choices = ['annotate', 'html', 'xml']
term_choices = ['term', 'term-missing']
term_modifier_choices = ['skip-covered']
all_choices = term_choices + file_choices
values = arg.split(":", 1)
report_type = values[0]
if report_type not in all_choices + ['']:
msg = 'invalid choice: "{}" (choose from "{}")'.format(arg, all_choices)
raise argparse.ArgumentTypeError(msg)
if len(values) == 1:
return report_type, None
report_modifier = values[1]
if report_type in term_choices and report_modifier in term_modifier_choices:
return report_type, report_modifier
if report_type not in file_choices:
msg = 'output specifier not supported for: "{}" (choose from "{}")'.format(arg,
file_choices)
raise argparse.ArgumentTypeError(msg)
return values
class StoreReport(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
report_type, file = values
namespace.cov_report[report_type] = file
def pytest_addoption(parser):
"""Add options to control coverage."""
group = parser.getgroup(
'cov', 'coverage reporting with distributed testing support')
group.addoption('--cov', action='append', default=[], metavar='path',
nargs='?', const=True, dest='cov_source',
help='measure coverage for filesystem path '
'(multi-allowed)')
group.addoption('--cov-report', action=StoreReport, default={},
metavar='type', type=validate_report,
help='type of report to generate: term, term-missing, '
'annotate, html, xml (multi-allowed). '
'term, term-missing may be followed by ":skip-covered".'
'annotate, html and xml may be be followed by ":DEST" '
'where DEST specifies the output location.')
group.addoption('--cov-config', action='store', default='.coveragerc',
metavar='path',
help='config file for coverage, default: .coveragerc')
group.addoption('--no-cov-on-fail', action='store_true', default=False,
help='do not report coverage if test run fails, '
'default: False')
group.addoption('--no-cov', action='store_true', default=False,
help='Disable coverage report completely (useful for debuggers) '
'default: False')
group.addoption('--cov-fail-under', action='store', metavar='MIN', type=int,
help='Fail if the total coverage is less than MIN.')
group.addoption('--cov-append', action='store_true', default=False,
help='do not delete coverage but append to current, '
'default: False')
@pytest.mark.tryfirst
def pytest_load_initial_conftests(early_config, parser, args):
ns = parser.parse_known_args(args)
ns.cov = bool(ns.cov_source)
if ns.cov_source == [True]:
ns.cov_source = None
if not ns.cov_report:
ns.cov_report = ['term']
elif len(ns.cov_report) == 1 and '' in ns.cov_report:
ns.cov_report = {}
if ns.cov:
plugin = CovPlugin(ns, early_config.pluginmanager)
early_config.pluginmanager.register(plugin, '_cov')
def pytest_configure(config):
"""Activate coverage plugin if appropriate."""
if config.getvalue('cov_source'):
if not config.pluginmanager.hasplugin('_cov'):
if not config.option.cov_report:
config.option.cov_report = ['term']
if config.option.cov_source == [True]:
config.option.cov_source = None
plugin = CovPlugin(config.option, config.pluginmanager,
start=False)
config.pluginmanager.register(plugin, '_cov')
class CovPlugin(object):
"""Use coverage package to produce code coverage reports.
Delegates all work to a particular implementation based on whether
this test process is centralised, a distributed master or a
distributed slave.
"""
def __init__(self, options, pluginmanager, start=True):
"""Creates a coverage pytest plugin.
We read the rc file that coverage uses to get the data file
name. This is needed since we give coverage through it's API
the data file name.
"""
# Our implementation is unknown at this time.
self.pid = None
self.cov = None
self.cov_controller = None
self.cov_report = compat.StringIO()
self.cov_total = None
self.failed = False
self._started = False
self._disabled = False
self.options = options
is_dist = (getattr(options, 'numprocesses', False) or
getattr(options, 'distload', False) or
getattr(options, 'dist', 'no') != 'no')
if getattr(options, 'no_cov', False):
self._disabled = True
return
if is_dist and start:
self.start(engine.DistMaster)
elif start:
self.start(engine.Central)
# slave is started in pytest hook
def start(self, controller_cls, config=None, nodeid=None):
if config is None:
# fake config option for engine
class Config(object):
option = self.options
config = Config()
self.cov_controller = controller_cls(
self.options.cov_source,
self.options.cov_report,
self.options.cov_config,
self.options.cov_append,
config,
nodeid
)
self.cov_controller.start()
self._started = True
cov_config = self.cov_controller.cov.config
if self.options.cov_fail_under is None and hasattr(cov_config, 'fail_under'):
self.options.cov_fail_under = cov_config.fail_under
def _is_slave(self, session):
return hasattr(session.config, 'slaveinput')
def pytest_sessionstart(self, session):
"""At session start determine our implementation and delegate to it."""
if self.options.no_cov:
# Coverage can be disabled because it does not cooperate with debuggers well.py
self._disabled = True
return
self.pid = os.getpid()
if self._is_slave(session):
nodeid = session.config.slaveinput.get('slaveid',
getattr(session, 'nodeid'))
self.start(engine.DistSlave, session.config, nodeid)
elif not self._started:
self.start(engine.Central)
def pytest_configure_node(self, node):
"""Delegate to our implementation.
Mark this hook as optional in case xdist is not installed.
"""
self.cov_controller.configure_node(node)
pytest_configure_node.optionalhook = True
def pytest_testnodedown(self, node, error):
"""Delegate to our implementation.
Mark this hook as optional in case xdist is not installed.
"""
self.cov_controller.testnodedown(node, error)
pytest_testnodedown.optionalhook = True
def _should_report(self):
return not (self.failed and self.options.no_cov_on_fail)
def _failed_cov_total(self):
cov_fail_under = self.options.cov_fail_under
return cov_fail_under is not None and self.cov_total < cov_fail_under
# we need to wrap pytest_runtestloop. by the time pytest_sessionfinish
# runs, it's too late to set testsfailed
@compat.hookwrapper
def pytest_runtestloop(self, session):
yield
if self._disabled:
return
compat_session = compat.SessionWrapper(session)
self.failed = bool(compat_session.testsfailed)
if self.cov_controller is not None:
self.cov_controller.finish()
if not self._is_slave(session) and self._should_report():
try:
self.cov_total = self.cov_controller.summary(self.cov_report)
except CoverageException as exc:
raise pytest.UsageError(
'Failed to generate report: %s\n' % exc
)
assert self.cov_total is not None, 'Test coverage should never be `None`'
if self._failed_cov_total():
# make sure we get the EXIT_TESTSFAILED exit code
compat_session.testsfailed += 1
def pytest_terminal_summary(self, terminalreporter):
if self._disabled:
msg = 'Coverage disabled via --no-cov switch!'
terminalreporter.write('WARNING: %s' % msg, red=True, bold=True)
terminalreporter.config.warn(code='COV-U1', message=msg)
return
if self.cov_controller is None:
return
if self.cov_total is None:
# we shouldn't report, or report generation failed (error raised above)
return
terminalreporter.write('\n' + self.cov_report.getvalue() + '\n')
if self._failed_cov_total():
markup = {'red': True, 'bold': True}
msg = (
'FAIL Required test coverage of %d%% not '
'reached. Total coverage: %.2f%%\n'
% (self.options.cov_fail_under, self.cov_total)
)
terminalreporter.write(msg, **markup)
def pytest_runtest_setup(self, item):
if os.getpid() != self.pid:
# test is run in another process than session, run
# coverage manually
self.cov = embed.init()
def pytest_runtest_teardown(self, item):
if self.cov is not None:
embed.multiprocessing_finish(self.cov)
self.cov = None
@pytest.fixture
def cov(request):
"""A pytest fixture to provide access to the underlying coverage object."""
# Check with hasplugin to avoid getplugin exception in older pytest.
if request.config.pluginmanager.hasplugin('_cov'):
plugin = request.config.pluginmanager.getplugin('_cov')
if plugin.cov_controller:
return plugin.cov_controller.cov
return None
|