Adding gcovr code coverage generation and use reusable workflow from everest-ci (#36)

Signed-off-by: Sebastian Lukas <sebastian.lukas@pionix.de>
Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Author: SebaLukas

.ci/build-kit/build_and_test.sh

@@ -0,0 +1,3 @@
+# syntax=docker/dockerfile:1
+ARG BASE_IMAGE_TAG=latest
+FROM ghcr.io/everest/everest-ci/build-kit-base:${BASE_IMAGE_TAG}

.ci/build-kit/docker/Dockerfile

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+cmake \
+    -B "$EXT_MOUNT/build" \
+    -S "$EXT_MOUNT/source" \
+    -G Ninja \
+    -DBUILD_TESTING=ON \
+    -DCMAKE_BUILD_TYPE=Debug \
+    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+
+retVal=$?
+if [ $retVal -ne 0 ]; then
+    echo "Configuring failed with return code $retVal"
+    exit $retVal
+fi
+
+ninja -C "$EXT_MOUNT/build"
+retVal=$?
+if [ $retVal -ne 0 ]; then
+    echo "Compiling failed with return code $retVal"
+    exit $retVal
+fi

.ci/build-kit/scripts/compile.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+ninja \
+    -C "$EXT_MOUNT/build" \
+    iso15118_gcovr_coverage
+retValHTML=$?
+
+ninja \
+    -C "$EXT_MOUNT/build" \
+    iso15118_gcovr_coverage_xml
+retValXML=$?
+
+# Copy the generated coverage report and xml to the mounted directory in any case
+cp -R "$EXT_MOUNT/build/iso15118_gcovr_coverage" "$EXT_MOUNT/gcovr-coverage"
+cp "$EXT_MOUNT/build/iso15118_gcovr_coverage_xml.xml" "$EXT_MOUNT/gcovr-coverage-xml.xml"
+
+if [ $retValHTML -ne 0 ]; then
+    echo "Coverage HTML report failed with return code $retValHTML"
+    exit $retValHTML
+fi
+
+if [ $retValXML -ne 0 ]; then
+    echo "Coverage XML report failed with return code $retValXML"
+    exit $retValXML
+fi

.ci/build-kit/scripts/run_coverage.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+CTEST_OUTPUT_ON_FAILURE=1 ninja -C "$EXT_MOUNT/build" test
+retVal=$?
+
+# Copy the LastTest.log file to the mounted directory in any case
+cp "$EXT_MOUNT/build/Testing/Temporary/LastTest.log" "$EXT_MOUNT/ctest-report"
+
+if [ $retVal -ne 0 ]; then
+    echo "Unit tests failed with return code $retVal"
+    exit $retVal
+fi

.ci/build-kit/scripts/run_unit_tests.sh

@@ -1,4 +1,4 @@
-name: Build and test libiso15118
+name: Build, lint and test libiso15118
 on: 
   pull_request: {}
   workflow_dispatch:
@@ -11,46 +11,24 @@ on:
         options:
           - 'ubuntu-22.04'
           - 'large-ubuntu-22.04-xxl'
+  schedule:
+    - cron: '37 13,1 * * *'
 jobs:
-  lint:
-    name: Lint
-    runs-on: ${{ inputs.runner || 'ubuntu-22.04' }}
-    steps:
-      - name: Checkout libiso15118
-        uses: actions/checkout@v3
-        with:
-          path: source
-      - name: Run clang-format
-        uses: everest/everest-ci/github-actions/run-clang-format@v1.1.0
-        with:
-          source-dir: source
-          extensions: hpp,cpp
-          exclude: cache
-  build_and_test:
-    name: Build and test
-    runs-on: ${{ inputs.runner || 'ubuntu-22.04' }}
-    steps:
-      - name: Checkout libiso15118
-        uses: actions/checkout@v3
-        with:
-          path: source
-      - name: Setup run scripts
-        run: |
-          mkdir scripts
-          rsync -a source/.ci/build-kit/ scripts
-      - name: Pull docker container
-        run: |
-          docker pull --platform=linux/x86_64 --quiet ghcr.io/everest/build-kit-alpine:latest
-          docker image tag ghcr.io/everest/build-kit-alpine:latest build-kit
-      - name: Build and test
-        run: |
-          docker run \
-          --volume "$(pwd):/ext" \
-          --name test-container \
-          build-kit run-script build_and_test
-      - name: Archive test results
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: ctest-report
-          path: ${{ github.workspace }}/ctest-report
+  ci:
+    name: Build, Lint and Test
+    uses: everest/everest-ci/.github/workflows/continuous_integration.yml@v1.4.3
+    permissions:
+      contents: read
+    secrets:
+      coverage_deploy_token: ${{ secrets.SA_GITHUB_PAT }}
+    with:
+      runner: ${{ inputs.runner || 'ubuntu-22.04' }}
+      artifact_deploy_target_repo: EVerest/everest.github.io
+      run_coverage: true
+      do_not_run_coverage_badge_creation: false
+      run_install: false
+      run_install_wheels: false
+      run_integration_tests: false
+      ctest_report_path: ctest-report
+      coverage_report_path: gcovr-coverage
+      coverage_xml_path: gcovr-coverage-xml.xml

.github/workflows/build_and_test.yaml

@@ -37,6 +37,8 @@ message(STATUS "Building libiso15118 with the following compile options: ${ISO15
 
 if((${CMAKE_PROJECT_NAME} STREQUAL ${PROJECT_NAME} OR ${PROJECT_NAME}_BUILD_TESTING) AND BUILD_TESTING)
     set(ISO15118_BUILD_TESTING ON)
+    evc_include(CodeCoverage)
+    append_coverage_compiler_flags()
 endif()
 
 # dependencies
@@ -54,9 +56,25 @@ add_subdirectory(input)
 add_subdirectory(src)
 
 if (ISO15118_BUILD_TESTING)
+    set(CMAKE_BUILD_TYPE Debug CACHE STRING "Build type" FORCE) # TODO(sl): Check if necessary
+
     include(CTest)
     list(APPEND CMAKE_MODULE_PATH ${CPM_PACKAGE_catch2_SOURCE_DIR}/extras)
     add_subdirectory(test)
+
+    # FIXME(sl): Set gcovr correctly so that it finds the catch2 files. 
+    set(GCOVR_ADDITIONAL_ARGS "--gcov-ignore-errors=no_working_dir_found")
+    setup_target_for_coverage_gcovr_html(
+        NAME ${PROJECT_NAME}_gcovr_coverage
+        EXECUTABLE ctest
+        EXCLUDE "test/*" "build/*"
+    )
+
+    setup_target_for_coverage_gcovr_xml(
+        NAME ${PROJECT_NAME}_gcovr_coverage_xml
+        EXECUTABLE ctest
+        EXCLUDE "test/*" "build/*"
+    )
 endif()
 
 if (ISO15118_INSTALL)

CMakeLists.txt

@@ -43,4 +43,14 @@ ninja -C build
 
 # Running tests
 ninja -C build test
+
+# Generating a code coverage (BUILD_TESTING should be enabled)
+ninja -C build iso15118_gcovr_coverage
+```
+
+The coverage report will be available in the index.html file in the `build/iso15118_gcovr_coverage` directory.
+
+Version 8.2 or higher of gcovr is required for the coverage report. Install gcovr release from PyPI:
+```
+pip install gcovr
 ```