Skip to content
GitHub Get started

Guides

The pattern book.

Seven short guides, one task each. Every sample compiles against rstest-bdd 0.6.0, and each guide ends at the matching section of the full user’s guide.

Start with feature files
At dusk on a patchwork quilt, the rabbit reads a felt pattern book beside a lantern, Marrow the crab climbs out of an open sewing box with a spool of rust-red wool, and the robot lines up spools of thread by colour.
The sewing box Clover reads the pattern while Marrow fetches the thread and Bobbin sorts the spools.

All guides

Guide 1 of 7

Write feature files

Scenarios, Background, Scenario Outlines, data tables, docstrings, tags, and feature files in other languages.

Covers Gherkin, Examples, tables, docstrings Guide 2 of 7

Define steps

Step patterns, typed placeholders, and steps that return a value for the next step to use.

Covers #[given], #[when], #[then], placeholders Guide 3 of 7

Fixtures and state

Fixtures as the world: &mut access in steps, a fresh fixture per scenario, and what should really be shared.

Covers #[fixture], &mut, Slot, #[once] Guide 4 of 7

Bind and filter scenarios

#[scenario] for one scenario, scenarios! for a directory, tag expressions, and skipping with a reason.

Covers #[scenario], scenarios!, tags, skip! Guide 5 of 7

Async scenarios

Async steps on Tokio's current-thread runtime, and which of the two async forms to reach for.

Covers async fn steps, #[tokio::test] Guide 6 of 7

Tooling

Strict compile-time validation, cargo bdd, the language server, and JSON and JUnit reports.

Covers validation, cargo bdd, rstest-bdd-lsp Guide 7 of 7

Migrate to 0.6

What changed from 0.5: fixture-name normalization, Result aliases that now fail, the Tokio runtime alias, HarnessResult, and Rust 1.88.

Covers the 0.5 to 0.6 upgrade Reference

The full user’s guide

Every feature, organized by the three amigos, in the df12 reference library.

Covers everything, at length