Struct FailScenario

pub struct FailScenario { /* private fields */ }

Test scenario with configured fail points.

Implementations

impl FailScenario

pub fn setup(fp_registry: Arc<FailPointRegistry>) -> Self

Set up the system for a fail points scenario.

Configures all fail points specified in the FAILPOINTS environment variable. It does not otherwise change any existing fail point configuration.

The format of FAILPOINTS is failpoint=actions;..., where failpoint is the name of the fail point. For more information about fail point actions see the cfg function and the fail_point macro.

FAILPOINTS may configure fail points that are not actually defined. In this case the configuration has no effect.

This function should generally be called prior to running a test with fail points, and afterward paired with teardown.

Panics

Panics if an action is not formatted correctly.

pub fn teardown(self)

Tear down the fail point system.

Clears the configuration of all fail points. Any paused fail points will be notified before they are deactivated.

This function should generally be called after running a test with fail points. Calling teardown without previously calling setup results in a no-op.

Trait Implementations

impl Debug for FailScenario

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

Formats the value using the given formatter.

impl Drop for FailScenario

fn drop(&mut self)

Executes the destructor for this type.