chore: improve test coverage

add (de)serialization tests
improve documentation of `set` on slots
fix machine slot calculation in menus

Author: marcus8448

build.gradle.kts

@@ -242,6 +242,7 @@ tasks.withType<Jar> {
 
 tasks.test {
     useJUnitPlatform()
+    enableAssertions = true
     workingDir("run")
 
     Files.createDirectories(workingDir.toPath())

src/main/java/dev/galacticraft/machinelib/api/block/MachineBlock.java

@@ -41,7 +41,6 @@
 import net.minecraft.core.component.DataComponentPatch;
 import net.minecraft.core.component.DataComponents;
 import net.minecraft.core.registries.BuiltInRegistries;
-import net.minecraft.nbt.ByteTag;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.nbt.NbtOps;
 import net.minecraft.nbt.Tag;
@@ -252,7 +251,7 @@ public void appendHoverText(ItemStack stack, TooltipContext context, List<Compon
                 }
 
                 if (nbt.contains(Constant.Nbt.REDSTONE_MODE, Tag.TAG_BYTE)) {
-                    tooltip.add(Component.translatable(Constant.TranslationKey.REDSTONE_MODE, RedstoneMode.readTag((ByteTag) Objects.requireNonNull(nbt.get(Constant.Nbt.REDSTONE_MODE))).getName()).setStyle(Constant.Text.DARK_RED_STYLE));
+                    tooltip.add(Component.translatable(Constant.TranslationKey.REDSTONE_MODE, RedstoneMode.readTag(Objects.requireNonNull(nbt.get(Constant.Nbt.REDSTONE_MODE))).getName()).setStyle(Constant.Text.DARK_RED_STYLE));
                 }
             }
         }
@@ -277,7 +276,7 @@ public void appendHoverText(ItemStack stack, TooltipContext context, List<Compon
     }
 
     @Override
