[CI] Measure code coverage after unit test (#1417)

* [CI] Measure code coverage after unit test

* [CI] Update workflow

* [CI] Fix indentation

* [CI] Ignore geninfo errors

* [CI] Force gcov 11

* [CI] Install gcc 11

* [CI] Revert gcc-11

* Use ubuntu 22.04 as unit test runner

* Deploy coverage report to github pages

* Add coverage link

---------

Co-authored-by: jgromes <jan.gromes>

.github/workflows/unit-test.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   unit-test:
     name: Build and run unit test
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     - name: Checkout repository
@@ -19,9 +19,29 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y libboost-all-dev libfmt-dev
+        sudo apt-get install -y libboost-all-dev libfmt-dev lcov
 
     - name: Run unit test
       run: |
         cd extras/test/unit
         ./test.sh
+
+    - name: Measure test coverage
+      run: |
+        cd extras/test/unit
+        ./coverage.sh
+    
+    - name: Upload coverage report as artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage_report
+        path: extras/test/unit/lcov.report
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_branch: gh-pages
+        publish_dir: extras/test/unit/lcov.report
+        destination_dir: coverage
+        keep_files: true

extras/test/unit/.gitignore

@@ -1 +1,2 @@
 build/
+lcov*

extras/test/unit/CMakeLists.txt

@@ -18,11 +18,13 @@ add_executable(${PROJECT_NAME} ${TEST_SOURCES})
 target_include_directories(${PROJECT_NAME} PUBLIC include)
 
 # link RadioLib
-target_link_libraries(${PROJECT_NAME} RadioLib fmt)
+target_link_libraries(${PROJECT_NAME} RadioLib fmt gcov)
 
 # set target properties and options
 set_property(TARGET ${PROJECT_NAME} PROPERTY CXX_STANDARD 20)
-target_compile_options(${PROJECT_NAME} PRIVATE -Wall -Wextra)
+set(BUILD_FLAGS -Wall -Wextra -fprofile-arcs -ftest-coverage -O0)
+target_compile_options(${PROJECT_NAME} PRIVATE ${BUILD_FLAGS})
+target_compile_options(RadioLib PRIVATE ${BUILD_FLAGS})
 
 # set RadioLib debug
 #target_compile_definitions(RadioLib PUBLIC RADIOLIB_DEBUG_BASIC RADIOLIB_DEBUG_SPI RADIOLIB_DEBUG_PROTOCOL)

extras/test/unit/coverage.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+filename="lcov"
+rm -rf $filename.*
+lcov --capture --directory build --output-file "${filename}.info"
+
+# filter out boost and C++ standard library
+lcov --remove "${filename}.info" "/usr/*/boost/*" "/usr/include/c++/*" --output-file "${filename}.info"
+
+# generate HTML
+genhtml "${filename}.info" --output-directory "${filename}.report"

src/RadioLib.h

@@ -37,6 +37,7 @@
   - PhysicalLayer - FSK and LoRa radio modules
 
   \see https://github.com/jgromes/RadioLib
+  \see https://jgromes.github.io/RadioLib/coverage/src/index.html
 
   \copyright  Copyright (c) 2019 Jan Gromes
 */