Skip to content

Commit 24c1a8a

Browse files
CalinouCalinou
committed
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.
1 parent 06faefc commit 24c1a8a

File tree

115 files changed

+2943
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+2943
-1
lines changed

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Export Godot project
2+
description: Export a test Godot project.
3+
4+
inputs:
5+
bin:
6+
description: The path to the Godot executable
7+
required: true
8+
9+
runs:
10+
using: composite
11+
steps:
12+
- name: Build test GDExtension
13+
shell: sh
14+
run: |
15+
cd misc/test_project/addons/test_extension/
16+
git clone --depth=1 https://github.com/godotengine/godot-cpp.git src/godot-cpp/
17+
scons target=template_debug
18+
scons target=template_release
19+
cd ../../../../
20+
21+
- name: Import resources and export project
22+
shell: sh
23+
run: |
24+
echo "Exporting project for Linux (PCK)"
25+
xvfb-run ${{ inputs.bin }} --headless --path misc/test_project/ --export-pack "Linux" /tmp/test_project.pck 2>&1 | tee log.txt || true
26+
misc/scripts/check_ci_log.py log.txt
27+
28+
echo "Exporting project for Linux (ZIP)"
29+
xvfb-run ${{ inputs.bin }} --headless --path misc/test_project/ --export-pack "Linux" /tmp/test_project.zip 2>&1 | tee log.txt || true
30+
misc/scripts/check_ci_log.py log.txt
31+
32+
echo "Exporting project for Linux as dedicated server (PCK)"
33+
xvfb-run ${{ inputs.bin }} --headless --path misc/test_project/ --export-pack "Linux Server" /tmp/test_project_server.pck 2>&1 | tee log.txt || true
34+
misc/scripts/check_ci_log.py log.txt
35+
36+
- name: Run project files from folder
37+
shell: sh
38+
run: |
39+
xvfb-run ${{ inputs.bin }} --path misc/test_project/ --audio-driver Dummy --resolution 64x64 --write-movie /tmp/test_project_folder.png --quit
40+
# FIXME: Not checked currently, as leaked resources on exit cause CI failures.
41+
# misc/scripts/check_ci_log.py log.txt
42+
43+
xvfb-run ${{ inputs.bin }} --path misc/test_project/ --headless --quit
44+
45+
- name: Run exported project PCK/ZIP
46+
shell: sh
47+
run: |
48+
xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project.pck --audio-driver Dummy --resolution 64x64 --write-movie /tmp/test_project_pck.png --quit
49+
# FIXME: Not checked currently, as leaked resources on exit cause CI failures.
50+
# misc/scripts/check_ci_log.py log.txt
51+
52+
xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project.zip --audio-driver Dummy --resolution 64x64 --write-movie /tmp/test_project_zip.png --quit
53+
54+
# Headless mode is implied for dedicated server PCKs.
55+
xvfb-run ${{ inputs.bin }} --main-pack /tmp/test_project_server.pck --quit
56+
57+
echo "Checking whether video output from project folder and exported project match..."
58+
md5sum /tmp/test_project*.png | md5sum --check
59+
60+
echo "Checking whether audio output from project folder and exported project match..."
61+
md5sum /tmp/test_project*.wav | md5sum --check

‎.github/workflows/linux_builds.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ jobs:
3434
build-mono: true
3535
doc-test: true
3636
proj-conv: true
37+
proj-export: true
3738
api-compat: true
3839
artifact: true
3940
# Validate godot-cpp compatibility on one arbitrary editor build.
@@ -117,7 +118,7 @@ jobs:
117118
run: |
118119
sudo apt-get update
119120
sudo apt-get install libwayland-bin # TODO: Figure out somehow how to embed this one.
120-
if [ "${{ matrix.proj-test }}" == "true" ]; then
121+
if [ "${{ matrix.proj-test }}" == "true" || "${{ matrix.proj-export }}" == "true" ]; then
121122
sudo apt-get install mesa-vulkan-drivers
122123
fi
123124
@@ -249,6 +250,13 @@ jobs:
249250
with:
250251
bin: ${{ matrix.bin }}
251252

253+
# Test project export
254+
- name: Test project export
255+
uses: ./.github/actions/godot-project-export
256+
if: matrix.proj-export
257+
with:
258+
bin: ${{ matrix.bin }}
259+
252260
# Test the project converter
253261
- name: Test project converter
254262
uses: ./.github/actions/godot-converter-test

