Add code coverage workflow

.github/workflows/cmake_test.yml

@@ -7,18 +7,24 @@ on:
     branches: [ "main" ]
 
 env:
-  BUILD_TYPE: Release
+  BUILD_TYPE: Debug
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - name: Update apt repo
+      run: sudo apt-get update
+
+    - name: Install tools manually
+      run: sudo apt-get install lcov gcovr
+
+    - uses: actions/checkout@v4
 
     - name: Configure CMake
       working-directory: ${{github.workspace}}/test
-      run: cmake -B ${{github.workspace}}/test/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+      run: cmake -DTEST=ON -DCODE_COVERAGE=ON -B ${{github.workspace}}/test/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
 
     - name: Build
       working-directory: ${{github.workspace}}/test
@@ -28,3 +34,15 @@ jobs:
     - name: Run tests
       working-directory: ${{github.workspace}}/test
       run: ./dsm_tests.out
+
+    - name: create Report
+      working-directory: ${{github.workspace}}/test
+      run: lcov --capture --directory .. --output-file coverage.xml
+
+    - uses: codecov/codecov-action@v3.1.4
+      with:
+        #token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+        file: ${{github.workspace}}/test/coverage.xml # optional
+        flags: unittests # optional
+        name: codecov-umbrella # optional
+        fail_ci_if_error: true # optional (default = false)

README.md

@@ -1,4 +1,5 @@
 # DynamicalSystemFramework
+[![codecov](https://codecov.io/github/sbaldu/DynamicalSystemFramework/graph/badge.svg?token=JV53J6IUJ3)](https://codecov.io/github/sbaldu/DynamicalSystemFramework)
 
 The aim of this project is to rework the original [Traffic Flow Dynamics Model](https://github.com/Grufoony/TrafficFlowDynamicsModel).
 This rework consists of a full code rewriting, in order to implement more features (like *intersections*) and get advantage from the latest C++ updates.

test/CMakeLists.txt

@@ -7,8 +7,12 @@ set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
-# Set the C++ flags
-string(APPEND CMAKE_CXX_FLAGS "-Wall -Wextra -O3 -g")
+# Add code coverage options
+if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+    message(STATUS "Enable code coverage")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -g --coverage")
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+endif()
 
 # Set the folder for the executable
 set(EXECUTABLE_OUTPUT_PATH ../)