Integrate Docker with JUnit for test execution

Szelagi · Szelagi · commit 7abb16f27c79 · 2025-06-11T15:27:41.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -200,5 +200,4 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
-
 </project>
diff --git a/src/main/java/pl/szelagi/SessionAPI.java b/src/main/java/pl/szelagi/SessionAPI.java
@@ -16,6 +16,7 @@
 import pl.szelagi.manager.SessionManager;
 import pl.szelagi.manager.VersionManager;
 import pl.szelagi.recovery.RecoveryManager;
+import pl.szelagi.test.Tests;
 import pl.szelagi.util.Debug;
 import pl.szelagi.world.SessionWorldManager;
 
@@ -63,6 +64,8 @@ public void onEnable() {
         RecoveryManager.initialize(this);
         SessionWorldManager.initialize(this);
         Command.registerCommands();
+
+        Tests.loadAll();
     }
 
     @Override
diff --git a/src/main/java/pl/szelagi/command/Command.java b/src/main/java/pl/szelagi/command/Command.java
@@ -20,6 +20,7 @@
 import pl.szelagi.command.manage.LeaveSessionCommand;
 import pl.szelagi.command.manage.PlayerSessionCommand;
 import pl.szelagi.command.manage.StopSessionCommand;
+import pl.szelagi.command.test.IntegrationTestCommand;
 
 
 public class Command {
@@ -108,5 +109,11 @@ public static void registerCommands() {
         assert selfTest != null;
         var selfTestResolver = new SelfTestCommand();
         selfTest.setExecutor(selfTestResolver);
+
+        // session-integration-test
+        var integrationTest = sapi.getCommand("session-integration-test");
+        assert integrationTest != null;
+        var integrationTestResolver = new IntegrationTestCommand();
+        integrationTest.setExecutor(integrationTestResolver);
     }
 }
