Try to do test coverage using clang and see what happens

Author: TrentHouliston

.github/workflows/sonarcloud.yaml

@@ -26,9 +26,6 @@ jobs:
         with:
           fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
 
-      - name: Install gcovr
-        run: pip install gcovr==8.2
-
       - name: Install sonar-scanner and build-wrapper
         uses: SonarSource/sonarcloud-github-c-cpp@v3
 
@@ -61,41 +58,27 @@ jobs:
             -DENABLE_COVERAGE=ON \
             -DENABLE_CLANG_TIDY=OFF
 
-      - name: Build the code in debug mode
+      - name: Build the code
         timeout-minutes: 30
-        run: cmake --build build/ --config Debug
+        run: cmake --build build/ --config Release
 
       - name: Run tests to generate coverage statistics
         timeout-minutes: 10
         working-directory: build
-        run: ninja run_all_tests -j1 -k 0
+        run: ninja coverage -k 0
 
       - name: Test Summary
         if: ${{ !cancelled() }}
         uses: test-summary/action@v2
         with:
           paths: "build/reports/tests/*.junit.xml"
 
-      - name: Collect coverage into one XML report
-        if: ${{ !cancelled() }}
-        run: |
-          gcovr \
-            --root . \
-            --object-directory build \
-            --force-color \
-            --no-markers \
-            --decisions \
-            --calls \
-            --exclude-noncode-lines \
-            --gcov-ignore-parse-errors negative_hits.warn \
-            --sonarqube "coverage.xml"
-
       - name: Upload coverage report
         if: ${{ !cancelled() }}
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-sonar
-          path: coverage.xml
+          name: coverage
+          path: build/reports/coverage.txt
           retention-days: 1 # This sets the artifact TTL to 1 day (minimum is 1 day)
           overwrite: true
 
@@ -111,7 +94,7 @@ jobs:
             --define sonar.sources=src \
             --define sonar.tests=tests \
             --define sonar.cfamily.compile-commands=build/compile_commands.json \
-            --define sonar.coverageReportPaths=coverage.xml
+            --define sonar.cfamily.llvm-cov.reportPath=build/reports/coverage.txt
 
       - name: Upload Traces
         if: ${{ !cancelled() }}

cmake/TestRunner.cmake

@@ -36,25 +36,68 @@ get_all_catch_test_targets(all_targets ${PROJECT_SOURCE_DIR})
 
 # Create a custom command for each test target to run it
 # Make sure that coverage data is written with paths relative to the source directory
-unset(reports)
+unset(report_outputs)
+unset(coverage_reports)
 foreach(target ${all_targets})
 
-  set(sonarqube_report_file "${PROJECT_BINARY_DIR}/reports/tests/${target}.sonarqube.xml")
+  unset(command_prefix)
+  if(ENABLE_COVERAGE AND CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+    # Extra output files for the profile data
+    set(raw_coverage "${PROJECT_BINARY_DIR}/reports/tests/${target}.profraw")
+    set(indexed_coverage "${PROJECT_BINARY_DIR}/reports/tests/${target}.profdata")
+    set(coverage_report "${PROJECT_BINARY_DIR}/reports/tests/${target}.txt")
+    set(command_prefix "cmake" "-E" "env" "LLVM_PROFILE_FILE=${raw_coverage}")
+    list(APPEND coverage_reports ${coverage_report})
+  endif()
+
   set(junit_report_file "${PROJECT_BINARY_DIR}/reports/tests/${target}.junit.xml")
-  list(APPEND reports ${sonarqube_report_file} ${junit_report_file})
+  list(APPEND report_outputs ${junit_report_file})
   add_custom_command(
-    OUTPUT ${sonarqube_report_file} ${junit_report_file}
-    COMMAND $<TARGET_FILE:${target}> --reporter console --reporter SonarQube::out=${sonarqube_report_file} --reporter
-            JUnit::out=${junit_report_file}
+    OUTPUT ${junit_report_file} ${raw_coverage}
+    COMMAND ${command_prefix} $<TARGET_FILE:${target}> --reporter console --reporter JUnit::out=${junit_report_file}
     WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+    DEPENDS ${target}
     USES_TERMINAL
     COMMENT "Running test ${target}"
   )
+
+  if(ENABLE_COVERAGE AND CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+    add_custom_command(
+      OUTPUT ${indexed_coverage}
+      COMMAND llvm-profdata merge -sparse ${raw_coverage} -o ${indexed_coverage}
+      DEPENDS ${raw_coverage}
+    )
+
+    add_custom_command(
+      OUTPUT ${coverage_report}
+      COMMAND llvm-cov show --show-branches=count -Xdemangler c++filt
+              -instr-profile=${CMAKE_CURRENT_BINARY_DIR}/coverage.profdata $<TARGET_FILE:${target}> > ${coverage_report}
+      DEPENDS ${indexed_coverage}
+    )
+  endif()
+
 endforeach()
 
 # Create a custom target that depends on all test targets
 add_custom_target(
   run_all_tests
-  DEPENDS ${reports}
+  DEPENDS ${report_outputs} ${all_targets}
   COMMENT "Running all Catch2 tests"
 )
+
+# Concatenate all the coverage reports together
+if(ENABLE_COVERAGE AND CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+
+  add_custom_command(
+    OUTPUT ${PROJECT_BINARY_DIR}/reports/coverage.txt
+    COMMAND cat ${coverage_reports} > ${PROJECT_BINARY_DIR}/reports/coverage.txt
+    DEPENDS ${coverage_reports}
+  )
+
+  add_custom_target(
+    coverage
+    DEPENDS ${PROJECT_BINARY_DIR}/reports/coverage.txt
+    COMMENT "Running all Catch2 tests with coverage"
+  )
+
+endif()