feat: automatically enable coverage for all targets excluding test targets (#897)

* feat: automatically enable coverage for all targets excluding test targets

* fix: correct typo in target_compile_options for mutation testing

Author: daantimmer

.github/workflows/static-analysis.yml

@@ -39,7 +39,7 @@ jobs:
           GTEST_OUTPUT: "xml:${{ github.workspace }}/testresults/"
       - name: Collect coverage
         run: |
-          gcovr --sonarqube=coverage.xml --exclude-lines-by-pattern '.*assert\(.*\);|.*really_assert\(.*\);|.*std::abort();' --exclude-unreachable-branches --exclude-throw-branches -j "$(nproc)" --exclude=.*/generated/.* --exclude=.*/examples/.* --exclude=.*/external/.* --exclude=.*/lwip/.* --exclude=.*/tracing/.* --exclude=.*/test/.*
+          gcovr --sonarqube=coverage.xml --exclude-lines-by-pattern '.*assert\(.*\);|.*really_assert\(.*\);|.*std::abort();' --exclude-unreachable-branches --exclude-throw-branches -j "$(nproc)" --exclude=.*/generated/.* --exclude=.*/examples/.* --exclude=.*/external/.* --exclude=.*/lwip/.* --exclude=.*/tracing/.*
       - name: Perform mutation testing
         uses: lukka/run-cmake@af1be47fd7c933593f687731bc6fdbee024d3ff4 # v10.8
         with:

CMakeLists.txt

@@ -15,6 +15,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED On)
 set_directory_properties(PROPERTY USE_FOLDERS On)
 
 include(CMakePackageConfigHelpers)
+include(emil_coverage)
 include(emil_antora)
 include(emil_build_for)
 include(emil_folderize)
@@ -160,6 +161,7 @@ emil_clangformat_directories(emil DIRECTORIES .)
 
 if (EMIL_STANDALONE)
     emil_generate_antora_docs_target(antora-playbook-branch.yml)
+    emil_coverage_targets(DIRECTORIES .)
     emil_folderize_all_targets()
 endif()
 

cmake/emil_coverage.cmake

@@ -0,0 +1,68 @@
+define_property(TARGET PROPERTY EXCLUDE_FROM_COVERAGE)
+
+function(emil_exclude_from_coverage target)
+    set_target_properties(${target} PROPERTIES EXCLUDE_FROM_COVERAGE TRUE)
+endfunction()
+
+function(emil_exclude_directory_from_coverage directory)
+    emil_get_subdirectories(directories DIRECTORIES ${directory})
+    list(APPEND directories ${directory})
+    emil_get_targets_from_directories(targets DIRECTORIES ${directories})
+
+    foreach(target ${targets})
+       emil_exclude_from_coverage(${target})
+    endforeach()
+endfunction()
+
+function(emil_enable_coverage_for target)
+    if (EMIL_ENABLE_COVERAGE)
+        message(DEBUG "enable coverage for: ${target}")
+        target_compile_options(${target} PRIVATE
+            -g -O0 --coverage -fprofile-arcs -ftest-coverage -fno-inline
+            $<$<COMPILE_LANGUAGE:CXX>:-fno-elide-constructors>
+        )
+
+        if (CMAKE_C_COMPILER_ID STREQUAL "GNU")
+            target_link_libraries(${target} PRIVATE gcov)
+        else()
+            target_link_options(${target} PRIVATE --coverage)
+        endif()
+    endif()
+endfunction()
+
+function(emil_enable_mutation_for target)
+    if (EMIL_ENABLE_MUTATION_TESTING)
+        message(DEBUG "enable mutation for: ${target}")
+        if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+            target_compile_options(${target} PRIVATE
+                -g -O0 -grecord-command-line -fprofile-instr-generate -fcoverage-mapping -fpass-plugin=/usr/lib/mull-ir-frontend
+            )
+
+            target_link_options(${target} PRIVATE -fprofile-instr-generate)
+        else()
+            message(FATAL_ERROR "Mutation testing is currently only supported for Clang/LLVM; not for ${CMAKE_CXX_COMPILER_ID}")
+        endif()
+    endif()
+endfunction()
+
+function(emil_coverage_targets directories)
+    set(singleArgs COVERAGE_FILE)
+    set(multiValueArgs DIRECTORIES)
+    cmake_parse_arguments(PARSE_ARGV 0 MY "" "${singleArgs}" "${multiValueArgs}")
+
+    emil_get_subdirectories(subdirectories DIRECTORIES ${MY_DIRECTORIES})
+    emil_get_targets_from_directories(targets DIRECTORIES ${subdirectories})
+
+    set(non_generated_target_sources)
+    foreach(target ${targets})
+        get_target_property(exclude ${target} EXCLUDE_FROM_COVERAGE)
+        get_target_property(type ${target} TYPE)
+
+        if (NOT exclude AND NOT ${type} STREQUAL "INTERFACE_LIBRARY" AND NOT ${type} STREQUAL "UTILITY")
+            emil_enable_coverage_for(${target})
+            emil_enable_mutation_for(${target})
+        else()
+            message(DEBUG "skipping coverage and mutation for: ${target}")
+        endif()
+    endforeach()
+endfunction()

cmake/emil_test_helpers.cmake

@@ -15,38 +15,14 @@ function(emil_fetch_googletest)
     FetchContent_MakeAvailable(googletest)
 
     set_target_properties(gtest gtest_main gmock gmock_main PROPERTIES FOLDER External/GoogleTest)
+    set_target_properties(gtest gtest_main gmock gmock_main PROPERTIES EXCLUDE_FROM_COVERAGE TRUE)
     mark_as_advanced(BUILD_GMOCK BUILD_GTEST BUILD_SHARED_LIBS gmock_build_tests gtest_build_samples test_build_tests gtest_disable_pthreads gtest_force_shared_crt gtest_hide_internal_symbols)
 endfunction()
 
 function(emil_enable_testing)
     include(GoogleTest)
 
     emil_fetch_googletest()
-
-    if (EMIL_ENABLE_COVERAGE)
-        add_compile_options(
-            -g -O0 --coverage -fprofile-arcs -ftest-coverage -fno-inline
-            $<$<COMPILE_LANGUAGE:CXX>:-fno-elide-constructors>
-        )
-
-        if (CMAKE_C_COMPILER_ID STREQUAL "GNU")
-            link_libraries(gcov)
-        else()
-            add_link_options(--coverage)
-        endif()
-    endif()
-
-    if (EMIL_ENABLE_MUTATION_TESTING)
-        if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
-            add_compile_options(
-                -g -O0 -grecord-command-line -fprofile-instr-generate -fcoverage-mapping -fpass-plugin=/usr/lib/mull-ir-frontend
-            )
-
-            add_link_options(-fprofile-instr-generate)
-        else()
-            message(FATAL_ERROR "Mutation testing is currently only supported for Clang/LLVM; not for ${CMAKE_CXX_COMPILER_ID}")
-        endif()
-    endif()
 endfunction()
 
 function(emil_enable_fuzzing)
@@ -66,6 +42,7 @@ function(emil_add_test target)
         else()
             add_test(NAME ${target} COMMAND ${target})
         endif()
+        emil_exclude_from_coverage(${target})
     endif()
 endfunction()
 

external/CMakeLists.txt

@@ -8,3 +8,4 @@ if (EMIL_INCLUDE_SEGGER_RTT)
 endif()
 
 emil_exclude_directory_from_clang_format(.)
+emil_exclude_directory_from_coverage(.)