diff --git a/src/main/java/pl/szelagi/command/test/IntegrationTestCommand.java b/src/main/java/pl/szelagi/command/test/IntegrationTestCommand.java
@@ -0,0 +1,80 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+package pl.szelagi.command.test;
+
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandExecutor;
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+import pl.szelagi.buildin.creator.Creator;
+import pl.szelagi.buildin.creator.CreatorBoard;
+import pl.szelagi.component.board.Board;
+import pl.szelagi.manager.SessionManager;
+import pl.szelagi.spatial.ISpatial;
+import pl.szelagi.tag.TagAnalyzer;
+import pl.szelagi.test.Test;
+
+import java.util.*;
+import java.util.stream.Collectors;
+
+import static pl.szelagi.command.CommandHelper.PREFIX;
+
+public class IntegrationTestCommand implements CommandExecutor {
+    public static final String SUCCESS = "OK";
+    private static final Map<String, Test> TESTS = new HashMap<>();
+
+    public static void register(String name, Test test) {
+        if (TESTS.containsKey(name))
+            throw new IllegalArgumentException("Test already registered." + name);
+        TESTS.put(name, test);
+    }
+
+    private void sendError(CommandSender sender, String message) {
+        if (message.equals(SUCCESS)) {
+            throw new IllegalArgumentException("Success cannot be an error.");
+        }
+        sender.sendMessage(message);
+    }
+
+    private void sendSuccess(CommandSender sender) {
+        sender.sendMessage(SUCCESS);
+    }
+
+    @Override
+    public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] strings) {
+        if (strings.length == 0) {
+            sendError(commandSender, "Test name not provided.");
+            return true;
+        }
+
+        var testName = strings[0];
+        var args = Arrays.copyOfRange(strings, 1, strings.length);
+
+        var test = TESTS.get(testName);
+        if (test == null) {
+            sendError(commandSender, "Unknown test.");
+            return true;
+        }
+
+        try {
+            test.execute(args);
+            sendSuccess(commandSender);
+        } catch (Exception e) {
+            var stackTrace = Arrays.stream(e.getStackTrace())
+                    .map(StackTraceElement::toString)
+                    .collect(Collectors.joining("\n"));
+
+            var errorMessage = e.getClass().getName() + ": " + e.getMessage() + "\n" + stackTrace;
+
+            sendError(commandSender, errorMessage);
+        }
+
+        return true;
+    }
+}
diff --git a/src/main/java/pl/szelagi/test/Test.java b/src/main/java/pl/szelagi/test/Test.java
@@ -0,0 +1,12 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+package pl.szelagi.test;
+
+public abstract class Test {
+    public abstract void execute(String[] args) throws Exception;
+}
diff --git a/src/main/java/pl/szelagi/test/Tests.java b/src/main/java/pl/szelagi/test/Tests.java
@@ -0,0 +1,19 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+package pl.szelagi.test;
+
+import pl.szelagi.command.test.IntegrationTestCommand;
+import pl.szelagi.test.sample.SampleTest;
+
+public abstract class Tests {
+    public static final String SAMPLE_TEST_NAME = "sample-test";
+
+    public static void loadAll() {
+        IntegrationTestCommand.register(SAMPLE_TEST_NAME, new SampleTest());
+    }
+}
diff --git a/src/main/java/pl/szelagi/test/sample/SampleBoard.java b/src/main/java/pl/szelagi/test/sample/SampleBoard.java
@@ -0,0 +1,25 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+package pl.szelagi.test.sample;
+
+import org.jetbrains.annotations.NotNull;
+import pl.szelagi.component.board.Board;
+import pl.szelagi.component.session.Session;
+import pl.szelagi.spatial.ISpatial;
+import pl.szelagi.spatial.Spatial;
+
+public class SampleBoard extends Board {
+    public SampleBoard(@NotNull Session session) {
+        super(session);
+    }
+
+    @Override
+    public ISpatial defineSecureZone() {
+        return new Spatial(space().getFirstPoint(), space().getSecondPoint());
+    }
+}
diff --git a/src/main/java/pl/szelagi/test/sample/SampleSession.java b/src/main/java/pl/szelagi/test/sample/SampleSession.java
@@ -0,0 +1,24 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+package pl.szelagi.test.sample;
+
+import org.bukkit.plugin.java.JavaPlugin;
+import org.jetbrains.annotations.NotNull;
+import pl.szelagi.component.board.Board;
+import pl.szelagi.component.session.Session;
+
+public class SampleSession extends Session {
+    public SampleSession(JavaPlugin plugin) {
+        super(plugin);
+    }
+
+    @Override
+    protected @NotNull Board defaultBoard() {
+        return new SampleBoard(this);
+    }
+}
diff --git a/src/main/java/pl/szelagi/test/sample/SampleTest.java b/src/main/java/pl/szelagi/test/sample/SampleTest.java
@@ -0,0 +1,22 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+package pl.szelagi.test.sample;
+
+import pl.szelagi.SessionAPI;
+import pl.szelagi.test.Test;
+
+public class SampleTest extends Test {
+
+    @Override
+    public void execute(String[] args) throws Exception {
+        var session = new SampleSession(SessionAPI.instance());
+        session.start();
+        session.stop();
+    }
+
+}
diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml
@@ -63,6 +63,11 @@ commands:
     description: "Checks if SessionAPI is working correctly."
     permission: "sessionapi.debug"
 
+  session-integration-test:
+    description: "Command for running integration tests."
+    permission: "sessionapi.test"
+
+
 
 permissions:
   # Board editor permissions
@@ -102,4 +107,8 @@ permissions:
   # Session debug permissions
   sessionapi.debug:
     description: "Allows the user to start test sessions and toggle debug messages."
+    default: op
+
+  sessionapi.test:
+    description: "Allows use of the integration test command"
     default: op
diff --git a/src/test/java/IntegrationTestFailed.java b/src/test/java/IntegrationTestFailed.java
@@ -0,0 +1,12 @@
+/*
+ * SessionAPI - A framework for game containerization on Minecraft servers
+ * Copyright (C) 2025 Szelagi (https://github.com/Szelagi/SessionAPI)
+ * Licensed under the GNU General Public License v3.0.
+ * For more details, visit <https://www.gnu.org/licenses/>.
+ */
+
+public class IntegrationTestFailed extends RuntimeException {
+    public IntegrationTestFailed(String message) {
+        super(message);
+    }
+}
diff --git a/src/test/java/MainTest.java b/src/test/java/MainTest.java
@@ -5,7 +5,10 @@
  * For more details, visit <https://www.gnu.org/licenses/>.
  */
 
