Only generate coverage targets if the COVERAGE option is enabled (#384)

PJK · web-flow · commit 2ec60998211d · 2026-01-11T11:32:25.000+01:00
* Only generate coverage targets if the COVERAGE option is enabled Fixes #383 * Add changelog entry
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ Template:
 Next
 ---------------------
 
+- [Only generate CMake coverage build targets when explicitly enabled](https://github.com/PJK/libcbor/issues/383)
+
 0.13.0 (2025-08-30)
 ---------------------
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,18 +2,18 @@ cmake_minimum_required(VERSION 3.5)
 
 project(libcbor LANGUAGES C CXX)
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH}
-                      "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules/")
+  "${CMAKE_CURRENT_SOURCE_DIR}/CMakeModules/")
 include(CTest)
 include(GNUInstallDirs) # Provides CMAKE_INSTALL_ variables
 
 set(CBOR_VERSION_MAJOR "0")
 set(CBOR_VERSION_MINOR "13")
 set(CBOR_VERSION_PATCH "0")
 set(CBOR_VERSION
-    ${CBOR_VERSION_MAJOR}.${CBOR_VERSION_MINOR}.${CBOR_VERSION_PATCH})
+  ${CBOR_VERSION_MAJOR}.${CBOR_VERSION_MINOR}.${CBOR_VERSION_PATCH})
 
 option(CMAKE_SKIP_INSTALL_ALL_DEPENDENCY
-       "cmake --build --target install does not depend on cmake --build" true)
+  "cmake --build --target install does not depend on cmake --build" true)
 option(BUILD_SHARED_LIBS "Build as a shared library" false)
 
 include(CheckIncludeFiles)
@@ -28,19 +28,19 @@ option(CBOR_CUSTOM_ALLOC "Custom, dynamically defined allocator support" OFF)
 if(CBOR_CUSTOM_ALLOC)
   message(
     WARNING
-      "CBOR_CUSTOM_ALLOC has been deprecated. \
+    "CBOR_CUSTOM_ALLOC has been deprecated. \
       Custom allocators are now enabled by default. \
       The flag is a no-op and will be removed in the next version. \
       Please remove CBOR_CUSTOM_ALLOC from your build configuration.")
 endif()
 
 option(CBOR_PRETTY_PRINTER "Include a pretty-printing routine" ON)
 set(CBOR_BUFFER_GROWTH
-    "2"
-    CACHE STRING "Factor for buffer growth & shrinking")
+  "2"
+  CACHE STRING "Factor for buffer growth & shrinking")
 set(CBOR_MAX_STACK_SIZE
-    "2048"
-    CACHE STRING "maximum size for decoding context stack")
+  "2048"
+  CACHE STRING "maximum size for decoding context stack")
 
 option(WITH_TESTS "[TEST] Build unit tests (requires CMocka)" OFF)
 if(WITH_TESTS)
@@ -50,14 +50,14 @@ endif()
 option(WITH_EXAMPLES "Build examples" ON)
 
 option(HUGE_FUZZ "[TEST] Fuzz through 8GB of data in the test.\
-       Do not use with memory instrumentation!" OFF)
+       Do not use with memory instrumentation!"  OFF)
 if(HUGE_FUZZ)
   add_definitions(-DHUGE_FUZZ)
 endif()
 
 option(SANE_MALLOC
-       "[TEST] Assume that malloc will not allocate multi-GB blocks.\
-       Tests only, platform specific" OFF)
+  "[TEST] Assume that malloc will not allocate multi-GB blocks.\
+       Tests only, platform specific"  OFF)
 if(SANE_MALLOC)
   add_definitions(-DSANE_MALLOC)
 endif()
