Merge pull request #85 from DARMA-tasking/32-vt-tv-improve-ci

#32: vt-tv: Improve CI

Author: cwschilly

.github/workflows/action-git-diff-check.yml

@@ -7,7 +7,7 @@ jobs:
     name: Run git check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/build-and-test-bindings.yml

@@ -0,0 +1,95 @@
+name: Build and Test
+
+# Trigger the workflow on push or pull request
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, reopened, synchronize, converted_to_draft, ready_for_review]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        image:
+        - ubuntu_22.04-gcc_11-vtk_9.2.2-py_3.8
+        - ubuntu_22.04-clang_11-vtk_9.2.2-py_3.8
+        - ubuntu_22.04-gcc_12-vtk_9.3.0-py_3.8
+    env:
+      OUTPUT_DIR: '/tmp/artifacts'
+      VT_TV_TESTS_ENABLED: 'ON' # Build & Test in all configurations
+      VT_TV_COVERAGE_ENABLED: ${{ matrix.image == 'ubuntu_22.04-gcc_12-vtk_9.3.0-py_3.8' && 'ON' || 'OFF' }}  # Coverage only with main test image
+      VT_TV_PYTHON_BINDINGS_ENABLED: 'ON'
+      DOCKER_REPOSITORY: lifflander1/vt
+    name: vt-tv build and test
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: CI Variables
+        id: vars
+        run: echo "DOCKER_TAG=$(echo ${{ github.ref }} | cut -d'/' -f3- | sed 's/[^a-z0-9_-]/__/gi')" >> $GITHUB_ENV
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Inspect Builder
+        run: |
+          echo "Name:      ${{ steps.buildx.outputs.name }}"
+          echo "Endpoint:  ${{ steps.buildx.outputs.endpoint }}"
+          echo "Status:    ${{ steps.buildx.outputs.status }}"
+          echo "Flags:     ${{ steps.buildx.outputs.flags }}"
+          echo "Platforms: ${{ steps.buildx.outputs.platforms }}"
+          echo "DOCKER_TAG: ${{ env.DOCKER_TAG }}"
+
+      - name: Build the Docker Image; build and test vt-tv
+        id: docker_build
+        continue-on-error: false
+        uses: docker/build-push-action@v6
+        with:
+          push: false
+          tags: ${{ env.DOCKER_TAG }}
+          context: .
+          file: ./ci/docker/build-and-test.dockerfile
+          build-args: |
+            BASE_IMAGE=${{ env.DOCKER_REPOSITORY }}:${{ matrix.image }}
+            VT_TV_TESTS_ENABLED=${{ env.VT_TV_TESTS_ENABLED }}
+            VT_TV_COVERAGE_ENABLED=${{ env.VT_TV_COVERAGE_ENABLED }}
+          outputs: type=local,dest=${{ env.OUTPUT_DIR }}
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: vt-tv-Artifacts-${{ matrix.image }}
+          path: ${{ env.OUTPUT_DIR }}
+
+      - name: Unit tests
+        if: ${{ env.VT_TV_TESTS_ENABLED == 'ON' }}
+        uses: phoenix-actions/test-reporting@v15
+        with:
+          name: Tests report
+          path: ${{ env.OUTPUT_DIR }}/tmp/artifacts/junit-report.xml
+          reporter: java-junit
+          output-to: step-summary
+
+      - name: CCM Example output to summary
+        if: ${{ (success() || failure()) && env.VT_TV_TESTS_ENABLED == 'ON' }}
+        run: |
+          echo '## CCM Example output' >> $GITHUB_STEP_SUMMARY
+          if [ -f "${{ env.OUTPUT_DIR }}/tmp/artifacts/ccm_example0.png" ]; then
+            echo '!'"[CCM Example](${{ env.OUTPUT_DIR }}/tmp/artifacts/ccm_example0.png)" >> $GITHUB_STEP_SUMMARY
+          else
+            echo 'Missing !' >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Coverage summary
+        if: ${{ (success() || failure()) &&  env.VT_TV_COVERAGE_ENABLED == 'ON' }}
+        run: |
+          echo '## Coverage' >> $GITHUB_STEP_SUMMARY
+          echo '```shell' >> $GITHUB_STEP_SUMMARY
+          cat ${{ env.OUTPUT_DIR }}/tmp/artifacts/lcov-list-report.txt >> $GITHUB_STEP_SUMMARY
+          echo '```' >> $GITHUB_STEP_SUMMARY

