Struct TestJobContext 

pub struct TestJobContext {
    pub job_id: Uuid,
    pub job_type: String,
    pub attempt: u32,
    pub max_attempts: u32,
    pub auth: AuthContext,
    /* private fields */
}

Test context for job functions.

Provides an isolated testing environment for jobs with progress tracking, retry simulation, cancellation testing, and HTTP mocking.

Example

let ctx = TestJobContext::builder("export_users")
    .with_job_id(Uuid::new_v4())
    .build();

// Simulate progress
ctx.progress(50, "Halfway there")?;

// Verify progress was recorded
assert_eq!(ctx.progress_updates().len(), 1);

// Test cancellation
ctx.request_cancellation();
assert!(ctx.is_cancel_requested().unwrap());

Fields

job_id: Uuid

Job ID.

job_type: String

Job type name.

attempt: u32

Current attempt number (1-based).

max_attempts: u32

Maximum attempts allowed.

auth: AuthContext

Authentication context.

Implementations

impl TestJobContext

pub fn builder(job_type: impl Into<String>) -> TestJobContextBuilder

Create a new builder.

pub fn db(&self) -> Option<&PgPool>

Get the database pool (if available).

pub fn http(&self) -> &MockHttp

Get the mock HTTP client.

pub fn progress(&self, percent: u8, message: impl Into<String>) -> Result<()>

Report job progress.

pub fn progress_updates(&self) -> Vec<TestProgressUpdate>

Get all progress updates.

pub fn saved(&self) -> Value

Get all saved job data.

pub fn set_saved(&self, data: Value) -> Result<()>

Replace all saved job data.

pub fn save(&self, key: &str, value: Value) -> Result<()>

Save a key-value pair to job data.

pub fn is_retry(&self) -> bool

Check if this is a retry attempt.

pub fn is_last_attempt(&self) -> bool

Check if this is the last attempt.

pub async fn heartbeat(&self) -> Result<()>

Simulate heartbeat (no-op in tests, but records the intent).

pub fn is_cancel_requested(&self) -> Result<bool>

Check if cancellation has been requested.

pub fn check_cancelled(&self) -> Result<()>

Return an error if cancellation has been requested.

Use this in job handlers to check for cancellation and exit early.

pub fn request_cancellation(&self)

Request cancellation (for testing cancellation flows).

After calling this, is_cancel_requested() returns true and check_cancelled() returns an error.

pub fn env_mock(&self) -> &MockEnvProvider

Get the mock env provider for verification.

Trait Implementations

impl EnvAccess for TestJobContext

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>

Get a required environment variable.

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

where T::Err: Display,

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

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

where T::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.