Migrate tests to Fabric Client GameTest API

Author: Alexander01998

.github/workflows/gradle.yml

@@ -87,57 +87,29 @@ jobs:
         done
         echo "</details>" >> $GITHUB_STEP_SUMMARY
 
-    - name: Run the mod and take screenshots
-      # TODO: Migrate to Fabric Client Gametest API so this can run with configuration cache enabled
-      run: xvfb-run --auto-servernum ./gradlew runEndToEndTest --stacktrace --warning-mode=fail --no-configuration-cache
+    - name: Run client gametests
+      env:
+        IMGUR_CLIENT_ID: ${{ secrets.IMGUR_CLIENT_ID }}
+      run: xvfb-run --auto-servernum ./gradlew runClientGameTest --stacktrace --warning-mode=fail
 
-    - name: Upload screenshots.zip artifact
+    - name: Upload screenshots
       uses: actions/upload-artifact@v5
       if: ${{ success() || failure() }}
       with:
         name: screenshots
-        path: run/screenshots
+        path: build/run/*/screenshots
         compression-level: 0
 
-    - name: Upload crash-reports.zip artifact
+    - name: Upload logs
+      uses: actions/upload-artifact@v5
+      if: ${{ success() || failure() }}
+      with:
+        name: logs
+        path: build/run/*/logs/latest.log
+
+    - name: Upload crash reports
       uses: actions/upload-artifact@v5
       if: ${{ failure() }}
       with:
         name: crash-reports
-        path: run/crash-reports
-
-    - name: Create test screenshot gallery
-      env:
-        IMGUR_CLIENT_ID: ${{ secrets.IMGUR_CLIENT_ID }}
-      if: ${{ env.IMGUR_CLIENT_ID && (success() || failure()) }}
-      # Imgur uploads randomly fail sometimes, probably because of the low rate limit.
-      # TODO: Find a better place to upload the screenshots.
-      continue-on-error: true
-      run: |
-        echo "<details open>" >> $GITHUB_STEP_SUMMARY
-        echo "<summary>📸 Test Screenshots</summary>" >> $GITHUB_STEP_SUMMARY
-        echo "" >> $GITHUB_STEP_SUMMARY
-        for img in run/screenshots/*.png; do
-          if [ -f "$img" ]; then
-            filename=$(basename "$img")
-            name_without_ext="${filename%.*}"
-            # Upload to Imgur
-            response=$(curl -s -X POST \
-              -H "Authorization: Client-ID $IMGUR_CLIENT_ID" \
-              -F "image=@$img" \
-              https://api.imgur.com/3/image)
-            # Extract the URL from the response
-            url=$(echo $response | grep -o '"link":"[^"]*"' | cut -d'"' -f4)
-            if [ ! -z "$url" ]; then
-              # Convert underscores to spaces and capitalize first letter of each word
-              title=$(echo "$name_without_ext" | tr '_' ' ' | awk '{for(i=1;i<=NF;i++)sub(/./,toupper(substr($i,1,1)),$i)}1')
-              echo "### $title" >> $GITHUB_STEP_SUMMARY
-              echo "![${name_without_ext}]($url)" >> $GITHUB_STEP_SUMMARY
-              echo "" >> $GITHUB_STEP_SUMMARY
-            else
-              echo "Failed to upload $filename" >> $GITHUB_STEP_SUMMARY
-              echo "Imgur upload response for $filename: $response"
-            fi
-          fi
-        done
-        echo "</details>" >> $GITHUB_STEP_SUMMARY
+        path: build/run/*/crash-reports

build.gradle

