Let GameTest harness own benchmark shutdown

Author: SkyBlade1978

.github/workflows/ci.yml

@@ -132,9 +132,9 @@ jobs:
           if-no-files-found: error
           retention-days: 30
           path: |
-            build/libs/OreSpawn-4.0.15.120011.jar
-            build/libs/OreSpawn-4.0.15.120011-sources.jar
-            build/libs/OreSpawn-4.0.15.120011-javadoc.jar
+            build/libs/OreSpawn-4.0.16.120011.jar
+            build/libs/OreSpawn-4.0.16.120011-sources.jar
+            build/libs/OreSpawn-4.0.16.120011-javadoc.jar
             build/release/SHA256SUMS
             CHANGELOG.txt
 

CHANGELOG.txt

@@ -1,3 +1,10 @@
+Version 4.0.16.120011
+
+* Leave benchmark shutdown to the GameTest harness when a benchmark is run
+  through Forge's GameTest server, preventing a null test-tracker crash and
+  allowing the harness to report its real test result.
+* Ordinary dedicated benchmark servers still stop automatically when requested.
+
 Version 4.0.15.120011
 
 * Classify generated geology and public geology samples through the same

README.md

@@ -17,7 +17,7 @@ End" policy used by mods such as Base Metals.
 This is not the unrelated mod that adds mobs and dimensions under the same
 name.
 
-This branch builds target-qualified version `4.0.15.120011`: the OreSpawn 4.0.15
+This branch builds target-qualified version `4.0.16.120011`: the OreSpawn 4.0.16
 feature set for Minecraft 1.20.1 and Forge. See the
 [versioning policy](docs/VERSIONS.md) for the encoding and release convention.
 

build.gradle

@@ -156,6 +156,9 @@ minecraft {
         }
         register('client')
         register('server') { args '--nogui' }
