C++ example project scanned on SonarQube Server using compilation database (compile_commands.json)

This project is analysed on SonarQube Server!

It is very easy to analyze a C, C++ and Objective-C project with SonarQube using compilation database:

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

2. In your .github/workflows/build.yml file:

   1. Set the environment variable SONAR_HOST_URL to your server url (e.g.: https://example.com:9000)

   2. Generate the compilation database file (set CMAKE_EXPORT_COMPILE_COMMANDS to ON)

   3. Run the SonarQube scan using the SonarSource/sonarqube-scan-action action with the property sonar.cfamily.compile-commands set to your compilation database file

3. Ensure that your token is stored as a secret in your repository (SONARQUBE_TOKEN in this example project). If you don’t have a token yet, you can generate a new one in SonarQube Server (see Managing your tokens).

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

Documentation

• C/C++/Objective-C analysis overview

• GitHub Integration

• Generating a compilation database

• Running the CFamily analysis

macOS\CMake

A build of the code repository on a macOS 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 Server or SonarQube Cloud.

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 Server

• SonarQube Cloud

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.