Test coverage reporting

Use this plugin to activate coverage report.

To install this plugin, you need to activate coverage-plugin with extra requirements :

$ pip install nose2[coverage-plugin]

Next, you can enable coverage reporting with :

$ nose2 --with-coverage

Or with this lines in unittest.cfg :

[coverage]
always-on = True

Configuration [coverage]

always-on

Default:False Type:boolean

coverage

Default:[] Type:list

coverage-config

Default: Type:str

coverage-report

Default:[] Type:list

Sample configuration

The default configuration is equivalent to including the following in a unittest.cfg file.

[coverage]
always-on = False
coverage = 
coverage-config = 
coverage-report = 

Command-line options

--coverage PATH

Measure coverage for filesystem path (multi-allowed)

--coverage-report TYPE

Generate selected reports, available types: term, term-missing, annotate, html, xml (multi-allowed)

--coverage-config FILE

Config file for coverage, default: .coveragerc

-C DEFAULT, --with-coverage DEFAULT

Turn on coverage reporting

Plugin class reference: Coverage

class nose2.plugins.coverage.Coverage

afterSummaryReport(event)

Only called if active so stop coverage and produce reports.

createTests(event)

Start coverage early to catch imported modules.

Only called if active so, safe to just start without checking flags

createdTestSuite(event)

Pause coverage collection until we begin running tests.

handleArgs(event)

Get our options in order command line, config file, hard coded.

startTestRun(event)

Resume coverage collection before running tests.