Merge pull request #8 from OneLiteFeatherNET/feature/connectionUpdate

Improve useability of the TestConnection

Author: theEvilReaper

build.gradle.kts

@@ -2,11 +2,10 @@ plugins {
     java
     `java-library`
     `maven-publish`
-    jacoco
 }
 
 group = "net.onelitefeather"
-version = "0.1.1"
+version = "0.2.0"
 
 java {
     toolchain {
@@ -25,20 +24,6 @@ tasks {
         options.encoding = "UTF-8"
         options.release.set(21)
     }
-
-    compileTestJava {
-        options.encoding = "UTF-8"
-        options.release.set(21)
-    }
-
-    test {
-        finalizedBy(jacocoTestReport)
-        useJUnitPlatform()
-        jvmArgs("-Dminestom.inside-test=true")
-        testLogging {
-            events("passed", "skipped", "failed")
-        }
-    }
 }
 
 publishing {

src/main/java/net/minestom/testing/EnvImpl.java

@@ -22,7 +22,7 @@ public EnvImpl(ServerProcess process) {
 
         // Use player provider to disable queued chunk sending.
         // Set here to allow an individual test to override if they want.
-        process.connection().setPlayerProvider(TestConnectionImpl.TestPlayerImpl::new);
+        process.connection().setPlayerProvider(TestPlayerImpl::new);
     }
 
     @Override

src/main/java/net/minestom/testing/TestConnection.java

@@ -6,11 +6,48 @@
 import net.minestom.server.network.packet.server.ServerPacket;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * The {@link TestConnection} represents a connection from a player to a test server instance.
+ * It provides methods to connect a player to an instance and track incoming packets.
+ *
+ * @version 1.0.0
+ * @since 0.1.0
+ */
 public interface TestConnection {
+
+    /**
+     * Connects a player to the given instance at the specified position.
+     *
+     * @param instance the instance to connect to
+     * @param pos      the position to connect at
+     * @return the connected player
+     */
     @NotNull Player connect(@NotNull Instance instance, @NotNull Pos pos);
 
+    /**
+     * Connects a player to the given instance at the default position (0, 0, 0).
+     *
+     * @param instance the instance to connect to
+     * @return the connected player
+     */
+    default @NotNull Player connect(@NotNull Instance instance) {
+        return connect(instance, Pos.ZERO);
+    }
+
+    /**
+     * Tracks incoming packets of the specified type.
+     *
+     * @param type the class of the packet type to track
+     * @param <T>  the type of the packet
+     * @return a collector for the specified packet type
+     */
     <T extends ServerPacket> @NotNull Collector<T> trackIncoming(@NotNull Class<T> type);
 
+    /**
+     * Tracks incoming packets of the default type {@link ServerPacket}.
+     *
+     * @return a collector for the default packet type
+     */
     default @NotNull Collector<ServerPacket> trackIncoming() {
         return trackIncoming(ServerPacket.class);
     }

src/main/java/net/minestom/testing/TestConnectionImpl.java

@@ -6,7 +6,6 @@
 import net.minestom.server.coordinate.Pos;
 import net.minestom.server.entity.Player;
 import net.minestom.server.event.player.AsyncPlayerConfigurationEvent;
-import net.minestom.server.instance.Chunk;
 import net.minestom.server.instance.Instance;
 import net.minestom.server.network.ConnectionState;
 import net.minestom.server.network.packet.server.SendablePacket;
@@ -130,16 +129,4 @@ public IncomingCollector(Class<T> type) {
             return List.copyOf(packets);
         }
     }
-
-    static final class TestPlayerImpl extends Player {
-        public TestPlayerImpl(@NotNull PlayerConnection playerConnection, @NotNull GameProfile gameProfile) {
-            super(playerConnection, gameProfile);
-        }
-
-        @Override
-        public void sendChunk(@NotNull Chunk chunk) {
-            // Send immediately
-            sendPacket(chunk.getFullDataPacket());
-        }
-    }
 }