Merge branch 'main' into cleanup/readme-mention-acknowledgements

Author: dglaeser

.github/actions/prepare-python-env/action.yml

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2024 Dennis Gläser <dennis.a.glaeser@gmail.com>
+# SPDX-License-Identifier: MIT
+
+name: prepare-python-env
+runs:
+  using: composite
+  steps:
+    - name: prepare-python-env
+      run: |
+        source /gfmt-venv/bin/activate
+        echo "PATH=$PATH" >> $GITHUB_ENV
+      shell: bash

.github/actions/set-git-variables/action.yml

@@ -8,15 +8,17 @@ runs:
     - name: set-git-variables
       run: |
         if [[ ${{ github.event_name }} == "pull_request" ]]; then
-          echo "GFMT_ORIGIN=${{ github.event.pull_request.head.repo.clone_url }}" >> "$GITHUB_ENV"
-          echo "GFMT_TREE=${{ github.head_ref }}" >> "$GITHUB_ENV"
-          echo "GFMT_SOURCE_TREE=origin/${{ github.head_ref }}" >> "$GITHUB_ENV"
+          echo "GFMT_SOURCE_REMOTE=${{ github.event.pull_request.head.repo.clone_url }}" >> "$GITHUB_ENV"
+          echo "GFMT_TARGET_REMOTE=${{ github.event.pull_request.base.repo.clone_url }}" >> "$GITHUB_ENV"
+          echo "GFMT_SOURCE_TREE=${{ github.head_ref }}" >> "$GITHUB_ENV"
+          echo "GFMT_TARGET_TREE=${{ github.base_ref }}" >> "$GITHUB_ENV"
         else
-          echo "GFMT_ORIGIN=${{ github.event.repository.clone_url }}" >> "$GITHUB_ENV"
-          echo "GFMT_TREE=${{ github.head_ref }}" >> "$GITHUB_ENV"
-          if [[ -z "$GFMT_TREE" ]]; then
-            echo "GFMT_TREE=${{ github.sha }}" >> "$GITHUB_ENV"
+          echo "GFMT_SOURCE_REMOTE=${{ github.event.repository.clone_url }}" >> "$GITHUB_ENV"
+          echo "GFMT_TARGET_REMOTE=${{ github.event.repository.clone_url }}" >> "$GITHUB_ENV"
+          echo "GFMT_SOURCE_TREE=${{ github.head_ref }}" >> "$GITHUB_ENV"
+          if [[ -z "${{github.head_ref}}" ]]; then
+            echo "GFMT_SOURCE_TREE=${{ github.sha }}" >> "$GITHUB_ENV"
           fi
-          echo "GFMT_SOURCE_TREE=${GFMT_TREE}" >> "$GITHUB_ENV"
+          echo "GFMT_TARGET_TREE=main" >> "$GITHUB_ENV"
         fi
       shell: bash

.github/actions/set-test-commands/action.yml

@@ -5,8 +5,12 @@ name: set-test-commands
 inputs:
   source_tree:
     required: True
+  source_remote:
+    required: True
   target_tree:
     required: True
+  target_remote:
+    required: True
   build_directory:
     required: True
 runs:
@@ -18,28 +22,42 @@ runs:
             ( ${{ github.ref_type }} == "tag" && ${{ github.ref_name }} =~ v[0-9]\.[0-9]\.[0-9]$ )]]; then
           echo "Using 'all' target on main branch (i.e. all tests are built & run)"
           echo "all" > _affected_tests.txt
+          echo "GFMT_TEST_EXAMPLES=true" >> "$GITHUB_ENV"
         else
+          echo "Regression-testing sample files only for branch ${{ github.ref_name }}"
+          echo "GRIDFORMAT_REGRESSION_SAMPLES_ONLY=true" >> "$GITHUB_ENV"
+
           pushd ${{inputs.build_directory}}
-            echo "Detecting files that change from '${{inputs.source_tree}}' to '${{inputs.target_tree}}'"
-            python3 ../bin/detect_modified_files.py -s "${{inputs.source_tree}}" -t "${{inputs.target_tree}}" &> _modfiles.out
+            echo "Detecting files that change from '${{inputs.source_remote}}/${{inputs.source_tree}}' to '${{inputs.target_remote}}/${{inputs.target_tree}}'"
+            python3 ../test/detect_modified_files.py \
+              -sr "${{inputs.source_remote}}" \
+              -s "${{inputs.source_tree}}" \
+              -tr "${{inputs.target_remote}}" \
+              -t "${{inputs.target_tree}}" \
+              -o _modfiles.out
+
+            if cat _modfiles.out | grep 'examples/'; then
+              echo "Including examples in tests"
+              echo "GFMT_TEST_EXAMPLES=true" >> "$GITHUB_ENV"
+            fi
 
             echo "Detecting tests affected by these changes"
-            python3 ../bin/detect_affected_tests.py -i _modfiles.out -o ../_affected_tests.txt
+            python3 ../test/detect_affected_tests.py -i _modfiles.out -o ../_affected_tests.txt
 
             echo "Generating list of all available targets"
             cmake --build . --target help &> ../all_targets.txt
           popd
         fi
 
-        BUILD_CMD=$(python3 bin/print_test_commands.py --build -f _affected_tests.txt)
+        BUILD_CMD=$(python3 test/print_test_commands.py --build -f _affected_tests.txt)
         echo "Setting build command to ${BUILD_CMD}"
         echo "GFMT_BUILD_CMD=$BUILD_CMD" >> "$GITHUB_ENV"
 
