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,77 @@
+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: Build test GDExtension
+      shell: sh
+      run: |
+        cd misc/test_project/addons/test_extension/
+        git clone --depth=1 https://github.com/godotengine/godot-cpp.git src/godot-cpp/
+        scons target=template_debug
+        scons target=template_release
+        cd ../../../../
+
+    - name: Import resources and export project
+      shell: bash
+      run: |
+        dotnet nuget add source "$PWD/bin/GodotSharp/Tools/nupkgs/" --name MyLocalNugetSource
+
+        echo "Importing resources"
+        ${{ inputs.bin }} --headless --path misc/test_project/ --import 2>&1 | tee log.txt || true
+        # TODO: Try non-headless (also for export)?
+
+        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
+        misc/scripts/check_ci_log.py log.txt
+
+        # FIXME: Remove this once no longer needed.
+        #shopt -s globstar nullglob
+        #cat $HOME/.local/share/godot/mono/build_logs/**/*
+
+        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
+        misc/scripts/check_ci_log.py log.txt
+
+        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
+        misc/scripts/check_ci_log.py log.txt
+
+    - name: Run project files from folder
+      shell: sh
+      run: |
+        xvfb-run ${{ inputs.bin }} --path misc/test_project/ --language fr --audio-driver Dummy --resolution 64x64 --write-movie /tmp/test_project_folder.png --quit-after 9
+        # FIXME: Not checked currently, as leaked resources on exit cause CI failures.
+        # TODO: Check if above notice is still needed.
+        misc/scripts/check_ci_log.py log.txt
+
+        # Wait several frames before quitting to ensure we don't quit while audio is still playing,
+        # as this would cause an ObjectDB leaked instances warning, causing CI to fail (see GH-76745).
+        ${{ inputs.bin }} --headless --path misc/test_project/ --quit-after 9
+
+    - name: Run exported project PCK/ZIP
+      shell: sh
+      run: |
+        xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project.pck --language fr --audio-driver Dummy --resolution 64x64 --write-movie /tmp/test_project_pck.png --quit-after 9
+        # FIXME: Not checked currently, as leaked resources on exit cause CI failures.
+        # TODO: Check if above notice is still needed.
+        misc/scripts/check_ci_log.py log.txt
+
+        xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project.zip --language fr --audio-driver Dummy --resolution 64x64 --write-movie /tmp/test_project_zip.png --quit-after 9
+
+        # Headless mode is implied for dedicated server PCKs.
+        # Wait several frames before quitting to ensure we don't quit while audio is still playing,
+        # as this would cause an ObjectDB leaked instances warning, causing CI to fail (see GH-76745).
+        ${{ inputs.bin }} --main-pack /tmp/test_project_server.pck --quit-after 9
+
+        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

@@ -34,6 +34,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.
@@ -117,7 +118,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
 
@@ -249,6 +250,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/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/addons/test_extension/.gitignore

@@ -0,0 +1,23 @@
+# GDExtension generated files
+*.gen.*
+.sconsign*.dblite
+bin/
+compile_commands.json
+src/gen/
+
+# Compiled files
+*.bc
+*.creator
+*.creator.user
+*.dblite
+*.exp
+*.files
+*.idb
+*.includes
+*.lib
+*.o
+*.os
+*.pdb
+*.pyc
+*.so
+*.obj

misc/test_project/addons/test_extension/SConstruct

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+
+# ruff: noqa: F821
+
+# This file is for building as a Godot GDExtension.
+
+env = SConscript("src/godot-cpp/SConstruct")
+
+# Add source files.
+env.Append(CPPPATH=["src/"])
+sources = Glob("src/*.cpp")
+
+env.Append(CPPDEFINES=["GDEXTENSION"])
+
+bin_path = "bin/"
+extension_name = "test_extension"
+debug_or_release = "release" if env["target"] == "template_release" else "debug"
+
+if "arch_suffix" not in env:
+    env["arch_suffix"] = env["arch"]
+
+if env["target"] in ["editor", "template_debug"]:
+    # GDExtension has editor classes available in debug templates, which allows editor code to compile.
+    # If you don't want to compile editor stuff in templates, move these 2 lines to a separate "if" block.
+    env.Append(CPPPATH=["src/editor/"])
+    sources += Glob("src/editor/*.cpp")
+    # Add documentation XML files as a generated cpp file. Only works in Godot 4.3+.
+    doc_data = env.GodotCPPDocData("src/gen/doc_data.gen.cpp", source=Glob("doc_classes/*.xml"))
+    sources.append(doc_data)
+
+# Create the library target (e.g. libtest_extension.linux.debug.x86_64.so).
+if env["platform"] == "macos":
+    library = env.SharedLibrary(
+        "{0}/lib{1}.{2}.{3}.framework/{1}.{2}.{3}".format(
+            bin_path,
+            extension_name,
+            env["platform"],
+            debug_or_release,
+        ),
+        source=sources,
+    )
+else:
+    library = env.SharedLibrary(
+        "{}/{}{}.{}.{}.{}{}".format(
+            bin_path,
+            env.subst("$SHLIBPREFIX"),
+            extension_name,
+            env["platform"],
+            debug_or_release,
+            env["arch_suffix"],
+            env["SHLIBSUFFIX"],
+        ),
+        source=sources,
+    )
+
+Default(library)

misc/test_project/addons/test_extension/doc_classes/ExampleNode.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ExampleNode" inherits="Node" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
+	<brief_description>
+		GDExtension example node.
+	</brief_description>
+	<description>
+		An example node that demonstrates how to create a node in [GDExtension], which can be compiled and loaded by [GDExtensionManager]. This example node can also be compiled as an engine module, if that option was selected in the editor when creating the GDExtension.
+	</description>
+	<tutorials>
+		<link title="GDExtension overview">$DOCS_URL/tutorials/scripting/gdextension/what_is_gdextension.html</link>
+		<link title="GDExtension example in C++">$DOCS_URL/tutorials/scripting/gdextension/gdextension_cpp_example.html</link>
+	</tutorials>
+	<methods>
+		<method name="print_hello" qualifiers="const">
+			<return type="void" />
+			<description>
+				Prints either [code]"Hello, World! From GDExtension."[/code] if compiled as GDExtension or [code]"Hello, World! From a module."[/code] if compiled as a module, determined by the [code]#if[/code] directives in the C++ code.
+			</description>
+		</method>
+		<method name="return_hello" qualifiers="const">
+			<return type="String" />
+			<description>
+				Returns either [code]"Hello, World! From GDExtension."[/code] if compiled as GDExtension or [code]"Hello, World! From a module."[/code] if compiled as a module, determined by the [code]#if[/code] directives in the C++ code. If neither a module or extension, the code does not compile.
+			</description>
+		</method>
+	</methods>
+</class>