Add Sodium compatibility test

Author: Alexander01998

.github/workflows/gradle.yml

@@ -90,7 +90,7 @@ jobs:
     - name: Run client gametests
       env:
         IMGUR_CLIENT_ID: ${{ secrets.IMGUR_CLIENT_ID }}
-      run: xvfb-run --auto-servernum ./gradlew runClientGameTest --stacktrace --warning-mode=fail
+      run: xvfb-run --auto-servernum ./gradlew runClientGameTest runClientGameTestWithMods --stacktrace --warning-mode=fail
 
     - name: Upload screenshots
       uses: actions/upload-artifact@v5

build.gradle

@@ -24,6 +24,17 @@ repositories {
 	// Loom adds the essential maven repositories to download Minecraft and libraries from automatically.
 	// See https://docs.gradle.org/current/userguide/declaring_repositories.html
 	// for more information about repositories.
+	exclusiveContent {
+		forRepository {
+			maven {
+				name = "Modrinth"
+				url = "https://api.modrinth.com/maven"
+			}
+		}
+		filter {
+			includeGroup "maven.modrinth"
+		}
+	}
 }
 
 dependencies {
@@ -55,6 +66,43 @@ fabricApi.configureTests {
 
 loom {
 	accessWidenerPath = file("src/main/resources/wurst.accesswidener")
+	
+	runs {
+		clientGameTestWithMods {
+			inherit client
+			source = sourceSets.gametest
+			runDir = "build/run/clientGameTestWithMods"
+			vmArgs.add("-Dfabric.client.gametest")
+			vmArgs.add("-Dwurst.test.withMods=true")
+			programArgs.add("--username=Wurst-Bot")
+		}
+	}
+}
+
+configurations {
+	testMods {
+		transitive = false
+	}
+}
+
+dependencies {
+	testMods "maven.modrinth:sodium:${project.sodium_version}"
+}
+
+def cleanClientGameTestWithMods = tasks.register("cleanClientGameTestWithMods", Delete) {
+	delete layout.buildDirectory.dir("run/clientGameTestWithMods")
+}
+
+def prepareClientGameTestWithMods = tasks.register("prepareClientGameTestWithMods", Sync) {
+	dependsOn cleanClientGameTestWithMods
+	from configurations.testMods
+	into layout.buildDirectory.dir("run/clientGameTestWithMods/mods")
+}
+
+def doModCompatTest = providers.gradleProperty("do_mod_compat_test").map { it.toBoolean() }.orElse(false)
+tasks.named("runClientGameTestWithMods") {
+	onlyIf { doModCompatTest.get() }
+	dependsOn prepareClientGameTestWithMods
 }
 
 processResources {

gradle.properties

@@ -25,3 +25,5 @@ gh_repo_id=Wurst-Imperium/Wurst7
 mcx_repo_id=Wurst-Imperium/Wurst-MCX2
 
 # Dependencies
+sodium_version=mc1.21.10-0.7.2-fabric
+do_mod_compat_test=true

src/gametest/java/net/wurstclient/gametest/WurstTest.java

@@ -36,6 +36,9 @@ public class WurstTest implements FabricClientGameTest
 {
 	public static final Logger LOGGER = LoggerFactory.getLogger("Wurst Test");
 
+	public static final boolean IS_MOD_COMPAT_TEST =
+		System.getProperty("wurst.test.withMods") != null;
+	
 	@Override
 	public void runTest(ClientGameTestContext context)
 	{
@@ -86,7 +89,8 @@ private void testInWorld(ClientGameTestContext context,
 		world.waitForChunksRender();
 
 		assertScreenshotEquals(context, "in_game",
-			"https://i.imgur.com/EfzN9Cd.png");
+			IS_MOD_COMPAT_TEST ? "https://i.imgur.com/VxbGFrb.png"
+				: "https://i.imgur.com/EfzN9Cd.png");
 
 		LOGGER.info("Recording debug menu");
 		input.pressKey(GLFW.GLFW_KEY_F3);

src/gametest/java/net/wurstclient/gametest/tests/FreecamHackTest.java

@@ -41,14 +41,16 @@ public static void testFreecamHack(ClientGameTestContext context,
 		input.holdKeyFor(GLFW.GLFW_KEY_S, 2);
 		input.holdKeyFor(GLFW.GLFW_KEY_SPACE, 1);
 		assertScreenshotEquals(context, "freecam_moved",
-			"https://i.imgur.com/pZDlYfH.png");
+			WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/oZUpI8c.png"
+				: "https://i.imgur.com/pZDlYfH.png");
 		clearChat(context);
 
 		// Enable tracer
 		runWurstCommand(context, "setcheckbox Freecam tracer on");
 		context.waitTick();
 		assertScreenshotEquals(context, "freecam_tracer",
-			"https://i.imgur.com/jYqDFzE.png");
+			WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/teKaxAK.png"
+				: "https://i.imgur.com/jYqDFzE.png");
 		clearChat(context);
 
 		// Clean up

src/gametest/java/net/wurstclient/gametest/tests/XRayHackTest.java

@@ -40,7 +40,8 @@ public static void testXRayHack(ClientGameTestContext context,
 		context.waitTick();
 		world.waitForChunksRender();
 		assertScreenshotEquals(context, "xray_default",
-			"https://i.imgur.com/Dftamqv.png");
+			WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/02KZHLm.png"
+				: "https://i.imgur.com/Dftamqv.png");
 		input.pressKey(GLFW.GLFW_KEY_X);
 		clearChat(context);
 
@@ -51,7 +52,8 @@ public static void testXRayHack(ClientGameTestContext context,
 		context.waitTick();
 		world.waitForChunksRender();
 		assertScreenshotEquals(context, "xray_exposed_only",
-			"https://i.imgur.com/QlEpQTu.png");
+			WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/xplrJwM.png"
+				: "https://i.imgur.com/QlEpQTu.png");
 		input.pressKey(GLFW.GLFW_KEY_X);
 		clearChat(context);
 
@@ -62,7 +64,8 @@ public static void testXRayHack(ClientGameTestContext context,
 		context.waitTick();
 		world.waitForChunksRender();
 		assertScreenshotEquals(context, "xray_opacity",
-			"https://i.imgur.com/0nLulJn.png");
+			WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/MFc821z.png"
+				: "https://i.imgur.com/0nLulJn.png");
 		input.pressKey(GLFW.GLFW_KEY_X);
 		clearChat(context);
 
@@ -73,7 +76,8 @@ public static void testXRayHack(ClientGameTestContext context,
 		context.waitTick();
 		world.waitForChunksRender();
 		assertScreenshotEquals(context, "xray_exposed_only_opacity",
-			"https://i.imgur.com/noPWDUl.png");
+			WurstTest.IS_MOD_COMPAT_TEST ? "https://i.imgur.com/GRHgW6P.png"
+				: "https://i.imgur.com/noPWDUl.png");
 		input.pressKey(GLFW.GLFW_KEY_X);
 		clearChat(context);