+import com.github.dockerjava.api.model.HostConfig;
 import com.github.t9t.minecraftrconclient.RconClient;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -14,6 +17,8 @@
 import org.testcontainers.shaded.com.trilead.ssh2.log.Logger;
 import org.testcontainers.shaded.org.awaitility.Awaitility;
 import org.testcontainers.utility.MountableFile;
+import pl.szelagi.command.test.IntegrationTestCommand;
+import pl.szelagi.test.Tests;
 
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -22,6 +27,7 @@
 import java.nio.file.Paths;
 import java.security.SecureRandom;
 import java.time.Duration;
+import java.util.List;
 import java.util.Objects;
 
 public class MainTest {
@@ -61,34 +67,48 @@ private static Path fawePath() throws URISyntaxException {
         return plugin;
     }
 
+    private static Path worldPath() throws URISyntaxException {
+        var plugin = Paths.get(
+                Objects.requireNonNull(MainTest.class.getClassLoader().getResource("world.zip")).toURI()
+        );
+        if (!Files.exists(plugin)) {
+            throw new RuntimeException("Could not find world.zip");
+        }
+        return plugin;
+    }
+
 
     @BeforeAll
     public static void setup() throws IOException, InterruptedException, URISyntaxException {
         rconPassword = generatePassword(16);
 
         var sapiPath = sapiPath();
         var fawePath = fawePath();
+        var worldPath = worldPath();
 
         server = new GenericContainer<>("itzg/minecraft-server")
+                .withCreateContainerCmdModifier(cmd -> cmd.withName("sessionapi-test"))
                 .withEnv("EULA", "TRUE")
                 .withEnv("TYPE", "PAPER")
                 .withEnv("VERSION", "1.21.1")
                 .withEnv("ENABLE_RCON", "true")
                 .withEnv("RCON_PASSWORD", rconPassword)
                 .withEnv("RCON_PORT", "25575")
+                .withEnv("LEVEL_TYPE", "FLAT")
                 .withExposedPorts(25565, 25575)
                 .withCopyFileToContainer(MountableFile.forHostPath(sapiPath.toString()), "/plugins/sapi.jar")
                 .withCopyFileToContainer(MountableFile.forHostPath(fawePath.toString()), "/plugins/fawe.jar")
-                .withCreateContainerCmdModifier(cmd -> cmd.withName("sessionapi-test"))
+                .withCopyFileToContainer(MountableFile.forHostPath(worldPath.toString()), "/world.zip")
+                .withCommand("unzip -o /world.zip -d /world")
                 .waitingFor(org.testcontainers.containers.wait.strategy.Wait.forListeningPort());
 
         System.out.println("Starting the container...");
         server.start();
         System.out.println("Waiting for the server to fully start...");
 
         Awaitility.await()
-                .atMost(Duration.ofMinutes(2))
-                .pollInterval(Duration.ofSeconds(2))
+                .atMost(Duration.ofMinutes(1))
+                .pollInterval(Duration.ofMillis(500))
                 .until(() -> {
                     String logs = server.getLogs();
                     return logs.contains("Done (");
@@ -121,7 +141,17 @@ public void hasPlugins() {
 
     @Test
     public void sample() {
-        System.out.println("OK");
+        internalTest(Tests.SAMPLE_TEST_NAME, null);
+    }
+
+    private void internalTest(@NotNull String name, @Nullable List<String> args) throws IntegrationTestFailed {
+        var query = "session-integration-test " + name + (args == null || args.isEmpty() ? "" : String.join(" ", args));
+        var response = rcon.sendCommand(query);
+        if (!response.contains(IntegrationTestCommand.SUCCESS)) {
+            throw new IntegrationTestFailed(response);
+        } else {
+            System.out.println("Successfully executed: " + name);
+        }
     }
 
 }
diff --git a/src/test/resources/junit-platform.properties b/src/test/resources/junit-platform.properties
@@ -4,7 +4,3 @@
 # Licensed under the GNU General Public License v3.0.
 # For more details, visit <https://www.gnu.org/licenses/>.
 #
-
-junit.jupiter.execution.parallel.enabled=true
-junit.jupiter.execution.parallel.mode.default=concurrent
-junit.jupiter.execution.parallel.mode.classes.default=concurrent
