Proof of concept for a hot-reload test case

Author: enetheru

.github/workflows/ci-cmake.yml

@@ -32,23 +32,53 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          # Linux: Standard tests with bash
           - name: 🐧 Linux (GCC, Makefiles)
             os: ubuntu-22.04
             platform: linux
             config-flags: -DCMAKE_BUILD_TYPE=Release
             artifact-name: godot-cpp-linux-glibc2.27-x86_64-release.cmake
             artifact-path: cmake-build/bin/libgodot-cpp.linux.template_release.x86_64.a
             run-tests: true
-
+            godot_workflow: linux_builds.yml
+            godot_artifact_name: linux-editor-mono
+            godot_binary_path: godot.linuxbsd.editor.x86_64.mono
+            test_shell: bash
+            stable_url: https://github.com/godotengine/godot-builds/releases/download/4.5.1-stable/Godot_v4.5.1-stable_linux.x86_64.zip
+            stable_binary_path: Godot_v4.5.1-stable_linux.x86_64
+
+          # Windows MSVC: Tests with pwsh, .exe binary
           - name: 🏁 Windows (x86_64, MSVC)
             os: windows-2022
             platform: windows
             compiler: msvc
             build-flags: --config Release
             artifact-name: godot-cpp-windows-msvc2019-x86_64-release.cmake
             artifact-path: cmake-build/bin/libgodot-cpp.windows.template_release.x86_64.lib
-            run-tests: false
-
+            run-tests: true  # Enabled: Uses PS1 script
+            godot_workflow: windows_builds.yml
+            godot_artifact_name: windows-editor-mono
+            godot_binary_path: godot.windows.editor.x86_64.mono.exe
+            test_shell: pwsh
+            stable_url: https://github.com/godotengine/godot-builds/releases/download/4.5.1-stable/Godot_v4.5.1-stable_win64.zip
+            stable_binary_path: Godot_v4.5.1-stable_win64.exe
+
+          # macOS: Tests with bash, .app path
+          - name: 🍎 macOS (universal, Makefiles)
+            os: macos-latest
+            platform: macos
+            config-flags: -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
+            artifact-name: godot-cpp-macos-universal-release.cmake
+            artifact-path: cmake-build/bin/libgodot-cpp.macos.template_release.universal.a
+            run-tests: true  # Enabled: Quick macOS validation
+            godot_workflow: macos_builds.yml
+            godot_artifact_name: macos-editor-mono
+            godot_binary_path: Godot.app/Contents/MacOS/Godot  # Inside .app bundle
+            test_shell: bash
+            stable_url: https://github.com/godotengine/godot-builds/releases/download/4.5.1-stable/Godot_v4.5.1-stable_macos.universal.zip
+            stable_binary_path: Godot_v4.5.1-stable_macos.universal/Godot.app/Contents/MacOS/Godot
+
+          # Other platforms: No tests, no godot vars (MinGW uses compiler: mingw, etc.)
           - name: 🏁 Windows (x86_64, MinGW, Ninja)
             os: windows-2022
             platform: windows
@@ -60,14 +90,6 @@ jobs:
             artifact-path: cmake-build/bin/libgodot-cpp.windows.template_release.x86_64.a
             run-tests: false
 
-          - name: 🍎 macOS (universal, Makefiles)
-            os: macos-latest
-            platform: macos
-            config-flags: -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
-            artifact-name: godot-cpp-macos-universal-release.cmake
-            artifact-path: cmake-build/bin/libgodot-cpp.macos.template_release.universal.a
-            run-tests: false
-
           - name: 🤖 Android (arm64, Ninja)
             os: ubuntu-22.04
             platform: android
@@ -140,43 +162,83 @@ jobs:
         shell: bash
         run: ${SCCACHE_PATH} --show-stats
 
+      # Godot Download & Prep (only if run-tests: true) - Identical to SCons
       - name: Download latest Godot artifacts
-        uses: dsnopek/action-download-artifact@1322f74e2dac9feed2ee76a32d9ae1ca3b4cf4e9
+        id: godot-download
         if: matrix.run-tests && env.GODOT_TEST_VERSION == 'master'
