C++ code coverage report not loading

bapserver · August 7, 2020, 3:57pm

Hoping I could get some help with finding out why my c++ coverage report information is not loading.

I am using a unit testing framework called Catch2. The Catch2 documentation tells me the following:

SonarQube Reporter

-r sonarqube SonarQube Generic Test Data XML format for tests metrics.

link to the documentation:

catchorg/Catch2/blob/master/docs/ci-and-misc.md#other-reporters

<a id="top"></a>
# CI and other odd pieces

**Contents**<br>
[Continuous Integration systems](#continuous-integration-systems)<br>
[Other reporters](#other-reporters)<br>
[Low-level tools](#low-level-tools)<br>
[CMake](#cmake)<br>

This page talks about how Catch integrates with Continuous Integration 
Build Systems may refer to low-level tools, like CMake, or larger systems that run on servers, like Jenkins or TeamCity. This page will talk about both.

## Continuous Integration systems

Probably the most important aspect to using Catch with a build server is the use of different reporters. Catch comes bundled with three reporters that should cover the majority of build servers out there - although adding more for better integration with some is always a possibility (currently we also offer TeamCity, TAP, Automake and SonarQube reporters).

Two of these reporters are built in (XML and JUnit) and the third (TeamCity) is included as a separate header. It's possible that the other two may be split out in the future too - as that would make the core of Catch smaller for those that don't need them.

### XML Reporter
```-r xml```

This file has been truncated. show original

It would appear the coverage report is getting generated.

The following is my sonar-project.properties file:

sonar.organization=imanage
sonar.projectName=Work Server Core
sonar.projectKey=work-server-core
sonar.working.directory=target/sonar
sonar.cfamily.threads=3
sonar.cfamily.cache.enabled=true
sonar.cfamily.cache.path=sonar/sonar-cache/target/sonar-cache

#combine python and c++ analysis
sonar.sources=mlib,app
sonar.exclusions=**/tests,mlib/**/restclient-tests,mlib/**/restclient-mocks,mlib/**/DownloadTest,**/target,thirdparty
#sonar.exclusions=app/**/tests/**,mlib/**/restclient-tests/**,mlib/**/restclient-mocks/**,mlib/**/DownloadTest/**,mlib/**/target/**,app/**/target/**
sonar.cfamily.build-wrapper-output=build_wrapper_output_directory

sonar.cxx.coverage.reportPath=test/**/sonar-*.xml
sonar.python.coverage.reportPaths=app/pymodule/coverage.xml

My python coverage is being reported correctly. I have debug information turned on for the sonar processing. I do not see anything (including errors) regarding loading the coverage files for either python or cxx. But my python coverage is showing correctly on sonarcloud.

Not sure if I am just missing something simple or what I am trying to do simply is not supported for c++. I find some conflicting documentation. The sonar documentation seems to be very specific about what tools can be used to generate the c++ coverage files. Other documentation, like the catch2 documentation, indicates that sonar will support their coverage file.

Can someone help point me in the correct direction?

Thanks…

janos · August 24, 2020, 1:59pm

I think you can only use the coverage report formats mentioned in our docs. I don’t see sonar.cxx.coverage.reportPath there, so I think it’s simply ignored. Indeed you won’t see any logs about it, as you wouldn’t see about any unused sonar.foo.bar.baz properties.

The Catch2 tool you mention seems to use the generic test data format. As documented here, the name of the properties to find these reports are:

sonar.coverageReportPaths
sonar.testExecutionReportPaths