Merge pull request lagadic#1785 from SamFlt/pixi_coverage

Add coverage task with gcovr, add coverage CI

Author: fspindle

.github/workflows/coverage-pixi.yml

@@ -0,0 +1,66 @@
+name: CI - Coverage via Pixi
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, reopened, synchronize]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  visp-pixi:
+    name: ${{ matrix.os }} - Env ${{ matrix.environment }} ${{ matrix.build_type }} ${{ matrix.compiler }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, macos-13]
+        environment: [full-ci-coverage]
+        build_type: [Release]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: prefix-dev/[email protected]
+        with:
+          cache: true
+          environments: ${{ matrix.environment }}
+
+      - name: Clone visp-images
+        env:
+          BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+        # https://remarkablemark.org/blog/2022/09/25/check-git-branch-exists-in-remote-repository/
+        run: |
+          git clone --depth 1 https://github.com/lagadic/visp-images ${HOME}/visp-images
+          echo "VISP_INPUT_IMAGE_PATH=$HOME/visp-images" >> $GITHUB_ENV
+          echo ${VISP_INPUT_IMAGE_PATH}
+
+      - name: Build Visp [MacOS/Linux/Windows]
+        shell: bash -el {0}
+        env:
+          VISP_BUILD_TYPE: ${{ matrix.build_type }}
+        run: |
+          pixi run -e ${{ matrix.environment }} build
+
+      - name: Generate coverage file [MacOS/Linux/Windows]
+        shell: bash -el {0}
+        run: |
+          pixi run -e ${{ matrix.environment }} coverage
+
+      - name: Export coverage file location [MacOS/Linux/Windows]
+        shell: bash -el {0}
+        run: |
+          COVERAGE_PATH=`pixi run -e ${{ matrix.environment }} echo-coverage-path`
+          echo "VISP_COVERAGE_FILE=$COVERAGE_PATH" >> $GITHUB_ENV
+
+      - name: Upload report to Codecov
+        uses: codecov/codecov-action@v5
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        with:
+          files: ${{ env.VISP_COVERAGE_FILE }}
+          disable_search: true
+          fail_ci_if_error: true
+          verbose: true

.github/workflows/coverage.yml

@@ -482,7 +482,7 @@ VP_OPTION(BUILD_APPS "" "" "Build utility applications (used for example for cal
 VP_OPTION(BUILD_EXAMPLES  "" "" "Build ViSP examples" "" ON)
 # Build examples as an option.
 VP_OPTION(BUILD_TESTS  "" "" "Build ViSP tests" "" ON)
-VP_OPTION(BUILD_COVERAGE "" "" "Enables test coverage" "" OFF IF (BUILD_TESTS AND CMAKE_COMPILER_IS_GNUCXX))
+VP_OPTION(BUILD_COVERAGE "" "" "Enables test coverage" "" OFF IF (BUILD_TESTS AND (CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANGCXX)))
 
 # Build java as an option
 VP_OPTION(BUILD_JAVA  "" "" "Enable Java support" "" (ANDROID OR NOT CMAKE_CROSSCOMPILING)  IF (ANDROID OR (NOT APPLE_FRAMEWORK AND NOT WINRT)) )

CMakeLists.txt

@@ -153,8 +153,14 @@ elseif((VISP_CXX_STANDARD EQUAL VISP_CXX_STANDARD_17) AND CXX17_CXX_FLAGS)
 endif()
 
 if(BUILD_COVERAGE)
-  set(CMAKE_REQUIRED_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} gcov)
-  add_extra_compiler_options("-ftest-coverage -fprofile-arcs -lgcov")
+  if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
+    set(CMAKE_REQUIRED_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} gcov)
+    add_extra_compiler_options("-ftest-coverage -fprofile-arcs -lgcov")
+  elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang") # Clang or AppleClang (see CMP0025)
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+    set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage")
+    add_extra_compiler_options("--coverage")
+  endif()
 endif()
 
 if(CMAKE_COMPILER_IS_GNUCXX)

cmake/AddExtraCompilationFlags.cmake

@@ -16,3 +16,5 @@ if not defined VISP_BUILD_EXAMPLES (set VISP_BUILD_EXAMPLES=OFF)
 if not defined VISP_USE_MATHJAX (set VISP_USE_MATHJAX=OFF)
 if not defined VISP_BUILD_TUTORIALS (set VISP_BUILD_TUTORIALS=OFF)
 if not defined VISP_ENABLE_TEST_WITHOUT_DISPLAY (set VISP_ENABLE_TEST_WITHOUT_DISPLAY=ON)
+if not defined VISP_BUILD_COVERAGE (set VISP_BUILD_COVERAGE=OFF)
+if not defined VISP_BUILD_DEPRECATED_FUNCTIONS (set VISP_BUILD_DEPRECATED_FUNCTIONS=ON)

development/scripts/pixi/activation.bat

@@ -17,3 +17,5 @@ export VISP_BUILD_TESTS=${VISP_BUILD_TESTS:=OFF}
 export VISP_BUILD_EXAMPLES=${VISP_BUILD_EXAMPLES:=OFF}
 export VISP_BUILD_TUTORIALS=${VISP_BUILD_TUTORIALS:=OFF}
 export VISP_ENABLE_TEST_WITHOUT_DISPLAY=${VISP_ENABLE_TEST_WITHOUT_DISPLAY:=ON}
+export VISP_BUILD_COVERAGE=${VISP_BUILD_COVERAGE:=OFF}
+export VISP_BUILD_DEPRECATED_FUNCTIONS=${VISP_BUILD_DEPRECATED_FUNCTIONS:=ON}