set up code coverage

Author: thundermage117

.github/workflows/ci.yml

@@ -11,32 +11,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Essential for SonarCloud to see history/blame
 
       - name: Install Dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y cmake g++ libopencv-dev
+          pip install gcovr==8.6
 
-      - name: Cache GoogleTest
-        id: cache-gtest
-        uses: actions/cache@v4
-        with:
-          path: build/_deps
-          # If you change the GTest version, the hash changes and the cache clears
-          key: ${{ runner.os }}-gtest-${{ hashFiles('core/tests/CMakeLists.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-gtest-
+      # Use a dedicated directory for build wrapper output
+      # This replaces the old 'build-wrapper-action'
+      - name: Install Build Wrapper
+        uses: SonarSource/sonarqube-scan-action/install-build-wrapper@a31c9398be7ace6bbfaf30c0bd5d415f843d45e9
 
-      - name: Configure and Build
+      - name: Run Build Wrapper
         run: |
-          # -B creates the build folder if it doesn't exist
-          cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
-          cmake --build build --config Release -j $(nproc)
+          build-wrapper-linux-x86-64 --out-dir bw-output make coverage
 
-      - name: Run Tests
-        run: |
-          cd build
-          ctest --output-on-failure
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarqube-scan-action@a31c9398be7ace6bbfaf30c0bd5d415f843d45e9
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          args: >
+            -Dsonar.cfamily.build-wrapper-output=bw-output
+            -Dsonar.coverageReportPaths=coverage.xml
 
   build-web:
     runs-on: ubuntu-latest

.gitignore

@@ -2,4 +2,5 @@
 core/build/
 core/images/
 build/
-images/
+images/
+coverage.xml

CMakeLists.txt

@@ -14,6 +14,15 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 # --- Testing ---
 enable_testing()
 
+# --- Coverage ---
+option(ENABLE_COVERAGE "Enable code coverage" OFF)
+if(ENABLE_COVERAGE)
+    if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
+        add_compile_options(--coverage -O0 -g)
+        add_link_options(--coverage)
+    endif()
+endif()
+
 # --- Subdirectories ---
 add_subdirectory(core)
 add_subdirectory(apps/native)

Makefile

@@ -59,6 +59,17 @@ test:
 	@cd build && cmake .. && make -j$(NPROCS)
 	@cd build && ctest --output-on-failure
 
+# 5. Coverage
+coverage:
+	@echo "📊 Generating Coverage..."
+	@mkdir -p build
+	@find build -name "*.gcda" -delete 
+	@cd build && cmake .. -DENABLE_COVERAGE=ON && make -j$(NPROCS)
+	@cd build && ctest --output-on-failure
+	@echo "📈 Generating Sonar-compatible XML report..."
+	# In gcovr 8.6, we use the search path at the end instead of --build-root
+	gcovr --sonarqube -o coverage.xml -r . --filter core/src/ -e build/ --gcov-ignore-parse-errors=all build
+
 # ------------------------------------
 # 🧹 CLEANUP
 # ------------------------------------

readme.md

@@ -1,6 +1,6 @@
 # Codec Explorer
 
-[![Build Status](https://github.com/thundermage117/codec/actions/workflows/ci.yml/badge.svg)](https://github.com/thundermage117/codec/actions/workflows/ci.yml) [![License: GPL v3](https://img.shields.io/badge/License-GPL_v3-blue.svg)](LICENSE) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=thundermage117_codec)](https://sonarcloud.io/summary/new_code?id=thundermage117_codec)
+[![Build Status](https://github.com/thundermage117/codec/actions/workflows/ci.yml/badge.svg)](https://github.com/thundermage117/codec/actions/workflows/ci.yml) [![License: GPL v3](https://img.shields.io/badge/License-GPL_v3-blue.svg)](LICENSE) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=thundermage117_codec&metric=coverage)](https://sonarcloud.io/summary/new_code?id=thundermage117_codec) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=thundermage117_codec)](https://sonarcloud.io/summary/new_code?id=thundermage117_codec)
 
 An interactive codec laboratory to visualize how transform-based image compression works. The C++ core is compiled to WebAssembly, allowing for real-time, in-browser experimentation.
 

sonar-project.properties

@@ -0,0 +1,16 @@
+sonar.projectKey=thundermage117_codec
+sonar.organization=thundermage117
+
+# Sources and Tests
+sonar.sources=core/src,apps/native,web/src
+sonar.tests=core/tests
+sonar.sourceEncoding=UTF-8
+
+# C++ Analysis Requirements
+sonar.cfamily.build-wrapper-output=bw-output
+
+# Use the XML report generated by gcovr in your GitHub Action
+sonar.coverageReportPaths=coverage.xml
+
+# Exclusions to keep the noise down
+sonar.exclusions=web/public/**, build/**, images/**, _deps/**