flowbber.plugins.sinks.lcov_html

Lcov HTML

This sink plugin run lcov genhtml executable to generate a html report of coverage.

Note

This sink requires the genhtml executable to be available in your system to run.

Dependencies:

pip3 install flowbber[lcov]

Usage:

[[sinks]]
type = "lcov_html"
id = "..."

    [sinks.config]
    key = "<id of lcov source>"
    output = "<output directory>"
    override = true
    create_parents = true
{
    "sinks": [
        {
            "type": "lcov_html",
            "id": "...",
            "config": {
                "key": "<id of lcov source>",
                "output": "<output directory>",
                "override": true,
                "create_parents": true
            }
        }
    ]
}

key

Id of a lcov source in the pipeline.

  • Default: N/A

  • Optional: False

  • Schema:

    {
        'type': 'string',
        'empty': False,
    }
    
  • Secret: False

output

Path to a directory to write the generated html.

  • Default: N/A

  • Optional: False

  • Schema:

    {
        'type': 'string',
        'empty': False,
    }
    
  • Secret: False

override

Override output directory if already exists.

  • Default: False

  • Optional: True

  • Schema:

    {
        'type': 'boolean',
    }
    
  • Secret: False

create_parents

Create output parent directories if don’t exist.

  • Default: True

  • Optional: True

  • Schema:

    {
        'type': 'boolean',
    }
    
  • Secret: False

Classes

class flowbber.plugins.sinks.lcov_html.LcovHTMLSink(index, type_, id_, optional=False, timeout=None, config=None)

Inheritance

Inheritance diagram of LcovHTMLSink