sonarcloud.yaml

name: Sonar
on:
  push:
    branches:
      - main
      - sonar
  pull_request:
    types: [opened, synchronize, reopened]

# Ensure that only one instance of the workflow is run at a time for each branch/tag.
# Jobs currently running on the branch/tag will be cancelled when new commits are pushed.
# See https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency.
concurrency:
  # `github.workflow` is the workflow name, `github.ref` is the current branch/tag identifier
  group: ${{ format('{0}:{1}', github.workflow, github.ref) }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  sonarcloud:
    name: SonarCloud
    runs-on: ubuntu-latest
    env:
      BUILD_WRAPPER_OUT_DIR: build_wrapper_output_directory # Directory where build-wrapper output will be placed
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis

      - name: Install gcovr
        run: pip install gcovr==7.2

      - name: Install sonar-scanner and build-wrapper
        uses: SonarSource/sonarcloud-github-c-cpp@v3

      - name: Install CMake
        uses: lukka/get-cmake@latest
        with:
          cmakeVersion: 3.27.1
          ninjaVersion: 1.11.1

      - name: Setup CCache
        uses: hendrikmuhs/ccache-action@v1.2
        with:
          key: ${{ github.job }}
          max-size: 100M

      - name: Configure CMake
        run: |
          cmake -E make_directory build
          cmake -S . -B build \
            -GNinja \
            -DCMAKE_CXX_FLAGS="--coverage" \
            -DCMAKE_C_COMPILER_LAUNCHER=ccache \
            -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
            -DBUILD_TESTS=ON \
            -DCMAKE_BUILD_TYPE=Debug \
            -DCI_BUILD=ON \
            -DENABLE_CLANG_TIDY=OFF

      - name: Build the code in debug mode
        timeout-minutes: 30
        run: cmake --build build/ --config Debug

      - name: Run tests to generate coverage statistics
        timeout-minutes: 10
        working-directory: build/tests
        run: ctest --output-on-failure

      - name: Collect coverage into one XML report
        if: always()
        run: gcovr --gcov-ignore-parse-errors=negative_hits.warn_once_per_file --exclude-unreachable-branches --exclude-noncode-lines --sonarqube > coverage.xml

      - name: Run sonar-scanner
        if: always()
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
        run: |
          sonar-scanner \
            --define sonar.cfamily.compile-commands=build/compile_commands.json \
            --define sonar.coverageReportPaths=coverage.xml

      - name: Upload Traces
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: traces-sonar
          path: build/tests/**/*.trace
          retention-days: 1 # This sets the artifact TTL to 1 day (minimum is 1 day)
          overwrite: true