test: Add MTE tests for ItemCommands

module.txt

@@ -2,10 +2,13 @@
     "id" : "Inventory",
     "version" : "1.2.0",
     "isReleaseManaged": true,
-    "displayName" : "Core Inventory",
+    "displayName": "Core Inventory",
     "author": "The Terasology Foundation",
-    "description" : "This module adds a standard and simple inventory system as well as hooks for other modules",
-    "dependencies" : [],
+    "description": "This module adds a standard and simple inventory system as well as hooks for other modules",
+    "dependencies": [
+        {"id": "CoreAssets", "minVersion": "2.0.0", "optional": true},
+        {"id": "ModuleTestingEnvironment", "minVersion": "0.2.0-SNAPSHOT", "optional": true}
+    ],
     "isLibrary": true,
     "isAugmentation": true
 }

src/test/java/org/terasology/logic/inventory/InventoryAuthoritySystemTest.java

@@ -15,8 +15,8 @@
  */
 package org.terasology.logic.inventory;
 
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 import org.terasology.entitySystem.entity.EntityManager;
 import org.terasology.entitySystem.entity.EntityRef;
@@ -48,7 +48,7 @@ public class InventoryAuthoritySystemTest {
     private InventoryComponent inventoryComp;
     private EntityManager entityManager;
 
-    @Before
+    @BeforeEach
     public void setup() {
         inventoryAuthoritySystem = new InventoryAuthoritySystem();
         instigator = Mockito.mock(EntityRef.class);

src/test/java/org/terasology/logic/inventory/ItemCommandsTest.java

@@ -0,0 +1,124 @@
+/*
+ * Copyright 2020 MovingBlocks
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.terasology.logic.inventory;
+
+import com.google.common.collect.Sets;
+import org.junit.Assert;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import org.terasology.context.Context;
+import org.terasology.entitySystem.entity.EntityManager;
+import org.terasology.entitySystem.entity.EntityRef;
+import org.terasology.logic.players.LocalPlayer;
+import org.terasology.math.TeraMath;
+import org.terasology.moduletestingenvironment.ModuleTestingEnvironment;
+import org.terasology.world.block.BlockManager;
+import org.terasology.world.block.items.BlockItemFactory;
+
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * Verify that the {@link ItemCommands} are working as expected.
+ */
+public class ItemCommandsTest {
+
+    static final String URI_DIRT = "CoreAssets:Dirt";
+
+    private static ModuleTestingEnvironment mte;
+
+    private Context hostContext;
+    private EntityManager entityManager;
+    private InventoryManager inventoryManager;
+    private BlockManager blockManager;
+    private ItemCommands itemCommands;
+
+    @BeforeAll
+    public static void setup() throws Exception {
+        mte = new ModuleTestingEnvironment() {
+            @Override
+            public Set<String> getDependencies() {
+                return Sets.newHashSet("CoreAssets", "Inventory");
+            }
+        };
+        mte.setup();
+    }
+
+    @AfterAll
+    public static void tearDown() throws Exception {
+        mte.tearDown();
+    }
+
+    @BeforeEach
+    public void beforeEach() {
+        hostContext = mte.getHostContext();
+        entityManager = hostContext.get(EntityManager.class);
+        inventoryManager = hostContext.get(InventoryManager.class);
+        blockManager = hostContext.get(BlockManager.class);
+        itemCommands = hostContext.get(ItemCommands.class);
+    }
+
+    @ParameterizedTest
+    @ValueSource(ints = {0, 1, 99, 100})
+    public void giveItemSingleBlockStack(int amount) {
+
+        Context clientContext = mte.createClient();
+        LocalPlayer localPlayer = clientContext.get(LocalPlayer.class);
+        final EntityRef player = localPlayer.getClientEntity();
+        final EntityRef character = localPlayer.getCharacterEntity();
+        character.upsertComponent(InventoryComponent.class, maybeInventory -> maybeInventory.orElse(new InventoryComponent(40)));
+
+        final BlockItemFactory factory = new BlockItemFactory(entityManager);
+        final EntityRef blockItem = factory.newInstance(blockManager.getBlockFamily(URI_DIRT), amount);
+
+        Assert.assertNotEquals("Cannot create a block item instance for '" + URI_DIRT + "'", EntityRef.NULL, blockItem);
+
+        //TODO: I don't know what to pass in there, whether it needs to be the player, character, or something else
+        itemCommands.give(player, URI_DIRT, amount, null);
+
+        final List<EntityRef> filledSlots =
+                character.getComponent(InventoryComponent.class).itemSlots.stream()
+                        .filter(entityRef -> entityRef != EntityRef.NULL)
+                        .collect(Collectors.toList());
+
+        final int maxStackSize = Byte.toUnsignedInt(blockItem.getComponent(ItemComponent.class).maxStackSize);
+        final int expectedFilledSlots = TeraMath.ceilToInt(amount / (float) maxStackSize);
+        Assert.assertEquals("Unexpected number of filled inventory slots", expectedFilledSlots, filledSlots.size());
+
+        filledSlots.forEach(item ->
+                Assert.assertEquals("Slot should contain exactly the added block",
+                        blockItem, item));
+
+        filledSlots.forEach(item ->
+                Assert.assertEquals("Item quantity diverges from requested amount",
+                        amount, Byte.toUnsignedInt(item.getComponent(ItemComponent.class).stackCount)));
+
+        for (int i = 0; i < filledSlots.size(); i++) {
+            int actualStackCount = Byte.toUnsignedInt(filledSlots.get(i).getComponent(ItemComponent.class).stackCount);
+            if (i == amount / maxStackSize) {
+                Assert.assertEquals(amount % maxStackSize, actualStackCount);
+            } else {
+                Assert.assertEquals(maxStackSize, actualStackCount);
+            }
+        }
+    }
+
+}

src/test/java/org/terasology/logic/inventory/StartingInventorySystemTest.java

@@ -16,59 +16,59 @@
 package org.terasology.logic.inventory;
 
 import org.junit.Assert;
-import org.junit.Ignore;
-import org.junit.Test;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
 
 /**
  *
  */
 public class StartingInventorySystemTest {
 
     @Test
-    @Ignore
+    @Disabled
     public void giveSingleBlock() {
-        Assert.assertTrue("Player inventory should contain exactly the single block.", false);
+        Assert.fail("Player inventory should contain exactly the single block.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveBlockStack() {
-        Assert.assertTrue("Player inventory should contain exactly the block stack.", false);
+        Assert.fail("Player inventory should contain exactly the block stack.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveSingleItem() {
-        Assert.assertTrue("Player inventory should contain exactly the single item.", false);
+        Assert.fail("Player inventory should contain exactly the single item.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveNonStackableItem() {
-        Assert.assertTrue("Player inventory should contain multiple instances of the non-stackable item.", false);
+        Assert.fail("Player inventory should contain multiple instances of the non-stackable item.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveStackableItemExceedingStackSize() {
-        Assert.assertTrue("Player inventory should contain multiple slots filled with the stackable item.", false);
+        Assert.fail("Player inventory should contain multiple slots filled with the stackable item.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveStackableItemExceedingInventorySize() {
-        Assert.assertTrue("Player inventory should be filled completely with non-stackable item.", false);
+        Assert.fail("Player inventory should be filled completely with non-stackable item.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveMultipleItems() {
-        Assert.assertTrue("Player inventory should contain all given items in correct amount.", false);
+        Assert.fail("Player inventory should contain all given items in correct amount.");
     }
 
     @Test
-    @Ignore
+    @Disabled
     public void giveStackableItemSplitStacks() {
-        Assert.assertTrue("Player inventory should contain a single item stack with combined amount.", false);
+        Assert.fail("Player inventory should contain a single item stack with combined amount.");
     }
 }