‎misc/test_project/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*.dblite
2+
3+
# Ignore the submodule so we don't add it to version control.
4+
# We clone it on CI when needed instead.
5+
addons/test_extension/src/godot-cpp

‎misc/test_project/CSharpScript.cs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
using Godot;
2+
using System;
3+
4+
public partial class CSharpScript : Node
5+
{
6+
public override void _Ready()
7+
{
8+
GD.PrintRich("[color=green]C#: OK");
9+
}
10+
}

‎misc/test_project/CSharpScript.cs.uid‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
uid://83iffhl68irk

‎misc/test_project/LICENSE.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# License for third-party files
2+
3+
## `polyhaven/*`
4+
5+
Copyright (c) Poly Haven
6+
7+
- Upstream: https://polyhaven.com
8+
- License: CC0-1.0
9+
10+
## `fonts/librequake_conchars.webp`
11+
12+
- Upstream: https://github.com/lavenderdotpet/LibreQuake
13+
- License: BSD-3-Clause

‎misc/test_project/SConstruct‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/usr/bin/env python
2+
3+
# ruff: noqa: F821
4+
5+
# This file is for building as a Godot GDExtension.
6+
SConscript("addons/test_extension/SConstruct")

‎misc/test_project/TestProject.csproj‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<Project Sdk="Godot.NET.Sdk/4.6.0-dev.2">
2+
<PropertyGroup>
3+
<TargetFramework>net8.0</TargetFramework>
4+
<TargetFramework Condition=" '$(GodotTargetPlatform)' == 'android' ">net9.0</TargetFramework>
5+
<EnableDynamicLoading>true</EnableDynamicLoading>
6+
</PropertyGroup>
7+
</Project>

‎misc/test_project/addons/test_extension/.gitignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# GDExtension generated files
2+
*.gen.*
3+
.sconsign*.dblite
4+
bin/
5+
compile_commands.json
6+
src/gen/
7+
8+
# Compiled files
9+
*.bc
10+
*.creator
11+
*.creator.user
12+
*.dblite
13+
*.exp
14+
*.files
15+
*.idb
16+
*.includes
17+
*.lib
18+
*.o
19+
*.os
20+
*.pdb
21+
*.pyc
22+
*.so
23+
*.obj

‎misc/test_project/addons/test_extension/SConstruct‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
#!/usr/bin/env python
2+
3+
# ruff: noqa: F821
4+
5+
# This file is for building as a Godot GDExtension.
6+
7+
env = SConscript("src/godot-cpp/SConstruct")
8+
9+
# Add source files.
10+
env.Append(CPPPATH=["src/"])
11+
sources = Glob("src/*.cpp")
12+
13+
env.Append(CPPDEFINES=["GDEXTENSION"])
14+
15+
bin_path = "bin/"
16+
extension_name = "test_extension"
17+
debug_or_release = "release" if env["target"] == "template_release" else "debug"
18+
19+
if "arch_suffix" not in env:
20+
env["arch_suffix"] = env["arch"]
21+
22+
if env["target"] in ["editor", "template_debug"]:
23+
# GDExtension has editor classes available in debug templates, which allows editor code to compile.
24+
# If you don't want to compile editor stuff in templates, move these 2 lines to a separate "if" block.
25+
env.Append(CPPPATH=["src/editor/"])
26+
sources += Glob("src/editor/*.cpp")
27+
# Add documentation XML files as a generated cpp file. Only works in Godot 4.3+.
28+
doc_data = env.GodotCPPDocData("src/gen/doc_data.gen.cpp", source=Glob("doc_classes/*.xml"))
29+
sources.append(doc_data)
30+
31+
# Create the library target (e.g. libtest_extension.linux.debug.x86_64.so).
32+
if env["platform"] == "macos":
33+
library = env.SharedLibrary(
34+
"{0}/lib{1}.{2}.{3}.framework/{1}.{2}.{3}".format(
35+
bin_path,
36+
extension_name,
37+
env["platform"],
38+
debug_or_release,
39+
),
40+
source=sources,
41+
)
42+
else:
43+
library = env.SharedLibrary(
44+
"{}/{}{}.{}.{}.{}{}".format(
45+
bin_path,
46+
env.subst("$SHLIBPREFIX"),
47+
extension_name,
48+
env["platform"],
49+
debug_or_release,
50+
env["arch_suffix"],
51+
env["SHLIBSUFFIX"],
52+
),
53+
source=sources,
54+
)
55+
56+
Default(library)

0 commit comments

Comments
 (0)