Backported changes from the CC: Tweaked Gametest framework present in the 1.20.x branch

This was mainly done to allow the execution of client tests

Author: dogboy21

src/testMod/java/dan200/computercraft/gametest/core/CCTestCommand.java

@@ -107,7 +107,7 @@ private static Path getWorldComputerPath(MinecraftServer server) {
     }
 
     private static Path getSourceComputerPath() {
-        return TestHooks.sourceDir.resolve("computer");
+        return TestHooks.getSourceDir().resolve("computer");
     }
 
     private static int error(CommandSourceStack source, String message) {

src/testMod/java/dan200/computercraft/gametest/core/ClientHooks.java

@@ -0,0 +1,15 @@
+/*
+ * This file is part of ComputerCraft - http://www.computercraft.info
+ * Copyright Daniel Ratcliffe, 2011-2022. Do not distribute without permission.
+ * Send enquiries to dratcliffe@gmail.com
+ */
+package dan200.computercraft.gametest.core;
+
+import net.minecraft.client.Minecraft;
+
+/**
+ * Extensions to {@link Minecraft}, injected via mixin.
+ */
+public interface MinecraftExtensions {
+    boolean computercraft$isRenderingStable();
+}

src/testMod/java/dan200/computercraft/gametest/core/MinecraftExtensions.java

@@ -16,7 +16,10 @@
 import de.srendi.advancedperipherals.common.util.LuaConverter;
 import net.minecraft.gametest.framework.GameTestSequence;
 import net.minecraftforge.server.ServerLifecycleHooks;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+import javax.annotation.Nullable;
 import java.util.Optional;
 
 /**
@@ -27,8 +30,10 @@
  * @see TestExtensionsKt#thenComputerOk(GameTestSequence, String, String)   To check tests on the computer have passed.
  */
 public class TestAPI extends ComputerState implements ILuaAPI {
+    private static final Logger LOG = LoggerFactory.getLogger(TestAPI.class);
+
     private final IComputerSystem system;
-    private String label;
+    private @Nullable String label;
 
     TestAPI(IComputerSystem system) {
         this.system = system;
@@ -39,30 +44,29 @@ public void startup() {
         if (label == null) label = system.getLabel();
         if (label == null) {
             label = "#" + system.getID();
-            ComputerCraft.log.warn("Computer {} has no label", label);
+            LOG.warn("Computer {} has no label", label);
         }
 
-        ComputerCraft.log.info("Computer '{}' has turned on.", label);
+        LOG.info("Computer '{}' has turned on.", label);
         markers.clear();
         error = null;
         lookup.put(label, this);
     }
 
     @Override
     public void shutdown() {
-        ComputerCraft.log.info("Computer '{}' has shut down.", label);
-        if (lookup.get(label) == this)
-            lookup.remove(label);
+        LOG.info("Computer '{}' has shut down.", label);
+        if (lookup.get(label) == this) lookup.remove(label);
     }
 
     @Override
     public String[] getNames() {
-        return new String[]{"test"};
+        return new String[]{ "test" };
     }
 
     @LuaFunction
     public final void fail(String message) throws LuaException {
-        ComputerCraft.log.error("Computer '{}' failed with {}", label, message);
+        LOG.error("Computer '{}' failed with {}", label, message);
         if (markers.contains(ComputerState.DONE)) throw new LuaException("Cannot call fail/ok multiple times.");
         markers.add(ComputerState.DONE);
         error = message;
@@ -71,7 +75,7 @@ public final void fail(String message) throws LuaException {
 
     @LuaFunction
     public final void ok(Optional<String> marker) throws LuaException {
-        String actualMarker = marker.orElse(ComputerState.DONE);
+        var actualMarker = marker.orElse(ComputerState.DONE);
         if (markers.contains(ComputerState.DONE) || markers.contains(actualMarker)) {
             throw new LuaException("Cannot call fail/ok multiple times.");
         }
@@ -81,7 +85,7 @@ public final void ok(Optional<String> marker) throws LuaException {
 
     @LuaFunction
     public final void log(String message) {
-        ComputerCraft.log.info("[Computer '{}'] {}", label, message);
+        LOG.info("[Computer '{}'] {}", label, message);
     }
 
     @LuaFunction

src/testMod/java/dan200/computercraft/gametest/core/TestAPI.java

@@ -7,17 +7,16 @@
 
 import dan200.computercraft.export.Exporter;
 import dan200.computercraft.gametest.api.GameTestHolder;
-import net.minecraft.gametest.framework.GameTest;
-import net.minecraft.gametest.framework.GameTestRegistry;
-import net.minecraft.gametest.framework.StructureUtils;
-import net.minecraft.gametest.framework.TestFunction;
-import net.minecraft.resources.ResourceLocation;
+import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.client.event.RegisterClientCommandsEvent;
+import net.minecraftforge.client.event.ScreenEvent;
 import net.minecraftforge.common.MinecraftForge;
 import net.minecraftforge.event.RegisterCommandsEvent;
 import net.minecraftforge.event.RegisterGameTestsEvent;
+import net.minecraftforge.event.TickEvent;
 import net.minecraftforge.event.server.ServerStartedEvent;
 import net.minecraftforge.eventbus.api.EventPriority;
+import net.minecraftforge.fml.DistExecutor;
 import net.minecraftforge.fml.ModList;
 import net.minecraftforge.fml.common.Mod;
 import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
@@ -43,7 +42,7 @@ public TestMod() {
         var bus = MinecraftForge.EVENT_BUS;
         bus.addListener(EventPriority.LOW, (ServerStartedEvent e) -> TestHooks.onServerStarted(e.getServer()));
         bus.addListener((RegisterCommandsEvent e) -> CCTestCommand.register(e.getDispatcher()));
-        bus.addListener((RegisterClientCommandsEvent e) -> Exporter.register(e.getDispatcher()));
+        DistExecutor.unsafeRunWhenOn(Dist.CLIENT, () -> TestMod::onInitializeClient);
 
         var modBus = FMLJavaModLoadingContext.get().getModEventBus();
         modBus.addListener((RegisterGameTestsEvent event) -> {
@@ -56,6 +55,17 @@ public TestMod() {
         });
     }
 
+    private static void onInitializeClient() {
+        var bus = MinecraftForge.EVENT_BUS;
+
+        bus.addListener((TickEvent.ServerTickEvent e) -> {
+            if (e.phase == TickEvent.Phase.START) ClientTestHooks.onServerTick(e.getServer());
+        });
+        bus.addListener((ScreenEvent.Opening e) -> {
+            if (ClientTestHooks.onOpenScreen(e.getScreen())) e.setCanceled(true);
+        });
+        bus.addListener((RegisterClientCommandsEvent e) -> Exporter.register(e.getDispatcher()));
+    }
 
     private static Class<?> loadClass(String name) {
         try {
@@ -68,60 +78,7 @@ private static Class<?> loadClass(String name) {
     private static void registerClass(String className, Consumer<Method> fallback) {
         var klass = loadClass(className);
         for (var method : klass.getDeclaredMethods()) {
-            var testInfo = method.getAnnotation(GameTest.class);
-            if (testInfo == null) {
-                fallback.accept(method);
-                continue;
-            }
-
-            GameTestRegistry.getAllTestFunctions().add(turnMethodIntoTestFunction(method, testInfo));
-            GameTestRegistry.getAllTestClassNames().add(className);
+            TestHooks.registerTest(klass, method, fallback);
         }
     }
-
-    /**
-     * Custom implementation of {@link GameTestRegistry#turnMethodIntoTestFunction(Method)} which makes
-     * {@link GameTest#template()} behave the same as Fabric, namely in that it points to a {@link ResourceLocation},
-     * rather than a test-class-specific structure.
-     * <p>
-     * This effectively acts as a global version of {@link PrefixGameTestTemplate}, just one which doesn't require Forge
-     * to be present.
-     *
-     * @param method   The method to register.
-     * @param testInfo The test info.
-     * @return The constructed test function.
-     */
-    private static TestFunction turnMethodIntoTestFunction(Method method, GameTest testInfo) {
-        var className = method.getDeclaringClass().getSimpleName().toLowerCase(Locale.ROOT);
-        var testName = className + "." + method.getName().toLowerCase(Locale.ROOT);
-        return new TestFunction(
-                testInfo.batch(),
-                testName,
-                testInfo.template().isEmpty() ? testName : testInfo.template(),
-                StructureUtils.getRotationForRotationSteps(testInfo.rotationSteps()), testInfo.timeoutTicks(), testInfo.setupTicks(),
-                testInfo.required(), testInfo.requiredSuccesses(), testInfo.attempts(),
-                turnMethodIntoConsumer(method)
-        );
-    }
-
-    private static <T> Consumer<T> turnMethodIntoConsumer(Method method) {
-        return value -> {
-            try {
-                Object instance = null;
-                if (!Modifier.isStatic(method.getModifiers())) {
-                    instance = method.getDeclaringClass().getConstructor().newInstance();
-                }
-
-                method.invoke(instance, value);
-            } catch (InvocationTargetException e) {
-                if (e.getCause() instanceof RuntimeException) {
-                    throw (RuntimeException) e.getCause();
-                } else {
-                    throw new RuntimeException(e.getCause());
-                }
-            } catch (ReflectiveOperationException e) {
-                throw new RuntimeException(e);
-            }
-        };
-    }
 }

src/testMod/java/dan200/computercraft/gametest/core/TestHooks.java

@@ -37,7 +37,7 @@ public void tickAndContinue(long ticks) {
             parent.fail(e);
         } catch (Exception e) {
             // Fail the test, rather than crashing the server.
-            TestHooks.LOGGER.error("{} threw unexpected exception", parent.getTestName(), e);
+            TestHooks.LOG.error("{} threw unexpected exception", parent.getTestName(), e);
             parent.fail(e);
         }
     }

src/testMod/java/dan200/computercraft/gametest/core/TestMod.java

@@ -0,0 +1,19 @@
+package dan200.computercraft.mixin.gametest.client;
+
+import net.minecraft.world.level.storage.LevelSummary;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Overwrite;
+
+/**
+ * Used to suppress the "Worlds using Experimental Settings are not supported" warning
+ * when loading a world in GameTest.
+ */
+@Mixin(LevelSummary.class)
+public class LevelSummaryMixin {
+
+    @Overwrite
+    public boolean isExperimental() {
+        return false;
+    }
+
+}