Struct E2EScenario 

pub struct E2EScenario<H> { /* private fields */ }

E2E test scenario builder and executor.

Provides structured E2E testing with step logging, timing, and detailed failure reporting. Automatically captures request/response data on failures.

Example

use fastapi_core::testing::{E2EScenario, TestClient};

let client = TestClient::new(app);
let mut scenario = E2EScenario::new("User Registration Flow", client);

scenario.step("Visit registration page", |client| {
    let response = client.get("/register").send();
    assert_eq!(response.status().as_u16(), 200);
});

scenario.step("Submit registration form", |client| {
    let response = client
        .post("/register")
        .json(&serde_json::json!({"email": "test@example.com", "password": "secret123"}))
        .send();
    assert_eq!(response.status().as_u16(), 201);
});

// Generate report
let report = scenario.report();
println!("{}", report.to_text());

Implementations

impl<H: Handler + 'static> E2EScenario<H>

pub fn new(name: impl Into<String>, client: TestClient<H>) -> Self

Creates a new E2E scenario.

pub fn description(self, desc: impl Into<String>) -> Self

Sets the scenario description.

pub fn stop_on_failure(self, stop: bool) -> Self

Configures whether to stop on first failure (default: true).

pub fn client(&self) -> &TestClient<H>

Returns a reference to the test client.

pub fn client_mut(&mut self) -> &mut TestClient<H>

Returns a mutable reference to the test client.

pub fn log(&mut self, message: impl Into<String>)

Logs a message to the scenario log.

pub fn step<F>(&mut self, name: impl Into<String>, f: F)

where F: FnOnce(&TestClient<H>) + UnwindSafe,

Executes a step in the scenario.

The step function receives a reference to the test client and should perform assertions. Panics are caught and recorded as failures.

pub fn try_step<F, E>(&mut self, name: impl Into<String>, f: F) -> Result<(), E>

where F: FnOnce(&TestClient<H>) -> Result<(), E>, E: Display,

Executes a step that returns a result (for more control over error handling).

pub fn passed(&self) -> bool

Returns whether the scenario passed (no failures).

pub fn steps(&self) -> &[E2EStep]

Returns the steps executed so far.

pub fn logs(&self) -> &[String]

Returns the log buffer.

pub fn report(&self) -> E2EReport

Generates a test report.

pub fn assert_passed(&self)

Asserts that the scenario passed, panicking with a detailed report if not.

Call this at the end of your test to ensure all steps passed.