feat: script & custom target for cleaning old coverage output

Author: benthevining

.github/workflows/build_and_test.yml

@@ -113,7 +113,7 @@ jobs:
       env:
         BUILD_NAME: ${{ github.head_ref || github.ref_name }}.${{ matrix.os }}.${{ matrix.preset }}.${{ matrix.config }}
         CMAKE_OSX_ARCHITECTURES: arm64;x86_64
-      run: cmake --preset ${{ matrix.preset }} -D BENBOT_DOCS=OFF -D BUILDNAME=${{ env.BUILD_NAME }}
+      run: cmake --preset ${{ matrix.preset }} -D BENBOT_DOCS=OFF -D BUILDNAME=${{ env.BUILD_NAME }} --log-level=VERBOSE
 
     - name: Build and test
       run: |

config/cmake/Coverage.cmake

@@ -14,6 +14,13 @@
 
 include_guard (GLOBAL)
 
+include (FeatureSummary)
+
+add_feature_info (
+    coverage [[CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang" AND NOT WIN32]]
+    "Enabled coverage reporting flags for debug configurations"
+)
+
 if (CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang" AND NOT WIN32)
     get_cmake_property (debug_configs DEBUG_CONFIGURATIONS)
 
@@ -38,5 +45,13 @@ if (CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang" AND NOT WIN32)
         link_libraries ("$<${config_debug}:gcov>")
     endif ()
 
-    message (STATUS "Coverage enabled")
+    set (clean_script "${CMAKE_SOURCE_DIR}/scripts/CleanOldCoverageOutput.cmake")
+
+    add_custom_target (
+        coverage-clean
+        COMMAND "${CMAKE_COMMAND}" -D "BUILD_DIR=${CMAKE_BINARY_DIR}" -P "${clean_script}"
+        COMMENT "Cleaning old coverage output files..."
+        VERBATIM USES_TERMINAL
+        SOURCES "${clean_script}"
+    )
 endif ()

config/cmake/Sanitizers.cmake

@@ -62,6 +62,8 @@ function (__add_build_config name flags linkerFlags)
         CMAKE_CXX_FLAGS_${name} CMAKE_C_FLAGS_${name} CMAKE_EXE_LINKER_FLAGS_${name}
         CMAKE_SHARED_LINKER_FLAGS_${name} CMAKE_MODULE_LINKER_FLAGS_${name}
     )
+
+    message (VERBOSE "Added build configuration ${name}")
 endfunction ()
 
 # ASAN

scripts/CleanOldCoverageOutput.cmake

@@ -0,0 +1,36 @@
+# ======================================================================================
+#
+# ░▒▓███████▓▒░░▒▓████████▓▒░▒▓███████▓▒░       ░▒▓███████▓▒░ ░▒▓██████▓▒░▒▓████████▓▒░
+# ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
+# ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
+# ░▒▓███████▓▒░░▒▓██████▓▒░ ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
+# ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
+# ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
+# ░▒▓███████▓▒░░▒▓████████▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓███████▓▒░ ░▒▓██████▓▒░  ░▒▓█▓▒░
+#
+# ======================================================================================
+
+#[[
+This script can be run to remove all old coverage files in a build directory.
+
+Example usage (from repo root):
+cmake -D BUILD_DIR=$(pwd)/Builds/clang -P scripts/CleanOldCoverageOutput.cmake
+]]
+
+cmake_minimum_required (VERSION 4.0.0 FATAL_ERROR)
+
+if (NOT DEFINED BUILD_DIR)
+    message (FATAL_ERROR "BUILD_DIR not defined!")
+endif ()
+
+file (GLOB_RECURSE coverage_files LIST_DIRECTORIES false
+      "${BUILD_DIR}/*.gcda" "${BUILD_DIR}/*.gcov" "${BUILD_DIR}/*.profraw"
+)
+
+if (coverage_files)
+    file (REMOVE ${coverage_files})
+    list (LENGTH coverage_files num_files)
+    message (STATUS "Removed ${num_files} files.")
+else ()
+    message (STATUS "No coverage files found.")
+endif ()