Package com.hammy275.immersivemc.test

Interface Test

All Known Implementing Classes:
ChestTest, CraftingTest, ETableTest, FurnaceTest, TestTest
public interface Test
Class for tests run by Tests.
All public methods that start with "test" are tests that will be run.
All test methods should take the same parameter types in the same order as setup(ServerPlayer) and teardown(ServerPlayer).
All test methods should return a String or void. An empty string or null is a passing test, while a non-empty string is a test failure. A test that returns void will always pass if it doesn't throw.
Test objects should be reusable! As such, all initialization should take place within setup(ServerPlayer) and all teardowns in teardown(ServerPlayer).
This interface contains some utility methods. One shouldn't overwrite these!

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    assertEmpty(net.minecraft.world.item.ItemStack itemStack)
     
    default void
    assertEmptyMainHand(net.minecraft.server.level.ServerPlayer player)
     
    default <T> void
    assertEquals(T expected, T actual)
     
    default void
    assertFalse(boolean condition)
     
    default void
    assertTrue(boolean condition)
     
    default void
    createTestingArea(net.minecraft.server.level.ServerPlayer player)
    Create a testing area to easily perform tests within.
    default void
    fastForward(net.minecraft.server.level.ServerPlayer player, int numTicks)
    Fast-forwards the game by some number of ticks, blocking until done.
    default net.minecraft.core.BlockPos
    fromVec3(net.minecraft.world.phys.Vec3 vec3)
     
    default net.minecraft.server.level.ServerLevel
    level(net.minecraft.server.level.ServerPlayer player)
     
    default void
    lookAt(net.minecraft.server.level.ServerPlayer player, net.minecraft.core.BlockPos pos)
     
    default void
    setBlock(net.minecraft.server.level.ServerPlayer player, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.Block block)
     
    default void
    setBlock(net.minecraft.server.level.ServerPlayer player, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.state.BlockState state)
     
    default void
    setItemInMainHand(net.minecraft.server.level.ServerPlayer player, net.minecraft.world.item.Item item)
     
    default void
    setup(net.minecraft.server.level.ServerPlayer player)
    Setup method called before every test.
    default void
    teardown(net.minecraft.server.level.ServerPlayer player)
    Teardown method called after every test.

  • Method Details

    • setup

      default void setup(net.minecraft.server.level.ServerPlayer player)
      Setup method called before every test. This method will always have an empty body in this interface.
      Parameters:
      player - Player performing tests.

    • teardown

      default void teardown(net.minecraft.server.level.ServerPlayer player)
      Teardown method called after every test. This method will always have an empty body in this interface. This method will always be called, even with a test failure. However, if a test fails and teardown fails, only the test failure will be logged.
      Parameters:
      player - Player performing tests.

    • fastForward

      default void fastForward(net.minecraft.server.level.ServerPlayer player, int numTicks)
      Fast-forwards the game by some number of ticks, blocking until done.
      Parameters:
      player - Player performing tests.
      numTicks - Number of ticks to fast-forward by.

    • createTestingArea

      default void createTestingArea(net.minecraft.server.level.ServerPlayer player)
      Create a testing area to easily perform tests within. Useful to run before each tests to have a "fresh slate".
      Parameters:
      player - Player performing tests.

    • lookAt

      default void lookAt(net.minecraft.server.level.ServerPlayer player, net.minecraft.core.BlockPos pos)

    • setBlock

      default void setBlock(net.minecraft.server.level.ServerPlayer player, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.Block block)

    • setBlock

      default void setBlock(net.minecraft.server.level.ServerPlayer player, net.minecraft.core.BlockPos pos, net.minecraft.world.level.block.state.BlockState state)

    • setItemInMainHand

      default void setItemInMainHand(net.minecraft.server.level.ServerPlayer player, net.minecraft.world.item.Item item)

    • fromVec3

      default net.minecraft.core.BlockPos fromVec3(net.minecraft.world.phys.Vec3 vec3)

    • level

      default net.minecraft.server.level.ServerLevel level(net.minecraft.server.level.ServerPlayer player)

    • assertTrue

      default void assertTrue(boolean condition)

    • assertFalse

      default void assertFalse(boolean condition)

    • assertEquals

      default <T> void assertEquals(T expected, T actual)

    • assertEmpty

      default void assertEmpty(net.minecraft.world.item.ItemStack itemStack)

    • assertEmptyMainHand

      default void assertEmptyMainHand(net.minecraft.server.level.ServerPlayer player)