Skip to main content

Pytest plugin for measuring coverage.

Project description

docs

Documentation Status

tests

Travis-CI Build Status AppVeyor Build Status Requirements Status

package

PyPI Package latest release PyPI Wheel Supported versions Supported implementations
Commits since latest release

This plugin produces coverage reports. It supports centralised testing and distributed testing in both load and each modes. It also supports coverage of subprocesses.

All features offered by the coverage package should be available, either through pytest-cov or through coverage’s config file.

  • Free software: MIT license

Installation

Install with pip:

pip install pytest-cov

For distributed testing support install pytest-xdist:

pip install pytest-xdist

Upgrade

pytest-cov 2.0 is using a new .pth file (pytest-cov.pth). You may want to manually remove the older init_cov_core.pth from site-packages as it’s not automatically removed.

Uninstallation

Uninstall with pip:

pip uninstall pytest-cov

Under certain scenarios a stray .pth file may be left around in site-packages.

  • pytest-cov 2.0 may leave a pytest-cov.pth if you installed without wheels (easy_install, setup.py install etc).

  • pytest-cov 1.8 or older will leave a init_cov_core.pth.

Usage

Centralised Testing

Centralised testing will report on the combined coverage of the main process and all of its subprocesses.

Running centralised testing:

py.test --cov=myproj tests/

Shows a terminal report:

-------------------- coverage: platform linux2, python 2.6.4-final-0 ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

Distributed Testing: Load

Distributed testing with dist mode set to load will report on the combined coverage of all slaves. The slaves may be spread out over any number of hosts and each slave may be located anywhere on the file system. Each slave will have its subprocesses measured.

Running distributed testing with dist mode set to load:

py.test --cov=myproj -n 2 tests/

Shows a terminal report:

-------------------- coverage: platform linux2, python 2.6.4-final-0 ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

Again but spread over different hosts and different directories:

py.test --cov=myproj --dist load
        --tx ssh=memedough@host1//chdir=testenv1
        --tx ssh=memedough@host2//chdir=/tmp/testenv2//python=/tmp/env1/bin/python
        --rsyncdir myproj --rsyncdir tests --rsync examples
        tests/

Shows a terminal report:

-------------------- coverage: platform linux2, python 2.6.4-final-0 ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

Distributed Testing: Each

Distributed testing with dist mode set to each will report on the combined coverage of all slaves. Since each slave is running all tests this allows generating a combined coverage report for multiple environments.

Running distributed testing with dist mode set to each:

py.test --cov=myproj --dist each
        --tx popen//chdir=/tmp/testenv3//python=/usr/local/python27/bin/python
        --tx ssh=memedough@host2//chdir=/tmp/testenv4//python=/tmp/env2/bin/python
        --rsyncdir myproj --rsyncdir tests --rsync examples
        tests/

Shows a terminal report:

---------------------------------------- coverage ----------------------------------------
                          platform linux2, python 2.6.5-final-0
                          platform linux2, python 2.7.0-final-0
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

Reporting

It is possible to generate any combination of the reports for a single test run.

The available reports are terminal (with or without missing line numbers shown), HTML, XML and annotated source code.

The terminal report without line numbers (default):

py.test --cov-report term --cov=myproj tests/

-------------------- coverage: platform linux2, python 2.6.4-final-0 ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

The terminal report with line numbers:

py.test --cov-report term-missing --cov=myproj tests/

-------------------- coverage: platform linux2, python 2.6.4-final-0 ---------------------
Name                 Stmts   Miss  Cover   Missing
--------------------------------------------------
myproj/__init__          2      0   100%
myproj/myproj          257     13    94%   24-26, 99, 149, 233-236, 297-298, 369-370
myproj/feature4286      94      7    92%   183-188, 197
--------------------------------------------------
TOTAL                  353     20    94%

The terminal report with skip covered:

py.test --cov-report term:skip-covered --cov=myproj tests/

-------------------- coverage: platform linux2, python 2.6.4-final-0 ---------------------
Name                 Stmts   Miss  Cover
----------------------------------------
myproj/myproj          257     13    94%
myproj/feature4286      94      7    92%
----------------------------------------
TOTAL                  353     20    94%

1 files skipped due to complete coverage.

You can use skip-covered with term-missing as well. e.g. --cov-report term-missing:skip-covered

These three report options output to files without showing anything on the terminal:

py.test --cov-report html
        --cov-report xml
        --cov-report annotate
        --cov=myproj tests/

The output location for each of these reports can be specified. The output location for the XML report is a file. Where as the output location for the HTML and annotated source code reports are directories:

py.test --cov-report html:cov_html
        --cov-report xml:cov.xml
        --cov-report annotate:cov_annotate
        --cov=myproj tests/

The final report option can also suppress printing to the terminal:

py.test --cov-report= --cov=myproj tests/

This mode can be especially useful on continuous integration servers, where a coverage file is needed for subsequent processing, but no local report needs to be viewed. For example, tests run on Travis-CI could produce a .coverage file for use with Coveralls.

Coverage Data File

The data file is erased at the beginning of testing to ensure clean data for each test run. If you need to combine the coverage of several test runs you can use the --cov-append option to append this coverage data to coverage data from previous test runs.

The data file is left at the end of testing so that it is possible to use normal coverage tools to examine it.

Coverage Config File

This plugin provides a clean minimal set of command line options that are added to pytest. For further control of coverage use a coverage config file.

