improvement: Add tests for packet roundtrips (#16)

Author: ConnorLinfoot

pom.xml

@@ -49,7 +49,13 @@
  <dependency>
  <groupId>org.junit.jupiter</groupId>
  <artifactId>junit-jupiter-engine</artifactId>
- <version>5.9.2</version>
+ <version>5.9.3</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.junit.jupiter</groupId>
+ <artifactId>junit-jupiter-params</artifactId>
+ <version>5.9.3</version>
  <scope>test</scope>
  </dependency>
  </dependencies>

src/main/java/net/hypixel/modapi/packet/PacketRegistry.java

@@ -2,6 +2,7 @@
 
 import net.hypixel.modapi.serializer.PacketSerializer;
 
+import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
 import java.util.Set;
@@ -38,6 +39,10 @@ private Registration getRegistration(String identifier) {
  return registration;
  }
 
+ Collection<Registration> getRegistrations() {
+ return registrations.values();
+ }
+
  public boolean isRegistered(String identifier) {
  return registrations.containsKey(identifier);
  }
@@ -92,7 +97,7 @@ public void register() {
 
  }
 
- private static final class Registration {
+ static final class Registration {
 
  private final Class<? extends ClientboundHypixelPacket> clientboundClazz;
  private final Function<PacketSerializer, ? extends ClientboundHypixelPacket> clientPacketFactory;
@@ -107,13 +112,19 @@ public Registration(Class<? extends ClientboundHypixelPacket> clientboundClazz,
  this.serverPacketFactory = serverPacketFactory;
  }
 
+ Class<? extends ClientboundHypixelPacket> getClientboundClazz() {
+ return clientboundClazz;
+ }
+
+ Class<? extends HypixelPacket> getServerboundClazz() {
+ return serverboundClazz;
+ }
+
  @Override
  public String toString() {
  return "Registration{" +
  "clientboundClazz=" + clientboundClazz +
- ", clientPacketFactory=" + clientPacketFactory +
  ", serverboundClazz=" + serverboundClazz +
- ", serverPacketFactory=" + serverPacketFactory +
  '}';
  }
  }

src/test/java/net/hypixe/modapi/TestPacketIdentifierLength.java renamed to src/test/java/net/hypixel/modapi/TestPacketIdentifierLength.java

@@ -1,6 +1,5 @@
-package net.hypixe.modapi;
+package net.hypixel.modapi;
 
-import net.hypixel.modapi.HypixelModAPI;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 

src/test/java/net/hypixel/modapi/packet/PacketHandler.java

@@ -0,0 +1,10 @@
+package net.hypixel.modapi.packet;
+
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.packet.HypixelPacket;
+
+public interface PacketHandler<T extends HypixelPacket> {
+
+ ClientboundHypixelPacket handle(String identifier, T packet);
+
+}

src/test/java/net/hypixel/modapi/packet/ServerboundPacketHandler.java

@@ -0,0 +1,38 @@
+package net.hypixel.modapi.packet;
+
+import net.hypixel.modapi.packet.handler.LocationHandler;
+import net.hypixel.modapi.packet.handler.PartyInfoHandler;
+import net.hypixel.modapi.packet.handler.PingHandler;
+import net.hypixel.modapi.packet.handler.PlayerInfoHandler;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundLocationPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundPartyInfoPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundPingPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundPlayerInfoPacket;
+
+import java.util.HashMap;
+import java.util.Map;
+
+class ServerboundPacketHandler {
+ private final Map<Class<? extends HypixelPacket>, PacketHandler> packetHandlers = new HashMap<>();
+
+ ServerboundPacketHandler() {
+ register(ServerboundPingPacket.class, new PingHandler());
+ register(ServerboundLocationPacket.class, new LocationHandler());
+ register(ServerboundPartyInfoPacket.class, new PartyInfoHandler());
+ register(ServerboundPlayerInfoPacket.class, new PlayerInfoHandler());
+ }
+
+ private <T extends HypixelPacket> void register(Class<T> packetClass, PacketHandler<T> handler) {
+ packetHandlers.put(packetClass, handler);
+ }
+
+ public ClientboundHypixelPacket handle(String identifier, HypixelPacket packet) {
+ PacketHandler handler = packetHandlers.get(packet.getClass());
+ if (handler == null) {
+ return null;
+ }
+
+ return handler.handle(identifier, packet);
+ }
+
+}

src/test/java/net/hypixel/modapi/packet/TestPacketRoundtrip.java

@@ -0,0 +1,47 @@
+package net.hypixel.modapi.packet;
+
+import io.netty.buffer.Unpooled;
+import net.hypixel.modapi.HypixelModAPI;
+import net.hypixel.modapi.serializer.PacketSerializer;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.lang.reflect.InvocationTargetException;
+import java.util.stream.Stream;
+
+public class TestPacketRoundtrip {
+ private static final ServerboundPacketHandler HANDLER = new ServerboundPacketHandler();
+
+ private static ClientboundHypixelPacket handleServerbound(String identifier, PacketSerializer serializer) {
+ HypixelPacket packet = HypixelModAPI.getInstance().getRegistry().createServerboundPacket(identifier, serializer);
+ if (packet == null) {
+ throw new IllegalArgumentException("Unknown packet identifier: " + identifier);
+ }
+
+ return HANDLER.handle(identifier, packet);
+ }
+
+ private static ClientboundHypixelPacket doPacketRoundtrip(HypixelPacket packet) {
+ PacketSerializer serializer = new PacketSerializer(Unpooled.buffer());
+ packet.write(serializer);
+ return handleServerbound(packet.getIdentifier(), serializer);
+ }
+
+ private static Stream<Arguments> packetProvider() {
+ return HypixelModAPI.getInstance().getRegistry().getRegistrations().stream()
+ .filter(registration -> registration.getServerboundClazz() != null)
+ .map(Arguments::of);
+ }
+
+ @ParameterizedTest
+ @MethodSource("packetProvider")
+ void testPacketRoundtrip(PacketRegistry.Registration registration) throws NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {
+ HypixelPacket serverbound = registration.getServerboundClazz().getConstructor().newInstance();
+ ClientboundHypixelPacket response = doPacketRoundtrip(serverbound);
+ Assertions.assertNotNull(response, "No response for packet " + registration.getServerboundClazz().getSimpleName());
+ Assertions.assertEquals(registration.getClientboundClazz(), response.getClass(), "Unexpected response for packet " + registration.getServerboundClazz().getSimpleName());
+ }
+
+}

src/test/java/net/hypixel/modapi/packet/handler/LocationHandler.java

@@ -0,0 +1,23 @@
+package net.hypixel.modapi.packet.handler;
+
+import net.hypixel.data.region.Environment;
+import net.hypixel.data.type.GameType;
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.packet.PacketHandler;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundLocationPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundLocationPacket;
+
+public class LocationHandler implements PacketHandler<ServerboundLocationPacket> {
+ @Override
+ public ClientboundHypixelPacket handle(String identifier, ServerboundLocationPacket packet) {
+ return new ClientboundLocationPacket(
+ Environment.TEST,
+ "chi-hp-bungee1",
+ "mini1A",
+ GameType.HOUSING,
+ null,
+ null,
+ null
+ );
+ }
+}

src/test/java/net/hypixel/modapi/packet/handler/PartyInfoHandler.java

@@ -0,0 +1,19 @@
+package net.hypixel.modapi.packet.handler;
+
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.packet.PacketHandler;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPartyInfoPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundPartyInfoPacket;
+
+import java.util.Collections;
+
+public class PartyInfoHandler implements PacketHandler<ServerboundPartyInfoPacket> {
+ @Override
+ public ClientboundHypixelPacket handle(String identifier, ServerboundPartyInfoPacket packet) {
+ return new ClientboundPartyInfoPacket(
+ false,
+ null,
+ Collections.emptySet()
+ );
+ }
+}

src/test/java/net/hypixel/modapi/packet/handler/PingHandler.java

@@ -0,0 +1,13 @@
+package net.hypixel.modapi.packet.handler;
+
+import net.hypixel.modapi.packet.PacketHandler;
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPingPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundPingPacket;
+
+public class PingHandler implements PacketHandler<ServerboundPingPacket> {
+ @Override
+ public ClientboundHypixelPacket handle(String identifier, ServerboundPingPacket packet) {
+ return new ClientboundPingPacket("pong");
+ }
+}

src/test/java/net/hypixel/modapi/packet/handler/PlayerInfoHandler.java

@@ -0,0 +1,21 @@
+package net.hypixel.modapi.packet.handler;
+
+import net.hypixel.data.rank.MonthlyPackageRank;
+import net.hypixel.data.rank.PackageRank;
+import net.hypixel.data.rank.PlayerRank;
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.packet.PacketHandler;
+import net.hypixel.modapi.packet.impl.clientbound.ClientboundPlayerInfoPacket;
+import net.hypixel.modapi.packet.impl.serverbound.ServerboundPlayerInfoPacket;
+
+public class PlayerInfoHandler implements PacketHandler<ServerboundPlayerInfoPacket> {
+ @Override
+ public ClientboundHypixelPacket handle(String identifier, ServerboundPlayerInfoPacket packet) {
+ return new ClientboundPlayerInfoPacket(
+ PlayerRank.NORMAL,
+ PackageRank.MVP_PLUS,
+ MonthlyPackageRank.SUPERSTAR,
+ null
+ );
+ }
+}