Merge branch 'client_gametest_api/1.21.8-neoforge' into 1.21.8-neoforge

Author: Alexander01998

.github/workflows/gradle.yml

@@ -104,51 +104,14 @@ jobs:
         done
         echo "</details>" >> $GITHUB_STEP_SUMMARY
 
-    - name: Run the mod and take screenshots
+    - name: Run client gametest
       uses: GabrielBB/[email protected]
       with:
-        run: ./gradlew runEndToEndTest --stacktrace --warning-mode=fail
+        run: ./gradlew runClientGameTest --stacktrace --warning-mode=fail
 
-    # Needed because the screenshot gallery won't be created on pull requests.
-    # Also useful if Imgur uploads fail.
     - name: Upload Test Screenshots.zip artifact
       uses: actions/upload-artifact@v4
       if: always()
       with:
         name: Test Screenshots
-        path: runs/client/screenshots
-
-    - name: Create test screenshot gallery
-      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 runs/client/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/clientGameTest/screenshots

build.gradle

@@ -59,12 +59,18 @@ tasks.named("build").configure {
 java.toolchain.languageVersion = JavaLanguageVersion.of(21)
 
 mixin {
-	config 'chestesp.mixins.json'
+	config "chestesp.mixins.json"
 }
 
 minecraft.accessTransformers.file rootProject.file('src/main/resources/META-INF/accesstransformer.cfg')
 //minecraft.accessTransformers.entry public net.minecraft.client.Minecraft textureManager # textureManager
 
+sourceSets {
+    gametest {
+        depends.on sourceSets.main
+    }
+}
+
 // Default run configurations.
 // These can be tweaked, removed, or duplicated as needed.
 runs {
@@ -109,6 +115,30 @@ runs {
 		// Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
 		arguments.addAll '--mod', project.mod_id, '--all', '--output', file('src/generated/resources/').getAbsolutePath(), '--existing', file('src/main/resources/').getAbsolutePath()
 	}
+
+	clientGameTest {
+		runType("client")
+		jvmArguments("-Dchestesp.e2eTest", "-Dmixin.debug.verify=true", "-Dmixin.debug.countInjections=true")
+		systemProperties("fabric.client.gametest.disableNetworkSynchronizer": "true")
+		arguments("--username", "Wurst-Bot")
+		workingDirectory(file("build/run/clientGameTest"))
+		modSource project.sourceSets.gametest
+		mixin {
+			config "fabric_api.mixins.json"
+			config "client_gametest.mixins.json"
+		}
+	}
+}
+
+tasks.withType(JavaExec).configureEach {
+	doFirst {
+		if (name == "runClientGameTest") {
+			def runDir = file("build/run/clientGameTest")
+			if(runDir.exists())
+				delete runDir
+			runDir.mkdirs()
+		}
+	}
 }
 
 // Include resources generated by data generators.
@@ -209,27 +239,6 @@ tasks.withType(ProcessResources).configureEach {
 	}
 }
 
-tasks.register('runEndToEndTest') {
-	group = 'NeoGradle/Runs'
-	description = 'Runs the game with end-to-end tests enabled'
-	dependsOn 'runClient'
-}
-
-// Modify runClient if it's running as a dependency of runEndToEndTest.
-// Since NeoGradle doesn't allow custom run types yet, this is the only way to
-// make runEndToEndTest work for now.
-tasks.withType(JavaExec).configureEach {
-	doFirst {
-		if (gradle.startParameter.taskNames.contains('runEndToEndTest')) {
-			jvmArgs += [
-				'-Dchestesp.e2eTest',
-				'-Dmixin.debug.verify=true',
-				'-Dmixin.debug.countInjections=true'
-			]
-		}
-	}
-}
-
 tasks.withType(JavaCompile).configureEach {
 	options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
 }
@@ -256,7 +265,7 @@ spotless {
 		eclipse().configFile(file("codestyle/formatter.xml"))
 	}
 	format("licenseHeader") {
-		target("src/*/java/**/*.java", "src/test/java/**/*.java")
+		target("src/main/java/**/*.java", "src/test/java/**/*.java", "src/gametest/java/net/wimods/**/*.java")
 		def header_file = file("codestyle/license_header.txt")
 		def delimiter = LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER
 		licenseHeaderFile(header_file, delimiter).updateYearWithLatest(true)

src/gametest/java/net/fabricmc/fabric/api/client/gametest/v1/FabricClientGameTest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.api.client.gametest.v1;
+
+import net.fabricmc.fabric.api.client.gametest.v1.context.ClientGameTestContext;
+
+/**
+ * The {@code fabric-client-gametest} entrypoint interface. See the package
+ * documentation.
+ */
+public interface FabricClientGameTest
+{
+	/**
+	 * Runs the gametest.
+	 */
+	void runTest(ClientGameTestContext context);
+}