C++ example project scanned on SonarQube using Jenkins

It is very easy to analyze a C, C++ and Objective-C project with SonarQube in your Jenkins Pipelines:

1. Create a sonar-project.properties file to store your configuration

2. Follow the steps described in the documentation of SonarScanner for Jenkins

   1. Install and configure the "SonarQube Scanner for Jenkins" plugin in "Configure System" section

   2. Configure the SonarScanner in "Global Tool Configuration" section

3. Add a task to download the Build Wrapper

4. Wrap your compilation with the Build Wrapper

5. Launch the analysis using withSonarQubeEnv block

You can take a look at the sonar-project.properties and Jenkinsfile to see it in practice. Please be aware that the SonarQube server URL is not completed in this Jenkinsfile example.

Documentation

• Documentation overview of the C, C++ and Objective-C analyzer

• Generating a compilation database (compile_commands.json)

• Running the analysis in Compilation Database mode

Linux\CMake

A build of the code repository on a Linux platform using CMake build system.

To build the code run:

mkdir build && cd build
cmake ..
make

Code Description

An example of a flawed C++ code. The code repository is meant to 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.