From 00abbb4acdc4f888995e530d63bfb6b6bca7a37e Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 20 Jun 2021 17:15:10 +0200 Subject: [PATCH 1/8] Add InPacket interface and ByteBuf implementation Replacement for LittleEndianAccessor, SeekableLittleEndianAccessor, GenericLittleEndianAccessor, and GenericSeekableLittleEndianAccessor. --- pom.xml | 5 ++ src/main/java/net/packet/ByteBufInPacket.java | 79 +++++++++++++++++++ .../java/net/packet/ByteBufOutPacket.java | 11 +++ src/main/java/net/packet/InPacket.java | 17 ++++ src/main/java/net/packet/OutPacket.java | 4 + src/main/java/net/packet/Packet.java | 5 ++ 6 files changed, 121 insertions(+) create mode 100644 src/main/java/net/packet/ByteBufInPacket.java create mode 100644 src/main/java/net/packet/ByteBufOutPacket.java create mode 100644 src/main/java/net/packet/InPacket.java create mode 100644 src/main/java/net/packet/OutPacket.java create mode 100644 src/main/java/net/packet/Packet.java diff --git a/pom.xml b/pom.xml index 7df287a87f..ba08e2d62a 100644 --- a/pom.xml +++ b/pom.xml @@ -47,6 +47,11 @@ jcip-annotations 1.0 + + io.netty + netty-buffer + 4.1.65.Final + diff --git a/src/main/java/net/packet/ByteBufInPacket.java b/src/main/java/net/packet/ByteBufInPacket.java new file mode 100644 index 0000000000..481c5855cb --- /dev/null +++ b/src/main/java/net/packet/ByteBufInPacket.java @@ -0,0 +1,79 @@ +package net.packet; + +import io.netty.buffer.ByteBuf; + +import java.awt.*; + +public class ByteBufInPacket implements InPacket { + private final ByteBuf byteBuf; + + public ByteBufInPacket(ByteBuf byteBuf) { + this.byteBuf = byteBuf; + } + + @Override + public byte[] getBytes() { + // TODO + return null; + } + + @Override + public byte readByte() { + return byteBuf.readByte(); + } + + @Override + public short readShort() { + return byteBuf.readShortLE(); + } + + @Override + public int readInt() { + return byteBuf.readIntLE(); + } + + @Override + public long readLong() { + return byteBuf.readLongLE(); + } + + @Override + public Point readPoint() { + final short x = byteBuf.readShortLE(); + final short y = byteBuf.readShortLE(); + return new Point(x, y); + } + + @Override + public String readString() { + // TODO + return null; + } + + @Override + public byte[] read(int numberOfBytes) { + byte[] bytes = new byte[numberOfBytes]; + byteBuf.readBytes(bytes); + return bytes; + } + + @Override + public void skip(int numberOfBytes) { + byteBuf.skipBytes(numberOfBytes); + } + + @Override + public int available() { + return byteBuf.readableBytes(); + } + + @Override + public void seek(int byteOffset) { + byteBuf.readerIndex(byteOffset); + } + + @Override + public int getPosition() { + return byteBuf.readerIndex(); + } +} diff --git a/src/main/java/net/packet/ByteBufOutPacket.java b/src/main/java/net/packet/ByteBufOutPacket.java new file mode 100644 index 0000000000..f2aa491cfb --- /dev/null +++ b/src/main/java/net/packet/ByteBufOutPacket.java @@ -0,0 +1,11 @@ +package net.packet; + +import io.netty.buffer.ByteBuf; + +public class ByteBufOutPacket implements OutPacket { + private final ByteBuf byteBuf; + + public ByteBufOutPacket(ByteBuf byteBuf) { + this.byteBuf = byteBuf; + } +} diff --git a/src/main/java/net/packet/InPacket.java b/src/main/java/net/packet/InPacket.java new file mode 100644 index 0000000000..53ef38bb42 --- /dev/null +++ b/src/main/java/net/packet/InPacket.java @@ -0,0 +1,17 @@ +package net.packet; + +import java.awt.*; + +public interface InPacket extends Packet { + byte readByte(); + short readShort(); + int readInt(); + long readLong(); + Point readPoint(); + String readString(); + byte[] read(int numberOfBytes); + void skip(int numberOfBytes); + int available(); + void seek(int byteOffset); + int getPosition(); +} diff --git a/src/main/java/net/packet/OutPacket.java b/src/main/java/net/packet/OutPacket.java new file mode 100644 index 0000000000..6d1fb8982a --- /dev/null +++ b/src/main/java/net/packet/OutPacket.java @@ -0,0 +1,4 @@ +package net.packet; + +public interface OutPacket extends Packet { +} diff --git a/src/main/java/net/packet/Packet.java b/src/main/java/net/packet/Packet.java new file mode 100644 index 0000000000..8e1b7cfb99 --- /dev/null +++ b/src/main/java/net/packet/Packet.java @@ -0,0 +1,5 @@ +package net.packet; + +public interface Packet { + byte[] getBytes(); +} From f3faee2e16755154f084e96c41d01f0729af9169 Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 20 Jun 2021 20:40:23 +0200 Subject: [PATCH 2/8] Add OutPacket interface and ByteBuf implementation Replacement for LittleEndianWriter, GenericLittleEndianWriter, and MaplePacketLittleEndianWriter. --- src/main/java/net/packet/ByteBufInPacket.java | 17 ++-- .../java/net/packet/ByteBufOutPacket.java | 79 ++++++++++++++++++- src/main/java/net/packet/InPacket.java | 2 +- src/main/java/net/packet/OutPacket.java | 16 ++++ src/main/java/net/packet/Packet.java | 1 + 5 files changed, 107 insertions(+), 8 deletions(-) diff --git a/src/main/java/net/packet/ByteBufInPacket.java b/src/main/java/net/packet/ByteBufInPacket.java index 481c5855cb..c2e2984499 100644 --- a/src/main/java/net/packet/ByteBufInPacket.java +++ b/src/main/java/net/packet/ByteBufInPacket.java @@ -11,10 +11,15 @@ public class ByteBufInPacket implements InPacket { this.byteBuf = byteBuf; } + @Override + public short getHeader() { + return byteBuf.getShortLE(0); + } + @Override public byte[] getBytes() { - // TODO - return null; + // TODO implement + throw new UnsupportedOperationException(); } @Override @@ -51,15 +56,15 @@ public class ByteBufInPacket implements InPacket { } @Override - public byte[] read(int numberOfBytes) { - byte[] bytes = new byte[numberOfBytes]; + public byte[] readBytes(int bytesToRead) { + byte[] bytes = new byte[bytesToRead]; byteBuf.readBytes(bytes); return bytes; } @Override - public void skip(int numberOfBytes) { - byteBuf.skipBytes(numberOfBytes); + public void skip(int bytesToSkip) { + byteBuf.skipBytes(bytesToSkip); } @Override diff --git a/src/main/java/net/packet/ByteBufOutPacket.java b/src/main/java/net/packet/ByteBufOutPacket.java index f2aa491cfb..d36c594f83 100644 --- a/src/main/java/net/packet/ByteBufOutPacket.java +++ b/src/main/java/net/packet/ByteBufOutPacket.java @@ -1,11 +1,88 @@ package net.packet; import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import net.jcip.annotations.NotThreadSafe; +import net.opcodes.SendOpcode; +import java.awt.*; + +@NotThreadSafe public class ByteBufOutPacket implements OutPacket { private final ByteBuf byteBuf; - public ByteBufOutPacket(ByteBuf byteBuf) { + public ByteBufOutPacket(SendOpcode op) { + ByteBuf byteBuf = Unpooled.buffer(); + byteBuf.writeShortLE((short) op.getValue()); this.byteBuf = byteBuf; } + + public ByteBufOutPacket(SendOpcode op, int initialCapacity) { + ByteBuf byteBuf = Unpooled.buffer(initialCapacity); + byteBuf.writeShortLE((short) op.getValue()); + this.byteBuf = byteBuf; + } + + @Override + public short getHeader() { + return byteBuf.getShortLE(0); + } + + @Override + public byte[] getBytes() { + // TODO implement + throw new UnsupportedOperationException(); + } + + @Override + public void writeByte(byte value) { + byteBuf.writeByte(value); + } + + @Override + public void writeByte(int value) { + writeByte((byte) value); + } + + @Override + public void writeBytes(byte[] value) { + byteBuf.writeBytes(value); + } + + @Override + public void writeShort(short value) { + byteBuf.writeShortLE(value); + } + + @Override + public void writeInt(int value) { + byteBuf.writeIntLE(value); + } + + @Override + public void writeLong(long value) { + byteBuf.writeLongLE(value); + } + + @Override + public void writeBoolean(boolean value) { + byteBuf.writeByte(value ? 1 : 0); + } + + @Override + public void writeString(String value) { + writeShort((short) value.length()); + writeBytes(value.getBytes(STRING_CHARSET)); + } + + @Override + public void writePoint(Point value) { + writeShort((short) value.getX()); + writeShort((short) value.getY()); + } + + @Override + public void skip(int bytesToSkip) { + writeBytes(new byte[bytesToSkip]); + } } diff --git a/src/main/java/net/packet/InPacket.java b/src/main/java/net/packet/InPacket.java index 53ef38bb42..c2493227a4 100644 --- a/src/main/java/net/packet/InPacket.java +++ b/src/main/java/net/packet/InPacket.java @@ -9,7 +9,7 @@ public interface InPacket extends Packet { long readLong(); Point readPoint(); String readString(); - byte[] read(int numberOfBytes); + byte[] readBytes(int bytesToRead); void skip(int numberOfBytes); int available(); void seek(int byteOffset); diff --git a/src/main/java/net/packet/OutPacket.java b/src/main/java/net/packet/OutPacket.java index 6d1fb8982a..9b6804abb8 100644 --- a/src/main/java/net/packet/OutPacket.java +++ b/src/main/java/net/packet/OutPacket.java @@ -1,4 +1,20 @@ package net.packet; +import java.awt.*; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; + public interface OutPacket extends Packet { + Charset STRING_CHARSET = StandardCharsets.US_ASCII; + + void writeByte(byte value); + void writeByte(int value); + void writeBytes(byte[] value); + void writeShort(short value); + void writeInt(int value); + void writeLong(long value); + void writeBoolean(boolean value); + void writeString(String value); + void writePoint(Point value); + void skip(int numberOfBytes); } diff --git a/src/main/java/net/packet/Packet.java b/src/main/java/net/packet/Packet.java index 8e1b7cfb99..6bbd4cc4dc 100644 --- a/src/main/java/net/packet/Packet.java +++ b/src/main/java/net/packet/Packet.java @@ -1,5 +1,6 @@ package net.packet; public interface Packet { + short getHeader(); byte[] getBytes(); } From aaf4b558f3345c86c3679c60bb81c943e65ebd14 Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 20 Jun 2021 21:27:50 +0200 Subject: [PATCH 3/8] Finish InPacket & OutPacket implementations --- src/main/java/net/packet/ByteBufInPacket.java | 28 ++++++++++--------- .../java/net/packet/ByteBufOutPacket.java | 17 +++++------ src/main/java/net/packet/InPacket.java | 2 +- src/main/java/net/packet/OutPacket.java | 2 +- src/main/java/net/packet/Packet.java | 1 - 5 files changed, 24 insertions(+), 26 deletions(-) diff --git a/src/main/java/net/packet/ByteBufInPacket.java b/src/main/java/net/packet/ByteBufInPacket.java index c2e2984499..02c8f3cb41 100644 --- a/src/main/java/net/packet/ByteBufInPacket.java +++ b/src/main/java/net/packet/ByteBufInPacket.java @@ -11,15 +11,12 @@ public class ByteBufInPacket implements InPacket { this.byteBuf = byteBuf; } - @Override - public short getHeader() { - return byteBuf.getShortLE(0); - } - @Override public byte[] getBytes() { - // TODO implement - throw new UnsupportedOperationException(); + byte[] bytes = new byte[byteBuf.readableBytes()]; + int readerIndex = byteBuf.readerIndex(); + byteBuf.getBytes(readerIndex, bytes); + return bytes; } @Override @@ -51,20 +48,25 @@ public class ByteBufInPacket implements InPacket { @Override public String readString() { - // TODO - return null; + short length = readShort(); + char[] characters = new char[length]; + for(int i = 0; i < length; i++) { + characters[i] = (char) readByte(); + } + + return String.valueOf(characters); } @Override - public byte[] readBytes(int bytesToRead) { - byte[] bytes = new byte[bytesToRead]; + public byte[] readBytes(int numberOfBytes) { + byte[] bytes = new byte[numberOfBytes]; byteBuf.readBytes(bytes); return bytes; } @Override - public void skip(int bytesToSkip) { - byteBuf.skipBytes(bytesToSkip); + public void skip(int numberOfBytes) { + byteBuf.skipBytes(numberOfBytes); } @Override diff --git a/src/main/java/net/packet/ByteBufOutPacket.java b/src/main/java/net/packet/ByteBufOutPacket.java index d36c594f83..5fc77f3c3d 100644 --- a/src/main/java/net/packet/ByteBufOutPacket.java +++ b/src/main/java/net/packet/ByteBufOutPacket.java @@ -23,15 +23,12 @@ public class ByteBufOutPacket implements OutPacket { this.byteBuf = byteBuf; } - @Override - public short getHeader() { - return byteBuf.getShortLE(0); - } - @Override public byte[] getBytes() { - // TODO implement - throw new UnsupportedOperationException(); + byte[] bytes = new byte[byteBuf.readableBytes()]; + int readerIndex = byteBuf.readerIndex(); + byteBuf.getBytes(readerIndex, bytes); + return bytes; } @Override @@ -50,7 +47,7 @@ public class ByteBufOutPacket implements OutPacket { } @Override - public void writeShort(short value) { + public void writeShort(int value) { byteBuf.writeShortLE(value); } @@ -82,7 +79,7 @@ public class ByteBufOutPacket implements OutPacket { } @Override - public void skip(int bytesToSkip) { - writeBytes(new byte[bytesToSkip]); + public void skip(int numberOfBytes) { + writeBytes(new byte[numberOfBytes]); } } diff --git a/src/main/java/net/packet/InPacket.java b/src/main/java/net/packet/InPacket.java index c2493227a4..2c899c2ade 100644 --- a/src/main/java/net/packet/InPacket.java +++ b/src/main/java/net/packet/InPacket.java @@ -9,7 +9,7 @@ public interface InPacket extends Packet { long readLong(); Point readPoint(); String readString(); - byte[] readBytes(int bytesToRead); + byte[] readBytes(int numberOfBytes); void skip(int numberOfBytes); int available(); void seek(int byteOffset); diff --git a/src/main/java/net/packet/OutPacket.java b/src/main/java/net/packet/OutPacket.java index 9b6804abb8..615f932db0 100644 --- a/src/main/java/net/packet/OutPacket.java +++ b/src/main/java/net/packet/OutPacket.java @@ -10,7 +10,7 @@ public interface OutPacket extends Packet { void writeByte(byte value); void writeByte(int value); void writeBytes(byte[] value); - void writeShort(short value); + void writeShort(int value); void writeInt(int value); void writeLong(long value); void writeBoolean(boolean value); diff --git a/src/main/java/net/packet/Packet.java b/src/main/java/net/packet/Packet.java index 6bbd4cc4dc..8e1b7cfb99 100644 --- a/src/main/java/net/packet/Packet.java +++ b/src/main/java/net/packet/Packet.java @@ -1,6 +1,5 @@ package net.packet; public interface Packet { - short getHeader(); byte[] getBytes(); } From 926371c9a7c04087ecfef32f05af3ae58315d489 Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 20 Jun 2021 22:53:20 +0200 Subject: [PATCH 4/8] Add unit tests for ByteBufInPacket --- pom.xml | 14 ++ .../java/net/packet/ByteBufInPacketTest.java | 169 ++++++++++++++++++ 2 files changed, 183 insertions(+) create mode 100644 src/test/java/net/packet/ByteBufInPacketTest.java diff --git a/pom.xml b/pom.xml index ba08e2d62a..b3916598c8 100644 --- a/pom.xml +++ b/pom.xml @@ -86,6 +86,20 @@ js-scriptengine ${graalvm.version} + + + + org.junit.jupiter + junit-jupiter-api + 5.7.2 + + + org.junit.jupiter + junit-jupiter-engine + 5.7.2 + + + diff --git a/src/test/java/net/packet/ByteBufInPacketTest.java b/src/test/java/net/packet/ByteBufInPacketTest.java new file mode 100644 index 0000000000..595055cd00 --- /dev/null +++ b/src/test/java/net/packet/ByteBufInPacketTest.java @@ -0,0 +1,169 @@ +package net.packet; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.awt.*; +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ByteBufInPacketTest { + private ByteBuf byteBuf; + private InPacket inPacket; + + @BeforeEach + void reset() { + this.byteBuf = Unpooled.buffer(); + this.inPacket = new ByteBufInPacket(byteBuf); + } + + @Test + void readByte() { + final byte writtenByte = 123; + byteBuf.writeByte(writtenByte); + + byte readByte = inPacket.readByte(); + + assertEquals(writtenByte, readByte); + } + + @Test + void readShort() { + final short writtenShort = 12_345; + byteBuf.writeShortLE(writtenShort); + + short readShort = inPacket.readShort(); + + assertEquals(writtenShort, readShort); + } + + @Test + void readInt() { + final int writtenInt = 1_234_567_890; + byteBuf.writeIntLE(writtenInt); + + int readInt = inPacket.readInt(); + + assertEquals(writtenInt, readInt); + } + + @Test + void readLong() { + final long writtenLong = 9_223_372_036_854_775_807L; + byteBuf.writeLongLE(writtenLong); + + long readLong = inPacket.readLong(); + + assertEquals(writtenLong, readLong); + } + + @Test + void readPoint() { + final Point writtenPoint = new Point(111, 222); + byteBuf.writeShortLE((short) writtenPoint.getX()); + byteBuf.writeShortLE((short) writtenPoint.getY()); + + Point readPoint = inPacket.readPoint(); + + assertEquals(writtenPoint, readPoint); + } + + @Test + void readString() { + final String writtenString = "You have gained experience (+3200)"; + byteBuf.writeShortLE(writtenString.length()); + byte[] writtenStringBytes = writtenString.getBytes(StandardCharsets.US_ASCII); + byteBuf.writeBytes(writtenStringBytes); + + String readString = inPacket.readString(); + + assertEquals(writtenString, readString); + } + + @Test + void readBytes() { + byte[] writtenBytes = {10, 11, 12, 13, 14, 15}; + byteBuf.writeBytes(writtenBytes); + + byte[] byteBatch1 = inPacket.readBytes(1); + assertEquals(1, byteBatch1.length); + assertEquals(10, byteBatch1[0]); + + byte[] byteBatch2 = inPacket.readBytes(2); + assertEquals(2, byteBatch2.length); + assertEquals(11, byteBatch2[0]); + assertEquals(12, byteBatch2[1]); + + byte[] byteBatch3 = inPacket.readBytes(3); + assertEquals(3, byteBatch3.length); + assertEquals(13, byteBatch3[0]); + assertEquals(14, byteBatch3[1]); + assertEquals(15, byteBatch3[2]); + } + + @Test + void skip() { + byte[] writtenBytes = {20, 21, 22, 23, 24, 25}; + byteBuf.writeBytes(writtenBytes); + + byte firstByte = inPacket.readByte(); + assertEquals(20, firstByte); + + inPacket.skip(3); + + byte fifthByte = inPacket.readByte(); + assertEquals(24, fifthByte); + } + + @Test + void available() { + byte[] writtenBytes = {30, 31, 32, 33, 34, 35}; + byteBuf.writeBytes(writtenBytes); + + assertEquals(6, inPacket.available()); + + inPacket.readByte(); + assertEquals(5, inPacket.available()); + + inPacket.readInt(); + assertEquals(1, inPacket.available()); + } + + @Test + void seek() { + byte[] writtenBytes = {40, 41, 42, 43, 44, 45}; + byteBuf.writeBytes(writtenBytes); + + inPacket.seek(2); + assertEquals(4, inPacket.available()); + byte byteAtSeek = inPacket.readByte(); + assertEquals(42, byteAtSeek); + + inPacket.seek(0); + byte byteAtReset = inPacket.readByte(); + assertEquals(40, byteAtReset); + } + + @Test + void getPosition() { + byte[] writtenBytes = {50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60}; + byteBuf.writeBytes(writtenBytes); + + assertEquals(0, inPacket.getPosition()); + + inPacket.readByte(); + assertEquals(1, inPacket.getPosition()); + + inPacket.readShort(); + assertEquals(3, inPacket.getPosition()); + + inPacket.readInt(); + assertEquals(7, inPacket.getPosition()); + + inPacket.seek(5); + assertEquals(5, inPacket.getPosition()); + } +} \ No newline at end of file From 6d02a952732cc644e64d1a93cfe2f4432d9a37a5 Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 20 Jun 2021 23:02:01 +0200 Subject: [PATCH 5/8] Simplify test setup for written bytes --- .../java/net/packet/ByteBufInPacketTest.java | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/src/test/java/net/packet/ByteBufInPacketTest.java b/src/test/java/net/packet/ByteBufInPacketTest.java index 595055cd00..df5c88d68d 100644 --- a/src/test/java/net/packet/ByteBufInPacketTest.java +++ b/src/test/java/net/packet/ByteBufInPacketTest.java @@ -20,6 +20,12 @@ class ByteBufInPacketTest { this.inPacket = new ByteBufInPacket(byteBuf); } + private void givenWrittenBytes(int... bytes) { + for (int b : bytes) { + byteBuf.writeByte(b); + } + } + @Test void readByte() { final byte writtenByte = 123; @@ -85,8 +91,7 @@ class ByteBufInPacketTest { @Test void readBytes() { - byte[] writtenBytes = {10, 11, 12, 13, 14, 15}; - byteBuf.writeBytes(writtenBytes); + givenWrittenBytes(10, 11, 12, 13, 14, 15); byte[] byteBatch1 = inPacket.readBytes(1); assertEquals(1, byteBatch1.length); @@ -106,8 +111,7 @@ class ByteBufInPacketTest { @Test void skip() { - byte[] writtenBytes = {20, 21, 22, 23, 24, 25}; - byteBuf.writeBytes(writtenBytes); + givenWrittenBytes(20, 21, 22, 23, 24, 25); byte firstByte = inPacket.readByte(); assertEquals(20, firstByte); @@ -120,8 +124,7 @@ class ByteBufInPacketTest { @Test void available() { - byte[] writtenBytes = {30, 31, 32, 33, 34, 35}; - byteBuf.writeBytes(writtenBytes); + givenWrittenBytes(30, 31, 32, 33, 34, 35); assertEquals(6, inPacket.available()); @@ -134,8 +137,7 @@ class ByteBufInPacketTest { @Test void seek() { - byte[] writtenBytes = {40, 41, 42, 43, 44, 45}; - byteBuf.writeBytes(writtenBytes); + givenWrittenBytes(40, 41, 42, 43, 44, 45); inPacket.seek(2); assertEquals(4, inPacket.available()); @@ -149,8 +151,7 @@ class ByteBufInPacketTest { @Test void getPosition() { - byte[] writtenBytes = {50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60}; - byteBuf.writeBytes(writtenBytes); + givenWrittenBytes(50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60); assertEquals(0, inPacket.getPosition()); From 4fd64884f2f1903108b9ecad78bb9f99cb7fc002 Mon Sep 17 00:00:00 2001 From: P0nk Date: Mon, 21 Jun 2021 21:45:06 +0200 Subject: [PATCH 6/8] Simplify getBytes and add tests for it --- src/main/java/net/packet/ByteBufInPacket.java | 6 ++--- .../java/net/packet/ByteBufOutPacket.java | 6 ++--- .../java/net/packet/ByteBufInPacketTest.java | 23 +++++++++++++++++++ 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/src/main/java/net/packet/ByteBufInPacket.java b/src/main/java/net/packet/ByteBufInPacket.java index 02c8f3cb41..d1b9f4f87e 100644 --- a/src/main/java/net/packet/ByteBufInPacket.java +++ b/src/main/java/net/packet/ByteBufInPacket.java @@ -1,6 +1,7 @@ package net.packet; import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufUtil; import java.awt.*; @@ -13,10 +14,7 @@ public class ByteBufInPacket implements InPacket { @Override public byte[] getBytes() { - byte[] bytes = new byte[byteBuf.readableBytes()]; - int readerIndex = byteBuf.readerIndex(); - byteBuf.getBytes(readerIndex, bytes); - return bytes; + return ByteBufUtil.getBytes(byteBuf); } @Override diff --git a/src/main/java/net/packet/ByteBufOutPacket.java b/src/main/java/net/packet/ByteBufOutPacket.java index 5fc77f3c3d..5aa7a20b79 100644 --- a/src/main/java/net/packet/ByteBufOutPacket.java +++ b/src/main/java/net/packet/ByteBufOutPacket.java @@ -1,6 +1,7 @@ package net.packet; import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufUtil; import io.netty.buffer.Unpooled; import net.jcip.annotations.NotThreadSafe; import net.opcodes.SendOpcode; @@ -25,10 +26,7 @@ public class ByteBufOutPacket implements OutPacket { @Override public byte[] getBytes() { - byte[] bytes = new byte[byteBuf.readableBytes()]; - int readerIndex = byteBuf.readerIndex(); - byteBuf.getBytes(readerIndex, bytes); - return bytes; + return ByteBufUtil.getBytes(byteBuf); } @Override diff --git a/src/test/java/net/packet/ByteBufInPacketTest.java b/src/test/java/net/packet/ByteBufInPacketTest.java index df5c88d68d..1ed28e1d56 100644 --- a/src/test/java/net/packet/ByteBufInPacketTest.java +++ b/src/test/java/net/packet/ByteBufInPacketTest.java @@ -8,6 +8,7 @@ import org.junit.jupiter.api.Test; import java.awt.*; import java.nio.charset.StandardCharsets; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; class ByteBufInPacketTest { @@ -167,4 +168,26 @@ class ByteBufInPacketTest { inPacket.seek(5); assertEquals(5, inPacket.getPosition()); } + + @Test + void getBytes() { + givenWrittenBytes(20, 19, 21, 18, 22); + + byte[] bytes = inPacket.getBytes(); + + assertArrayEquals(new byte[]{20, 19, 21, 18, 22}, bytes); + } + + @Test + void whenGetBytes_shouldBeRepeatable() { + givenWrittenBytes(1, 2, 3, 4, 5); + + byte[] bytes = inPacket.getBytes(); + assertEquals(5, bytes.length); + + byte[] sameBytes = inPacket.getBytes(); + assertEquals(5, sameBytes.length); + + assertArrayEquals(bytes, sameBytes); + } } \ No newline at end of file From c4c5700d32010756cdaba025c5457158bd44a67c Mon Sep 17 00:00:00 2001 From: P0nk Date: Mon, 21 Jun 2021 21:45:30 +0200 Subject: [PATCH 7/8] Add basic unit tests for ByteBufOutPacket --- .../java/net/packet/ByteBufOutPacketTest.java | 206 ++++++++++++++++++ 1 file changed, 206 insertions(+) create mode 100644 src/test/java/net/packet/ByteBufOutPacketTest.java diff --git a/src/test/java/net/packet/ByteBufOutPacketTest.java b/src/test/java/net/packet/ByteBufOutPacketTest.java new file mode 100644 index 0000000000..3673254736 --- /dev/null +++ b/src/test/java/net/packet/ByteBufOutPacketTest.java @@ -0,0 +1,206 @@ +package net.packet; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.Unpooled; +import net.opcodes.SendOpcode; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.awt.*; +import java.nio.charset.StandardCharsets; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; + +class ByteBufOutPacketTest { + private ByteBufOutPacket outPacket; + + @BeforeEach + void reset() { + outPacket = new ByteBufOutPacket(SendOpcode.ADMIN_SHOP); // Any opcode will do + } + + private static ByteBuf wrapExplicitlyWrittenBytes(OutPacket outPacket) { + byte[] packetBytes = outPacket.getBytes(); + ByteBuf byteBuf = Unpooled.copiedBuffer(packetBytes); + byteBuf.readShortLE(); // Skip over opcode + return byteBuf; + } + + @Test + void whenInstantiatingNew_shouldWriteOpcode() { + byte[] packetBytes = new ByteBufOutPacket(SendOpcode.NPC_TALK).getBytes(); + assertEquals(2, packetBytes.length); + } + + @Test + void getBytes() { + ByteBufOutPacket outPacket = new ByteBufOutPacket(SendOpcode.PING); // This opcode has value 0x11 = 17 in decimal + outPacket.writeByte(10); + outPacket.writeByte(20); + outPacket.writeByte(30); + + byte[] bytes = outPacket.getBytes(); + + assertArrayEquals(new byte[]{(byte) 17, (byte) 0, (byte) 10, (byte) 20, (byte) 30}, bytes); + } + + @Test + void writeByte() { + final byte writtenByte = 19; + outPacket.writeByte(writtenByte); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + byte readByte = wrapped.readByte(); + + assertEquals(writtenByte, readByte); + } + + @Test + void writeByteFromInt() { + final int writtenInt = 123; + outPacket.writeByte(writtenInt); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + byte readByte = wrapped.readByte(); + + assertEquals(writtenInt, readByte); + } + + @Test + void whenWritingByteFromInt_shouldOnlyWrite1Byte() { + final int writtenInt = Integer.MAX_VALUE; + outPacket.writeByte(writtenInt); + + byte[] bytes = outPacket.getBytes(); + assertEquals(2 + 1, bytes.length); // 2 for opcode + } + + @Test + void writeBytes() { + byte[] writtenBytes = {101, 102, 103}; + outPacket.writeBytes(writtenBytes); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + + assertEquals(101, wrapped.readByte()); + assertEquals(102, wrapped.readByte()); + assertEquals(103, wrapped.readByte()); + } + + @Test + void writeShort() { + final short writtenShort = 4312; + outPacket.writeShort(writtenShort); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + short readShort = wrapped.readShortLE(); + + assertEquals(writtenShort, readShort); + } + + @Test + void whenWritingShortFromInt_shouldOnlyWrite2Bytes() { + final int writtenInt = Integer.MAX_VALUE; + outPacket.writeShort(writtenInt); + + byte[] bytes = outPacket.getBytes(); + assertEquals(2 + 2, bytes.length); // 2 for opcode + } + + @Test + void writeShortFromInt() { + final int writtenInt = 34_567; + outPacket.writeShort(writtenInt); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + short readShort = wrapped.readShortLE(); + + assertEquals((short) writtenInt, readShort); + } + + @Test + void writeInt() { + final int writtenInt = 1_010_101_010; + outPacket.writeInt(writtenInt); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + int readInt = wrapped.readIntLE(); + + assertEquals(writtenInt, readInt); + } + + @Test + void writeLong() { + final long writtenLong = 100_200_300_400_500_600L; + outPacket.writeLong(writtenLong); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + long readLong = wrapped.readLongLE(); + + assertEquals(writtenLong, readLong); + } + + @Test + void writeBoolean_true() { + outPacket.writeBoolean(true); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + byte readByte = wrapped.readByte(); + + assertEquals(1, readByte); + } + + @Test + void writeBoolean_false() { + outPacket.writeBoolean(false); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + byte readByte = wrapped.readByte(); + + assertEquals(0, readByte); + } + + @Test + void writeString() { + final String writtenString = "You've been weakened, making you unable to jump."; + outPacket.writeString(writtenString); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + int length = wrapped.readShortLE(); + byte[] stringBytes = new byte[length]; + wrapped.readBytes(stringBytes); + String readString = new String(stringBytes, StandardCharsets.US_ASCII); + + assertEquals(writtenString, readString); + } + + @Test + void writePoint() { + final Point writtenPoint = new Point(23, 42); + outPacket.writePoint(writtenPoint); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + short readX = wrapped.readShortLE(); + short readY = wrapped.readShortLE(); + + assertEquals((short) writtenPoint.getX(), readX); + assertEquals((short) writtenPoint.getY(), readY); + } + + @Test + void whenSkipping_shouldWriteZeroes() { + final byte firstWrittenByte = 9; + final byte secondWrittenByte = 11; + outPacket.writeByte(firstWrittenByte); + outPacket.skip(2); + outPacket.writeByte(secondWrittenByte); + + ByteBuf wrapped = wrapExplicitlyWrittenBytes(outPacket); + + assertEquals(firstWrittenByte, wrapped.readByte()); + assertEquals(0, wrapped.readByte()); + assertEquals(0, wrapped.readByte()); + assertEquals(secondWrittenByte, wrapped.readByte()); + } +} \ No newline at end of file From 72ff8d563baada9fcbd731a192db9f76f8ce3b3c Mon Sep 17 00:00:00 2001 From: P0nk Date: Mon, 21 Jun 2021 22:03:20 +0200 Subject: [PATCH 8/8] Refactor packet string charset --- src/main/java/net/packet/ByteBufInPacket.java | 9 +++------ src/main/java/net/packet/OutPacket.java | 4 ---- src/main/java/net/packet/Packet.java | 5 +++++ src/test/java/net/packet/ByteBufInPacketTest.java | 3 +-- 4 files changed, 9 insertions(+), 12 deletions(-) diff --git a/src/main/java/net/packet/ByteBufInPacket.java b/src/main/java/net/packet/ByteBufInPacket.java index d1b9f4f87e..0977172354 100644 --- a/src/main/java/net/packet/ByteBufInPacket.java +++ b/src/main/java/net/packet/ByteBufInPacket.java @@ -47,12 +47,9 @@ public class ByteBufInPacket implements InPacket { @Override public String readString() { short length = readShort(); - char[] characters = new char[length]; - for(int i = 0; i < length; i++) { - characters[i] = (char) readByte(); - } - - return String.valueOf(characters); + byte[] stringBytes = new byte[length]; + byteBuf.readBytes(stringBytes); + return new String(stringBytes, STRING_CHARSET); } @Override diff --git a/src/main/java/net/packet/OutPacket.java b/src/main/java/net/packet/OutPacket.java index 615f932db0..57e953a6f7 100644 --- a/src/main/java/net/packet/OutPacket.java +++ b/src/main/java/net/packet/OutPacket.java @@ -1,12 +1,8 @@ package net.packet; import java.awt.*; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; public interface OutPacket extends Packet { - Charset STRING_CHARSET = StandardCharsets.US_ASCII; - void writeByte(byte value); void writeByte(int value); void writeBytes(byte[] value); diff --git a/src/main/java/net/packet/Packet.java b/src/main/java/net/packet/Packet.java index 8e1b7cfb99..79f257cd38 100644 --- a/src/main/java/net/packet/Packet.java +++ b/src/main/java/net/packet/Packet.java @@ -1,5 +1,10 @@ package net.packet; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; + public interface Packet { + Charset STRING_CHARSET = StandardCharsets.US_ASCII; + byte[] getBytes(); } diff --git a/src/test/java/net/packet/ByteBufInPacketTest.java b/src/test/java/net/packet/ByteBufInPacketTest.java index 1ed28e1d56..80a611abd8 100644 --- a/src/test/java/net/packet/ByteBufInPacketTest.java +++ b/src/test/java/net/packet/ByteBufInPacketTest.java @@ -6,7 +6,6 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import java.awt.*; -import java.nio.charset.StandardCharsets; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; @@ -82,7 +81,7 @@ class ByteBufInPacketTest { void readString() { final String writtenString = "You have gained experience (+3200)"; byteBuf.writeShortLE(writtenString.length()); - byte[] writtenStringBytes = writtenString.getBytes(StandardCharsets.US_ASCII); + byte[] writtenStringBytes = writtenString.getBytes(Packet.STRING_CHARSET); byteBuf.writeBytes(writtenStringBytes); String readString = inPacket.readString();