C/C++/Objective-C test coverage
SonarQube supports the reporting of test coverage information as part of the analysis of your C/C++/Objective-C project.
However, SonarQube does not generate the coverage report itself. Instead, you must set up a third-party tool to produce the report as part of your build process. You then need to configure your analysis to tell the SonarScanner where the report is located so that it can pick it up and send it to SonarQube, where it will be displayed on your project dashboard along with the other analysis metrics.
To enable coverage, you need to:
- Adjust your build process so that the coverage tool generates the report(s). This is done just after your unit tests as part of the clean build required to run analysis.
- Make sure that the coverage tool writes its report file to a defined path in the build environment.
- Configure the scanning step of your build so that the scanner picks up the report file from that defined path.
For C/C++/Objective-C projects, SonarQube supports a number of coverage tools. Each has an associated analysis parameter that must be set to the location of the coverage report that is produced by the tool. The parameters are:
Assuming that you have already set up your project, you will have seen the example projects (without coverage) referenced in the in-product tutorials: sonarsource-cfamily-examples.
In the same GitHub organization, you will also find example repositories that provide guidance on how to add coverage to an already-configured project. These examples do not explicitly describe every possible combination of tooling and platform but do cover the most significant variants. You may need to adapt them slightly:
- Visual Studio Coverage example on GitHub Actions
- Visual Studio Coverage example on Azure DevOps
- XCode Coverage example
- llvm-cov example
- gcovr example
- gcov example
Note that these examples do not include every possible combination of tooling and platform, so you may need to adapt them slightly to your situation:
These examples include the major free-to-use coverage tools for C/C++/Objective-C (VS Coverage, XCode Coverage, LLVM-COV, GCOVR, GCOV and OpenCppCoverage). For information on the popular commercial Bullseye product, see BullseyeCoverage - C++ Code Coverage Tool.
As with other analysis parameters, the coverage-related parameters for C/C++/Objective-C projects can be set in multiple places:
- On the command line of the scanner invocation use the
--defineswitch. This is what is done in the examples above, inside the
build.ymlfiles of each example.
- In the
- In the SonarQube interface under Your Project > Project Settings > General Settings > Languages > C/C++/Objective-C > Coverage for project-level settings, and Administration > Configuration > General Settings > Languages > C/C++/Objective-C > Coverage for global settings (applying to all projects).