Skip to main content

Pytest plugin for excluding tests based on coverage data

Project description

https://api.travis-ci.org/mhallin/cov-exclude-py.svg?branch=master https://img.shields.io/pypi/v/pytest-cov-exclude.svg

Coverage-based test exclusion plugin for pytest. By looking at which lines are executed by each test, the next test run can be sped up by not executing the tests where no source files have changed.

If you have a large test suite which you often re-run, this plugin can drastically improve the iteration times.

Installation

Install with pip:

$ pip install pytest-cov-exclude

pytest-cov-exclude requires Pytest 2.8 or later. It is compatible with Python 2.7, 3.3, 3.4, 3.5, as well as PyPy. It does not work on PyPy 3 due to an unknown bug with the coverage data generated.

Usage

The first time you run your test suite, per-test coverage is enabled and the suite will take a little bit longer than usual:

$ py.test

==================== test session starts =====================

# Test output...

================ MANY passed in MANY seconds =================

Now when you re-run the test suite, all tests should have been excluded:

$ py.test

==================== test session starts =====================

# Test output...

=============== MANY deselected in FEW seconds ===============

If a test fails, it will re-run even if nothing changed in order to preserve the general failure status of the test suite.

Forcing individual test inclusion

If you have tests that depend on files not included in coverage data, such as data files or generated sources, you can mark the tests with external_dependencies. This forces them to be re-run even if no files were changed:

@pytest.mark.external_dependencies
def test_something():
    # Run tests from external data files

Known bugs

  • Changes to files during pytest’s collection phase will be ignored. Test files and their dependencies are scanned as soon as possible after the test collection is complete.

    There is a test case marked xfail that highlights this issue.

Running the whole test suite

If you want to force a complete re-run of the whole test suite, you have two options: either disable the plugin, or clear pytest’s cache:

$ py.test -p no:cov-exclude  # Disable the plugin

$ py.test --cache-clear  # Clear pytest's cache

Compatibility

As stated earlier, this plugin requires Pytest 2.8 or later since it depends on the new cache module.

While PyPy is supported, the ujson library used for faster serialization/deserialization is not available, so a fallback to the default JSON implementation is used instead. Because of this, the tests might actually run slower with this plugin under PyPy.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-cov-exclude-0.0.9.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

pytest_cov_exclude-0.0.9-py2.py3-none-any.whl (11.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-cov-exclude-0.0.9.tar.gz.

File metadata

File hashes

Hashes for pytest-cov-exclude-0.0.9.tar.gz
Algorithm Hash digest
SHA256 f67e3a0ef44160e6b9ceb36902cee68a64d328a0a61b1b7fe881414f4c94fa88
MD5 85d68987c7581ced152817fce65389b8
BLAKE2b-256 3e55e4c346205bc51efe8632fc419b15349a8ea297fe32fce03bf684c10e2d0c

See more details on using hashes here.

File details

Details for the file pytest_cov_exclude-0.0.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_cov_exclude-0.0.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e5e373c4e5b13a43b5f2d7ec4baf68af4fcdedd4097702cb7983475a95fd4b25
MD5 020d94d68423db21f440c674aa00504e
BLAKE2b-256 2127c63af4ce00ce26000ac82e78228f7de4f273e54f3c628aa79d9699abaabd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page