Merge pull request #96 from DARMA-tasking/95-improve-ci-rendering-tests

#95: Improve CI rendering tests

Author: tlamonthezie

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

@@ -76,16 +76,6 @@ jobs:
           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: |

CMakeLists.txt

@@ -55,7 +55,9 @@ 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)
+if (VT_TV_TESTS_ENABLED)
+  add_custom_target(vt_tv_tests)
+endif()
 add_custom_target(vt_tv_apps)
 
 set(PROJECT_BIN_DIR      ${CMAKE_CURRENT_BINARY_DIR})

README.md

@@ -40,6 +40,7 @@ VT_TV_COVERAGE_ENABLED=$(on_off ${VT_TV_COVERAGE_ENABLED:-OFF})
 VT_TV_CLEAN=$(on_off ${VT_TV_CLEAN:-ON})
 VT_TV_PYTHON_BINDINGS_ENABLED=$(on_off ${VT_TV_PYTHON_BINDINGS_ENABLED:-OFF})
 VT_TV_WERROR_ENABLED=$(on_off ${VT_TV_WERROR_ENABLED:-OFF})
+VT_TV_XVFB_ENABLED=$(on_off ${VT_TV_XVFB_ENABLED:-OFF})
 # >> Run tests settings
 VT_TV_RUN_TESTS=$(on_off ${VT_TV_RUN_TESTS:-OFF})
 VT_TV_RUN_TESTS_FILTER=${VT_TV_RUN_TESTS_FILTER:-""}
@@ -76,6 +77,8 @@ help() {
       -r   --tests-run=[bool]       Run unit tests (and build coverage report if coverage is enabled) (VT_TV_RUN_TESTS=$VT_TV_RUN_TESTS)
       -f   --tests-run-filter=[str] Filter unit test to run. (VT_TV_RUN_TESTS_FILTER=$VT_TV_RUN_TESTS_FILTER)
 
+      -x   --xvfb=[bool]            Use X Virtual Frame Buffer instead of default for rendering (VT_TV_XVFB_ENABLED=$VT_TV_XVFB_ENABLED)
+
       -h   --help                   Show help and default option values.
 
   Examples:
@@ -123,6 +126,7 @@ while getopts btch-: OPT; do  # allow -b -t -c -h, and --long_attr=value"
     r | tests-run )       VT_TV_RUN_TESTS=$(on_off $OPTARG) ;;
     f | tests-run-filter) VT_TV_RUN_TESTS_FILTER="$OPTARG" ;;
     k | vtk-dir )         VTK_DIR=$(realpath "$OPTARG") ;;
+    x | xvfb )            VT_TV_XVFB_ENABLED=$(on_off $OPTARG) ;;
     h | help )            help ;;
 
     \? )           exit 2 ;;  # bad short option (error reported via getopts)
@@ -142,6 +146,7 @@ echo VT_TV_PYTHON_BINDINGS_ENABLED=$VT_TV_PYTHON_BINDINGS_ENABLED
 echo VT_TV_RUN_TESTS=$VT_TV_RUN_TESTS
 echo VT_TV_TESTS_ENABLED=$VT_TV_TESTS_ENABLED
 echo VT_TV_TEST_REPORT=$VT_TV_TEST_REPORT
+echo VT_TV_XVFB_ENABLED=$VT_TV_XVFB_ENABLED
 echo VT_TV_RUN_TESTS_FILTER=$VT_TV_RUN_TESTS_FILTER
 echo VT_TV_COVERAGE_ENABLED=$VT_TV_COVERAGE_ENABLED
 echo VT_TV_COVERAGE_REPORT=$VT_TV_COVERAGE_REPORT
@@ -208,10 +213,21 @@ if [[ "$VT_TV_RUN_TESTS" == "ON" ]]; then
 
   gtest_cmd="\"$VT_TV_BUILD_DIR/tests/unit/AllTests\" $GTEST_OPTIONS"
   echo "Run GTest..."
+
+  CURRENT_DISPLAY=$(echo $DISPLAY)
+  if [[ "$VT_TV_RUN_TESTS" == "ON" ]]; then
+    export DISPLAY=:99.0
+    Xvfb :99 -screen 0 1024x768x24 -nolisten tcp > /dev/null 2>&1 &
+    sleep 1s
+  fi
   eval "$gtest_cmd" || true
+  if [[ "$VT_TV_RUN_TESTS" == "ON" ]]; then
+    pkill Xvfb
+    export DISPLAY=$CURRENT_DISPLAY
+    rm -rf /tmp/.X11-unix/X99
+  fi
 
   echo "Tests done."
-
   popd
 fi
 

build.sh

@@ -1,7 +1,7 @@
 ARG BASE_IMAGE=lifflander1/vt:ubuntu_22.04-gcc_11-vtk_9.2.2-py_3.8
 ARG VT_TV_TESTS_ENABLED=OFF
 ARG VT_TV_COVERAGE_ENABLED=OFF
-ARG VT_TV_PYTHON_BINDINGS_ENABLED=OFF
+ARG VT_TV_PYTHON_BINDINGS_ENABLED=ON
 
 FROM ${BASE_IMAGE} AS base
 

ci/build.sh

@@ -7,7 +7,7 @@ ARG BASE_IMAGE=ubuntu:22.04
 FROM ${BASE_IMAGE} AS base
 
 # Arguments
-ARG VTK_VERSION=v9.2.2
+ARG VTK_VERSION=9.2.2
 ARG PYTHON_VERSION=3.8
 ARG CC=gcc-11
 ARG CXX=g++-11

ci/docker/README.md

@@ -2,12 +2,6 @@
 
 set -ex
 
-export DISPLAY=:99.0
-
-# Start custom display with X virtual frame buffer
-Xvfb :99 -screen 0 1024x768x24 -nolisten tcp > /dev/null 2>&1 &
-sleep 1s
-
 VT_TV_OUTPUT_DIR=/var/vt-tv/output
 VT_TV_TESTS_OUTPUT_DIR=/opt/src/vt-tv/output/tests
 
@@ -19,6 +13,7 @@ bash -c "VTK_DIR=/opt/build/vtk \
     VT_TV_COVERAGE_ENABLED=${VT_TV_COVERAGE_ENABLED:-OFF} \
     VT_TV_OUTPUT_DIR=$VT_TV_OUTPUT_DIR \
     VT_TV_RUN_TESTS=ON \
+    VT_TV_XVFB_ENABLED=ON \
     /opt/src/vt-tv/build.sh"
 
 # Add artifacts
@@ -53,8 +48,3 @@ popd
 
 # list artifacts dir content
 ls $VT_TV_ARTIFACTS_DIR
-
-# Clean and restore regular display
-pkill Xvfb
-rm -rf /tmp/.X11-unix/X99
-export DISPLAY=:0

ci/docker/build-and-test.dockerfile

@@ -1,5 +1,5 @@
 input:
-  directory: tests/data/lb_test_data
+  directory: data/lb_test_data
   n_ranks: 4
 
 viz: