Struct TestWorkflowContext 

pub struct TestWorkflowContext {
    pub run_id: Uuid,
    pub workflow_name: String,
    pub version: u32,
    pub started_at: DateTime<Utc>,
    pub auth: AuthContext,
    /* private fields */
}

Test context for workflow functions.

Provides an isolated testing environment for workflows with step tracking, resume simulation, and durable sleep verification.

Example

let ctx = TestWorkflowContext::builder("account_verification")
    .with_run_id(Uuid::new_v4())
    .build();

ctx.record_step_start("validate_email");
ctx.record_step_complete("validate_email", json!({"valid": true}));

assert!(ctx.is_step_completed("validate_email"));

Fields

run_id: Uuid

Workflow run ID.

workflow_name: String

Workflow name.

version: u32

Workflow version.

started_at: DateTime<Utc>

When the workflow started.

auth: AuthContext

Authentication context.

Implementations

impl TestWorkflowContext

pub fn builder(workflow_name: impl Into<String>) -> TestWorkflowContextBuilder

Create a new builder.

pub fn db(&self) -> Option<&Pool<Postgres>>

Get the database pool (if available).

pub fn http(&self) -> &MockHttp

Get the mock HTTP client.

pub fn is_resumed(&self) -> bool

Check if this is a resumed execution.

pub fn workflow_time(&self) -> DateTime<Utc>

Get the deterministic workflow time.

pub fn tenant_id(&self) -> Option<Uuid>

Get the tenant ID.

pub fn is_step_completed(&self, name: &str) -> bool

Check if a step is completed.

pub fn is_step_started(&self, name: &str) -> bool

Check if a step has been started (exists in step states).

pub fn get_step_result<T>(&self, name: &str) -> Option<T>

where T: DeserializeOwned,

Get the result of a completed step.

pub fn record_step_start(&self, name: &str)

Record step start.

pub fn record_step_complete(&self, name: &str, result: Value)

Record step completion.

pub async fn record_step_complete_async(&self, name: &str, result: Value)

Record step completion (async version for API compatibility).

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

Get completed step names in order.

pub async fn sleep(&self, _duration: Duration) -> Result<(), ForgeError>

Durable sleep (no-op in tests, but records the intent).

pub fn sleep_called(&self) -> bool

Check if sleep was called.

pub fn elapsed(&self) -> TimeDelta

Get elapsed time since workflow started.

pub fn env_mock(&self) -> &MockEnvProvider

Get the mock env provider for verification.

Trait Implementations

impl EnvAccess for TestWorkflowContext

fn env_provider(&self) -> &dyn EnvProvider

Get the environment provider.

fn env(&self, key: &str) -> Option<String>

Get an environment variable.

fn env_or(&self, key: &str, default: &str) -> String

Get an environment variable with a default value.

fn env_require(&self, key: &str) -> Result<String, ForgeError>

Get a required environment variable.

fn env_parse<T>(&self, key: &str) -> Result<T, ForgeError>

where T: FromStr, <T as FromStr>::Err: Display,

Get an environment variable and parse it to the specified type.

fn env_parse_or<T>(&self, key: &str, default: T) -> Result<T, ForgeError>

where T: FromStr, <T as FromStr>::Err: Display,

Get an environment variable and parse it, with a default.

fn env_contains(&self, key: &str) -> bool

Check if an environment variable is set.