feat: Add code coverage measurement and documentation

This commit introduces code coverage measurement using `lcov` for the project.

- **feat(ci):** Integrated `lcov` into the `test-linux` GitHub Actions workflow to automatically generate and upload coverage reports.
- **feat(cmake):** Added an `ENABLE_COVERAGE` option to `CMakeLists.txt` to compile the project with coverage instrumentation flags.
- **docs:** Added a new "Code Coverage" section to `README.md` with instructions on how to manually generate and view coverage reports using `lcov` and `genhtml`.

Signed-off-by: Dariusz Frankiewicz <[email protected]>

Author: dariusz-f

.github/workflows/build.yml

@@ -88,25 +88,37 @@ jobs:
 
   test-linux:
     runs-on: ubuntu-latest
-    needs: build-linux-amd64
     steps:
       - name: Checkout code
         uses: actions/checkout@v6
 
       - name: Set up CMake
         uses: jwlawson/actions-setup-cmake@v2
 
-      - name: Download build artifacts
-        uses: actions/download-artifact@v6
-        with:
-          name: build-PC-artifacts
+      - name: Build PC (Linux) for coverage
+        run: |
+          cmake -S ${{github.workspace}} -B ${{github.workspace}}/build -DENABLE_COVERAGE=ON
+          cmake --build ${{github.workspace}}/build
 
       - name: Run tests for PC
         run: |
-          tar -xvf build-pc.tar
           cd build
           ctest
 
+      - name: Generate coverage report
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y lcov
+          lcov --capture --directory ${{github.workspace}}/build --output-file ${{github.workspace}}/build/coverage.info
+          lcov --remove ${{github.workspace}}/build/coverage.info '/usr/*' --output-file ${{github.workspace}}/build/coverage.info
+          lcov --list ${{github.workspace}}/build/coverage.info
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v5
+        with:
+          name: coverage-report
+          path: ${{github.workspace}}/build/coverage.info
+
       - name: Upload test results
         uses: actions/upload-artifact@v5
         with:

CMakeLists.txt

@@ -68,6 +68,8 @@ option(OAPV_BUILD_APPS "Build the included command line apps" ON)
 option(OAPV_BUILD_STATIC_LIB "Build oapv static library" ON)
 option(OAPV_BUILD_SHARED_LIB "Build oapv shared library" ON)
 
+option(ENABLE_COVERAGE "Enable code coverage measurement" OFF)
+
 if(OAPV_BUILD_APPS AND OAPV_APP_STATIC_BUILD AND NOT OAPV_BUILD_STATIC_LIB)
   message(FATAL_ERROR "Cannot build static apps without static lib.")
 endif()
@@ -104,6 +106,9 @@ endif()
 if(MSVC)
   message("Not supported yet!")
 elseif(UNIX OR MINGW)
+    if(ENABLE_COVERAGE)
+        set(CMAKE_BUILD_TYPE "Debug")
+    endif()
     if(NOT CMAKE_BUILD_TYPE)
         set(CMAKE_BUILD_TYPE "Release")
     endif()
@@ -120,6 +125,11 @@ elseif(UNIX OR MINGW)
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${OPT_DBG} -${OPT_LV} -fomit-frame-pointer -pthread -std=c99")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wno-unused-function -Wno-pointer-sign -Wno-pointer-to-int-cast")
     set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lm")
+
+    if(ENABLE_COVERAGE)
+      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --coverage")
+      set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+    endif()
 else()
     message("Unknown compiler")
 endif()

README.md

@@ -132,6 +132,40 @@ Pattern file of APV bitstream for [ImHex](https://github.com/WerWolv/ImHex) is p
 
 In build directory run ``ctest``
 
+## Code Coverage
+
+To generate a code coverage report manually:
+
+1.  **`lcov` is required.**
+
+2.  **Build and Test with Coverage:**
+    ```bash
+    # Create build directory and configure with coverage enabled
+    cmake -S . -B build -DENABLE_COVERAGE=ON
+
+    # Build the project
+    cmake --build build
+
+    # Run tests to generate coverage data
+    cd build && ctest && cd ..
+    ```
+
+3.  **Generate HTML Report:**
+    ```bash
+    # Capture coverage data
+    lcov --capture --directory build --output-file build/coverage.info
+
+    # Remove coverage for external files (optional)
+    lcov --remove build/coverage.info '/usr/*' --output-file build/coverage.info
+
+    # Generate the HTML report
+    mkdir -p coverage_report
+    genhtml build/coverage.info --output-directory coverage_report
+    ```
+
+4.  **View Report:**
+    Open `coverage_report/index.html` in your web browser.
+
 ## Packaging
 
 For generating package ready for distribution (default deb) execute in build directory ``cpack``,  or other formats (tgz, zip etc.) ``cpack -G TGZ``.