-    public BlockState playerWillDestroy(Level level, BlockPos pos, BlockState state, Player player) {
+    public @NotNull BlockState playerWillDestroy(Level level, BlockPos pos, BlockState state, Player player) {
         super.playerWillDestroy(level, pos, state, player);
         BlockEntity entity = level.getBlockEntity(pos);
         if (entity instanceof MachineBlockEntity machine) {

src/main/java/dev/galacticraft/machinelib/api/compat/transfer/ExposedStorage.java

@@ -80,7 +80,6 @@ public interface ExposedStorage<Resource, Variant extends TransferVariant<Resour
         return new ExposedStorageImpl<>(storage, slots);
     }
 
-
     @Override
     long getVersion();
 }

src/main/java/dev/galacticraft/machinelib/api/menu/MachineMenu.java

@@ -217,7 +217,7 @@ public MachineMenu(int syncId, @NotNull ServerPlayer player, @NotNull Machine ma
 
         this.levelAccess = ContainerLevelAccess.create(machine.getLevel(), machine.getBlockPos());
 
-        this.machineSlots = new StorageSlot[this.itemStorage.size()];
+        StorageSlot[] slots = new StorageSlot[this.itemStorage.size()];
 
         int index = 0;
         for (ItemResourceSlot slot : this.itemStorage) {
@@ -230,10 +230,13 @@ public MachineMenu(int syncId, @NotNull ServerPlayer player, @NotNull Machine ma
                     slot1 = new StorageSlot(this.itemStorage, slot, display, index, this.playerUUID);
                 }
                 this.addSlot(slot1);
-                this.machineSlots[index++] = slot1;
+                slots[index++] = slot1;
             }
         }
 
+        this.machineSlots = new StorageSlot[index];
+        System.arraycopy(slots, 0, this.machineSlots, 0, index);
+
         index = 0;
         for (FluidResourceSlot slot : this.fluidStorage) {
             if (!slot.isHidden()) {

src/main/java/dev/galacticraft/machinelib/api/storage/slot/ItemResourceSlot.java

@@ -37,6 +37,9 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * A resource slot that stores items.
+ */
 public interface ItemResourceSlot extends ResourceSlot<Item>, ContainerItemContext, FakeRecipeHolder {
     @Contract("_ -> new")
     static @NotNull Builder builder(InputType inputType) {
@@ -69,7 +72,9 @@ public interface ItemResourceSlot extends ResourceSlot<Item>, ContainerItemConte
      * @param resource the item type to consume
      * @return {@code true} if the item was consumed, {@code false} otherwise
      */
-    boolean consumeOne(@NotNull Item resource);
+    default boolean consumeOne(@NotNull Item resource) {
+        return this.consumeOne(resource, null);
+    }
 
     /**
      * Consumes one item of the specified type and components from the slot.
@@ -98,7 +103,9 @@ public interface ItemResourceSlot extends ResourceSlot<Item>, ContainerItemConte
      * @param amount the number of items to consume
      * @return the number of items that were actually consumed
      */
-    long consume(@NotNull Item resource, long amount);
+    default long consume(@NotNull Item resource, long amount) {
+        return this.consume(resource, null, amount);
+    }
 
     /**
      * Consumes the specified number of items of the specified type and components from the slot.
@@ -109,7 +116,7 @@ public interface ItemResourceSlot extends ResourceSlot<Item>, ContainerItemConte
      * @param amount the number of items to consume
      * @return the number of items that were actually consumed
      */
-    long consume(@NotNull Item resource, @NotNull DataComponentPatch components, long amount);
+    long consume(@NotNull Item resource, @Nullable DataComponentPatch components, long amount);
 
     /**
      * {@return the display properties of this slot, or {@code null} if hidden}

src/main/java/dev/galacticraft/machinelib/api/storage/slot/ResourceSlot.java

@@ -34,6 +34,7 @@
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.VisibleForTesting;
 
 /**
  * A slot that can store multiple of a single instance of resource (e.g., sticks).
@@ -126,22 +127,26 @@ public interface ResourceSlot<Resource> extends StorageAccess<Resource>, Mutable
 
     /**
      * Sets the resource stored in this slot to the given resource and amount.
+     * For synchronization and testing purposes only.
      * Does not increment the modification counter.
      * Equivalent to {@link #set(Object, DataComponentPatch, long)} but assumes an empty component patch.
      *
      * @param resource The resource to set.
      * @param amount The amount of the resource to set.
      */
+    @VisibleForTesting
     void set(@Nullable Resource resource, long amount);
 
     /**
      * Sets the resource stored in this slot to the given resource, components, and amount.
+     * For synchronization and testing purposes only.
      * Does not increment the modification counter.
      *
      * @param resource The resource to set.
      * @param components The components of the resource to set.
      * @param amount The amount of the resource to set.
      */
+    @VisibleForTesting
     void set(@Nullable Resource resource, @NotNull DataComponentPatch components, long amount);
 
     /**

src/main/java/dev/galacticraft/machinelib/impl/storage/MachineEnergyStorageImpl.java

@@ -63,11 +63,6 @@ protected void readSnapshot(Long snapshot) {
         this.amount = snapshot;
     }
 
-    @Override
-    public boolean supportsInsertion() {
-        return true;
-    }
-
     @Override
     public boolean canExtract(long amount) {
         return this.amount >= amount;
@@ -144,11 +139,6 @@ public long insert(long amount, @NotNull TransactionContext transaction) {
         return 0;
     }
 
-    @Override
-    public boolean supportsExtraction() {
-        return this.maxOutput > 0;
-    }
-
     @Override
     public long extract(long amount, @NotNull TransactionContext transaction) {
         long extracted = this.tryExtract(amount);
@@ -211,7 +201,7 @@ public void setEnergy(long amount) {
             case BOTH -> {
                 if (this.insert) {
                     if (this.extract) {
-                        return this;
+                        return ExposedEnergyStorage.create(this, this.maxInput, this.maxOutput);
                     } else {
                         return ExposedEnergyStorage.create(this, this.maxInput, 0);
                     }
@@ -274,16 +264,6 @@ private void markModified() {
         if (this.listener != null) this.listener.run();
     }
 
-    @Override
-    public void readDeltaPacket(@NotNull ByteBuf buf) {
-        this.amount = buf.readLong();
-    }
-
-    @Override
-    public void writeDeltaPacket(@NotNull ByteBuf buf, long[] previous) {
-        buf.writeLong(this.amount);
-    }
-
     @Override
     public boolean hasChanged(long[] previous) {
         return previous[0] != this.amount;

src/main/java/dev/galacticraft/machinelib/impl/storage/slot/ItemResourceSlotImpl.java

@@ -89,17 +89,6 @@ public long getCapacityFor(@NotNull Item item, @NotNull DataComponentPatch compo
         return resource;
     }
 
-    @Override
-    public boolean consumeOne(@NotNull Item resource) {
-        DataComponentPatch tag = this.components;
-        if (this.extractOne(resource)) {
-            this.insertRemainder(resource, tag, 1);
-            return true;
-        } else {
-            return false;
-        }
-    }
-
     @Override
     public boolean consumeOne(@NotNull Item resource, @Nullable DataComponentPatch components) {
         DataComponentPatch actual = this.components;
@@ -124,16 +113,6 @@ public long consume(long amount) {
         return consumed;
     }
 
-    @Override
-    public long consume(@NotNull Item resource, long amount) {
-        DataComponentPatch components = this.components;
-        long consumed = this.extract(resource, amount);
-        if (consumed > 0) {
-            this.insertRemainder(resource, components, (int) consumed);
-        }
-        return consumed;
-    }
-
     @Override
     public long consume(@NotNull Item resource, @Nullable DataComponentPatch components, long amount) {
         DataComponentPatch actual = this.components;