[CONFIG] [Docker] [tools] gcovr tool (coverage) replaced by lcov.

Author: Gonzalo Diaz

.github/workflows/cpp-coverage.yml

@@ -21,14 +21,14 @@ jobs:
 
       - name: Install Tools
         run: |
-          pip install gcovr
+          sudo apt-get install lcov
 
       - name: Check Tools
         run: |
           make --version
           cmake --version
           vcpkg --version
-          gcovr --version
+          lcov --version
 
       - name: Install dependencies
         run: |
@@ -54,6 +54,6 @@ jobs:
         uses: codecov/codecov-action@v4
         with:
           directory: ./coverage
-          files: coverage.lcov
+          files: coverage/lcov.info
           token: ${{ secrets.CODECOV_TOKEN }} # required
           verbose: true # optional (default = false)

.github/workflows/sonarcloud.yml

@@ -22,13 +22,15 @@ jobs:
           fetch-depth: 0
       - name: Install Tools
         run: |
+          sudo apt-get install lcov
           pip install gcovr
 
       - name: Check Tools
         run: |
           make --version
           cmake --version
           vcpkg --version
+          lcov --version
           gcovr --version
 
       - name: Install dependencies
@@ -43,17 +45,13 @@ jobs:
       - name: Run build-wrapper
         run: |
           export VCPKG_ROOT=/usr/local/share/vcpkg
-          cmake --preset debug -B build
-          cmake --preset debug \
-            -DCMAKE_TOOLCHAIN_FILE=/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake \
-            -DCMAKE_EXPORT_COMPILE_COMMANDS=1 \
-            build
-          build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} cmake --build build --verbose
+          build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} make build
       # yamllint enable rule:line-length
 
       - name: Run tests to generate coverage statistics
         run: |
           make coverage
+
       - name: Collect coverage into one XML report
         run: |
           gcovr -e "src/tests/*" --sonarqube > coverage.xml

.lcovrc

@@ -0,0 +1,84 @@
+# Example LCOV configuration file
+#
+# External style sheet file
+#genhtml_css_file = gcov.css
+
+# Coverage rate limits for line coverage
+genhtml_hi_limit = 80
+genhtml_med_limit = 50
+
+# Coverage rate limits for function coverage
+genhtml_function_hi_limit = 90
+genhtml_function_med_limit = 75
+
+# Width of overview image
+genhtml_overview_width = 80
+
+# Resolution of overview navigation
+genhtml_nav_resolution = 4
+
+# Offset for source code navigation
+genhtml_nav_offset = 10
+
+# Do not remove unused test descriptions if non-zero
+genhtml_keep_descriptions = 0
+
+# Do not remove prefix from directory names if non-zero
+genhtml_no_prefix = 0
+
+# Do not create source code view if non-zero
+genhtml_no_source = 0
+
+# Specify size of tabs
+genhtml_num_spaces = 8
+
+# Highlight lines with converted-only data if non-zero
+genhtml_highlight = 0
+
+# Include color legend in HTML output if non-zero
+genhtml_legend = 0
+
+# Include HTML file at start of HTML output
+#genhtml_html_prolog = prolog.html
+
+# Include HTML file at end of HTML output
+#genhtml_html_epilog = epilog.html
+
+# Use custom HTML file extension
+#genhtml_html_extension = html
+
+# Compress all generated html files with gzip.
+#genhtml_html_gzip = 1
+
+# Include sorted overview pages
+genhtml_sort = 1
+
+# Include function coverage data display
+genhtml_function_coverage = 1
+
+# Location of the gcov tool
+#geninfo_gcov_tool = gcov
+
+# Adjust test names if non-zero
+#geninfo_adjust_testname = 0
+
+# Calculate a checksum for each line if non-zero
+geninfo_checksum = 0
+
+# Enable libtool compatibility mode if non-zero
+geninfo_compat_libtool = 0
+
+# Directory containing gcov kernel files
+lcov_gcov_dir = /proc/gcov
+
+# Location of the insmod tool
+lcov_insmod_tool = /sbin/insmod
+
+# Location of the modprobe tool
+lcov_modprobe_tool = /sbin/modprobe
+
+# Location of the rmmod tool
+lcov_rmmod_tool = /sbin/rmmod
+
+# Location for temporary directories
+lcov_tmp_dir = /tmp

Dockerfile

@@ -98,7 +98,7 @@ CMD ["make", "lint"]
 FROM development AS testing
 
 RUN apt-get -y update && \
-  apt-get -y install --no-install-recommends --no-install-suggests gcovr && \
+  apt-get -y install --no-install-recommends --no-install-suggests lcov && \
   rm -rf /var/lib/apt/lists/*
 
 COPY --from=builder ${WORKDIR}/build ${WORKDIR}/

Makefile

@@ -24,7 +24,7 @@ BUILDKIT_PROGRESS=plain
 DOCKER_COMPOSE=docker compose
 
 # TOOLS
-COVERAGE_TOOL=gcovr -e "src/tests/*" -e "build/*" --exclude-throw-branches --exclude-unreachable-branches --exclude-noncode-lines --print-summary
+COVERAGE_TOOL_OPTS=--config-file .lcovrc --rc branch_coverage=1
 
 # C++ specific
 SRC_DIR = src
@@ -94,11 +94,10 @@ test: env dependencies
 	cd build && make test
 
 coverage: test
-	${COVERAGE_TOOL}
-	${COVERAGE_TOOL} --lcov coverage/coverage.lcov
+	lcov ${COVERAGE_TOOL_OPTS} -o coverage/lcov.info --no-external -c --exclude "build/vcpkg_installed" --exclude "test.cpp" -d .
 
-coverage/html:
-	${COVERAGE_TOOL} --html-details coverage/index.html
+coverage/html: coverage
+	genhtml ${COVERAGE_TOOL_OPTS} -o coverage/ -s --legend coverage/lcov.info
 	open coverage/index.html
 
 outdated: