pytest-minecraft

A pytest plugin for running tests against Minecraft releases.

The plugin automatically downloads the latest version of the Minecraft client into the pytest cache. The provided fixtures can also extract the vanilla resource pack and data pack on demand.

Installation

The package can be installed with pip.

$ pip install pytest-minecraft

Usage

Downloading the Minecraft client takes a few seconds so the tests that use the fixtures provided by the plugin will be skipped unless explicitly enabled with a command-line flag. The --minecraft-latest flag will enable the tests and run them against the latest stable release.

$ pytest --minecraft-latest

You can also use the --minecraft-snapshot flag to test against the latest snapshot. Both flags can be specified at the same time to run the tests against both stable and snapshot releases.

$ pytest --minecraft-latest --minecraft-snapshot

Fixtures

• The minecraft_client_jar fixture returns the path to the downloaded Minecraft client as a pathlib.Path instance.

  def test_with_client(minecraft_client_jar):
      assert minecraft_client_jar.name == "client.jar"
  
      with ZipFile(minecraft_client_jar) as client:
          assert len(client.namelist()) > 10_000

• The minecraft_resource_pack fixture returns the path to the extracted vanilla resource pack as a pathlib.Path instance.

  def test_with_resource_pack(minecraft_resource_pack):
      assert minecraft_resource_pack.name == "resource_pack"
      assert (minecraft_resource_pack / "assets" / "minecraft" / "textures").is_dir()

• The minecraft_data_pack fixture returns the path to the extracted vanilla data pack as a pathlib.Path instance.

  def test_with_data_pack(minecraft_data_pack):
      assert minecraft_data_pack.name == "data_pack"
      assert (minecraft_data_pack / "data" / "minecraft" / "loot_tables").is_dir()

Contributing

Contributions are welcome. This project uses poetry.

$ poetry install

You can run the tests with poetry run pytest.

$ poetry run pytest

The code follows the black code style.

$ poetry run black .

License - MIT