Page History

...

This section focuses on configuration to generate coverage data suitable for consumption by the Sonar scanner. See the section later in this document on Jenkins job configuration for details about that.

Configure CXX/CMake Project for Code Coverage

CXX projects require use of cmake and a dedicated tool, the Sonar build wrapper, as documented here: https://docs.sonarqube.org/latest/analysis/languages/cfamily/  The build wrapper is used to invoke cmake.  The wrapper then gathers data without further configuration. This tool is automatically installed and invoked in CMake-style Jenkins jobs, implemented by the cmake-sonarqube.sh script from LF's global-jjb. Actually no configuration changes are required in the project's CMakeLists.txt or other files, just use of the appropriate Jenkins job template.

Execution of the build via make should create the output file build-wrapper-dump.json, which can be consumed by the Sonar scanner.

Examples : from the O-RAN-SC project RMR:

• Repository https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/lib/rmr

...

•  
• Job configuration https://gerrit.o-ran-sc.org/r/gitweb?p=ci-management.git;a=blob;f=jjb/ric-plt-lib-rmr/ric-plt-lib-rmr.yaml
• Sonar report https://sonarcloud.io/dashboard?id=o-ran-sc_ric-plt-lib-rmr-c

Configure Golang/Go Project for Code Coverage

Go projects should use the go-acc tool (``go get -v github.com/ory/go-acc``) to run tests and generate statistics.  This yields better results than standard features in golang versions 1.12 and 1.13.  Here's an example:

...

Execution of the build via this command should create the output file coverage.txt, which can be consumed by the Sonar scanner. However modules are not supported yet by the Sonar Scanner. The problem and some workarounds are described here: https://jira.sonarsource.com/browse/SONARSLANG-450

Examples : from the O-RAN-SC project Alarm:

• Repository https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/alarm-go

...

• Job configuration https://gerrit.o-ran-sc.org/r/gitweb?p=ci-management.git;a=blob;f=jjb/ric-plt-alarm-go/ric-plt-alarm-go.yaml
• Sonar report (pending)

Configure Java/Maven Project for Code Coverage

Java projects require maven and should use the jacoco maven plugin in their the POM file, which instruments their code and gathers code-coverage statistics during JUnit tests. Here's an example:

...

Execution of the build via maven should create the output file target/jacoco.exec, which can be consumed by the Sonar scanner.

Examples : from the O-RAN-SC project Dashboard:

• Repository https://gerrit.o-ran-sc.org/r/admin/repos/portal/ric-dashboard

...

•  
• Job configuration https://gerrit.o-ran-sc.org/r/gitweb?p=ci-management.git;a=blob;f=jjb/portal-ric-dashboard/portal-ric-dashboard.yaml
• Sonar report https://sonarcloud.io/dashboard?id=o-ran-sc_portal-ric-dashboard

Configure Python/Tox Project for Code Coverage

Python projects require tox and should extend the tox.ini file that runs tests as follows.

...

Execution of the build via tox (really just tests) should create the output file coverage.xml, which can be consumed by the Sonar scanner.

Examples : from the O-RAN-SC project A1:

• Repository https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/a1

...

• Job configuration https://gerrit.o-ran-sc.org/r/gitweb?p=ci-management.git;a=blob;f=jjb/ric-plt-a1/ric-plt-a1.yaml
• Sonar report https://sonarcloud.io/dashboard?id=o-ran-sc_ric-plt-a1

Setting up development environment

...