Add: Coverage CMake targets and Codecov upload

This adds new targets for measuring unit test coverage that can be
enabled with the CMake option ENABLE_COVERAGE.
The GitHub Actions workflow now also generates the coverage report
and uploads it to Codecov.

.github/workflows/build-and-test.yml

@@ -48,6 +48,11 @@ jobs:
  runs-on: ubuntu-latest
  container: ${{ vars.IMAGE_REGISTRY }}/greenbone/gvmd-build:stable
  steps:
+ - name: Install git for Codecov uploader
+ run: |
+ apt update
+ apt install --no-install-recommends -y ca-certificates git
+ rm -rf /var/lib/apt/lists/*
  - name: Check out gvmd
  uses: actions/checkout@v4
  - name: Build gvmd
@@ -56,3 +61,9 @@ jobs:
  cmake --build build
  - name: Configure and run tests
  run: CTEST_OUTPUT_ON_FAILURE=1 cmake --build build -- tests test
+ - name: Upload test coverage to Codecov
+ uses: codecov/codecov-action@v4
+ with:
+ file: build/coverage/coverage.xml
+ token: ${{ secrets.CODECOV_TOKEN }}
+ flags: unittests

.github/workflows/build-docs.yml

@@ -12,6 +12,8 @@ jobs:
  steps:
  - name: Run the c lang coverage action
  uses: greenbone/actions/doc-coverage-clang@v3
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
 
  build-gmp-doc:
  name: Build GMP documentation

CMakeLists.txt

@@ -259,6 +259,16 @@ configure_file (tools/greenbone-scapdata-sync.in tools/greenbone-scapdata-sync @
 configure_file (tools/greenbone-certdata-sync.in tools/greenbone-certdata-sync @ONLY)
 configure_file (tools/gvm-manage-certs.in tools/gvm-manage-certs @ONLY)
 
+## Code coverage
+
+OPTION (ENABLE_COVERAGE "Enable support for coverage analysis" OFF)
+if (ENABLE_COVERAGE)
+ set (COVERAGE_FLAGS "--coverage -ftest-coverage -fprofile-arcs")
+ set (COVERAGE_DIR "${CMAKE_BINARY_DIR}/coverage")
+ file (MAKE_DIRECTORY ${COVERAGE_DIR})
+ message ("-- Code Coverage enabled")
+endif (ENABLE_COVERAGE)
+
 ## Testing
 
 enable_testing ()
@@ -280,7 +290,7 @@ set (HARDENING_FLAGS "-Wformat -Wformat-security -D_FORTIFY_SOURCE=2
 set (LINKER_HARDENING_FLAGS "-Wl,-z,relro -Wl,-z,now")
 
 # To find unused functions, add: -flto -fwhole-program -ffunction-sections -Wl,--gc-sections -Wl,--print-gc-sections
-set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -D_BSD_SOURCE -D_ISOC99_SOURCE -D_SVID_SOURCE -D_DEFAULT_SOURCE -D_FILE_OFFSET_BITS=64 -DOPENVASD=${OPENVASD}")
+set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -D_BSD_SOURCE -D_ISOC99_SOURCE -D_SVID_SOURCE -D_DEFAULT_SOURCE -D_FILE_OFFSET_BITS=64 -DOPENVASD=${OPENVASD} ${COVERAGE_FLAGS}")
 
 set (CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -Werror -Wshadow ${COVERAGE_FLAGS} ${DEBUG_FUNCTION_NAMES_FLAGS}")
 set (CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} ${HARDENING_FLAGS} ${COVERAGE_FLAGS}")

src/CMakeLists.txt

@@ -262,6 +262,21 @@ add_custom_target (tests
  DEPENDS
  gmp-tickets-test manage-test manage-sql-test manage-utils-test utils-test)
 
+if (ENABLE_COVERAGE)
+ add_custom_target (coverage-html
+ COMMAND gcovr --html-details ${COVERAGE_DIR}/coverage.html
+ -r ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR})
+ add_custom_target (coverage-xml
+ COMMAND gcovr --xml ${COVERAGE_DIR}/coverage.xml
+ -r ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR})
+ add_custom_target (coverage DEPENDS coverage-xml coverage-html)
+endif (ENABLE_COVERAGE)
+
+add_custom_target (clean-coverage
+ COMMAND find . -name *.gcda -delete -or -name *.gcno -delete
+ COMMAND rm -f ${COVERAGE_DIR}/*)
+
+
 add_executable (gvmd
  main.c gvmd.c
  debug_utils.c