pawntest

README

pawntest

A Go CLI for discovering, compiling, and running Pawn tests for SA-MP and open.mp projects. Tests run on the pure-Go pawnkit/goamx backend, so no game server is required.

See Installation for release binaries and supported platforms.

Quick start

pawntest ./tests
pawntest --list ./tests
pawntest doctor

Pass a compiler or additional include directory when needed:

pawntest ./tests --pawncc ./tools/pawncc -i include

Test source files must end in .test.pwn or .test.inc. Source and precompiled AMX tests must include <pawntest>.

Output formats

pawntest ./tests --format plain
pawntest ./tests --format json
pawntest ./tests --format tap
pawntest ./tests --format junit --output test-results.xml

Configuration

Pawntest reads pawn.json or pawn.yaml from the project root. A local pawntest.json, pawntest.yaml, pawntest.yml, or pawntest.toml can override the project settings.

pawncc  = "./tools/pawncc"
include = ["include"]
tests   = ["tests/..."]
format  = "plain"

See Configuration for all options.

Documentation

• Runnable examples
• Usage
• Installation
• Writing tests
• Assertions
• Fixtures
• Mocking
• Native providers
• Scenario fidelity
• Compatibility
• Go API
• Reports
• Limitations

Contributing

Small test cases, runner fixes, and documentation corrections are welcome. See CONTRIBUTING.md.