Add code coverage

Author: Hind-M

.github/workflows/windows.yml

@@ -29,14 +29,24 @@ jobs:
           init-shell: bash
           cache-environment: true
 
+      - name: Enable tests coverage
+        if: matrix.build_type == 'Debug'
+        run: |
+          choco install opencppcoverage
+          echo "TEST_COVERAGE_ACTIVATION=' -DENABLE_COVERAGE=ON'" >> $GITHUB_ENV
+
       - name: Configure using cmake
         run: |
+          #if [[ "${{ matrix.build_type }}" == "Debug" ]]; then
+            #export CMAKE_ARGS="-DENABLE_COVERAGE=ON"
+          #fi
           cmake -S ./ -B ./build \
           -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
           -DCMAKE_INSTALL_PREFIX=%CONDA_PREFIX% \
           -DCMAKE_PREFIX_PATH=%CONDA_PREFIX% \
           -DSPARROW_IPC_BUILD_SHARED=${{ matrix.build_shared }} \
-          -DSPARROW_IPC_BUILD_TESTS=ON
+          -DSPARROW_IPC_BUILD_TESTS=ON \
+          $TEST_COVERAGE_ACTIVATION
 
       - name: Build sparrow-ipc
         working-directory: build
@@ -51,6 +61,23 @@ jobs:
         run: |
           cmake --build . --target run_tests
 
+      - name: Tests coverage
+        if: matrix.build_type == 'Debug'
+        working-directory: build
+        run: |
+          cmake --build . --config Debug --target generate_cobertura
+
+      - name: Upload coverage to Codecov
+        if: matrix.build_type == 'Debug'
+        uses: codecov/codecov-action@v5
+        with:
+          directory: ./build/coverage_reports/
+          fail_ci_if_error: true
+          files: ./cobertura.xml
+          flags: unittests
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+
   windows_build_fetch_from_source:
     runs-on: windows-latest
     strategy:

CMakeLists.txt

@@ -47,6 +47,9 @@ MESSAGE(STATUS "🔧 Build tests: ${SPARROW_IPC_BUILD_TESTS}")
 OPTION(BUILD_DOCS  "Build sparrow-ipc documentation" OFF)
 MESSAGE(STATUS "🔧 Build docs: ${BUILD_DOCS}")
 
+OPTION(ENABLE_COVERAGE "Enable test coverage" OFF)
+MESSAGE(STATUS "🔧 Enable coverage: ${ENABLE_COVERAGE}")
+
 set(SPARROW_IPC_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include)
 set(SPARROW_IPC_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src)
 
@@ -156,6 +159,10 @@ target_link_libraries(sparrow-ipc
 
 add_dependencies(sparrow-ipc generate_flatbuffers_headers)
 
+if(ENABLE_COVERAGE)
+    include(code_coverage)
+    enable_coverage(sparrow-ipc)
+endif()
 # Tests
 # =====
 if(SPARROW_IPC_BUILD_TESTS)

cmake/code_coverage.cmake

@@ -0,0 +1,51 @@
+if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+    message(WARNING "Code coverage results with an optimised (non-Debug) build may be misleading")
+endif()
+
+set(COVERAGE_REPORT_PATH "${CMAKE_BINARY_DIR}/coverage_reports" CACHE PATH "Path to store coverage reports")
+set(COBERTURA_REPORT_PATH "${COVERAGE_REPORT_PATH}/cobertura.xml" CACHE PATH "Path to store cobertura report")
+set(COVERAGE_TARGETS_FOLDER "Tests utilities/Code Coverage")
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+    message(STATUS "==============> Using MSVC")
+    find_program(OpenCPPCoverage OpenCppCoverage.exe opencppcoverage.exe REQUIRED
+        PATHS "C:/Program Files/OpenCppCoverage" "C:/Program Files (x86)/OpenCppCoverage")
+
+    cmake_path(CONVERT ${CMAKE_SOURCE_DIR} TO_NATIVE_PATH_LIST OPENCPPCOVERAGE_SOURCES)
+    set(OPENCPPCOVERAGE_COMMON_ARGS --sources=${OPENCPPCOVERAGE_SOURCES} --modules=${OPENCPPCOVERAGE_SOURCES} --excluded_sources=test*)
+
+    add_custom_target(generate_cobertura
+        COMMAND ${OpenCPPCoverage}
+            ${OPENCPPCOVERAGE_COMMON_ARGS}
+            --export_type=cobertura:${COBERTURA_REPORT_PATH}
+            -- $<TARGET_FILE:test_sparrow_ipc_lib>
+        DEPENDS test_sparrow_ipc_lib
+        COMMENT "Generating coverage cobertura report with OpenCppCoverage: ${COBERTURA_REPORT_PATH}"
+    )
+    set(TARGET_PROPERTIES generate_cobertura PROPERTIES FOLDER ${COVERAGE_TARGETS_FOLDER})
+
+    add_custom_target(generate_html_coverage_report
+        COMMAND ${OpenCPPCoverage}
+            ${OPENCPPCOVERAGE_COMMON_ARGS}
+            --export_type=html:${COVERAGE_REPORT_PATH}
+            -- $<TARGET_FILE:test_sparrow_ipc_lib>
+        DEPENDS test_sparrow_ipc_lib
+        COMMENT "Generating coverage report with OpenCppCoverage: ${COVERAGE_REPORT_PATH}"
+    )
+    set(TARGET_PROPERTIES generate_cobertura PROPERTIES FOLDER "Tests utilities/Code Coverage")
+elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    message(STATUS "==============> Using Clang or GNU")
+endif()
+
+#TODO this may not be useful if coverage only on Windows ci?
+function(enable_coverage target)
+    set(CLANG_COVERAGE_FLAGS --coverage -fprofile-instr-generate -fcoverage-mapping -fno-inline -fno-elide-constructors)
+    set(GCC_COVERAGE_FLAGS --coverage -fno-inline -fno-inline-small-functions -fno-default-inline)
+
+    target_compile_options(${target} PRIVATE
+        $<$<CXX_COMPILER_ID:Clang>:${CLANG_COVERAGE_FLAGS}>
+        $<$<CXX_COMPILER_ID:GNU>:${GCC_COVERAGE_FLAGS}>)
+    target_link_options(${target} PRIVATE
+        $<$<CXX_COMPILER_ID:Clang>:${CLANG_COVERAGE_FLAGS}>
+        $<$<CXX_COMPILER_ID:GNU>:${GCC_COVERAGE_FLAGS}>)
+endfunction(enable_coverage target)

tests/CMakeLists.txt

@@ -13,6 +13,11 @@ set(
 )
 
 add_executable(${test_target} ${SPARROW_IPC_TESTS_SRC})
+
+if(ENABLE_COVERAGE)
+    enable_coverage(${test_target})
+endif()
+
 target_link_libraries(${test_target}
     PRIVATE
         sparrow-ipc