C++ example project for generating test coverage with llvm-cov

The test coverage shown here works on both SonarQube and SonarCloud. In SonarQube import of branch coverage information from llvm-cov report is available only starting from SonarQube version 10.0. This project is analysed on SonarCloud!

ℹ️

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.

1. Add the -fprofile-instr-generate -fcoverage-mapping compilation flags to instrument the binaries

2. Run the tests to generate the test coverage information .* After each test run, "default.profraw" file will be generated. Make sure to move it someplace, to avoid overwriting with another test run.

3. Merge the coverage information from all test runs and convert the result into a format compatible with llvm-cov using llvm-profdata merge

4. Run llvm-cov show --show-branches=count on all the test executable files (or all object files you are interested in).

5. Save the output (the source files annotated with coverage counters) into a file

6. Point the property sonar.cfamily.llvm-cov.reportPath to the file with coverage report.

7. Run sonar-scanner as the final step

You can take a look at the sonar-project.properties and build.yml to see it in practice.

Documentation

• Documentation of the C, C++ and Objective-C plugin and its Build Wrapper

• Documentation of using SonarCloud with GitHub

• Configuring C, C++ and Objective-C analysis cache

• Configuring multithreaded execution

• Using compilation database (compile_commands.json)

• GitHub Action for C and C++ usage

Code Description

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 or SonarCloud.

You can find examples for:

• Linux

• macOS

• Windows

Using the following build systems:

• CMake

• GNU Autotools

• Xcode

• MSBuild

Running on the following CI services:

• Azure DevOps

• GitHub Actions

• Travis

• Jenkins

• GitLab CI

• BitBucket Pipelines

• Additionally, generic examples demonstrate integration with other CIs and manual-configuration examples should help you if you are running locally.

Configured for analysis on:

• SonarQube

• SonarCloud

You can find also a few examples demonstrating:

• The use of Compilation Database (compile_commands.json)

• Test coverage

See examples-structure.adoc for a description of the structure of this GitHub organization and the relations between its different repositories.