+        register('gameTestServer') {
+            workingDir.convention layout.buildDirectory.dir('gametest-benchmark-run')
+        }
         register('data') {
             workingDir.convention layout.projectDirectory.dir('run-data')
             args '--mod', project.mod_id, '--all', '--output', file('src/generated/resources/'),
@@ -237,6 +240,7 @@ tasks.withType(JavaExec).configureEach { JavaExec runTask ->
     Map<String, String> targets = [
             runClient: 'fmluserdevclient',
             runServer: 'fmluserdevserver',
+            runGameTestServer: 'fmluserdevgametestserver',
             runData: 'fmluserdevdata',
             runSurfaceIntegrationFresh: 'fmluserdevserver',
             runSurfaceIntegrationReload: 'fmluserdevserver'
@@ -568,10 +572,26 @@ task verifyMineralogyOracleIsolation {
 
 check.dependsOn verifyMineralogyOracleIsolation
 
-['runClient', 'runServer', 'runData'].each { String taskName ->
+['runClient', 'runServer', 'runGameTestServer', 'runData'].each { String taskName ->
     tasks.matching { it.name == taskName }.all { JavaExec runTask ->
+        if (taskName == 'runGameTestServer') {
+            runTask.workingDir = file("${buildDir}/gametest-benchmark-run")
+        }
         doFirst {
             new File(runTask.workingDir, 'mods').mkdirs()
+            if (taskName == 'runGameTestServer') {
+                new File(runTask.workingDir, 'server.properties').setText('''\
+level-name=gametest-benchmark-world
+level-seed=-4965128775892001975
+level-type=default
+online-mode=false
+server-port=0
+allow-nether=true
+generate-structures=false
+spawn-protection=0
+max-tick-time=-1
+''', 'UTF-8')
+            }
             runTask.ext.oreSpawnCrashSnapshot = runtimeCrashSnapshot(runTask.workingDir)
         }
         doLast {
@@ -847,7 +867,7 @@ def preparedReleaseDir = providers.gradleProperty('preparedReleaseDir')
 tasks.register('verifyReleaseConfiguration') {
     group = 'verification'
     doLast {
-        if (project.mod_version != '4.0.15.120011'
+        if (project.mod_version != '4.0.16.120011'
                 || project.mod_group != expectedMavenGroup
                 || project.minecraft_version != '1.20.1'
                 || project.forge_version != '47.4.10'
@@ -861,9 +881,9 @@ tasks.register('verifyReleaseConfiguration') {
             throw new GradleException('Unexpected dispatcher or Java target metadata')
         }
         List<String> expectedPublicArtifacts = [
-                'OreSpawn-4.0.15.120011.jar',
-                'OreSpawn-4.0.15.120011-sources.jar',
-                'OreSpawn-4.0.15.120011-javadoc.jar'
+                'OreSpawn-4.0.16.120011.jar',
+                'OreSpawn-4.0.16.120011-sources.jar',
+                'OreSpawn-4.0.16.120011-javadoc.jar'
         ]
         if (base.archivesName.get() != expectedMavenArtifact
                 || expectedReleaseFiles.get().collect { it.toString() } != expectedPublicArtifacts) {
@@ -880,7 +900,7 @@ tasks.register('verifyReleaseConfiguration') {
                 'src/main/java/zone/moddev/mc/orespawn/worldgen/LegacyMineralogyProfileMigration.java',
                 'README.md', 'CHANGELOG.txt'
         ].each { path ->
-            if (!file(path).getText('UTF-8').contains('4.0.15.120011')) {
+            if (!file(path).getText('UTF-8').contains('4.0.16.120011')) {
                 throw new GradleException("Release identity missing from ${path}")
             }
         }

docs/VERSIONS.md

@@ -58,7 +58,7 @@ Examples:
 | 1.17.1 | Forge | `117011` | `4.0.9.117011` |
 | 1.18.2 | Forge | `118021` | `4.0.10.118021` |
 | 1.19.4 | Forge | `119041` | `4.0.10.119041` |
-| 1.20.1 | Forge | `120011` | `4.0.15.120011` |
+| 1.20.1 | Forge | `120011` | `4.0.16.120011` |
 | 1.20.6 | Forge | `120061` | `4.0.6.120061` |
 | 1.21.11 | Forge | `121111` | `4.0.6.121111` |
 | 26.1.2 | Forge | `2601021` | `4.0.6.2601021` |
@@ -165,7 +165,9 @@ restore API biome-filter parity and accept provider-namespaced geomes in the
 creation editor, and to `4.0.14.120011` to convert exposed one-layer Snow
 without touching buried or authored weather materials. It then advanced to
 `4.0.15.120011` so generated geology and public samples use the same stable
-quart-biome cell at three-dimensional biome boundaries.
+quart-biome cell at three-dimensional biome boundaries, and to
+`4.0.16.120011` so GameTest benchmark runs leave shutdown and result reporting
+to the test harness.
 
 This provides three useful guarantees:
 

gradle.properties

@@ -19,7 +19,7 @@ mcp_version=20230612.114412
 mod_id=orespawn
 mod_name=MMD OreSpawn
 mod_license=LGPL-2.1
-mod_version=4.0.15.120011
+mod_version=4.0.16.120011
 mod_group=zone.moddev.mc.orespawn
 mod_authors=SkyBlade1978, dshadowwolf, the MMD Team
 mod_description=Configurable, provider-driven terrain, ore, and deposit generation.

src/clientIntegrationTest/java/zone/moddev/mc/orespawn/clientprobe/ClientProbeTestMod.java

@@ -364,7 +364,8 @@ private static void initializeScreen(Screen screen, Minecraft minecraft) {
 			Class<?>[] parameters = method.getParameterTypes();
 			if (parameters.length != 3 || parameters[0] != Minecraft.class
 					|| parameters[1] != int.class || parameters[2] != int.class
-					|| method.getReturnType() != void.class) continue;
+					|| method.getReturnType() != void.class
+					|| !java.lang.reflect.Modifier.isFinal(method.getModifiers())) continue;
 			try {
 				method.setAccessible(true);
 				method.invoke(screen, minecraft, 640, 480);

src/main/java/zone/moddev/mc/orespawn/worldgen/LegacyConfigMigrator.java

@@ -358,7 +358,7 @@ private static void writeReport(Path config, List<String> lines) {
 
 	private static void writeUpgradeReport(Path config, int imported, List<String> detail) {
 		List<String> lines = new ArrayList<>();
-		lines.add("OreSpawn 4.0.15.120011 Upgrade Report");
+		lines.add("OreSpawn 4.0.16.120011 Upgrade Report");
 		lines.add("================================");
 		lines.add("");
 		lines.add("RESULT: Legacy OreSpawn settings were imported into the OS4 profile.");

src/main/java/zone/moddev/mc/orespawn/worldgen/LegacyMineralogyProfileMigration.java

@@ -204,7 +204,7 @@ private static void writeUpgradeReport(Path worldRoot, Path configPath,
         Path report = worldRoot.resolve("serverconfig/orespawn-upgrade-report.txt");
         List<String> missing = missingBlocks(igneous, metamorphic, sedimentary);
         List<String> lines = new ArrayList<>();
-        lines.add("OreSpawn 4.0.15.120011 Upgrade Report");
+        lines.add("OreSpawn 4.0.16.120011 Upgrade Report");
         lines.add("================================");
         lines.add("");
         lines.add("RESULT: Existing Mineralogy " + identity.version + " world detected.");

src/main/java/zone/moddev/mc/orespawn/worldgen/WorldgenBenchmark.java

@@ -15,8 +15,10 @@
 import net.minecraft.core.Registry;
 import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.core.registries.Registries;
+import net.minecraft.gametest.framework.GameTestServer;
 import net.minecraft.resources.ResourceKey;
 import net.minecraft.resources.ResourceLocation;
+import net.minecraft.server.MinecraftServer;
 import net.minecraft.server.level.ServerLevel;
 import net.minecraft.world.level.Level;
 import net.minecraft.world.level.block.Block;
@@ -140,11 +142,19 @@ MODE, chunks, repetitions, format(median), format(median / chunks),
 			throw new IllegalStateException("Benchmark fluid audit found no successful deposits");
 		}
 		if (Boolean.getBoolean("orespawn.worldgenBenchmarkStopServer")) {
-			LOGGER.info("ORESPAWN_BENCHMARK stopping server after completed benchmark");
-			event.getServer().halt(false);
+			if (ownsServerShutdown(event.getServer().getClass())) {
+				LOGGER.info("ORESPAWN_BENCHMARK stopping server after completed benchmark");
+				event.getServer().halt(false);
+			} else {
+				LOGGER.info("ORESPAWN_BENCHMARK leaving shutdown to the GameTest harness");
+			}
 		}
 	}
 
+	static boolean ownsServerShutdown(Class<? extends MinecraftServer> serverType) {
+		return !GameTestServer.class.isAssignableFrom(serverType);
+	}
+
 	static ResourceKey<Level> benchmarkDimensionKey(String configured) {
 		String dimensionName = configured.trim().toLowerCase(Locale.ROOT);
 		return switch (dimensionName) {