+        uses: dsnopek/action-download-artifact@1322f74e2dac9feed2ee76a32d9ae1ca3b4cf4e9
         with:
           repo: godotengine/godot
           branch: master
           event: push
-          workflow: linux_builds.yml
+          workflow: ${{ matrix.godot_workflow }}
           workflow_conclusion: success
-          name: linux-editor-mono
+          name: ${{ matrix.godot_artifact_name }}
           search_artifacts: true
           check_artifacts: true
           ensure_latest: true
           path: godot-artifacts
+          if_no_artifact_found: warn
+        continue-on-error: true
+
+      - name: Download stable Godot (fallback or non-master)
+        id: godot-fallback
+        if: |
+          matrix.run-tests &&
+          (
+            (env.GODOT_TEST_VERSION == 'master' && steps.godot-download.outcome != 'success') ||
+            env.GODOT_TEST_VERSION != 'master'
+          )
+        shell: ${{ matrix.test_shell }}
+        run: |
+          curl -L -o Godot.zip "${{ matrix.stable_url }}"
+          unzip -q Godot.zip
+          echo "GODOT=$(pwd)/${{ matrix.stable_binary_path }}" >> $GITHUB_ENV
 
-      - name: Prepare Godot artifacts for testing
-        if: matrix.run-tests && env.GODOT_TEST_VERSION == 'master'
+      - name: Prepare Godot binary from artifacts
+        if: matrix.run-tests && env.GODOT_TEST_VERSION == 'master' && steps.godot-download.outcome == 'success'
+        shell: ${{ matrix.test_shell }}
         run: |
-          chmod +x ./godot-artifacts/godot.linuxbsd.editor.x86_64.mono
-          echo "GODOT=$(pwd)/godot-artifacts/godot.linuxbsd.editor.x86_64.mono" >> $GITHUB_ENV
+          if [ "${{ matrix.platform }}" != "windows" ]; then
+            chmod +x "./godot-artifacts/${{ matrix.godot_binary_path }}"
+          fi
+          echo "GODOT=$(pwd)/godot-artifacts/${{ matrix.godot_binary_path }}" >> $GITHUB_ENV
 
-      - name: Download requested Godot version for testing
-        if: matrix.run-tests && env.GODOT_TEST_VERSION != 'master'
+      - name: Verify Godot binary
+        if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        run: $GODOT --headless --version
+
+      - name: Prep project import
+        if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        run: |
+          cd test/project
+          timeout 30 $GODOT --import --headless || true
+
+      - name: Run unit tests
+        if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        working-directory: test
         run: |
-          wget "https://github.com/godotengine/godot-builds/releases/download/${GODOT_TEST_VERSION}/Godot_v${GODOT_TEST_VERSION}_linux.x86_64.zip" -O Godot.zip
-          unzip -a Godot.zip
-          chmod +x "Godot_v${GODOT_TEST_VERSION}_linux.x86_64"
-          echo "GODOT=$(pwd)/Godot_v${GODOT_TEST_VERSION}_linux.x86_64" >> $GITHUB_ENV
+          if [ "${{ matrix.test_shell }}" = "pwsh" ]; then
+            pwsh -File ./run-tests.ps1 --unit-only
+          else
+            ./run-tests.sh --unit-only
+          fi
 
-      - name: Run tests
+      - name: Run reload test
         if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        working-directory: test
         run: |
-          $GODOT --headless --version
-          cd test
-          # Need to run the editor so .godot is generated... but it crashes! Ignore that :-)
-          (cd project && (timeout 30 $GODOT --import --headless >/dev/null 2>&1 || true))
-          ./run-tests.sh
+          rm -f project/test_reload_lock
+          if [ "${{ matrix.test_shell }}" = "pwsh" ]; then
+            pwsh -File ./run-tests.ps1 --reload-only
+          else
+            ./run-tests.sh --reload-only
+          fi
+          rm -f project/test_reload_lock
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4

.github/workflows/ci-scons.yml

