Adding coverage check

Author: Samuel Rodriguez Sevilla

.devcontainer/Dockerfile

@@ -2,7 +2,9 @@ FROM gcc:13.2.0
 RUN \
     apt update && \
     apt upgrade -y && \
-    apt install -y cmake gdb valgrind vim
+    apt install -y cmake gdb valgrind vim lcov python3-pip python3-venv && \
+    python3 -m venv /tmp/gcovr && \
+    /tmp/gcovr/bin/pip install gcovr lxml
 
 ARG USERNAME=devcontainer
 ARG USER_UID=1000
@@ -13,4 +15,5 @@ ARG USER_GID=$USER_UID
 RUN groupadd --gid ${USER_GID} ${USERNAME} \
     && useradd --uid ${USER_UID} --gid ${USER_GID} -m ${USERNAME}
 
+ENV PATH="/tmp/gcovr/bin:${PATH}"
 ENTRYPOINT /bin/bash

.devcontainer/devcontainer.json

@@ -31,6 +31,9 @@
 		"source=${localEnv:HOME}/.gitconfig,target=/home/${localEnv:USER}/.gitconfig,type=bind"
 	],
 
+	"containerEnv": {
+		"SHELL": "/bin/bash"
+	},
 	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
 	"remoteUser": "${localEnv:USER}"
 

.github/workflows/cmake-ubuntu-g++13.yml

@@ -22,10 +22,13 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
+    - name: install
+        run: sudo apt-get update && sudo apt-get install lcov #libxrandr-dev libxcursor-dev libudev-dev libopenal-dev libflac-dev libvorbis-dev libgl1-mesa-dev libegl1-mesa-dev freeglut3-dev # OpenGL dependencies only needed for SFML
+
     - name: Configure CMake
       # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
       # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
-      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_COMPILER=g++-13
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCMAKE_CXX_COMPILER=g++-13 -DENABLE_TEST -DENABLE_COVERAGE
 
     - name: Build
       # Build your program with the given configuration
@@ -37,3 +40,21 @@ jobs:
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
       run: ctest -C ${{env.BUILD_TYPE}}
 
+    - name: generate coverage
+      working-directory: ./build
+      run: |
+        make cov
+
+    - name: Install gcovr
+      run: |
+        pip install -r requirements.txt
+
+    - name: Generate JSON coverage report
+      working-directory: ./build
+      run: |
+        gcovr -r .. . --branches --cobertura --filter ../include > coverage.xml
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v3
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -30,3 +30,10 @@
 *.exe
 *.out
 *.app
+
+# Visual Studio Code personal configuration
+.vscode
+
+# Build directory
+build
+Testing

CMakeLists.txt

@@ -35,5 +35,13 @@ install(TARGETS lzc-coro
 #    INSTALL_DESTINATION
 #    ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
 
-enable_testing()
-add_subdirectory(tests)
+option(ENABLE_TESTS "Build tests" OFF)
+option(ENABLE_COVERAGE "If ENABLE_TESTS is ON then coverage could be produced" OFF)
+if(ENABLE_TESTS)
+    enable_testing()
+    if(ENABLE_COVERAGE)
+        include(cmake/coverage.cmake)
+        add_coverage_target("*/tests/*")
+    endif()
+    add_subdirectory(tests)
+endif()

cmake/coverage.cmake

@@ -0,0 +1,38 @@
+function(add_coverage_target exclude)
+
+    find_program(GCOV gcov)
+    if (NOT GCOV)
+        message(WARNING "program gcov not found")
+    endif()
+
+    find_program(LCOV lcov)
+    if (NOT LCOV)
+        message(WARNING "program lcov not found")
+    endif()
+
+    find_program(GENHTML genhtml)
+    if (NOT GENHTML)
+        message(WARNING "program genhtml not found")
+    endif()
+
+    if (LCOV AND GCOV AND GENHTML)
+        set(covname cov.info)
+        add_compile_options(-fprofile-arcs -ftest-coverage)
+        add_link_options(--coverage)
+        add_custom_target(cov DEPENDS ${covname})
+        add_custom_command(
+            OUTPUT  ${covname}
+            COMMAND ${LCOV} -c -o ${covname} -d . -b . --gcov-tool ${GCOV}
+            COMMAND ${LCOV} -r ${covname} -o ${covname} ${exclude}
+            COMMAND ${LCOV} -l ${covname}
+            COMMAND ${GENHTML} ${covname} -output coverage
+            COMMAND ${LCOV} -l ${covname} 2>/dev/null | grep Total | sed 's/|//g' | sed 's/Total://g' | awk '{print $1}' | sed s/%//g > coverage/total
+        )
+        set_directory_properties(PROPERTIES
+            ADDITIONAL_CLEAN_FILES ${covname}
+        )
+    else()
+        message(WARNING "unable to add target `cov`: missing coverage tools")
+    endif()
+
+endfunction()

requirements.txt

@@ -0,0 +1,2 @@
+gcovr==6.0
+lxml==5.1.0