-        TEST_CMD=$(python3 bin/print_test_commands.py --test -f _affected_tests.txt --ctest-args='--output-on-failure')
+        TEST_CMD=$(python3 test/print_test_commands.py --test -f _affected_tests.txt --ctest-args='--output-on-failure')
         echo "Setting test command to ${TEST_CMD}"
         echo "GFMT_TEST_CMD=$TEST_CMD" >> "$GITHUB_ENV"
 
-        MEMCHECK_CMD=$(python3 bin/print_test_commands.py --build -f _affected_tests.txt --memcheck --all-targets-list all_targets.txt)
+        MEMCHECK_CMD=$(python3 test/print_test_commands.py --build -f _affected_tests.txt --memcheck --all-targets-list all_targets.txt)
         echo "Setting memcheck command to ${MEMCHECK_CMD}"
         echo "GFMT_MEMCHECK_CMD=$MEMCHECK_CMD" >> "$GITHUB_ENV"
       shell: bash

.github/actions/test-installed-pkg/action.yml

@@ -7,17 +7,23 @@ inputs:
     required: true
   cxx_compiler:
     required: true
+  allow_skipped_tests:
+    required: true
 runs:
   using: composite
   steps:
     - name: remove-build-directory
       run: rm -rf build
       shell: bash
 
+    - name: prepare-python-env
+      uses: ./.github/actions/prepare-python-env
+
     - name: install-gridformat
       run: |
         cmake -DCMAKE_C_COMPILER=${{inputs.c_compiler}} \
               -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}} \
+              -DCMAKE_BUILD_TYPE=Release \
               -DGRIDFORMAT_BUILD_TESTS=ON \
               -DGRIDFORMAT_BUILD_BINARIES=ON \
               -DCMAKE_INSTALL_PREFIX=$(pwd)/install \
@@ -34,14 +40,18 @@ runs:
       uses: ./.github/actions/set-test-commands
       with:
         build_directory: build
+        source_remote: ${{ env.GFMT_SOURCE_REMOTE }}
         source_tree: ${{ env.GFMT_SOURCE_TREE }}
-        target_tree: main
+        target_remote: ${{ env.GFMT_TARGET_REMOTE }}
+        target_tree: ${{ env.GFMT_TARGET_TREE }}
 
     - name: test-readme-cli-snippets
       run: |
-        export PATH=$PATH:$(pwd)/install/bin
-        python3 test/test_readme_cli_snippets.py \
-          -c "-DCMAKE_C_COMPILER=${{inputs.c_compiler}} -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}}"
+        mkdir readme_snippet_test && pushd readme_snippet_test
+          cp ../install/bin/* .
+          export PATH=$PATH:$(pwd)
+          python3 ../test/test_readme_cli_snippets.py \
+            -c "-DCMAKE_C_COMPILER=${{inputs.c_compiler}} -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}}"
       shell: bash
 
     - name: test-installed-pkg
@@ -67,26 +77,48 @@ runs:
           popd
       shell: bash
 
+    - name: verify-no-skipped-tests
+      run: |
+        if [[ '${{ inputs.allow_skipped_tests }}' != 'true' ]]; then
+          if [[ -e installation-test/build/Testing/Temporary/LastTestsDisabled.log ]]; then
+            echo "The full test suite should not skip any tests. Making the job fail..."
+            exit 1
+          else
+            echo "No skipped tests detected"
+          fi
+        else
+            echo "Skipping verification that no tests have been skipped"
+        fi
+      shell: bash
+
     - name: test-examples
       run: |
-        pushd examples
-          cmake -DCMAKE_C_COMPILER=${{inputs.c_compiler}} \
-                -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}} \
-                -DCMAKE_PREFIX_PATH=/gfmt-dependencies \
-                -Dgridformat_ROOT=$(pwd)/../install \
-                -B build
-        pushd build && make && ctest --output-on-failure
+        if [[ '${{ env.GFMT_TEST_EXAMPLES }}' == 'true' ]]; then
+          pushd examples
+            cmake -DCMAKE_C_COMPILER=${{inputs.c_compiler}} \
+                  -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}} \
+                  -DCMAKE_PREFIX_PATH=/gfmt-dependencies \
+                  -Dgridformat_ROOT=$(pwd)/../install \
+                  -B build
+          pushd build && make && ctest --output-on-failure
+        else
+          echo "Skipping example testing"
+        fi
       shell: bash
 
     - name: test-examples-with-fetch-content
       run: |
-        rm -rf examples/build && pushd examples
-          cmake -DCMAKE_C_COMPILER=${{inputs.c_compiler}} \
-                -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}} \
-                -DCMAKE_BUILD_TYPE=Release \
-                -DCMAKE_PREFIX_PATH=/gfmt-dependencies \
-                -DGRIDFORMAT_FETCH_TREE="$GFMT_TREE" \
-                -DGRIDFORMAT_ORIGIN="$GFMT_ORIGIN" \
-                -B build
-        pushd build && make && ctest --output-on-failure
+        if [[ '${{ env.GFMT_TEST_EXAMPLES }}' == 'true' ]]; then
+          rm -rf examples/build && pushd examples
+            cmake -DCMAKE_C_COMPILER=${{inputs.c_compiler}} \
+                  -DCMAKE_CXX_COMPILER=${{inputs.cxx_compiler}} \
+                  -DCMAKE_BUILD_TYPE=Release \
+                  -DCMAKE_PREFIX_PATH=/gfmt-dependencies \
+                  -DGRIDFORMAT_FETCH_TREE="$GFMT_SOURCE_TREE" \
+                  -DGRIDFORMAT_ORIGIN="$GFMT_SOURCE_REMOTE" \
+                  -B build
+          pushd build && make && ctest --output-on-failure
+        else
+          echo "Skipping example testing"
+        fi
       shell: bash