Merge pull request #38 from Rookfighter/feature/add-code-coverage

Implement coverage reporting in CI

Author: Rookfighter

.github/workflows/cmake.yml

@@ -8,12 +8,41 @@ on:
 
 jobs:
   format:
-    name: Check C++ Code Format
+    name: Check Code Format
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Check Format
         run: 'find test/ examples/ include/ -iname "*.h" -o -iname "*.cpp" -print0 | xargs -0 clang-format --dry-run --Werror'
+  coverage:
+    name: Generate Code Coverage
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install LCOV
+        run: |
+          sudo apt update
+          sudo apt install -y lcov
+      - name: Configure
+        run: cmake -S . -B ${{runner.workspace}}/build -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON -DGENERATE_COVERAGE=ON -DINICPP_CXX_STANDARD=17
+      - name: Build
+        run: cmake --build ${{runner.workspace}}/build --config Debug
+      - name: Test
+        run: ctest -C Debug --output-on-failure --test-dir ${{runner.workspace}}/build
+      - name: Generate Coverage
+        run: |
+          lcov --capture --directory ${{runner.workspace}}/build --include '*/inicpp.h' --output-file ${{runner.workspace}}/lcov.info
+          lcov --list ${{runner.workspace}}/lcov.info
+      - name: Codecov
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+        with:
+          file: ${{runner.workspace}}/lcov.info
+          verbose: true
+          fail_ci_if_error: true
   build:
     name: "${{matrix.config.name}} C++${{matrix.cxx}}"
     runs-on: ${{matrix.config.os}}
@@ -46,8 +75,8 @@ jobs:
       with:
         submodules: recursive
     - name: Configure
-      run: cmake -S . -B ${{runner.workspace}}/build -DCMAKE_BUILD_TYPE=${{matrix.config.build_type}} -DBUILD_TESTS=True -DBUILD_EXAMPLES=True -DINICPP_CXX_STANDARD=${{matrix.cxx}}
+      run: cmake -S . -B ${{runner.workspace}}/build -DCMAKE_BUILD_TYPE=${{matrix.config.build_type}} -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON -DINICPP_CXX_STANDARD=${{matrix.cxx}}
     - name: Build
       run: cmake --build ${{runner.workspace}}/build --config ${{matrix.config.build_type}}
     - name: Test
-      run: ctest -C ${{matrix.config.build_type}} --test-dir ${{runner.workspace}}/build
+      run: ctest -C ${{matrix.config.build_type}} --output-on-failure --test-dir ${{runner.workspace}}/build

.gitignore

@@ -1,3 +1,4 @@
+lcov.info
 build/
 Testing/
 .project

CMakeLists.txt

@@ -11,18 +11,22 @@ project(inifile-cpp)
 include(CTest)
 
 set(INICPP_CXX_STANDARD "11" CACHE STRING "C++ standard to use when building tests & examples.")
+option(GENERATE_COVERAGE "Enable generating code coverage" OFF)
+option(BUILD_TESTS "Enable building unit tests" OFF)
+option(BUILD_EXAMPLES "Enable building example applications" OFF)
 
-SET(CMAKE_CXX_STANDARD ${INICPP_CXX_STANDARD})
-SET(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_STANDARD ${INICPP_CXX_STANDARD})
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 if(CMAKE_COMPILER_IS_GNUCXX)
-    set(CMAKE_CXX_FLAGS "-Wall -Wextra")
+    add_compile_options(-Wall -Wextra)
 endif(CMAKE_COMPILER_IS_GNUCXX)
 
 if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
-    set(CMAKE_CXX_FLAGS "/WX /wd4530")
+    add_compile_options(/WX /wd4530)
 endif(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
 
+
 add_subdirectory(dep)
 
 add_library(inicpp INTERFACE)
@@ -32,6 +36,12 @@ target_include_directories(inicpp INTERFACE
 add_library(inicpp::inicpp ALIAS inicpp)
 install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/include/inicpp.h TYPE INCLUDE)
 
+if(GENERATE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+    # Add required flags (GCC & LLVM/Clang)
+    target_compile_options(inicpp INTERFACE -O0 -g --coverage)
+    target_link_options(inicpp INTERFACE --coverage)
+endif(GENERATE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+
 if(${BUILD_TESTS})
     add_subdirectory(test)
 endif(${BUILD_TESTS})