Skip to main content

MockInterceptor

Struct MockInterceptor 

Source
pub struct MockInterceptor { /* private fields */ }
Expand description

A StepInterceptor built from closures.

Built by TestEngine; a step kind with no mock attached falls through to the real executor.

§Examples

use ironflow_engine::config::{ShellConfig, StepConfig};
use ironflow_engine::executor::StepInterceptor;
use ironflow_engine::testing::{MockInterceptor, MockShellOutput};

let interceptor = MockInterceptor::new().shell(|_cfg| Ok(MockShellOutput::ok("mocked")));
let config = StepConfig::Shell(ShellConfig::new("./deploy.sh"));

let output = interceptor
    .intercept(&config)
    .expect("shell steps are mocked")
    .expect("the mock succeeded");
assert_eq!(output.stdout(), "mocked");

Implementations§

Source§

impl MockInterceptor

Source

pub fn new() -> Self

An interceptor that mocks nothing.

§Examples
use ironflow_engine::config::{ShellConfig, StepConfig};
use ironflow_engine::executor::StepInterceptor;
use ironflow_engine::testing::MockInterceptor;

let interceptor = MockInterceptor::new();
let config = StepConfig::Shell(ShellConfig::new("echo hi"));
assert!(interceptor.intercept(&config).is_none());
Source

pub fn shell( self, f: impl Fn(&ShellConfig) -> Result<MockShellOutput, OperationError> + Send + Sync + 'static, ) -> Self

Answer every shell step with f.

§Examples
use ironflow_engine::testing::{MockInterceptor, MockShellOutput};

let interceptor = MockInterceptor::new()
    .shell(|cfg| Ok(MockShellOutput::ok(&format!("ran {}", cfg.command))));
Source

pub fn http( self, f: impl Fn(&HttpConfig) -> Result<MockHttpResponse, OperationError> + Send + Sync + 'static, ) -> Self

Answer every HTTP step with f.

§Examples
use ironflow_engine::testing::{MockHttpResponse, MockInterceptor};
use serde_json::json;

let interceptor = MockInterceptor::new()
    .http(|_cfg| Ok(MockHttpResponse::ok(&json!({"ok": true}))));
Source

pub fn approval(self, outcome: ApprovalOutcome) -> Self

Resolve every approval gate with outcome.

§Examples
use ironflow_engine::testing::{ApprovalOutcome, MockInterceptor};

let interceptor = MockInterceptor::new().approval(ApprovalOutcome::Approved);
Source

pub fn human_input( self, f: impl Fn(&str, &HumanInputConfig) -> HumanInputOutcome + Send + Sync + 'static, ) -> Self

Answer every human input step with f.

§Examples
use ironflow_engine::testing::{HumanInputOutcome, MockInterceptor};
use serde_json::json;

let interceptor = MockInterceptor::new()
    .human_input(|_name, _cfg| HumanInputOutcome::Provided(json!({"answers": ["yes"]})));

Trait Implementations§

Source§

impl Clone for MockInterceptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MockInterceptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MockInterceptor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl StepInterceptor for MockInterceptor

Source§

fn intercept( &self, config: &StepConfig, ) -> Option<Result<StepOutput, EngineError>>

Return Some(result) to short-circuit this step, None to execute it for real.
Source§

fn intercept_approval( &self, _name: &str, _config: &ApprovalConfig, ) -> Option<ApprovalOutcome>

Resolve an approval gate instead of suspending the run. Read more
Source§

fn intercept_human_input( &self, name: &str, config: &HumanInputConfig, _schema: &Value, ) -> Option<HumanInputOutcome>

Answer a human input step instead of suspending the run. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more