Add code coverage

Author: jlblancoc

.github/workflows/ci-linux.yml

@@ -12,21 +12,22 @@ jobs:
       CTEST_OUTPUT_ON_FAILURE: ON
       CTEST_PARALLEL_LEVEL: 1
       CMAKE_BUILD_TYPE: ${{ matrix.build_type }}
-      VERBOSE: 1  # to show all cmake scripts debug info
+      VERBOSE: 1 # to show all cmake scripts debug info
 
     strategy:
       fail-fast: false
       matrix:
         # Github Actions requires a single row to be added to the build matrix.
         # See https://help.github.com/en/articles/workflow-syntax-for-github-actions.
-        name: [
-          ubuntu-22.04-gcc,
-          ubuntu-22.04-clang,
-          ubuntu-24.04-gcc,
-          ubuntu-24.04-clang,
-        ]
-
-        build_type: [ Release ]
+        name:
+          [
+            ubuntu-22.04-gcc,
+            ubuntu-22.04-clang,
+            ubuntu-24.04-gcc,
+            ubuntu-24.04-clang,
+          ]
+
+        build_type: [Release]
         include:
           - name: ubuntu-22.04-gcc
             os: ubuntu-22.04
@@ -44,6 +45,11 @@ jobs:
             os: ubuntu-24.04
             compiler: gcc
 
+          - name: ubuntu-24.04-coverage
+            os: ubuntu-24.04
+            compiler: gcc
+            build_type: Coverage
+
     steps:
       - name: Checkout
         uses: actions/checkout@master
@@ -79,7 +85,38 @@ jobs:
       - name: Build
         run: |
           make -C build
-          
+
       - name: Run tests
         run: |
           ctest --verbose --test-dir build
+
+      - name: Install lcov
+        if: matrix.build_type == 'Coverage'
+        run: sudo apt-get -y install lcov
+
+      - name: Generate coverage report
+        if: matrix.build_type == 'Coverage'
+        run: |
+          # 1. Capture coverage data from the build directory
+          #    lcov finds all the .gcno and .gcda files
+          lcov --capture --directory build/ --output-file coverage.info
+
+          # 2. Filter to *only* include the main header file
+          #    This fulfills your request to not include examples/tests
+          lcov --extract coverage.info "*/include/nanoflann.hpp" --output-file coverage_filtered.info
+
+          # 3. Print a summary to the console log for easy debugging
+          echo "--- Coverage Summary for nanoflann.hpp ---"
+          lcov --list coverage_filtered.info
+          echo "------------------------------------------"
+
+      - name: Upload coverage to Codecov
+        if: matrix.build_type == 'Coverage'
+        uses: codecov/codecov-action@v4
+        with:
+          # The token is required for private repos, but recommended for all
+          token: ${{ secrets.CODECOV_TOKEN }}
+          # Path to the filtered report
+          files: ./coverage_filtered.info
+          # Optional name for this upload in the Codecov UI
+          name: codecov-ubuntu-24.04

CMakeLists.txt

@@ -25,9 +25,17 @@ if (CMAKE_COMPILER_IS_GNUCXX)
   # The -Wno-long-long is required in 64bit systems when including sytem headers.
   # The -Wno-variadic-macros was needed for Eigen3, StdVector.h
   add_compile_options(-Wall -Wshadow -Wno-long-long -Wno-variadic-macros)
-  if (NOT "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
+
+  if ("${CMAKE_BUILD_TYPE}" STREQUAL "Coverage")
+    message(STATUS "Coverage build enabled. Adding gcov flags.")
+    # Add gcov flags, ensure no optimization (-O0), and include debug symbols (-g)
+    add_compile_options(-g -O0 --coverage)
+    add_link_options(--coverage)
+  elseif (NOT "${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
+    # Keep original logic for Release builds
     add_compile_options(-O2 -mtune=native)
   endif()
+
   # Workaround: Eigen <3.4 produces *tons* of warnings in GCC >=6. See http://eigen.tuxfamily.org/bz/show_bug.cgi?id=1221
   if (NOT ${CMAKE_CXX_COMPILER_VERSION} LESS "6.0")
     add_compile_options(-Wno-ignored-attributes -Wno-int-in-bool-context)

README.md

@@ -5,6 +5,7 @@
 [![CI Check clang-format](https://github.com/jlblancoc/nanoflann/actions/workflows/check-clang-format.yml/badge.svg)](https://github.com/jlblancoc/nanoflann/actions/workflows/check-clang-format.yml)
 [![CircleCI](https://circleci.com/gh/jlblancoc/nanoflann/tree/master.svg?style=svg)](https://circleci.com/gh/jlblancoc/nanoflann/tree/master)
 [![Windows build status](https://ci.appveyor.com/api/projects/status/h8k1apfogxyqhskd/branch/master?svg=true)](https://ci.appveyor.com/project/jlblancoc/nanoflann/branch/master)
+[![codecov](https://codecov.io/gh/jlblancoc/nanoflann/graph/badge.svg?token=yOKq5lpizE)](https://codecov.io/gh/jlblancoc/nanoflann)
 
 
 ## 1. About