Enum StepDef 

pub enum StepDef {
    Add {
        service: String,
        args: Option<String>,
        env: BTreeMap<String, String>,
        timeout: u64,
    },
    Remove {
        service: String,
    },
    Wait {
        service: String,
        timeout: u64,
    },
    Shell {
        name: String,
        run: String,
        timeout: u64,
        poll: Option<PollConfig>,
    },
    Http {
        name: Option<String>,
        url: String,
        method: HttpMethod,
        body: Option<String>,
        content_type: String,
        headers: BTreeMap<String, String>,
        status: u16,
        service: Option<String>,
        poll: Option<PollConfig>,
        timeout: u64,
    },
    Playwright {
        name: Option<String>,
        spec: String,
        env: BTreeMap<String, String>,
        timeout: u64,
    },
    Mail {
        name: Option<String>,
        mailbox: String,
        contains: Option<String>,
        poll: PollConfig,
        timeout: u64,
    },
}

A lifecycle test step — serde deserializes directly into the correct variant based on the action field. Invalid field combinations are rejected at parse time rather than runtime.

Variants

Add

Fields

service: String

args: Option<String>

env: BTreeMap<String, String>

timeout: u64

Remove

Fields

service: String

Wait

Fields

service: String

timeout: u64

Shell

Shell command step. Fails the test on non-zero exit code.

Fields

name: String

run: String

timeout: u64

poll: Option<PollConfig>

Optional retry configuration. When set, the runner re-executes the command on failure, up to attempts times.

Http

HTTP request step. Sends a request and checks the response status code. The URL supports shell variable expansion (e.g., $SERVICE_PORT_HTTP) after sourcing service .env files. Follows redirects automatically.

Fields

name: Option<String>

url: String

method: HttpMethod

body: Option<String>

Request body for POST/PUT. Shell heredoc-safe: arbitrary bytes are supported including quotes and newlines.

content_type: String

Content-Type header for requests with a body. Defaults to application/json since most API triggers we use ship JSON.

headers: BTreeMap<String, String>

Extra request headers (e.g., apikey, Authorization). Values support shell variable expansion after .env sourcing.

status: u16

service: Option<String>

When set, only source this service’s .env file (needed when multiple services define the same port variable).

poll: Option<PollConfig>

timeout: u64

Playwright

Playwright browser test step.

Fields

name: Option<String>

spec: String

env: BTreeMap<String, String>

timeout: u64

Mail

Inbucket mail-delivery assertion. Polls inbucket’s /api/v1/mailbox/ <mailbox> endpoint until a non-empty response arrives; when contains is set, additionally requires that substring in the raw JSON body. Collapses the 8-line port-discovery + curl-poll pattern that previously lived in every SMTP test into one step.

Fields

name: Option<String>

mailbox: String

Local-part of the recipient address (smtptest for smtptest@example.com).

contains: Option<String>

Optional substring required in the response body. Matches against the raw inbucket JSON, which includes subject + body.

poll: PollConfig

Retry config. Defaults favour short SMTP mail delivery; apps with async mail queues (twenty, supabase) should widen these.

timeout: u64

Implementations

impl StepDef

pub fn service(&self) -> Option<&str>

The service name referenced by this step, if any.

pub fn is_setup(&self) -> bool

Whether this step is a setup step (vs. a test/assertion step). Used by --retest to skip setup and only re-run test steps.

pub fn step_name(&self) -> String

Human-readable name for this step (used in output).

pub fn describe(&self) -> Vec<String>

Multi-line description for --list -v. Shows every field that meaningfully changes behaviour (args, env, headers, body, …). The caller indents each returned line.

Trait Implementations

impl Clone for StepDef

fn clone(&self) -> StepDef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StepDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StepDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StepDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.