This commit is contained in:
Iliyan Angelov
2025-12-06 03:27:35 +02:00
parent 7667eb5eda
commit 5a8ca3c475
2211 changed files with 28086 additions and 37066 deletions

View File

@@ -1,28 +1,17 @@
"""Coverage controllers for use by pytest-cov and nose-cov."""
import argparse
import contextlib
import copy
import functools
import os
import random
import shutil
import socket
import sys
import warnings
from pathlib import Path
from typing import Union
import coverage
from coverage.data import CoverageData
from coverage.sqldata import filename_suffix
from . import CentralCovContextWarning
from . import DistCovError
class BrokenCovConfigError(Exception):
pass
from .compat import StringIO
from .embed import cleanup
class _NullFile:
@@ -45,7 +34,7 @@ def _ensure_topdir(meth):
@functools.wraps(meth)
def ensure_topdir_wrapper(self, *args, **kwargs):
try:
original_cwd = Path.cwd()
original_cwd = os.getcwd()
except OSError:
# Looks like it's gone, this is non-ideal because a side-effect will
# be introduced in the tests here but we can't do anything about it.
@@ -63,14 +52,13 @@ def _ensure_topdir(meth):
class CovController:
"""Base class for different plugin implementations."""
def __init__(self, options: argparse.Namespace, config: Union[None, object], nodeid: Union[None, str]):
def __init__(self, cov_source, cov_report, cov_config, cov_append, cov_branch, config=None, nodeid=None):
"""Get some common config used by multiple derived classes."""
self.cov_source = options.cov_source
self.cov_report = options.cov_report
self.cov_config = options.cov_config
self.cov_append = options.cov_append
self.cov_branch = options.cov_branch
self.cov_precision = options.cov_precision
self.cov_source = cov_source
self.cov_report = cov_report
self.cov_config = cov_config
self.cov_append = cov_append
self.cov_branch = cov_branch
self.config = config
self.nodeid = nodeid
@@ -79,73 +67,67 @@ class CovController:
self.data_file = None
self.node_descs = set()
self.failed_workers = []
self.topdir = os.fspath(Path.cwd())
self.topdir = os.getcwd()
self.is_collocated = None
self.started = False
@contextlib.contextmanager
def ensure_topdir(self):
original_cwd = Path.cwd()
original_cwd = os.getcwd()
os.chdir(self.topdir)
yield
os.chdir(original_cwd)
@_ensure_topdir
def pause(self):
self.started = False
self.cov.stop()
self.unset_env()
@_ensure_topdir
def resume(self):
self.cov.start()
self.started = True
self.set_env()
def start(self):
self.started = True
@_ensure_topdir
def set_env(self):
"""Put info about coverage into the env so that subprocesses can activate coverage."""
if self.cov_source is None:
os.environ['COV_CORE_SOURCE'] = os.pathsep
else:
os.environ['COV_CORE_SOURCE'] = os.pathsep.join(self.cov_source)
config_file = os.path.abspath(self.cov_config)
if os.path.exists(config_file):
os.environ['COV_CORE_CONFIG'] = config_file
else:
os.environ['COV_CORE_CONFIG'] = os.pathsep
os.environ['COV_CORE_DATAFILE'] = os.path.abspath(self.cov.config.data_file)
if self.cov_branch:
os.environ['COV_CORE_BRANCH'] = 'enabled'
def finish(self):
self.started = False
@staticmethod
def unset_env():
"""Remove coverage info from env."""
os.environ.pop('COV_CORE_SOURCE', None)
os.environ.pop('COV_CORE_CONFIG', None)
os.environ.pop('COV_CORE_DATAFILE', None)
os.environ.pop('COV_CORE_BRANCH', None)
os.environ.pop('COV_CORE_CONTEXT', None)
@staticmethod
def get_node_desc(platform, version_info):
"""Return a description of this node."""
return 'platform {}, python {}'.format(platform, '{}.{}.{}-{}-{}'.format(*version_info[:5]))
return 'platform {}, python {}'.format(platform, '%s.%s.%s-%s-%s' % version_info[:5])
@staticmethod
def get_width():
# taken from https://github.com/pytest-dev/pytest/blob/33c7b05a/src/_pytest/_io/terminalwriter.py#L26
width, _ = shutil.get_terminal_size(fallback=(80, 24))
# The Windows get_terminal_size may be bogus, let's sanify a bit.
if width < 40:
width = 80
return width
def sep(self, stream, s, txt):
def sep(stream, s, txt):
if hasattr(stream, 'sep'):
stream.sep(s, txt)
else:
fullwidth = self.get_width()
# taken from https://github.com/pytest-dev/pytest/blob/33c7b05a/src/_pytest/_io/terminalwriter.py#L126
# The goal is to have the line be as long as possible
# under the condition that len(line) <= fullwidth.
if sys.platform == 'win32':
# If we print in the last column on windows we are on a
# new line but there is no way to verify/neutralize this
# (we may not know the exact line width).
# So let's be defensive to avoid empty lines in the output.
fullwidth -= 1
N = max((fullwidth - len(txt) - 2) // (2 * len(s)), 1)
fill = s * N
line = f'{fill} {txt} {fill}'
# In some situations there is room for an extra sepchar at the right,
# in particular if we consider that with a sepchar like "_ " the
# trailing space is not important at the end of the line.
if len(line) + len(s.rstrip()) <= fullwidth:
line += s.rstrip()
# (end of terminalwriter borrowed code)
line += '\n\n'
stream.write(line)
sep_total = max((70 - 2 - len(txt)), 2)
sep_len = sep_total // 2
sep_extra = sep_total % 2
out = f'{s * sep_len} {txt} {s * (sep_len + sep_extra)}\n'
stream.write(out)
@_ensure_topdir
def summary(self, stream):
@@ -153,21 +135,22 @@ class CovController:
total = None
if not self.cov_report:
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
return self.cov.report(show_missing=True, ignore_errors=True, file=_NullFile)
# Output coverage section header.
if len(self.node_descs) == 1:
self.sep(stream, '_', f'coverage: {"".join(self.node_descs)}')
self.sep(stream, '-', f"coverage: {''.join(self.node_descs)}")
else:
self.sep(stream, '_', 'coverage')
self.sep(stream, '-', 'coverage')
for node_desc in sorted(self.node_descs):
self.sep(stream, ' ', f'{node_desc}')
# Report on any failed workers.
if self.failed_workers:
self.sep(stream, '_', 'coverage: failed workers')
stream.write('The following workers failed to return coverage data, ensure that pytest-cov is installed on these workers.\n')
self.sep(stream, '-', 'coverage: failed workers')
stream.write('The following workers failed to return coverage data, '
'ensure that pytest-cov is installed on these workers.\n')
for node in self.failed_workers:
stream.write(f'{node.gateway.id}\n')
@@ -177,23 +160,22 @@ class CovController:
'show_missing': ('term-missing' in self.cov_report) or None,
'ignore_errors': True,
'file': stream,
'precision': self.cov_precision,
}
skip_covered = isinstance(self.cov_report, dict) and 'skip-covered' in self.cov_report.values()
options.update({'skip_covered': skip_covered or None})
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
total = self.cov.report(**options)
# Produce annotated source code report if wanted.
if 'annotate' in self.cov_report:
annotate_dir = self.cov_report['annotate']
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
self.cov.annotate(ignore_errors=True, directory=annotate_dir)
# We need to call Coverage.report here, just to get the total
# Coverage.annotate don't return any total and we need it for --cov-fail-under.
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
total = self.cov.report(ignore_errors=True, file=_NullFile)
if annotate_dir:
stream.write(f'Coverage annotated source written to dir {annotate_dir}\n')
@@ -203,44 +185,28 @@ class CovController:
# Produce html report if wanted.
if 'html' in self.cov_report:
output = self.cov_report['html']
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
total = self.cov.html_report(ignore_errors=True, directory=output)
stream.write(f'Coverage HTML written to dir {self.cov.config.html_dir if output is None else output}\n')
# Produce xml report if wanted.
if 'xml' in self.cov_report:
output = self.cov_report['xml']
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
total = self.cov.xml_report(ignore_errors=True, outfile=output)
stream.write(f'Coverage XML written to file {self.cov.config.xml_output if output is None else output}\n')
# Produce json report if wanted
if 'json' in self.cov_report:
output = self.cov_report['json']
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
total = self.cov.json_report(ignore_errors=True, outfile=output)
stream.write('Coverage JSON written to file %s\n' % (self.cov.config.json_output if output is None else output))
# Produce Markdown report if wanted.
if 'markdown' in self.cov_report:
output = self.cov_report['markdown']
with _backup(self.cov, 'config'):
with Path(output).open('w') as output_file:
total = self.cov.report(ignore_errors=True, file=output_file, output_format='markdown')
stream.write(f'Coverage Markdown information written to file {output}\n')
# Produce Markdown report if wanted, appending to output file
if 'markdown-append' in self.cov_report:
output = self.cov_report['markdown-append']
with _backup(self.cov, 'config'):
with Path(output).open('a') as output_file:
total = self.cov.report(ignore_errors=True, file=output_file, output_format='markdown')
stream.write(f'Coverage Markdown information appended to file {output}\n')
# Produce lcov report if wanted.
if 'lcov' in self.cov_report:
output = self.cov_report['lcov']
with _backup(self.cov, 'config'):
with _backup(self.cov, "config"):
self.cov.lcov_report(ignore_errors=True, outfile=output)
# We need to call Coverage.report here, just to get the total
@@ -257,39 +223,29 @@ class Central(CovController):
@_ensure_topdir
def start(self):
self.cov = coverage.Coverage(
source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
config_file=self.cov_config,
)
if self.cov.config.dynamic_context == 'test_function':
message = (
'Detected dynamic_context=test_function in coverage configuration. '
'This is unnecessary as this plugin provides the more complete --cov-context option.'
)
warnings.warn(CentralCovContextWarning(message), stacklevel=1)
cleanup()
self.combining_cov = coverage.Coverage(
source=self.cov_source,
branch=self.cov_branch,
data_suffix=f'{filename_suffix(True)}.combine',
data_file=os.path.abspath(self.cov.config.data_file), # noqa: PTH100
config_file=self.cov_config,
)
self.cov = coverage.Coverage(source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
config_file=self.cov_config)
self.combining_cov = coverage.Coverage(source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
data_file=os.path.abspath(self.cov.config.data_file),
config_file=self.cov_config)
# Erase or load any previous coverage data and start coverage.
if not self.cov_append:
self.cov.erase()
self.cov.start()
super().start()
self.set_env()
@_ensure_topdir
def finish(self):
"""Stop coverage, save data to file and set the list of coverage objects to report on."""
super().finish()
self.unset_env()
self.cov.stop()
self.cov.save()
@@ -307,28 +263,26 @@ class DistMaster(CovController):
@_ensure_topdir
def start(self):
self.cov = coverage.Coverage(
source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
config_file=self.cov_config,
)
if self.cov.config.dynamic_context == 'test_function':
raise DistCovError(
'Detected dynamic_context=test_function in coverage configuration. '
'This is known to cause issues when using xdist, see: https://github.com/pytest-dev/pytest-cov/issues/604\n'
'It is recommended to use --cov-context instead.'
)
cleanup()
# Ensure coverage rc file rsynced if appropriate.
if self.cov_config and os.path.exists(self.cov_config):
# rsyncdir is going away in pytest-xdist 4.0, already deprecated
if hasattr(self.config.option, 'rsyncdir'):
self.config.option.rsyncdir.append(self.cov_config)
self.cov = coverage.Coverage(source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
config_file=self.cov_config)
self.cov._warn_no_data = False
self.cov._warn_unimported_source = False
self.cov._warn_preimported_source = False
self.combining_cov = coverage.Coverage(
source=self.cov_source,
branch=self.cov_branch,
data_suffix=f'{filename_suffix(True)}.combine',
data_file=os.path.abspath(self.cov.config.data_file), # noqa: PTH100
config_file=self.cov_config,
)
self.combining_cov = coverage.Coverage(source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
data_file=os.path.abspath(self.cov.config.data_file),
config_file=self.cov_config)
if not self.cov_append:
self.cov.erase()
self.cov.start()
@@ -337,13 +291,11 @@ class DistMaster(CovController):
def configure_node(self, node):
"""Workers need to know if they are collocated and what files have moved."""
node.workerinput.update(
{
'cov_master_host': socket.gethostname(),
'cov_master_topdir': self.topdir,
'cov_master_rsync_roots': [str(root) for root in node.nodemanager.roots],
}
)
node.workerinput.update({
'cov_master_host': socket.gethostname(),
'cov_master_topdir': self.topdir,
'cov_master_rsync_roots': [str(root) for root in node.nodemanager.roots],
})
def testnodedown(self, node, error):
"""Collect data file name from worker."""
@@ -358,17 +310,27 @@ class DistMaster(CovController):
# If worker is not collocated then we must save the data file
# that it returns to us.
if 'cov_worker_data' in output:
data_suffix = '%s.%s.%06d.%s' % ( # noqa: UP031
socket.gethostname(),
os.getpid(),
random.randint(0, 999999), # noqa: S311
output['cov_worker_node_id'],
data_suffix = '%s.%s.%06d.%s' % (
socket.gethostname(), os.getpid(),
random.randint(0, 999999),
output['cov_worker_node_id']
)
cov_data = CoverageData(
suffix=data_suffix,
)
cov_data.loads(output['cov_worker_data'])
cov = coverage.Coverage(source=self.cov_source,
branch=self.cov_branch,
data_suffix=data_suffix,
config_file=self.cov_config)
cov.start()
if coverage.version_info < (5, 0):
data = CoverageData()
data.read_fileobj(StringIO(output['cov_worker_data']))
cov.data.update(data)
else:
data = CoverageData(no_disk=True)
data.loads(output['cov_worker_data'])
cov.get_data().update(data)
cov.stop()
cov.save()
path = output['cov_worker_path']
self.cov.config.paths['source'].append(path)
@@ -395,38 +357,34 @@ class DistWorker(CovController):
@_ensure_topdir
def start(self):
# Determine whether we are collocated with master.
self.is_collocated = (
socket.gethostname() == self.config.workerinput['cov_master_host']
and self.topdir == self.config.workerinput['cov_master_topdir']
)
# If we are not collocated, then rewrite master paths to worker paths.
cleanup()
# Determine whether we are collocated with master.
self.is_collocated = (socket.gethostname() == self.config.workerinput['cov_master_host'] and
self.topdir == self.config.workerinput['cov_master_topdir'])
# If we are not collocated then rewrite master paths to worker paths.
if not self.is_collocated:
master_topdir = self.config.workerinput['cov_master_topdir']
worker_topdir = self.topdir
if self.cov_source is not None:
self.cov_source = [source.replace(master_topdir, worker_topdir) for source in self.cov_source]
self.cov_source = [source.replace(master_topdir, worker_topdir)
for source in self.cov_source]
self.cov_config = self.cov_config.replace(master_topdir, worker_topdir)
# Erase any previous data and start coverage.
self.cov = coverage.Coverage(
source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
config_file=self.cov_config,
)
# Prevent workers from issuing module-not-measured type of warnings (expected for a workers to not have coverage in all the files).
self.cov._warn_unimported_source = False
self.cov = coverage.Coverage(source=self.cov_source,
branch=self.cov_branch,
data_suffix=True,
config_file=self.cov_config)
self.cov.start()
super().start()
self.set_env()
@_ensure_topdir
def finish(self):
"""Stop coverage and send relevant info back to the master."""
super().finish()
self.unset_env()
self.cov.stop()
if self.is_collocated:
@@ -446,15 +404,20 @@ class DistWorker(CovController):
# it on the master node.
# Send all the data to the master over the channel.
data = self.cov.get_data().dumps()
if coverage.version_info < (5, 0):
buff = StringIO()
self.cov.data.write_fileobj(buff)
data = buff.getvalue()
else:
data = self.cov.get_data().dumps()
self.config.workeroutput.update(
{
'cov_worker_path': self.topdir,
'cov_worker_node_id': self.nodeid,
'cov_worker_data': data,
}
)
self.config.workeroutput.update({
'cov_worker_path': self.topdir,
'cov_worker_node_id': self.nodeid,
'cov_worker_data': data,
})
def summary(self, stream):
"""Only the master reports so do nothing."""
pass