Minecraft:GameTest

Template:Hatnote Template:Hatnote GameTest is an automated end-to-end (E2E) testing framework for testing aspects of Minecraft. Each test contains a structure, parameters for how the test gets executed, and optional code to further specify the test behavior.

Java Edition

Test instance

File:Test instance block UI.png

UI of test instance block

Test instance can be defined in a datapack by creating a Minecraft:JSON file in the

1. REDIRECT Template:Code

Template:Redr registry. Players can inspect information about them using a

1. redirect Template:blockLink

Template:Redr. A test instance has the following properties:

• It belongs to a test environment, which groups the test and further specifies the environment in which the test is run in. (Template:Nbt/spriteTemplate:Nbt/sprite environment)
• It is associated with a Template:Nbt/sprite structure, which should contain all the blocks and entities it needs to be run. The structure can be easily altered with the test instance block.
• It can either be a block-based test or a function test. More information is available below.

There are more configuration available for test instances. For more information on the format, see test instance definition.

Block-based

In block-based tests, Test blocks are used inside the test structure to control the test logic using redstone signal.

1. redirect Template:BlockSprite

Template:Redr Start: A redstone pulse is triggered when the test starts.

1. redirect Template:BlockSprite

Template:Redr Log: Logs a message to the log file when powered by redstone.

1. redirect Template:BlockSprite

Template:Redr Fail: Fails the test when powered by redstone.

1. redirect Template:BlockSprite

Template:Redr Accept: Completes the test when powered by redstone.

If a race condition occurs, the first test block activated always wins.

Function

Function tests rely on built-in test functions to determine a test's success or failure. They are meant to be used by Mojang internally and by Minecraft:mod developers.

The game provides the GameTest framework interfaces through the net.minecraft.gametest.framework package (Mojang mapping). Mod loaders can use these to provide their own API for developers to use the GameTest framework – please refer to the respective documentation for Fabric and NeoForge for more information.

A test function must be registered in the test_function registry to be referenced in the test instance. The Template:Nbt/sprite function field in the test instance definition should contain the resource location of the test function.

Test environment