.github/workflows/build-and-test-vt-tv.yml

@@ -7,7 +7,7 @@ jobs:
     name: Check commit message format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/build-and-test.yml

@@ -7,7 +7,7 @@ jobs:
     name: Find Trailing Whitespace
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: DARMA-tasking/find-trailing-whitespace@master
         with:
-          exclude: "sketches;lib;docs"
+          exclude: "sketches;lib;docs;.png$"

.github/workflows/check-commit-format.yml

@@ -1,32 +1,73 @@
-name: Build dependencies and push base Docker Image to dockerhub
+name: Build & push base Docker image
 
-on: workflow_dispatch
+on:
+  workflow_dispatch:
+    inputs:
+      image:
+        type: choice
+        description: The configuration to build as a combination of os, compiler, vtk and python versions
+        options:
+        - ubuntu_22.04-gcc_11-vtk_9.2.2-py_3.8
+        - ubuntu_22.04-clang_11-vtk_9.2.2-py_3.8
+        - ubuntu_22.04-gcc_12-vtk_9.3.0-py_3.8
+        default: ubuntu_22.04-gcc_12-vtk_9.3.0-py_3.8
 
 jobs:
   push_to_registry:
-    name: Push Docker image to Docker Hub
+    name: Build & Push
     runs-on: ubuntu-latest
+    env:
+      DOCKER_REPOSITORY: lifflander1/vt
     steps:
       - name: Check out the repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Log in to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Extract build configuration
+        # If workflow dispatch event replace `matrix.image` by `inputs.image`
+        run: |
+          IFS='_-' read -r -a CONFIG <<< "${{ inputs.image }}"
+          echo "BASE_IMAGE=${CONFIG[0]}:${CONFIG[1]}" >> $GITHUB_ENV
+          echo "CC=${CONFIG[2]}-${CONFIG[3]}" >> $GITHUB_ENV
+          if [[ "${CONFIG[2]}" == "gcc" ]]; then
+            echo "CXX=g++-${CONFIG[3]}" >> $GITHUB_ENV
+            echo "GCOV=gcov-${CONFIG[3]}" >> $GITHUB_ENV
+          elif [[ "${CONFIG[2]}" == "clang" ]]; then
+            echo "CXX=clang++-${CONFIG[3]}" >> $GITHUB_ENV
+            echo "GCOV=gcov" >> $GITHUB_ENV
+          else
+            exit 1
+          fi
+          echo "VTK_VERSION=${CONFIG[5]}" >> $GITHUB_ENV
+          echo "PYTHON_VERSION=${CONFIG[7]}" >> $GITHUB_ENV
+          echo "DOCKER_TAG=${{ inputs.image }}" >> $GITHUB_ENV
 
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4
+      - name: Build configuration
+        run: |
+          echo "Base image: $BASE_IMAGE"
+          echo "C Compiler: $CC"
+          echo "CXX Compiler: $CXX"
+          echo "GCOV: $GCOV"
+          echo "VTK: $VTK_VERSION"
+          echo "Python: $PYTHON_VERSION"
+          echo "Docker tag: $DOCKER_TAG"
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
         with:
-          images: pierrpebay/vt-tv
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
 
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v4
+      - name: Build and push to Docker Hub
+        uses: docker/build-push-action@v6
         with:
           context: .
