The test coverage shown here works on both SonarQube Server and Cloud. This project is analyzed on SonarQube Cloud!
|
ℹ️
|
This simple example aims at demonstrating code coverage in action. It explains how to add coverage on a project for which the analysis is already configured. Analysis configuration examples are available here. Adding code coverage is done the same way regardless of whether you use the Build Wrapper or a Compilation Database to configure the analysis. |
To get coverage and feed it to the sonar-scanner, use the following procedure.
-
Add
--coveragecompilation flag to instrument the binaries -
Run the test binaries to count covered lines
-
Run
gcovr --sonarqubeto produce the SonarQube-compatible XML coverage report -
Point the
sonar.coverageReportPathsproperty to the generated coverage-report file -
Run the SonarQube scan using the SonarSource/sonarqube-scan-action action as final step
You can take a look at the sonar-project.properties and build.yml to see it in practice.
An example of a flawed C++ code. The code repository can be analyzed automatically, but it can also be compiled with different build systems using different CI pipelines on Linux, macOS, and Windows.
The code repository is forked into other repositories in this collection to add a specific build system, platform, and CI. The downstream repositories are analyzed either with SonarQube Server or SonarQube Cloud.
You can find examples for:
Using the following build systems:
Running on the following CI services:
-
Additionally, generic examples demonstrate integration with other CIs and manual-configuration examples should help you if you are running locally.
Configured for analysis on:
You can find also a few examples demonstrating:
See examples-structure.adoc for a description of the structure of this GitHub organization and the relations between its different repositories.