Code Coverage API

Gitter Jenkins Plugin Installs Jenkins GitHub Actions Codecov

This Jenkins plugin integrates and publishes multiple coverage report types. It has been developed since GSoC 2018.

Supported Coverage Formats

Embedded

Other plugins as an Extension of Code Coverage API plugin

Release Notes

See the GitHub Releases.

Features

  • Coverage analysis of whole projects and pull requests:

    • complete code (Project Coverage)
    • code changes (Change Coverage)
    • coverage changes created by changed test cases (Indirect Coverage Changes)
  • Modernized coverage report visualization:

    • Coverage overview and trend

      alt text

    • Colored project coverage tree map for line and branch coverage

      alt text

    • Source code navigation

      alt text

    • Specific source code view for specifically analyzing the coverage of code changes (Change Coverage):

      alt text

    • Specific source code view for specifically analyzing the coverage after test changes (Indirect Coverage Changes):

      alt text

  • Customizable coverage overview for the Jenkins dashboard view and for build results: alt text alt text

Usage

1. Configure your coverage tool to generate reports

Cobertura based coverage

Configure Maven to generate Cobertura coverage reports:

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>cobertura-maven-plugin</artifactId>
            <version>2.7</version>
            <configuration>
                <formats>
                    <format>xml</format>
                </formats>
                <check/>
            </configuration>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>cobertura</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

More information about Cobertura.

JaCoCo based coverage

Configure Maven to generate JaCoCo coverage reports:

<build>
    <plugins>
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                </execution>
                <execution>
                    <id>report</id>
                    <phase>package</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

More Information about JaCoCo.

llvm-cov based coverage

Use llvm-cov to generate JSON format report:

$ llvm-cov export -instr-profile /path/to/foo.profdata /path/to/foo

More Information llvm-cov.

2. (Optional) Install Jenkins plugins which implement Code Coverage API plugin (cobertura-plugin, llvm-cov-plugin).

3. Enable "Publish Coverage Report" publisher in the Post-build Actions.

4. Add your coverage tool adapter and specify reports path.

alt text

5. (Optional) Use the forensics-api plugin to discover the reference build that is used to compute a delta report of the coverage results.

6. (Optional) Specify Thresholds of each metrics in global or adapter level.

7. (Optional) Specify Source code storing level to enable source code navigation.

alt text

Pipeline example

We also support pipeline configuration, you can generate pipeline code in Jenkins Snippet Generator.

publishCoverage adapters: [jacocoAdapter('target/site/jacoco/jacoco.xml')]

You can also use jacoco instead of jacocoAdapter if you didn't install Jacoco-Plugin.

Parallel Pipeline Support

We support parallel pipeline. You can call the Code Coverage API plugin in different branches like this:

node {
    parallel firstBranch: {
        publishCoverage adapters: [jacocoAdapter('target/site/jacoco/jacoco.xml')]
}, secondBranch: {
        publishCoverage adapters: [jacocoAdapter('jacoco.xml')]
    }
}
Reports Combining Support

You can add tag on publishCoverage and Code Coverage API plugin will combine reports have same tag:

node {
    parallel firstBranch: {
        publishCoverage adapters: [jacocoAdapter('target/site/jacoco/jacoco.xml')], tag: ‘t’
}, secondBranch: {
        publishCoverage adapters: [jacocoAdapter('jacoco.xml')], tag: ‘t’
    }
}
Merging Reports

There is also a possibility to merge multiple reports (e.g. from multiple xml files) into one using the mergeToOneReport option with an ant-style path pattern. All reports found by the adapter will then be combined into a single report:

publishCoverage adapters: [jacocoAdapter(mergeToOneReport: true, path: '**/*.xml')]

REST API

We provide a REST API to retrieve coverage data:

  • Coverage result: …​/{buildNumber}/coverage/…​/result/api/\{json|xml\}?depth={number}
  • Trend result: …​/{buildNumber}/coverage/…​/trend/api/\{json|xml\}?depth={number}
  • Coverage result of last build: …​/{buildNumber}/coverage/…​/last/result/api/\{json|xml\}?depth={number}
  • Trend result of last build: …​/{buildNumber}/coverage/…​/last/trend/api/\{json|xml\}?depth={number}

Note: The larger the number, the deeper of coverage information can be retrieved.