-          file: ci/make-base-ubuntu22.04-gcc11-x64.dockerfile
+          build-args: |
+            BASE_IMAGE=${{ env.BASE_IMAGE }}
+            CC=${{ env.CC }}
+            CXX=${{ env.CXX }}
+            GCOV=${{ env.GCOV }}
+            VTK_VERSION=${{ env.VTK_VERSION }}
+            PYTHON_VERSION=${{ env.PYTHON_VERSION }}
+          file: ci/docker/make-base.dockerfile
           push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          tags: "${{ env.DOCKER_REPOSITORY }}:${{ env.DOCKER_TAG }}"

.github/workflows/find-trailing-whitespace.yml

@@ -1 +1,8 @@
 .*~undo-tree~
+.vscode/
+
+# Items generated at build time
+/build
+/python-build
+output
+Testing

.github/workflows/pushbasedockerimage.yml

@@ -31,6 +31,8 @@ message(STATUS "CMAKE_CXX_STANDARD: ${CMAKE_CXX_STANDARD}")
 
 option(VT_TV_PYTHON_BINDINGS_ENABLED "Build vt-tv with Python bindings" OFF)
 option(VT_TV_OPENMP_ENABLED "Build vt-tv with openMP support" ON)
+option(VT_TV_TESTS_ENABLED "Build vt-tv with unit tests" ON)
+option(VT_TV_COVERAGE_ENABLED "Build vt-tv with coverage" OFF)
 
 # add -fPIC to all targets (if building with nanobind)
 if(VT_TV_PYTHON_BINDINGS_ENABLED)
@@ -49,6 +51,8 @@ endif()
 
 add_definitions(-DVT_TV_N_THREADS=${VT_TV_N_THREADS})
 add_definitions(-DVT_TV_OPENMP_ENABLED=${VT_TV_OPENMP_ENABLED})
+add_compile_definitions(SRC_DIR="${CMAKE_CURRENT_SOURCE_DIR}")
+add_compile_definitions(BUILD_DIR="${CMAKE_BINARY_DIR}")
 
 add_custom_target(vt_tv_examples)
 add_custom_target(vt_tv_tests)
@@ -61,24 +65,31 @@ set(PROJECT_EXAMPLE_DIR  ${CMAKE_CURRENT_SOURCE_DIR}/examples)
 set(PROJECT_APP_DIR      ${CMAKE_CURRENT_SOURCE_DIR}/apps)
 set(PROJECT_BINDINGS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/bindings)
 
-include(CTest)
-
 add_subdirectory(src)
 add_subdirectory(examples)
-add_subdirectory(tests)
+
 add_subdirectory(apps)
 add_subdirectory(bindings)
 
+include(CTest) #adds option BUILD_TESTING (default ON)
+
+message(STATUS "VT_TV_COVERAGE_ENABLED: ${VT_TV_COVERAGE_ENABLED}")
+if (VT_TV_COVERAGE_ENABLED)
+  add_compile_options(-fprofile-arcs -ftest-coverage -O0)
+  add_link_options(-lgcov --coverage)
+endif()
+
+message(STATUS "VT_TV_TESTS_ENABLED: ${VT_TV_TESTS_ENABLED}")
+if (BUILD_TESTING AND VT_TV_TESTS_ENABLED)
+  set(CTEST_SOURCE_DIRECTORY ${SOURCE_DIR}/src)
+  add_subdirectory(tests)
+endif()
+
 configure_file(
   cmake/vtTVConfig.cmake.in
   "${PROJECT_BINARY_DIR}/vtTVConfig.cmake" @ONLY
 )
 
-configure_file(
-  ${PROJECT_BASE_DIR}/cmake/cmake_config.h.in
-  ${PROJECT_BASE_DIR}/tests/unit/cmake_config.h @ONLY
-)
-
 install(
   FILES        "${PROJECT_BINARY_DIR}/vtTVConfig.cmake"
   DESTINATION  cmake