[ci] Add regression tests (#24)

* [ci] Add regression tests references

* [ci] Add regression to github workflow

* [ci] up workflow

* Remove scenes with SofaCarving

Author: epernod

.github/workflows/ci.yml

@@ -14,31 +14,13 @@ jobs:
         sofa_branch: [master]
 
     steps:
-      - name: (Mac) Workaround for homebrew
-        shell: bash
-        if: runner.os == 'macOS'
-        run: |
-            rm -f /usr/local/bin/2to3
-            rm -f /usr/local/bin/idle3
-            rm -f /usr/local/bin/pydoc3
-            rm -f /usr/local/bin/python3
-            rm -f /usr/local/bin/python3-config
-            rm -f /usr/local/bin/2to3-3.11
-            rm -f /usr/local/bin/idle3.11
-            rm -f /usr/local/bin/pydoc3.11
-            rm -f /usr/local/bin/python3.11
-            rm -f /usr/local/bin/python3.11-config
-            rm -f /usr/local/bin/go
-            rm -f /usr/local/bin/gofmt
-            
       - name: Setup SOFA and environment
         id: sofa
         uses: sofa-framework/sofa-setup-action@v5
         with:
           sofa_root: ${{ github.workspace }}/sofa
           sofa_version: ${{ matrix.sofa_branch }}
-          sofa_scope: 'full'
-      
+          sofa_scope: 'standard'
       - name: Checkout source code
         uses: actions/checkout@v2
         with:
@@ -56,7 +38,7 @@ jobs:
                   -DCMAKE_BUILD_TYPE=Release \
                   -DCMAKE_INSTALL_PREFIX="$WORKSPACE_INSTALL_PATH" \
                   ../src \
-              && ninja -v install"
+              && ninja install"
           else
             cd "$WORKSPACE_BUILD_PATH"
             ccache -z
@@ -68,7 +50,7 @@ jobs:
               -DCMAKE_BUILD_TYPE=Release \
               -DCMAKE_INSTALL_PREFIX="$WORKSPACE_INSTALL_PATH" \
               ../src
-            ninja -v install
+            ninja install
             echo ${CCACHE_BASEDIR}
             ccache -s
           fi
@@ -83,25 +65,47 @@ jobs:
         with:
           name: InfinyToolkit_${{ steps.sofa.outputs.run_branch }}_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${{ runner.os }}
           path: ${{ env.WORKSPACE_ARTIFACT_PATH }}
-
+      
       - name: Set env vars for tests
         shell: bash
         run: |
           # Set env vars for tests
           if [[ "$RUNNER_OS" == "Windows" ]]; then
             echo "$WORKSPACE_ARTIFACT_PATH/lib" >> $GITHUB_PATH
             echo "$WORKSPACE_ARTIFACT_PATH/bin" >> $GITHUB_PATH
+            echo "$SOFA_ROOT/plugins/SofaPython3/bin" >> $GITHUB_PATH
             echo "SOFA_PLUGIN_PATH=$WORKSPACE_ARTIFACT_PATH/bin" | tee -a $GITHUB_ENV
           else
             echo "SOFA_PLUGIN_PATH=$WORKSPACE_ARTIFACT_PATH/lib" | tee -a $GITHUB_ENV
           fi
 
           if [[ "$RUNNER_OS" == "macOS" ]]; then
-            echo "DYLD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$DYLD_LIBRARY_PATH" | tee -a $GITHUB_ENV
+            echo "DYLD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$SOFA_ROOT/plugins/SofaPython3/lib:$DYLD_LIBRARY_PATH" | tee -a $GITHUB_ENV
           fi
 
           if [[ "$RUNNER_OS" == "Linux" ]]; then
-            echo "LD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$LD_LIBRARY_PATH" | tee -a $GITHUB_ENV
+            echo "LD_LIBRARY_PATH=$WORKSPACE_ARTIFACT_PATH/lib:$SOFA_ROOT/lib:$SOFA_ROOT/plugins/SofaPython3/lib:$LD_LIBRARY_PATH" | tee -a $GITHUB_ENV
+          fi
+
+      - name: Fetch, install and run Regression_test
+        if: always()
+        shell: bash
+        run: |
+          if [[ "$RUNNER_OS" != "macOS" ]]; then
+            # Get regression from github releases
+            mkdir -p "${{ runner.temp }}/regression_tmp/install"
+            curl --output "${{ runner.temp }}/regression_tmp/${RUNNER_OS}.zip" -L https://github.com/sofa-framework/regression/releases/download/release-master/Regression_test_master_for-SOFA-${{ steps.sofa.outputs.sofa_version }}_${RUNNER_OS}.zip
+            unzip -qq "${{ runner.temp }}/regression_tmp/${RUNNER_OS}.zip" -d "${{ runner.temp }}/regression_tmp/install"
+            # Install it in the SOFA bin directory
+            $SUDO mv "${{ runner.temp }}"/regression_tmp/install/Regression_*/bin/* "${SOFA_ROOT}/bin"
+            chmod +x ${SOFA_ROOT}/bin/Regression_test${{ steps.sofa.outputs.exe }}
+            # Setup mandatory env vars
+            export REGRESSION_SCENES_DIR="${WORKSPACE_SRC_PATH}/examples"
+            export REGRESSION_REFERENCES_DIR="${WORKSPACE_SRC_PATH}/regression/references"
+            # Run regression test bench
+            ${SOFA_ROOT}/bin/Regression_test${{ steps.sofa.outputs.exe }}
+          else
+            echo "Regression tests are not supported on the CI for macOS yet (TODO)"
           fi
 
   deploy:

examples/RegressionStateScenes.regression-tests

@@ -0,0 +1,13 @@
+# WARNING: 
+# REGRESSION_TEST DOES NOT SUPPORT DASHES ("-") IN SCENE NAMES.
+# USE UNDERSCORES ("_") INSTEAD.
+
+../regression/references
+
+### Demo scenes ###
+BeatingCube.scn 200 1e-4 1 1
+BeatingCube_moving.scn 200 1e-4 1 1
+Cube_AdvCarvingTexcoords.scn 500 1e-4 1 1
+# to be activated when SofaCarving is shipped
+#Cube_Carving.scn 500 1e-4 1 1
+#Cube_CarvingWithPenetration.scn 500 1e-4 1 1

examples/RegressionTopologyScenes.regression-tests

@@ -0,0 +1,9 @@
+# WARNING: 
+# REGRESSION_TEST DOES NOT SUPPORT DASHES ("-") IN SCENE NAMES.
+# USE UNDERSCORES ("_") INSTEAD.
+
+### References relative path ###
+#../regression/references
+
+### Topology scenes ###
+Triangle2RefinedTriangleTopologicalMapping.scn 100 1e-4 1