unittest2-cov / README.txt

unittest2-cov
=============

This plugin produces coverage reports.  It also supports coverage of subprocesses.

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


Installation
------------

The `unittest2-cov`_ package may be installed with pip or easy_install::

    pip install unittest2-cov
    easy_install unittest2-cov

.. _`unittest2-cov`: http://pypi.python.org/pypi/unittest2-cov/


Uninstallation
--------------

Uninstalling packages is supported by pip::

    pip uninstall unittest2-cov

However easy_install does not provide an uninstall facility.

.. IMPORTANT::

    Ensure that you manually delete the init_cov_core.pth file in your site-packages directory.

    This file starts coverage collection of subprocesses if appropriate during site initialisation
    at python startup.


Usage
-----

The following will report on the combined coverage of the main process and all of it's subprocesses::

    unit2 --cov testfoo testfoo

Shows a terminal report::

    ---------- coverage: platform linux2, python 2.6.5-final-0 -----------
    Name      Stmts   Exec  Cover
    -----------------------------
    testfoo      17      8    47%
    ----------------------------------------------------------------------


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)::

    unit2 --cov-report term --cov testfoo testfoo

    ---------- coverage: platform linux2, python 2.6.5-final-0 -----------
    Name      Stmts   Exec  Cover
    -----------------------------
    testfoo      17      8    47%
    ----------------------------------------------------------------------


The terminal report with line numbers::

    unit2 --cov-report term-missing --cov testfoo testfoo

    ---------- coverage: platform linux2, python 2.6.5-final-0 -----------
    Name      Stmts   Exec  Cover   Missing
    ---------------------------------------
    testfoo      17      8    47%   1-6, 9, 11, 15, 17, 19
    ----------------------------------------------------------------------


The remaining three reports output to files without showing anything on the terminal (useful for
when the output is going to a continuous integration server)::

    unit2 --cov-report html --cov-report xml --cov-report annotate --cov testfoo testfoo


Coverage Data File
------------------

The data file is erased at the beginning of testing to ensure clean data for each test run.

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


Limitations
-----------

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


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.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.