For example if tests are contained within the directory tree being measured the tests may be excluded if desired by using a .coveragerc file with the omit option set:

py.test --cov-config .coveragerc
        --cov=myproj
        myproj/tests/

Where the .coveragerc file contains file globs:

[run]
omit = tests/*

For full details refer to the coverage config file documentation.

Note that this plugin controls some options and setting the option in the config file will have no effect. These include specifying source to be measured (source option) and all data file handling (data_file and parallel options).

Limitations

For distributed testing the slaves must have the pytest-cov package installed. This is needed since the plugin must be registered through setuptools for pytest to start the plugin on the slave.

For subprocess measurement environment variables must make it from the main process to the subprocess. The python used by the subprocess must have pytest-cov installed. The subprocess must do normal site initialisation so that the environment variables can be detected and coverage started.

Coverage and debuggers

When it comes to TDD one obviously would like to debug tests. Debuggers in Python use mostly the sys.settrace function to gain access to context. Coverage uses the same technique to get access to the lines executed. Coverage does not play well with other tracers simultaneously running. This manifests itself in behaviour that PyCharm might not hit a breakpoint no matter what the user does. Since it is common practice to have coverage configuration in the pytest.ini file and pytest does not support removeopts or similar the –no-cov flag can disable coverage completely.

At the reporting part a warning message will show on screen

Coverage disabled via –no-cov switch!

Acknowledgements

Whilst this plugin has been built fresh from the ground up it has been influenced by the work done on pytest-coverage (Ross Lawley, James Mills, Holger Krekel) and nose-cover (Jason Pellerin) which are other coverage plugins.

Ned Batchelder for coverage and its ability to combine the coverage results of parallel runs.

Holger Krekel for pytest with its distributed testing support.

Jason Pellerin for nose.

Michael Foord for unittest2.

No doubt others have contributed to these tools as well.

Changelog

2.5.1 (2017-05-11)

  • Fixed xdist breakage (regression in 2.5.0). Fixes #157.

  • Allow setting custom data_file name in .coveragerc. Fixes #145. Contributed by Jannis Leidel & Ionel Cristian Mărieș in #156.

2.5.0 (2017-05-09)

  • Always show a summary when --cov-fail-under is used. Contributed by Francis Niu in PR#141.

  • Added --cov-branch option. Fixes #85.

  • Improve exception handling in subprocess setup. Fixes #144.

  • Fixed handling when --cov is used multiple times. Fixes #151.

2.4.0 (2016-10-10)

  • Added a “disarm” option: --no-cov. It will disable coverage measurements. Contributed by Zoltan Kozma in PR#135.

    WARNING: Do not put this in your configuration files, it’s meant to be an one-off for situations where you want to disable coverage from command line.

  • Fixed broken exception handling on .pth file. See #136.

2.3.1 (2016-08-07)

  • Fixed regression causing spurious errors when xdist was used. See #124.

  • Fixed DeprecationWarning about incorrect addoption use. Contributed by Florian Bruhin in PR#127.

  • Fixed deprecated use of funcarg fixture API. Contributed by Daniel Hahler in PR#125.

2.3.0 (2016-07-05)

  • Add support for specifying output location for html, xml, and annotate report. Contributed by Patrick Lannigan in PR#113.

  • Fix bug hiding test failure when cov-fail-under failed.

  • For coverage >= 4.0, match the default behaviour of coverage report and error if coverage fails to find the source instead of just printing a warning. Contributed by David Szotten in PR#116.

  • Fixed bug occurred when bare --cov parameter was used with xdist. Contributed by Michael Elovskikh in PR#120.

  • Add support for skip_covered and added --cov-report=term-skip-covered command line options. Contributed by Saurabh Kumar in PR#115.

2.2.1 (2016-01-30)

  • Fixed incorrect merging of coverage data when xdist was used and coverage was >= 4.0.

2.2.0 (2015-10-04)

  • Added support for changing working directory in tests. Previously changing working directory would disable coverage measurements in suprocesses.

  • Fixed broken handling for --cov-report=annotate.

2.1.0 (2015-08-23)

  • Added support for coverage 4.0b2.

  • Added the --cov-append command line options. Contributed by Christian Ledermann in PR#80.

2.0.0 (2015-07-28)

  • Added --cov-fail-under, akin to the new fail_under option in coverage-4.0 (automatically activated if there’s a [report] fail_under = ... in .coveragerc).

  • Changed --cov-report=term to automatically upgrade to --cov-report=term-missing if there’s [run] show_missing = True in .coveragerc.

  • Changed --cov so it can be used with no path argument (in wich case the source settings from .coveragerc will be used instead).

  • Fixed .pth installation to work in all cases (install, easy_install, wheels, develop etc).

  • Fixed .pth uninstallation to work for wheel installs.

  • Support for coverage 4.0.

  • Data file suffixing changed to use coverage’s data_suffix=True option (instead of the custom suffixing).

  • Avoid warning about missing coverage data (just like coverage.control.process_startup).

  • Fixed a race condition when running with xdist (all the workers tried to combine the files). It’s possible that this issue is not present in pytest-cov 1.8.X.

1.8.2 (2014-11-06)

  • N/A

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-2.5.1.tar.gz (36.2 kB view hashes)

Uploaded Source

Built Distribution

pytest_cov-2.5.1-py2.py3-none-any.whl (21.2 kB view hashes)

Uploaded Python 2 Python 3

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