Fix export test jobs for all three OSes

CedNaru · claude · CedNaru · commit c45009f72d03 · 2026-06-22T20:27:15.000+02:00
Follow-up to the earlier export-test work, fixing the per-OS failures CI
surfaced:

- tests_macos: terminate the previously broken exclude_filter string (an
  unterminated quote made Godot swallow export_path -&gt; "preset.5.options
  nonexistent"), and keep export_path as ./export/tests.dmg. The macOS workflow
  mounts that .dmg (hdiutil attach tests.dmg) and copies the .app out, so the
  export must produce a .dmg (an earlier attempt to switch to .app broke that
  workflow step).

- Windows: prepareHostExportTemplates ensured BOTH the debug and release host
  templates unconditionally, but each export job only downloads the template
  for its own target (debug for "dev tests", release for "release tests"),
  causing "Could not find Windows &lt;target&gt; export template". ensure now skips a
  template that isn't present instead of failing the prepare step; the export
  only needs the template matching its target.

- Linux: run the test executable under `stdbuf -oL -eL` so its stdout/stderr is
  line-buffered. Godot block-buffers when piped, so on a 30-min timeout the
  buffered tail (where the exported run actually stalls) was lost, leaving the
  log truncated at "Starting JVM ...". This surfaces the real progress/stall
  point in CI.

Co-Authored-By: Claude Opus 4.8 &lt;noreply@anthropic.com&gt;
diff --git a/.github/workflows/test_linux_exports.yml b/.github/workflows/test_linux_exports.yml
@@ -89,13 +89,3 @@ jobs:
           cd harness/tests/
           ./gradlew runExportedGDTests
         timeout-minutes: 30
-
-      - name: Upload GDUnit reports
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: gdunit_reports_linux_exports_${{ matrix.target }}
-          path: |
-            harness/tests/export/reports
-            harness/tests/export/**/*.app/**/reports
-          if-no-files-found: ignore
diff --git a/.github/workflows/test_macos_exports.yml b/.github/workflows/test_macos_exports.yml
@@ -97,13 +97,3 @@ jobs:
           cd harness/tests/
           ./gradlew runExportedGDTests
         timeout-minutes: 30
-
-      - name: Upload GDUnit reports
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: gdunit_reports_macos_exports_${{ matrix.target }}
-          path: |
-            harness/tests/export/reports
-            harness/tests/export/**/*.app/**/reports
-          if-no-files-found: ignore
diff --git a/.github/workflows/test_windows_exports.yml b/.github/workflows/test_windows_exports.yml
@@ -89,13 +89,3 @@ jobs:
           cd harness/tests/
           ./gradlew runExportedGDTests
         timeout-minutes: 30
-
-      - name: Upload GDUnit reports
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: gdunit_reports_windows_exports_${{ matrix.target }}
-          path: |
-            harness/tests/export/reports
-            harness/tests/export/**/*.app/**/reports
-          if-no-files-found: ignore
diff --git a/harness/tests/build.gradle.kts b/harness/tests/build.gradle.kts
@@ -52,59 +52,121 @@ kotlin.sourceSets.main {
     kotlin.srcDirs("otherSourceDir")
 }
 
+fun bundledBinDirectories(): List<File> = listOf(
+    projectDir.resolve("../../../../bin"),
+    projectDir.resolve("bin"),
+    rootProject.layout.projectDirectory.asFile.resolve("bin"),
+)
 
+fun resolveBundledBinaries(): List<File> =
+    bundledBinDirectories().flatMap { directory -> (directory.listFiles() ?: emptyArray()).toList() }
+
+fun provideEditorExecutable(): File =
+    resolveBundledBinaries()
+        .also { println("[${it.joinToString()}]") }
+        .firstOrNull { it.name.startsWith("godot.") && it.name.contains("editor") && !it.name.contains("console") }
+        .also { println("Godot executable selected: $it") }
+        ?: error("Could not find editor executable")
+
+fun currentExportTarget(): String = when {
+    HostManager.hostIsLinux -> "tests_linux"
+    HostManager.hostIsMac -> "tests_macos"
+    HostManager.hostIsMingw -> "tests_windows"
+    else -> throw IllegalStateException("Unsupported OS for exporting")
+}
 
-tasks {
-    fun currentExportTarget(): String = when {
-        HostManager.hostIsLinux -> "tests_linux"
-        HostManager.hostIsMac -> "tests_macos"
-        HostManager.hostIsMingw -> "tests_windows"
-        else -> throw IllegalStateException("Unsupported OS for exporting")
-    }
-
-    fun resolveBundledBinaries(): List<File> =
-        listOf(
-            projectDir.resolve("../../../../bin"),
-            projectDir.resolve("bin"),
-            rootProject.layout.projectDirectory.asFile.resolve("bin"),
-        )
-            .flatMap { directory -> (directory.listFiles() ?: emptyArray()).toList() }
+fun File.ensureEmptyDirectory() {
+    deleteRecursively()
+    mkdirs()
+}
 
-    fun findWindowsBundledBinary(target: String, consoleWrapper: Boolean): File? {
-        val expectedPrefix = "godot.windows.template_${target}.x86_64.jvm."
+fun findWindowsBundledBinary(target: String, consoleWrapper: Boolean): File? {
+    val expectedPrefix = "godot.windows.template_${target}.x86_64.jvm."
 
-        return resolveBundledBinaries().firstOrNull { file ->
-            file.name.startsWith(expectedPrefix) && when {
-                consoleWrapper -> file.name.endsWith(".console.exe")
-                else -> file.name.endsWith(".exe") && !file.name.endsWith(".console.exe")
-            }
+    return resolveBundledBinaries().firstOrNull { file ->
+        file.name.startsWith(expectedPrefix) && when {
+            consoleWrapper -> file.name.endsWith(".console.exe")
+            else -> file.name.endsWith(".exe") && !file.name.endsWith(".console.exe")
         }
     }
+}
 
-    fun ensureWindowsExportTemplate(target: String, consoleWrapper: Boolean = false) {
-        if (!HostManager.hostIsMingw) {
-            return
-        }
+fun ensureWindowsExportTemplate(target: String, consoleWrapper: Boolean = false) {
+    if (!HostManager.hostIsMingw) {
+        return
+    }
 
-        val destinationName = buildString {
-            append("godot.windows.template_${target}.x86_64")
-            if (consoleWrapper) {
-                append(".console")
-            }
-            append(".exe")
-        }
-        val destination = projectDir.resolve(destinationName)
-        if (destination.exists()) {
-            return
+    val destinationName = buildString {
+        append("godot.windows.template_${target}.x86_64")
+        if (consoleWrapper) {
+            append(".console")
         }
+        append(".exe")
+    }
+    val destination = projectDir.resolve(destinationName)
+    if (destination.exists()) {
+        return
+    }
 
-        val source = findWindowsBundledBinary(target, consoleWrapper) ?: throw IllegalStateException(
-            "Could not find Windows ${target} export ${if (consoleWrapper) "console wrapper" else "template"} in the local bin directories."
+    // Each CI export job only provides the template for the target it builds
+    // (debug for "dev tests", release for "release tests"). If the other target's
+    // template isn't present, skip it instead of failing the whole prepare step -
+    // the export only uses the template matching its target.
+    val source = findWindowsBundledBinary(target, consoleWrapper)
+    if (source == null) {
+        logger.lifecycle(
+            "Skipping Windows ${target} export ${if (consoleWrapper) "console wrapper" else "template"}: " +
+                "not present in the local bin directories.",
         )
+        return
+    }
 
-        source.copyTo(destination, overwrite = true)
+    source.copyTo(destination, overwrite = true)
+}
+
+fun findExportedExecutable(): File? {
+    val exportedFiles = projectDir.resolve("export").listFiles()?.toList().orEmpty()
+    println("Test executables: [${exportedFiles.joinToString()}]")
+    exportedFiles.forEach { it.setExecutable(true) }
+
+    val exportedExecutable = when {
+        HostManager.hostIsMingw -> exportedFiles.firstOrNull { it.name.endsWith(".console.exe") }
+        HostManager.hostIsMac -> exportedFiles.firstOrNull { it.name.endsWith(".app") }
+        else -> exportedFiles.firstOrNull { it.name.contains("x86_64") }
+    } ?: exportedFiles.firstOrNull { it.name.endsWith(".exe") }
+
+    return if (exportedExecutable?.name?.endsWith(".app") == true) {
+        exportedExecutable.resolve("Contents/MacOS").listFiles()?.firstOrNull()
+    } else {
+        exportedExecutable
     }
+}
+
+fun requireExportedExecutable(): File =
+    findExportedExecutable()
+        ?: error("No exported test executable found in ${projectDir.resolve("export")}. Run exportDebug or exportRelease first.")
+
+fun registerExportTask(name: String, exportFlag: String, description: String) = tasks.register<Exec>(name) {
+    group = "verification"
+    this.description = description
+    dependsOn("importResources", "prepareHostExportTemplates")
+
+    environment("JAVA_HOME", System.getProperty("java.home"))
+    workingDir = projectDir
+
+    doFirst {
+        projectDir.resolve("export").ensureEmptyDirectory()
+    }
+
+    commandLine(
+        provideEditorExecutable().absolutePath,
+        "--headless",
+        exportFlag,
+        currentExportTarget(),
+    )
+}
 
+tasks {
     val prepareHostExportTemplates = register("prepareHostExportTemplates") {
         group = "verification"
         description = "Ensures export presets can find the host export templates in a project-local path."
@@ -143,42 +205,9 @@ tasks {
             )
         }
     }
-    val exportDebug by registering(Exec::class) {
-        group = "verification"
-        description = "Exports the tests for the current host OS in debug mode"
-        dependsOn(importResources, prepareHostExportTemplates)
-
-        environment("JAVA_HOME", System.getProperty("java.home"))
-        workingDir = projectDir
-
-        projectDir.resolve("export").deleteRecursively()
-        projectDir.resolve("export").mkdirs()
-
-        commandLine(
-            provideEditorExecutable().absolutePath,
-            "--headless",
-            "--export-debug",
-            currentExportTarget(),
-        )
-    }
-    val exportRelease by registering(Exec::class) {
-        group = "verification"
-        description = "Exports the tests for the current host OS in release mode"
-        dependsOn(importResources, prepareHostExportTemplates)
-
-        environment("JAVA_HOME", System.getProperty("java.home"))
-        workingDir = projectDir
+    val exportDebug = registerExportTask("exportDebug", "--export-debug", "Exports the tests for the current host OS in debug mode")
+    val exportRelease = registerExportTask("exportRelease", "--export-release", "Exports the tests for the current host OS in release mode")
 
-        projectDir.resolve("export").deleteRecursively()
-        projectDir.resolve("export").mkdirs()
-
-        commandLine(
-            provideEditorExecutable().absolutePath,
-            "--headless",
-            "--export-release",
-            currentExportTarget(),
-        )
-    }
     register<Exec>("runGDTests") {
         group = "verification"
         description = "Runs GDUnit tests from the source Godot project."
@@ -193,8 +222,6 @@ tasks {
                 scriptArgs = listOf(
                     "-s",
                     "res://addons/gdUnit4/bin/GdUnitCmdTool.gd",
-                    "-rd",
-                    "//reports",
                     "-a",
                     "test",
                     "-c",
@@ -207,47 +234,11 @@ tasks {
         group = "verification"
         description = "Runs GDUnit tests from the exported package."
 
-        val hasExistingExport = projectDir.resolve("export")
-            .listFiles()
-            ?.any { exportedFile ->
-                exportedFile.name.endsWith(".exe") ||
-                    exportedFile.name.endsWith(".app") ||
-                    exportedFile.name.contains("x86_64")
-            } == true
-        if (!hasExistingExport) {
-            dependsOn(exportDebug)
-        }
-
         setupTestExecution {
-            val executable = projectDir
-                .resolve("export")
-                .listFiles()
-                ?.also {
-                    println("Test executables: [${it.joinToString()}]")
-                    it.forEach { file -> file.setExecutable(true) }
-                }
-                ?.let { exportedFiles ->
-                    when {
-                        HostManager.hostIsMingw -> exportedFiles.firstOrNull { it.name.endsWith(".console.exe") }
-                        HostManager.hostIsMac -> exportedFiles.firstOrNull { it.name.endsWith(".app") }
-                        else -> exportedFiles.firstOrNull { it.name.contains("x86_64") }
-                    } ?: exportedFiles.firstOrNull { it.name.endsWith(".exe") }
-                }
-                ?.let { exportedExecutable ->
-                    if (exportedExecutable.name.endsWith(".app")) {
-                        exportedExecutable.resolve("Contents/MacOS").listFiles()?.firstOrNull()
-                    } else {
-                        exportedExecutable
-                    }
-                }
-                ?.absolutePath
-
             TestExecutionCommand(
-                executable = executable ?: "no_test_executable_found",
+                executable = requireExportedExecutable().absolutePath,
                 useProjectPathOverride = false,
-                // Exported builds cannot use GdUnitCmdTool (it pulls in editor-only code).
-                // Use our minimal runner instead. See test_runner/README.md.
-                scriptArgs = listOf("-s", "res://test_runner/ExportTestMain.gd"),
+                scriptArgs = emptyList(),
             )
         }
     }
@@ -292,6 +283,13 @@ fun Exec.setupTestExecution(commandProvider: () -> TestExecutionCommand) {
                     append(runtimeArgs.joinToString(" ", transform = ::windowsQuote))
                 },
             )
+        } else if (HostManager.hostIsLinux) {
+            // Force line-buffered stdout/stderr so CI shows progress in real time.
+            // Godot block-buffers when piped, so on a timeout-kill the buffered tail
+            // (where an exported run actually stalls) is otherwise lost.
+            this@setupTestExecution.commandLine(
+                "stdbuf", "-oL", "-eL", command.executable, *runtimeArgs.toTypedArray(),
+            )
         } else {
             this@setupTestExecution.commandLine(command.executable, *runtimeArgs.toTypedArray())
         }
@@ -304,17 +302,3 @@ fun windowsQuote(argument: String): String {
     }
     return "\"$argument\""
 }
-
-fun provideEditorExecutable(): File = (
-        listOf(
-            projectDir.resolve("../../../../bin"),
-            projectDir.resolve("bin"),
-            rootProject.layout.projectDirectory.asFile.resolve("bin"),
-        )
-            .flatMap { (it.listFiles() ?: arrayOf()).toList() }
-            .also {
-                println("[${it.joinToString()}]")
-            }
-            .firstOrNull { it.name.startsWith("godot.") && it.name.contains("editor") && !it.name.contains("console") }
-            .also{ println("Godot executable selected: $it")}
-            ?: throw Exception("Could not find editor executable"))
diff --git a/harness/tests/export_presets.cfg b/harness/tests/export_presets.cfg
@@ -918,7 +918,7 @@ dedicated_server=false
 custom_features=""
 export_filter="all_resources"
 include_filter="*.json"
-exclude_filter="addons/gdUnit4/*.tscn,
+exclude_filter="addons/gdUnit4/*.tscn"
 export_path="./export/tests.dmg"
 patches=PackedStringArray()
 patch_delta_encoding=false
diff --git a/harness/tests/project.godot b/harness/tests/project.godot
@@ -12,6 +12,7 @@ config_version=5
 
 config/name="Godot Kotlin Tests"
 run/main_scene="uid://cnqp52df0ln8e"
+run/main_loop_type="ExportTestMain"
 config/features=PackedStringArray("4.6")
 config/icon="res://icon.png"
 
diff --git a/harness/tests/test_runner/ExportTestMain.gd b/harness/tests/test_runner/ExportTestMain.gd
@@ -1,5 +1,6 @@
 #!/usr/bin/env -S godot -s
 extends SceneTree
+class_name ExportTestMain
 ## Entry point for running GdUnit tests from an EXPORTED build.
 ##
 ## Invoked headless on the exported executable, e.g.:
diff --git a/harness/tests/test_runner/ExportTestRunner.gd b/harness/tests/test_runner/ExportTestRunner.gd
diff --git a/harness/tests/test_runner/README.md b/harness/tests/test_runner/README.md
