marionette-test 0.1.0

Automated API testing tool for Spring projects, with custom action hooks and Essay-compatible evidence layout

marionette-test

Automated API testing tool for Spring projects, with custom action hooks and an Essay-compatible evidence layout.

Alpha — V1 backend-API surface is implemented and tested. See docs/marionette-test/ for the design specs and docs/guides/ for user-facing documentation.

Install

pip install marionette-test

Quick start

cd <your-project>
marionette-test init                  # scaffold workspace
$EDITOR config/env.yml                # point at your backend + DB
export DB_PASSWORD=... API_BEARER_TOKEN=...
marionette-test doctor                # six read-only checks
marionette-test run                   # execute every FeatureUnit
marionette-test serve                 # FastAPI + UI on :8765

A complete walk-through is in docs/guides/01-getting-started.md.

User guides

Guide	What it covers
01 — Getting Started	Install, scaffold, write & run your first test
02 — Writing FeatureUnits	Full YAML schema reference
03 — Custom Actions	@action, Context, 4 hook timings
04 — Database Baseline	pg_dump / pg_restore / clone lifecycle
05 — CLI Reference	Every subcommand and flag
06 — Variables & Assertions	${...} grammar, expect.* rule grammar

Develop locally

This repo uses uv for environment management.

uv sync                         # create .venv and install runtime + dev deps
uv run marionette-test --version
uv run pytest                   # full test suite
uv run ruff check src/ tests/

Build a wheel locally:

uv run hatch build              # produces dist/*.whl + *.tar.gz

Build the React UI (output lands inside the Python package so the wheel ships it):

cd web
npm install
npm run build                   # → src/marionette/test/web_dist/

License

MIT — see LICENSE.