# PackTest
\nPackTest allows you to write game tests in a data pack. Tests are `*.mcfunction` files in a `test` folder. They can be used to test custom data packs.<\/p>\n
## Example
\n**`data\/example\/test\/foo.mcfunction`**
\n“`mcfunction
\n#> Summons an armor stand and finds it
\n# @template example:small_platform
\n# @optional<\/p>\n
summon armor_stand ~1.5 ~1 ~1.5
\nexecute positioned ~1.5 ~1 ~1.5 run assert entity @e[type=armor_stand,dx=0]<\/p>\n
assert predicate example:test<\/p>\n
setblock ~1 ~1 ~1 grass_block
\nexecute if block ~1 ~1 ~1 stone run succeed<\/p>\n
fail “Oh no”
\n“`<\/p>\n
### Async tests
\nTest functions can be asynchronous, using the `await` keyword!
\n“`mcfunction
\nsetblock ~ ~ ~ stone
\nsummon item ~ ~6 ~<\/p>\n
await entity @e[type=item,distance=..2]<\/p>\n
await delay 1s<\/p>\n
data merge entity @e[type=item,distance=..2,limit=1] {Motion: [0.0, 0.01, 0.0]}
\n“`<\/p>\n
## Running tests ### Auto test server Setting `-Dpacktest.auto.annotations` will emit GitHub annotations for all test failures and resource load errors.<\/p>\n The following example can be adapted into a GitHub action workflow. env: jobs: ## Commands<\/p>\n ### `fail` ### `succeed` ### `assert` ### `await`
\nTests can be run in-game using the `test` command.
\n* `test runall`: runs all the tests
\n* `test runall
\n* `test run
\n* `test runfailed`: runs all the previously failed tests
\n* `test runthis`: runs the closes test
\n* `test runthese`: runs all tests within 200 blocks<\/p>\n
\nTests can also be run automatically, for instance in a CI environment. When `-Dpacktest.auto` is set, the game test server will start automatically with the loaded tests. The process will exit when all tests have finished with the exist code set to the number of failed tests. <\/p>\n
\n“`yaml
\non: [push, pull_request]<\/p>\n
\n # Make sure to update these links!
\n TEST_FABRIC_SERVER: https:\/\/meta.fabricmc.net\/v2\/versions\/loader\/1.20.4\/0.15.3\/0.11.2\/server\/jar
\n TEST_FABRIC_API: https:\/\/cdn.modrinth.com\/data\/P7dR8mSH\/versions\/JMCwDuki\/fabric-api-0.92.0%2B1.20.4.jar
\n TEST_PACKTEST: https:\/\/cdn.modrinth.com\/data\/XsKUhp45\/versions\/18smpIeE\/packtest-1.6-mc1.20.4.jar<\/p>\n
\n test:
\n runs-on: ubuntu-latest
\n steps:
\n – uses: actions\/checkout@v4
\n – uses: actions\/setup-java@v4
\n with:
\n distribution: ‘temurin’
\n java-version: ’17’
\n – name: Download and prepare files
\n run: |
\n curl -o server.jar $TEST_FABRIC_SERVER
\n mkdir mods
\n curl -o mods\/fabric-api.jar $TEST_FABRIC_API
\n curl -o mods\/packtest.jar $TEST_PACKTEST
\n mkdir -p world\/datapacks
\n cp -r datapack world\/datapacks\/datapack
\n – name: Run tests
\n run: |
\n java -Xmx2G -Dpacktest.auto -Dpacktest.auto.annotations -jar server.jar nogui
\n“`<\/p>\n
\n* `fail
\n* `succeed`: always succeeds the current test and returns from the function<\/p>\n
\n* `assert
\n* `assert not
\n* `await
\n* `await not
\n* `await delay