test_ok1/py/test/plugin/pytest_figleaf.py

"""
write and report coverage data with 'figleaf'. 

"""
import py

figleaf = py.test.importorskip("figleaf.annotate_html")

def pytest_addoption(parser):
    group = parser.addgroup('figleaf options')
    group.addoption('-F', action='store_true', default=False,
            dest = 'figleaf',
            help=('trace python coverage with figleaf and write HTML '
                 'for files below the current working dir'))
    group.addoption('--figleaf-data', action='store', default='.figleaf',
            dest='figleafdata',
            help='path to coverage tracing file.')
    group.addoption('--figleaf-html', action='store', default='html',
            dest='figleafhtml', 
            help='path to the coverage html dir.')

def pytest_configure(config):
    figleaf.start()

def pytest_terminal_summary(terminalreporter):
    config = terminalreporter.config
    datafile = py.path.local(config.getvalue('figleafdata'))
    tw = terminalreporter._tw
    tw.sep('-', 'figleaf')
    tw.line('Writing figleaf data to %s' % (datafile))
    figleaf.stop()
    figleaf.write_coverage(str(datafile))
    coverage = get_coverage(datafile, config)
    reportdir = py.path.local(config.getvalue('figleafhtml'))
    tw.line('Writing figleaf html to file://%s' % (reportdir))
    figleaf.annotate_html.prepare_reportdir(str(reportdir))
    exclude = []
    figleaf.annotate_html.report_as_html(coverage, 
            str(reportdir), exclude, {})

def get_coverage(datafile, config):
    # basepath = config.topdir
    basepath = py.path.local()
    data = figleaf.read_coverage(str(datafile))
    d = {}
    coverage = figleaf.combine_coverage(d, data)
    for path in coverage.keys():
        if not py.path.local(path).relto(basepath):
            del coverage[path]
    return coverage


def test_functional(testdir):
    py.test.importorskip("figleaf")
    testdir.plugins.append("figleaf")
    testdir.makepyfile("""
        def f():    
            x = 42
        def test_whatever():
            pass
        """)
    result = testdir.runpytest('-F')
    assert result.ret == 0
    assert result.stdout.fnmatch_lines([
        '*figleaf html*'
        ])
    #print result.stdout.str()