@@ -2,13 +2,6 @@ buildscript {
 	dependencies {
 		classpath "org.kohsuke:github-api:1.330"
 	}
-	
-	configurations.classpath {
-		resolutionStrategy {
-			// v28.0-jre, used by fabric-loom 1.13.3, is vulnerable to CVE-2020-8908 and CVE-2023-2976
-			force "com.google.guava:guava:32.0.1-jre"
-		}
-	}
 }
 
 plugins {
@@ -33,24 +26,6 @@ repositories {
 	// for more information about repositories.
 }
 
-// Override vulnerable dependencies until Minecraft updates to newer versions
-configurations.all {
-	resolutionStrategy {
-		// v2.5.1, used by Minecraft 1.21.4 - 1.21.10, is vulnerable to CVE-2024-57699
-		force "net.minidev:json-smart:2.5.2"
-		// v2.13.4, used by Minecraft 1.21.4 - 1.21.10, is vulnerable to CVE-2025-52999
-		force "com.fasterxml.jackson.core:jackson-core:2.15.0"
-		// v3.17.0, used by Minecraft 1.21.4 - 1.21.10, is vulnerable to CVE-2025-48924
-		force "org.apache.commons:commons-lang3:3.18.0"
-		// v9.40, used by Minecraft 1.21.4 - 1.21.10, is vulnerable to CVE-2025-53864
-		force "com.nimbusds:nimbus-jose-jwt:10.0.2"
-		// v4.1.118.Final, used by Minecraft 1.21.5 - 1.21.10, is vulnerable to CVE-2025-58057
-		force "io.netty:netty-codec:4.1.125.Final"
-		// v4.1.118.Final, used by Minecraft 1.21.5 - 1.21.10, is vulnerable to CVE-2025-58056
-		force "io.netty:netty-codec-http:4.1.125.Final"
-	}
-}
-
 dependencies {
 	// To change the versions see the gradle.properties file
 	minecraft "com.mojang:minecraft:${project.minecraft_version}"
@@ -70,53 +45,16 @@ dependencies {
 	modImplementation "com.google.code.findbugs:jsr305:3.0.2"
 }
 
-loom {
-	accessWidenerPath = file("src/main/resources/wurst.accesswidener")
-}
-
-configurations {
-	productionRuntime {
-		extendsFrom configurations.minecraftLibraries
-		extendsFrom configurations.loaderLibraries
-		extendsFrom configurations.minecraftRuntimeLibraries
-	}
-}
-
-dependencies {
-	productionRuntime "net.fabricmc:fabric-loader:${project.loader_version}"
-	productionRuntime "net.fabricmc:intermediary:${project.minecraft_version}"
+fabricApi.configureTests {
+	createSourceSet = true
+	enableGameTests = false
+	enableClientGameTests = true
+	modId = "wurst_testmod"
+	username = "Wurst-Bot"
 }
 
-import net.fabricmc.loom.util.Platform
-tasks.register('runEndToEndTest', JavaExec) {
-	dependsOn remapJar, downloadAssets
-	classpath.from configurations.productionRuntime
-	mainClass = "net.fabricmc.loader.impl.launch.knot.KnotClient"
-	workingDir = file("run")
-	
-	doFirst {
-		classpath.from loom.minecraftProvider.minecraftClientJar
-		workingDir.mkdirs()
-		
-		args(
-			"--assetIndex", loom.minecraftProvider.versionInfo.assetIndex().fabricId(loom.minecraftProvider.minecraftVersion()),
-			"--assetsDir", new File(loom.files.userCache, "assets").absolutePath,
-			"--gameDir", workingDir.absolutePath
-		)
-		
-		if (Platform.CURRENT.operatingSystem.isMacOS()) {
-			jvmArgs("-XstartOnFirstThread")
-		}
-		
-		jvmArgs(
-			"-Dfabric.addMods=${configurations.modImplementation.find { it.name.contains('fabric-api') }.absolutePath}${File.pathSeparator}${remapJar.archiveFile.get().asFile.absolutePath}",
-			"-Dwurst.e2eTest",
-			"-Dfabric-tag-conventions-v2.missingTagTranslationWarning=fail",
-			"-Dfabric-tag-conventions-v1.legacyTagWarning=fail",
-			"-Dmixin.debug.verify=true",
-			"-Dmixin.debug.countInjections=true"
-		)
-	}
+loom {
+	accessWidenerPath = file("src/main/resources/wurst.accesswidener")
 }
 
 processResources {
@@ -164,13 +102,13 @@ spotless {
 		eclipse().configFile(file("codestyle/formatter.xml"))
 	}
 	format("licenseHeader") {
-		target("src/*/java/**/*.java", "src/test/java/**/*.java")
+		target("src/*/java/**/*.java")
 		def header_file = file("codestyle/license_header.txt")
 		def delimiter = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER
 		licenseHeaderFile(header_file, delimiter).updateYearWithLatest(true)
 	}
 	json {
-		target "src/**/*.json"
+		target("src/**/*.json", "src/**/*.mcmeta")
 		gson().indentWithSpaces(2).version("2.11.0")
 	}
 }