{{#vardefine:params|0 }}Template:Hatnote

Test environment is a way to group up test instances and give them the right preconditions to run. It can be defined in a datapack by either creating a Minecraft:JSON file in the

1. REDIRECT Template:Code

Template:Redr registry or directly specified the environment inline with the Template:Nbt/sprite batch field. It can also use the test environment of the vanilla data package

1. REDIRECT Template:Code

Template:Redr, which is empty preconditions.

Test command

{{#vardefine:params|0 }}Template:Hatnote The

1. REDIRECT Template:Command

Template:Redr command exists to execute and manage block-based tests. Some notable sub-commands include:

• /test (run|runmultiple) <tests> ... sub-commands can run specific test(s) for a number of times by their identifier.
• /test (runclosest|runthat|runthese) ... sub-commands can run test(s) based on the player's location.
• /test (resetclosest|resetthat|resetthese) sub-commands reset the test structures for any tests.
• /test locate <tests> locates test in loaded chunks.

Server.jar entry point

The net.minecraft.gametest.Main entry point is included in Minecraft:server.jar which starts a server, runs all available game tests and then exits. It can be invoked in the command line, such as:

<syntaxhighlight lang="bash"> java -DbundlerMainClass="net.minecraft.gametest.Main" -jar server.jar [<options>] </syntaxhighlight>

Command-line options

1. REDIRECT Template:Code

Template:Redr - Shows usage information

1. REDIRECT Template:Code

Template:Redr - Set a folder of datapacks to include in the world

• • Any zip file or folder with a

1. REDIRECT Template:Code

Template:Redr file is included

1. REDIRECT Template:Code

Template:Redr - Exports results in a junit-like XML report at the given path

1. REDIRECT Template:Code

Template:Redr - Specify which tests to run with a selection - a wildcard expression matching namespace test instance IDs

• • If omitted, or used with an empty ID, runs all tests

1. REDIRECT Template:Code

Template:Redr - The path to where the test server world will be created

• • Any existing folder will be replaced
  • Default:

1. REDIRECT Template:Code

1. REDIRECT Template:Code

Template:Redr - Enables test verification

• • Runs the tests specified with

1. REDIRECT Template:Code

Template:Redr or

1. REDIRECT Template:Code

Template:Redr 100 times for each 90 degree rotation step

• • Default:

1. REDIRECT Template:Code

Exit code

The game will yield the following exit codes depending on the scenario:

Scenario	Exit code
All tests pass	0
Any test fails	(number of failures)
Server shut down without starting tests	-1
Game crashed	1

Bedrock Edition

The GameTest framework can be accessed through the @minecraft/server-gametest module from the Script API. The module must be added as a dependency in the Minecraft:manifest.json. It contains many

1. REDIRECT Template:Wikipedia

Template:Redrs used for

1. REDIRECT Template:Wikipedia

Template:Redr of any game objects' behaviors and interactions in a controlled testing environment.<ref>Template:Cite</ref> Developers can use these interfaces for:

• Asserting certain conditions for Minecraft:blocks, entities, and other game objects;
• Getting in-game information such as Minecraft:dimension, position, entities and blocks information;
• Modifying the testing environment by setting block permutation (block type and states data), sending Minecraft:redstone interactions, etc;
• Spawning entities controlled by the script with predictable mob behaviors;
• Creating simulated players for testing behaviors and interactions with other game objects;<ref>Template:Cite</ref>
• And other testing functionalities, further reading.

A testing environment can be created from a unit test (also called a GameTest), which contains a test function registered from the script, and a reference to a .mcstructure file exists in the behavior pack.<ref>Template:Cite</ref><ref name="registration-builder"/> Users can register a new unit test using GameTest#register(testClassName, testName, testFunction) method with additional builder parameters, such as .maxTicks(ticks) that indicates the test may take amount of ticks to run, .maxAttempts(attempts) which specifies how many attempt the test can run, and more.<ref name="registration-builder">Template:Cite</ref>

After the unit test is registered, it is loaded in the world, and can be run using the

1. REDIRECT Template:Command

Template:Redr command, referenced by <testClassName>:<testName>. When ran, the game spawns the test structure and calls the test function previously defined in the script. The unit test may succeed or fail depending on the test function, which usually contain instructions for testing behaviors and interactions in the testing environment.

History

References

<references group="">

 </references>

Navigation

Concepts Template:BlockLink Template:EnvLink Template:EffectLink Template:Nbt Loot context Template:EntityLink Template:BlockLink Template:File Identifier Template:BlockLink Template:EnvLink Template:ItemLink Template:ItemLink Template:EnvLink Template:BlockLink General format Template:EnvLink Template:LegacyBlockLink Remake Template:EntityLink Template:BlockLink Template:EnvLink Template:BlockLink Template:EnvLink Template:ItemLink Template:Nbt NBT format Template:EffectLink Template:ItemLink § Formatting codes Template:FileLink Template:FileLink Template:BlockLink Template:EnvLink World Template:EnvLink Template:EnvLink Anomalous Template:EnvLink Legacy Template:EnvLink Level format Template:BlockLink Template:EnvLink Template:EntityLink Template:BlockLink Template:EntityLink Template:BlockLink Template:EnvLink Legacy Template:LegacyBlockLink Classic server protocol Template:EntityLink Template:EnvLink Template:LegacyItemLink Template:ItemLink Template:FileLink Template:EnvLink Template:EnvLink .minecraft Template:File client.jar Template:EnvLink Template:ItemLink Template:BlockLink Template:Blocklink Template:FileLink Template:EnvLink Template:ItemLink Template:FileLink Tools Template:Keys Debug screen hotkey renderer Template:FileLink Template:BlockLink Template:FileLink Template:BlockLink Sound Template:BlockLink Template:EnvLink Template:EnvLink Commands Brigadier Template:BlockLink All commands Launching Mojang API Template:FileLink Template:FileLink Legacy Legacy Minecraft authentication Yggdrasil Protocol Template:EnvLink Template:ItemLink Data types Template:BlockLink Server Template:File server.jar Template:BlockLink Template:BlockLink Template:BlockLink Operator list Protocols Query RCON Server Management Protocol Legacy al_version Template:EnvLink

Components Template:Mono Template:EnvLink Template:ItemLink Template:BlockLink Template:BlockLink Template:ItemLink Template:BlockLink Template:BlockLink Template:EffectLink Template:EnvLink Template:ItemLink Template:BlockLink Template:ItemLink Template:BlockLink Template:ItemLink Template:BlockLink Template:BlockLink Template:EntityLink Template:ItemLink Template:ItemLink Template:ItemLink Template:ItemLink Template:EntityLink Trade set World Clock Template:EntityLinkTemplate:Upcoming Tag Template:BlockLink Template:EnvLink Template:BlockLink Template:ItemLink Template:EnvLink Template:BlockLink Template:BiomeLink Template:EnvLink Template:EnvLink Template:EnvLink Template:BlockLink Template:ItemLink Template:BlockLink Template:ItemLink Template:Healthbar Damage type Template:ItemLink Template:ItemLink Template:ItemLink Template:ItemLink Template:EntityLink Template:FileLink GameTest Template:BlockLink Template:BlockLink World generation Dimension Template:EnvLink Template:EnvLink Template:EnvLink Template:EnvLink Template:FileLink Template:EnvLink Template:EnvLink Environment attribute Noise settings Template:EnvLink Template:EnvLink Noises Template:EnvLink Structures Template:EnvLink Template:BlockLink Template:BlockLink Template:EnvLink Removed Template:ItemLink Data packs Template:BlockLink Template:ItemLink Tutorials Template:EnvLink Template:FileLink Optimizing Template:BlockLink Repairing a world corrupted by a data pack Content Template:ItemLink Template:ItemLink Template:ItemLink World generation Template:EnvLink Template:EnvLink

Components Template:Mono Template:EnvLink Template:EnvLink Template:EntityLink Template:BlockLink Template:EnvLink Template:EnvLink (sounds.json) Shaders Template:EnvLink Template:ItemLink Aa Fonts Template:BlockLink Template:File Texts Template:FileLink regional_compliancies.json Template:ItemLink Debug Missing font character Template:BlockLink Template:BlockLink Tools Slicer Legacy Texture Ender Unstitcher Tutorials Template:FileLink Template:FileLink Template:EnvLink Template:EnvLink

Editions	Merged Template:Edition Template:Edition Ports to consoles Template:Wikipedia Template:Wikipedia Template:Wikipedia Template:Wikipedia Template:Wikipedia Discontinued Template:Edition Template:Edition Template:Edition
Development	Version history Template:LegacyBlockLink Template:EntityLink Template:FileLink Template:FileLink Template:EnvLink Template:ItemLink Template:BlockLink Template:InvLink Template:EntityLink Template:FileLink Template:EntityLink
Technical	Template:EffectLink Template:FileLink Template:FileLink Template:File com.mojang Template:FileLink Template:File Installation files Template:FileLink Template:FileLink Template:FileLink Template:FileLink Template:BlockLink Template:File Identifier Template:FileLink Template:ItemLink Template:EnvLink Template:EnvLink Anomalous Template:ItemLink Template:EnvLink § Formatting codes Simulation distance Template:BlockLink Template:FileLink Template:FileLink Template:EnvLink Template:FileLink Template:EntityLink Template:BlockLink Development resources Template:Nbt NBT format Template:Nbt Level format Template:EnvLink Protocol Template:EnvLink RakNet Creator Template:File Official documentation Template:FileLink Template:EntityLink Template:File File extensions Template:FileLink Add-ons Template:ItemLink Template:EnvLink Template:EnvLink Template:EnvLink Template:EnvLink Template:FileLink Template:EnvLink Template:EnvLink Template:BiomeLink Template:EnvLink Family Spawn event Template:ItemLink Template:BlockLink Template:EnvLink Template:BiomeLink Template:EnvLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink manifest.json Template:EnvLink Template:Nbt Molang Template:BlockLink
Multiplayer	Template:FileLink Featured servers Event servers Server list Template:FileLink Template:FileLink Template:FileLink Template:FileLink
Exclusive features	Template:FileLink Template:FileLink Template:FileLink Template:FileLink Template:FileLink Template:EnvLink Template:EnvLink Template:ItemLink Template:FileLink Template:FileLink Template:EnvLink Template:EnvLink Template:EnvLink Template:PersonaLink Template:EnvLink Loading tips Template:FileLink Ray Tracing Template:BiomeLink Template:EnvLink Blocks Template:BlockLink Template:BlockLink Mobs Template:EntityLink Template:EntityLink Effects Template:EffectLink Unused Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:BlockLink Template:EntityLink Template:EntityLink Template:BiomeLink Template:EnvLink
Removed	Template:BlockLink Template:EnvLink Template:EnvLink Template:FileLink Pocket Edition protocol Legacy

de:Spieltest ja:ゲームテスト pt:GameTest ru:Игровой тест zh:游戏测试