@@ -25,22 +25,53 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          # Linux: Standard tests with bash
           - name: 🐧 Linux (GCC)
             os: ubuntu-22.04
             platform: linux
             artifact-name: godot-cpp-linux-glibc2.27-x86_64-release
             artifact-path: bin/libgodot-cpp.linux.template_release.x86_64.a
             run-tests: true
             cache-name: linux-x86_64
-
+            godot_workflow: linux_builds.yml
+            godot_artifact_name: linux-editor-mono
+            godot_binary_path: godot.linuxbsd.editor.x86_64.mono
+            test_shell: bash
+            stable_url: https://github.com/godotengine/godot-builds/releases/download/4.5.1-stable/Godot_v4.5.1-stable_linux.x86_64.zip
+            stable_binary_path: Godot_v4.5.1-stable_linux.x86_64
+
+          # Windows MSVC: Tests with pwsh, .exe binary
           - name: 🏁 Windows (x86_64, MSVC)
             os: windows-2022
             platform: windows
             artifact-name: godot-cpp-windows-msvc2019-x86_64-release
             artifact-path: bin/libgodot-cpp.windows.template_release.x86_64.lib
-            run-tests: false
+            run-tests: true  # Enabled: Uses PS1 script
             cache-name: windows-x86_64-msvc
-
+            godot_workflow: windows_builds.yml
+            godot_artifact_name: windows-editor-mono
+            godot_binary_path: godot.windows.editor.x86_64.mono.exe
+            test_shell: pwsh
+            stable_url: https://github.com/godotengine/godot-builds/releases/download/4.5.1-stable/Godot_v4.5.1-stable_win64.zip
+            stable_binary_path: Godot_v4.5.1-stable_win64.exe
+
+          # macOS: Tests with bash, .app path
+          - name: 🍎 macOS (universal)
+            os: macos-latest
+            platform: macos
+            artifact-name: godot-cpp-macos-universal-release
+            artifact-path: bin/libgodot-cpp.macos.template_release.universal.a
+            flags: arch=universal
+            run-tests: true  # Enabled: Quick macOS validation
+            cache-name: macos-universal
+            godot_workflow: macos_builds.yml
+            godot_artifact_name: macos-editor-mono
+            godot_binary_path: Godot.app/Contents/MacOS/Godot  # Inside .app bundle
+            test_shell: bash
+            stable_url: https://github.com/godotengine/godot-builds/releases/download/4.5.1-stable/Godot_v4.5.1-stable_macos.universal.zip
+            stable_binary_path: Godot_v4.5.1-stable_macos.universal/Godot.app/Contents/MacOS/Godot
+
+          # Other platforms: No tests, no godot vars
           - name: 🏁 Windows (x86_64, MinGW)
             os: windows-2022
             platform: windows
@@ -50,15 +81,6 @@ jobs:
             run-tests: false
             cache-name: windows-x86_64-mingw
 
-          - name: 🍎 macOS (universal)
-            os: macos-latest
-            platform: macos
-            artifact-name: godot-cpp-macos-universal-release
-            artifact-path: bin/libgodot-cpp.macos.template_release.universal.a
-            flags: arch=universal
-            run-tests: false
-            cache-name: macos-universal
-
           - name: 🤖 Android (arm64)
             os: ubuntu-22.04
             platform: android
@@ -133,43 +155,91 @@ jobs:
           cache-name: ${{ matrix.cache-name }}
         continue-on-error: true
 
+      # Godot Download & Prep (only if run-tests: true)
       - name: Download latest Godot artifacts
-        uses: dsnopek/action-download-artifact@1322f74e2dac9feed2ee76a32d9ae1ca3b4cf4e9
+        id: godot-download
         if: matrix.run-tests && env.GODOT_TEST_VERSION == 'master'
+        uses: dsnopek/action-download-artifact@1322f74e2dac9feed2ee76a32d9ae1ca3b4cf4e9
         with:
           repo: godotengine/godot
           branch: master
           event: push
-          workflow: linux_builds.yml
+          workflow: ${{ matrix.godot_workflow }}
           workflow_conclusion: success
-          name: linux-editor-mono
+          name: ${{ matrix.godot_artifact_name }}
           search_artifacts: true
           check_artifacts: true
           ensure_latest: true
           path: godot-artifacts