@@ -89,9 +89,9 @@ check_c_source_compiles("
   #include <stdio.h>
   [[nodiscard]] int f(void) { return 42; }
   int main(void) { return f(); }
-" HAS_NODISCARD_ATTRIBUTE)
+"  HAS_NODISCARD_ATTRIBUTE)
 
-if (HAS_NODISCARD_ATTRIBUTE)
+if(HAS_NODISCARD_ATTRIBUTE)
   message(STATUS "[[nodiscard]] is supported.")
   add_definitions(-D_CBOR_HAS_NODISCARD_ATTRIBUTE)
   # Assume that if we have [[nodiscard]], we have some C23 support. May fail.
@@ -129,12 +129,12 @@ else()
   set(CBOR_RESTRICT_SPECIFIER "restrict")
 
   set(CMAKE_C_FLAGS_DEBUG
-      "${CMAKE_C_FLAGS_DEBUG} -O0 -Wall -Wextra -g -ggdb -DDEBUG=true")
+    "${CMAKE_C_FLAGS_DEBUG} -O0 -Wall -Wextra -g -ggdb -DDEBUG=true")
   set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -O3 -Wall -Wextra -DNDEBUG")
 
   if(SANITIZE)
     set(CMAKE_C_FLAGS_DEBUG
-        "${CMAKE_C_FLAGS_DEBUG} \
+      "${CMAKE_C_FLAGS_DEBUG} \
             -fsanitize=undefined -fsanitize=address \
             -fsanitize=bounds -fsanitize=alignment")
   endif()
@@ -147,7 +147,7 @@ check_type_size("size_t" SIZEOF_SIZE_T)
 if(SIZEOF_SIZE_T LESS 8)
   message(
     WARNING
-      "Your size_t is less than 8 bytes. \
+    "Your size_t is less than 8 bytes. \
       Decoding of huge items that would exceed the memory address space \
       will always fail. Consider implementing a custom streaming \
       decoder if you need to deal with huge items.")
@@ -160,9 +160,9 @@ check_c_source_compiles("
         __builtin_unreachable();
         return 0;
     }
-" HAS_BUILTIN_UNREACHABLE)
+"  HAS_BUILTIN_UNREACHABLE)
 
-if (HAS_BUILTIN_UNREACHABLE)
+if(HAS_BUILTIN_UNREACHABLE)
   add_definitions(-D_CBOR_HAS_BUILTIN_UNREACHABLE)
 endif()
 
@@ -172,7 +172,7 @@ endif()
 # mandatory with CMP0069 set to NEW.
 set(LTO_SUPPORTED FALSE)
 if(${CMAKE_VERSION} VERSION_GREATER "3.9.0" OR ${CMAKE_VERSION} VERSION_EQUAL
-                                               "3.9.0")
+  "3.9.0")
   cmake_policy(SET CMP0069 NEW)
   # Require LTO support to build libcbor with newer CMake versions
   include(CheckIPOSupported)
@@ -186,7 +186,7 @@ endif()
 if(LTO_SUPPORTED)
   message(
     STATUS
-      "LTO is supported and CMAKE_INTERPROCEDURAL_OPTIMIZATION=${CMAKE_INTERPROCEDURAL_OPTIMIZATION}"
+    "LTO is supported and CMAKE_INTERPROCEDURAL_OPTIMIZATION=${CMAKE_INTERPROCEDURAL_OPTIMIZATION}"
   )
 else()
   message(STATUS "LTO is not supported")
@@ -200,64 +200,65 @@ enable_testing()
 
 set(CTEST_MEMORYCHECK_COMMAND "/usr/bin/valgrind")
 set(MEMORYCHECK_COMMAND_OPTIONS
-    "--tool=memcheck --track-origins=yes --leak-check=full --error-exitcode=1")
-
-add_custom_target(
-  coverage
-  COMMAND ctest
-  COMMAND lcov --capture --directory . --output-file coverage.info
-  COMMAND genhtml coverage.info --highlight --legend --output-directory
-          coverage_html
-  COMMAND
+  "--tool=memcheck --track-origins=yes --leak-check=full --error-exitcode=1")
+
+# TODO: Rename the option to be in line with the rest (CBOR_...)
+option(COVERAGE "Enable code coverage instrumentation" OFF)
+if(COVERAGE)
+  add_custom_target(
+    coverage
+    COMMAND ctest
+    COMMAND lcov --capture --directory . --output-file coverage.info
+    COMMAND genhtml coverage.info --highlight --legend --output-directory
+    coverage_html
+    COMMAND
     echo
     "Coverage report ready: ${CMAKE_CURRENT_BINARY_DIR}/coverage_html/index.html"
-  COMMENT "Generate coverage report using the GNU toolchain"
-)
-
-add_custom_target(
-  llvm-coverage
-  COMMAND make -j 16
-  COMMAND rm -rf coverage_profiles
-  COMMAND mkdir coverage_profiles
-  COMMAND
+    COMMENT "Generate coverage report using the GNU toolchain"
+  )
+
+  add_custom_target(
+    llvm-coverage
+    COMMAND make -j 16
+    COMMAND rm -rf coverage_profiles
+    COMMAND mkdir coverage_profiles
+    COMMAND
     bash -c
     [[ for TEST in $(ls test/*_test); do LLVM_PROFILE_FILE="coverage_profiles/$(basename -- ${TEST}).profraw" ./${TEST}; done ]]
-  # VERBATIM makes escaping working, but breaks shell expansions, so we need to
-  # explicitly use bash
-  COMMAND
+    # VERBATIM makes escaping working, but breaks shell expansions, so we need to
+    # explicitly use bash
+    COMMAND
     bash -c
     [[ llvm-profdata merge -sparse $(ls coverage_profiles/*.profraw) -o coverage_profiles/combined.profdata ]]
-  COMMAND
+    COMMAND
     bash -c
     [[ llvm-cov show -instr-profile=coverage_profiles/combined.profdata test/*_test -format=html > coverage_profiles/report.html ]]
-  COMMAND
+    COMMAND
     bash -c
     [[ llvm-cov report -instr-profile=coverage_profiles/combined.profdata test/*_test ]]
-  COMMAND
+    COMMAND
     echo
     "Coverage report ready: ${CMAKE_CURRENT_BINARY_DIR}/coverage_profiles/report.html"
-  VERBATIM
-  COMMENT "Generate coverage report using the LLVM toolchain")
+    VERBATIM
+    COMMENT "Generate coverage report using the LLVM toolchain")
 
-option(COVERAGE "Enable code coverage instrumentation" OFF)
-if(COVERAGE)
   message("Configuring code coverage instrumentation")
   if(CMAKE_C_COMPILER_ID MATCHES "GNU")
     # https://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html
     set(CMAKE_C_FLAGS
-        "${CMAKE_C_FLAGS} -g -fprofile-arcs -ftest-coverage --coverage")
+      "${CMAKE_C_FLAGS} -g -fprofile-arcs -ftest-coverage --coverage")
     set(CMAKE_EXE_LINKER_FLAGS_DEBUG
-        "${CMAKE_EXE_LINKER_FLAGS_DEBUG} -g -fprofile-arcs -ftest-coverage --coverage"
+      "${CMAKE_EXE_LINKER_FLAGS_DEBUG} -g -fprofile-arcs -ftest-coverage --coverage"
     )
   elseif(CMAKE_C_COMPILER_ID MATCHES "Clang")
     set(CMAKE_C_FLAGS
-        "${CMAKE_C_FLAGS} -fprofile-instr-generate -fcoverage-mapping")
+      "${CMAKE_C_FLAGS} -fprofile-instr-generate -fcoverage-mapping")
     set(CMAKE_EXE_LINKER_FLAGS_DEBUG
-        "${CMAKE_EXE_LINKER_FLAGS_DEBUG} -fprofile-instr-generate")
+      "${CMAKE_EXE_LINKER_FLAGS_DEBUG} -fprofile-instr-generate")
   else()
     message(
       WARNING
-        "Code coverage build not implemented for compiler ${CMAKE_C_COMPILER_ID}"
+      "Code coverage build not implemented for compiler ${CMAKE_C_COMPILER_ID}"
     )
   endif()
 endif()
@@ -272,9 +273,9 @@ include_directories(src)
 # is accessible using the same path during both library build and installed
 # header use, without littering the source dir.
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/cbor/configuration.h.in
-               ${PROJECT_BINARY_DIR}/cbor/configuration.h)
+  ${PROJECT_BINARY_DIR}/cbor/configuration.h)
 install(FILES ${PROJECT_BINARY_DIR}/cbor/configuration.h
-        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/cbor)
+  DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/cbor)
 
 add_subdirectory(src)
 if(LTO_SUPPORTED)
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -12,15 +12,17 @@ foreach(test_file ${TESTS})
   string(REGEX REPLACE ".*/([^/]+).c" "\\1" NAME ${test_file})
   message("Adding test ${NAME}")
   add_executable(${NAME} "${NAME}.c" assertions.c stream_expectations.c
-                         test_allocator.c)
+    test_allocator.c)
   target_link_libraries(${NAME} ${CMOCKA_LIBRARIES})
   target_link_libraries(${NAME} cbor)
   if(MATH_LIBRARY)
     target_link_libraries(${NAME} ${MATH_LIBRARY})
   endif()
   target_include_directories(${NAME} PUBLIC ${CMOCKA_INCLUDE_DIR})
   add_test(NAME ${NAME} COMMAND ${NAME})
-  add_dependencies(coverage ${NAME})
+  if(COVERAGE)
+    add_dependencies(coverage ${NAME})
+  endif()
 endforeach()
 
 add_executable(cpp_linkage_test cpp_linkage_test.cpp)
