Testing

Running Tests

Tests require a temporary game directory with migrations applied. Tests use Django's test runner, not pytest.

Using `uv run` (preferred)

The make targets call bare evennia, which only works if evennia is installed in the active shell environment. With uv run, you must run the init/migrate/test steps yourself, and run the test command from inside the game directory:

# One-time setup (creates .test_game_dir/ and applies migrations):
uv run evennia --init .test_game_dir
cd .test_game_dir
uv run evennia migrate

# Run tests (from inside .test_game_dir/):
uv run evennia test --keepdb evennia.server.tests          # specific module
uv run evennia test --keepdb evennia                        # full suite

If .test_game_dir/ already exists with migrations applied, skip straight to the test command.

Fallback: private index / auth errors

If uv run fails while resolving or building packages with a keyring, gcloud, or Missing password for <url> error, your user-level uv config (~/.config/uv/uv.toml) likely points at a private, authenticated package index. Evennia itself declares no custom index, so add --no-config (or set UV_NO_CONFIG=1) to make uv ignore config files and fall back to public PyPI:

UV_NO_CONFIG=1 uv run --no-config evennia --init .test_game_dir
cd .test_game_dir
UV_NO_CONFIG=1 uv run --no-config evennia migrate
UV_NO_CONFIG=1 uv run --no-config evennia test --keepdb evennia.utils.tests.test_evmenu

The same flag works for formatting: uv run --no-config isort --profile black . and uv run --no-config black evennia.

Using `make` (requires `evennia` on PATH)

These targets handle init/migrate automatically but require evennia installed in the current environment (e.g., via pip install -e . or an activated virtualenv):

make test                                        # full suite
make testp                                       # parallel (4 cores)
make TESTS=evennia.objects.tests test             # specific module
make TESTS=evennia.commands.tests.test_command test  # specific test file

The Makefile creates .test_game_dir/, runs evennia migrate, then evennia test --keepdb.

Test Base Classes

All in evennia/utils/test_resources.py:

BaseEvenniaTest — sets up default objects (account, char1, char2, room1, room2, obj1, obj2, exit, script, session) with enforced default settings. Use this for testing Evennia library code.
BaseEvenniaCommandTest — extends BaseEvenniaTest, adds .call(CmdClass, input, expected_output) for testing command execution.
EvenniaTest / EvenniaCommandTest — same but uses game-dir settings/typeclasses (for downstream game tests, not Evennia library tests).
EvenniaTestCase — lightweight, no default objects created. Faster for tests that don't need game state.

Agent Tooling Tests

Tests for .agents/tools/ use pytest (not Django's runner). Run with:

uv run pytest .agents/tools/tests/ -v

Do not use bare python -m pytest — the system Python may not have pytest installed. uv run ensures the project venv is used.

CI Matrix

CI tests against SQLite, MySQL 8.0, and PostgreSQL 14 across Python 3.12/3.13/3.14. Coverage is collected on Python 3.12 + SQLite only.

3.3 KiB Raw Blame History