Compute the maximum coverage available through pytest with the minimum execution time cost
Project description
Overview
THIS PLUGIN IS IN DEVELOPMENT -- Expect bugs. Expect incomplete behaviour
pytest-maxcov
is a pytest plugin to compute the maximum coverage available through pytest with the minimum execution time cost. The plugin serves two main use cases:
- to identify redundant unit tests which do not add additional coverage
- to discover a subset of unit tests which achieves a minimum coverage level, for example to create a fast subset for a smoke test
Installation
python3 -m pip install pytest-maxcov
Usage
The plugin works in two passes:
- Run alongside
pytest-cov
to collect coverage information and time every test. Pass--maxcov-record
on the command-line topytest
to configure the plugin to capture the data it needs for the second pass. You must also include--cov-context=text
to that per-test coverage can be measured. - Run using
--maxcov
to read the data from pass one to mark tests as skipped if they are not needed to achieve the chosen coverage level.
The command-line option --maxcov-threshold
specifies the threshold for computing the minimum set of tests. By default this is 100%.
For example using Poetry and pytest-xdist:
poetry run pytest -n logical --maxcov-record --cov=mypackage --cov-branch --cov-context=test
poetry run pytest -n logical --maxcov --cov=mypackage --cov-branch
Limitations
Current limitations include:
- multiple contexts are not supported; the plugin assumes everything runs in a single context
- multiple coverage files are not supported; the plugin reads from
.coverage
by default or the data file specified by the environment variableCOVERAGE_FILE
License
All code in this repository is licensed under the MIT License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pytest_maxcov-1.0.0.tar.gz
(5.4 kB
view hashes)
Built Distribution
Close
Hashes for pytest_maxcov-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a95e0d76d6bb50e930004e2786976e562c31d690cb24a6464e98cf98e85e3cb6 |
|
MD5 | 021c33be4df9141fec945c516d21d8a6 |
|
BLAKE2b-256 | ee4c9e5bc71cddea4fead43e442a04ebee6df28bae7d2432128d31a113f55180 |