-
-      - name: Prepare Godot artifacts for testing
-        if: matrix.run-tests && env.GODOT_TEST_VERSION == 'master'
+          if_no_artifact_found: warn
+        continue-on-error: true  # Allows fallback step
+
+      - name: Download stable Godot (fallback or non-master)
+        id: godot-fallback
+        if: |
+          matrix.run-tests &&
+          (
+            (env.GODOT_TEST_VERSION == 'master' && steps.godot-download.outcome != 'success') ||
+            env.GODOT_TEST_VERSION != 'master'
+          )
+        shell: ${{ matrix.test_shell }}
+        run: |
+          # wget/unzip to stable (matrix provides exact URL/path)
+          curl -L -o Godot.zip "${{ matrix.stable_url }}"
+          unzip -q Godot.zip
+          # Set GODOT env (platform-specific path from matrix)
+          echo "GODOT=$(pwd)/${{ matrix.stable_binary_path }}" >> $GITHUB_ENV
+
+      - name: Prepare Godot binary from artifacts
+        if: matrix.run-tests && env.GODOT_TEST_VERSION == 'master' && steps.godot-download.outcome == 'success'
+        shell: ${{ matrix.test_shell }}
         run: |
-          chmod +x ./godot-artifacts/godot.linuxbsd.editor.x86_64.mono
-          echo "GODOT=$(pwd)/godot-artifacts/godot.linuxbsd.editor.x86_64.mono" >> $GITHUB_ENV
+          # chmod only if not Windows (matrix binary_path assumes extracted name)
+          if [ "${{ matrix.platform }}" != "windows" ]; then
+            chmod +x "./godot-artifacts/${{ matrix.godot_binary_path }}"
+          fi
+          # Set GODOT env
+          echo "GODOT=$(pwd)/godot-artifacts/${{ matrix.godot_binary_path }}" >> $GITHUB_ENV
+
+      - name: Verify Godot binary
+        if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        run: $GODOT --headless --version  # Confirms correct binary loaded
 
-      - name: Download requested Godot version for testing
-        if: matrix.run-tests && env.GODOT_TEST_VERSION != 'master'
+      # Test Execution (separate for clarity; scripts handle internals)
+      - name: Prep project import
+        if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
         run: |
-          wget "https://github.com/godotengine/godot-builds/releases/download/${GODOT_TEST_VERSION}/Godot_v${GODOT_TEST_VERSION}_linux.x86_64.zip" -O Godot.zip
-          unzip -a Godot.zip
-          chmod +x "Godot_v${GODOT_TEST_VERSION}_linux.x86_64"
-          echo "GODOT=$(pwd)/Godot_v${GODOT_TEST_VERSION}_linux.x86_64" >> $GITHUB_ENV
+          cd test/project
+          # Timeout import (30s, ignore crash)
+          timeout 30 $GODOT --import --headless || true  # Bash; for pwsh, matrix.shell handles equiv if needed
 
-      - name: Run tests
+      - name: Run unit tests
         if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        working-directory: test
         run: |
-          $GODOT --headless --version
-          cd test
-          # Need to run the editor so .godot is generated... but it crashes! Ignore that :-)
-          (cd project && (timeout 30 $GODOT --import --headless >/dev/null 2>&1 || true))
-          ./run-tests.sh
+          # Calls run-tests.sh/ps1 for first half (unit tests)
+          if [ "${{ matrix.test_shell }}" = "pwsh" ]; then
+            pwsh -File ./run-tests.ps1 --unit-only  # Assume PS1 updated with flag; else split script
+          else
+            ./run-tests.sh --unit-only  # Assume bash updated with flag
+          fi
+
+      - name: Run reload test
+        if: matrix.run-tests
+        shell: ${{ matrix.test_shell }}
+        working-directory: test
+        run: |
+          # Handles lock/filtering in script
+          rm -f project/test_reload_lock  # Pre-clean (cross-shell safe)
+          if [ "${{ matrix.test_shell }}" = "pwsh" ]; then
+            pwsh -File ./run-tests.ps1 --reload-only
+          else
+            ./run-tests.sh --reload-only
+          fi
+          rm -f project/test_reload_lock  # Post-clean
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4