TestScript

A typed testing language for Web and API automation. Python interpreter · Lark grammar · .tscr files · tscr CLI.

User Guide · Language Reference · Examples · Español

0.2.0 / experimental. The implementation and language specification evolve together. Not yet published on PyPI. The PyPI name testscript belongs to an unrelated project; this distribution uses testscript-lang.

Install from source

Python 3.12+:

git clone https://github.com/angel-valdezzz/testscript.git
cd testscript
python -m pip install .

tscr --version
tscr check examples/core.tscr
tscr run examples/core.tscr

For browser automation:

python -m pip install ".[playwright]"
python -m playwright install chromium

Or python -m pip install ".[selenium]" with Chrome available. API and core examples do not need a browser.

A small language with a testing purpose

flow verifyName(name: String) {
    step "Validate the name" {
        expect len(name) > 0
    }
}

test "A valid user" tags ["smoke"] {
    verifyName("Angel")
}

• test: discoverable execution unit.
• flow: reusable behavior; can compose flows and return values.
• fn: pure data computation; no browser/HTTP/observability effects.
• fixture: setup and teardown, including cleanup after setup failure.
• record: typed immutable fields.
• data: CSV/JSON/YAML parameterization; one result per row.
• step: a named section in the execution timeline.
• expect: assertions; catching an assertion does not erase its failure.

Commands

Repeat --tag for OR inclusion; repeat --exclude-tag to exclude any matching tag. --name is a case-sensitive title substring. Exit codes: 0 passed/skipped, 1 test failure, 2 invalid input/configuration, 5 no tests selected.

Development

python -m pip install -e ".[dev,playwright,selenium]"
python -m pytest
python -m ruff check src tests
python scripts/check_docs.py
python scripts/build_docs.py
python -m build

See specification, architecture, roadmap and contributing.

Credits

Built on Python, Lark, HTTPX, PyYAML, Playwright/Selenium and MkDocs Material. TestScript is an independent project; it is not affiliated with these projects or the existing PyPI package named testscript.

MIT · Angel Gerardo Molina Valdez