GitHub Actions: Test project exporting on CI

This allows finding issues in headless project export early on,
including when exporting for a dedicated server.

We also use this opportunity to check whether the audiovisual output
between the project being run from its files and the exported PCK
matches (it should always be a perfect match, assuming the same GPU
is used for both runs). This can be used to catch audiovisual
discrepancies, which could indicate a bug in the export process.

Author: Calinou

.github/actions/godot-project-export/action.yml

@@ -0,0 +1,59 @@
+name: Export Godot project
+description: Export a test Godot project.
+
+inputs:
+  bin:
+    description: The path to the Godot executable
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Import resources and export project
+      shell: sh
+      run: |
+        #echo "Importing resources"
+        #${{ inputs.bin }} --headless --path misc/test_project/ --import 2>&1 | tee log.txt || true
+
+        echo "Exporting project for Linux (PCK)"
+        ${{ inputs.bin }} --headless --path misc/test_project/ --export-pack "Linux" /tmp/test_project.pck 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+        echo "Exporting project for Linux (ZIP)"
+        ${{ inputs.bin }} --headless --path misc/test_project/ --export-pack "Linux" /tmp/test_project.zip 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+        unzip -l /tmp/test_project.zip
+
+        echo "Exporting project for Linux as dedicated server (PCK)"
+        ${{ inputs.bin }} --headless --path misc/test_project/ --export-pack "Linux Server" /tmp/test_project_server.pck 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+        ls -l /tmp
+
+    - name: Run project files from folder
+      shell: sh
+      run: |
+        xvfb-run ${{ inputs.bin }} --path misc/test_project/ --language fr --resolution 64x64 --write-movie /tmp/test_project_folder.png --quit 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+        ${{ inputs.bin }} --headless --path misc/test_project/ --quit 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+    - name: Run exported project PCK/ZIP
+      shell: sh
+      run: |
+        xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project.pck --language fr --resolution 64x64 --write-movie /tmp/test_project_pck.png --quit 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+        xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project.zip --language fr --resolution 64x64 --write-movie /tmp/test_project_zip.png --quit 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+        # Headless mode is implied for dedicated server PCKs.
+        ${{ inputs.bin }} --main-pack /tmp/test_project_server.pck --quit 2>&1 | tee log.txt || true
+        GODOT_CHECK_CI_LOG_ALL_ERRORS=1 misc/scripts/check_ci_log.py log.txt
+
+        echo "Checking whether video output from project folder and exported project match..."
+        md5sum /tmp/test_project*.png | md5sum --check
+
+        echo "Checking whether audio output from project folder and exported project match..."
+        md5sum /tmp/test_project*.wav | md5sum --check

.github/workflows/linux_builds.yml

@@ -35,6 +35,7 @@ jobs:
             build-mono: true
             doc-test: true
             proj-conv: true
+            proj-export: true
             api-compat: true
             artifact: true
             # Validate godot-cpp compatibility on one arbitrary editor build.
@@ -118,7 +119,7 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install libwayland-bin  # TODO: Figure out somehow how to embed this one.
-          if [ "${{ matrix.proj-test }}" == "true" ]; then
+          if [ "${{ matrix.proj-test }}" == "true" -o "${{ matrix.proj-export }}" == "true" ]; then
             sudo apt-get install mesa-vulkan-drivers
           fi
 
@@ -250,6 +251,13 @@ jobs:
         with:
           bin: ${{ matrix.bin }}
 
+      # Test project export
+      - name: Test project export
+        uses: ./.github/actions/godot-project-export
+        if: matrix.proj-export
+        with:
+          bin: ${{ matrix.bin }}
+
       # Test the project converter
       - name: Test project converter
         uses: ./.github/actions/godot-converter-test

.gitignore

@@ -232,6 +232,7 @@ xcuserdata/
 
 # Actual VS project files we don't use
 *.sln
+!misc/test_project/TestProject.sln
 *.vcxproj*
 
 # User-specific files

misc/scripts/check_ci_log.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+import os
 import sys
 
 if len(sys.argv) < 2:
@@ -58,6 +59,12 @@
     print("ERROR: Assertion failed in project, check execution log for more info")
     sys.exit(55)
 
+if os.environ.get("GODOT_CHECK_CI_LOG_ALL_ERRORS"):
+    # If any occurrence of "ERROR:" is found in the log, we consider it a failure.
+    if file_contents.find("ERROR:") != -1:
+        print("ERROR: 'ERROR:' found in log and GODOT_CHECK_CI_LOG_ALL_ERRORS is set.")
+        sys.exit(56)
+
 # For now Godot leaks a lot of rendering stuff so for now we just show info
 # about it and this needs to be re-enabled after fixing this memory leaks.
 

misc/test_project/.gitignore

@@ -0,0 +1,5 @@
+*.dblite
+
+# Ignore the submodule so we don't add it to version control.
+# We clone it on CI when needed instead.
+addons/test_extension/src/godot-cpp

misc/test_project/LICENSE.md

@@ -0,0 +1,13 @@
+# License for third-party files
+
+## `polyhaven/*`
+
+Copyright (c) Poly Haven
+
+- Upstream: https://polyhaven.com
+- License: CC0-1.0
+
+## `fonts/librequake_conchars.webp`
+
+- Upstream: https://github.com/lavenderdotpet/LibreQuake
+- License: BSD-3-Clause

misc/test_project/SConstruct

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+
+# ruff: noqa: F821
+
+# This file is for building as a Godot GDExtension.
+SConscript("addons/test_extension/SConstruct")

misc/test_project/custom_shader.gdshader

@@ -0,0 +1,14 @@
+shader_type spatial;
+
+global uniform vec3 offset;
+instance uniform vec3 emission : source_color = vec3(1.0, 0.0, 0.0);
+uniform vec3 color : source_color = vec3(1.0, 0.0, 0.0);
+
+void vertex() {
+	VERTEX.xyz += offset;
+}
+
+void fragment() {
+	ALBEDO = color.rgb;
+	EMISSION = emission.rgb;
+}

misc/test_project/custom_shader.gdshader.uid

@@ -0,0 +1 @@
+uid://cqkjq1u1jfe1c

misc/test_project/custom_visual_shader.tres

@@ -0,0 +1,12 @@
+[gd_resource type="VisualShader" load_steps=2 format=3 uid="uid://barg7ns55yag2"]
+
+[sub_resource type="VisualShaderNodeColorParameter" id="VisualShaderNodeColorParameter_bwiop"]
+output_port_for_preview = 0
+parameter_name = "ColorParameter"
+default_value_enabled = true
+default_value = Color(1, 0, 0, 1)
+
+[resource]
+nodes/fragment/2/node = SubResource("VisualShaderNodeColorParameter_bwiop")
+nodes/fragment/2/position = Vector2(20, 260)
+nodes/fragment/connections = PackedInt32Array(2, 0, 0, 0)