Skip to main content

MockDaemon

Struct MockDaemon 

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

An in-process daemon for unit tests.

Implementations§

Source§

impl MockDaemon

Source

pub fn start() -> Result<Self>

Starts a daemon on a runtime of its own choosing.

§Errors

NodeError::Runtime when no runtime is running and one cannot be built.

Source

pub fn start_with( runtime: NodeRuntime, dataflow: DataflowId, auth: AuthToken, ) -> Result<Self>

Starts a daemon with an explicit runtime, dataflow and token.

§Errors

Nothing today; the signature is fallible so a future backing store can report a failure without a breaking change.

Source

pub fn dataflow(&self) -> DataflowId

The dataflow every node joins.

Source

pub fn auth(&self) -> AuthToken

The token the greeting requires.

Source

pub fn runtime(&self) -> &NodeRuntime

The runtime the serving tasks run on.

Source

pub fn node_ids(&self) -> Vec<NodeId>

The nodes currently connected.

Source

pub fn connect_node(&self, spec: NodeSpawnSpec) -> Result<(Node, EventStream)>

Connects a node with the given specification.

§Errors

NodeError::Testing when the greeting or registration fails, plus whatever NodeBuilder::finish reports.

Source

pub async fn connect_node_async( &self, spec: NodeSpawnSpec, ) -> Result<(Node, EventStream)>

Source

pub fn send_event(&self, node: &NodeId, event: NodeEvent) -> Result<()>

Sends an arbitrary event to a node.

§Errors

NodeError::Testing when no such node is connected.

Source

pub fn send_input( &self, node: &NodeId, input: &DataId, metadata: Metadata, payload: Vec<u8>, ) -> Result<()>

Delivers one input message to a node.

§Errors

As MockDaemon::send_event.

Source

pub fn close_input( &self, node: &NodeId, input: &DataId, reason: RouteCloseReason, ) -> Result<()>

Closes one of a node’s inputs.

§Errors

As MockDaemon::send_event.

Source

pub fn stop(&self, node: &NodeId, cause: StopCause) -> Result<()>

Stops one node.

§Errors

As MockDaemon::send_event.

Source

pub fn stop_all(&self, cause: StopCause)

Stops every connected node.

Source

pub fn set_param( &self, node: &NodeId, key: ParamKey, value: Parameter, ) -> Result<()>

Pushes a parameter update to a node (§17 param set).

§Errors

As MockDaemon::send_event.

Source

pub fn upgrade_route( &self, node: &NodeId, output: &DataId, segment: ShmSegmentSpec, consumers: Vec<PortRef>, ) -> Result<()>

Offers a node a route upgrade (§6.3).

§Errors

As MockDaemon::send_event.

Source

pub fn downgrade_route( &self, node: &NodeId, output: &DataId, reason: RouteDowngradeReason, ) -> Result<()>

Takes a node’s route back to the daemon path (§6.3).

§Errors

As MockDaemon::send_event.

Source

pub fn requests(&self) -> Vec<RecordedRequest>

Every request the daemon has received.

Source

pub fn sends(&self) -> Vec<RecordedSend>

Every message the daemon has seen published.

Source

pub fn sends_on(&self, node: &NodeId, output: &DataId) -> Vec<RecordedSend>

The messages one node published on one output.

Source

pub fn logs(&self) -> Vec<LogRecord>

Every log record the daemon has received.

Source

pub fn extension(&self, key: &ExtensionKey) -> Option<Vec<u8>>

One entry of the extension table.

Source

pub fn is_subscribed(&self, node: &NodeId) -> bool

Whether a node has subscribed to its inputs.

Source

pub fn wait_for( &self, timeout: Duration, predicate: impl FnMut(&[RecordedRequest]) -> bool, ) -> Result<()>

Waits until predicate holds over the recorded requests.

The synchronisation primitive a test needs when the node’s own thread is doing the work: assert on what the daemon saw, not on a sleep.

§Errors

NodeError::Timeout when it never holds.

Source

pub fn wait_for_sends( &self, node: &NodeId, output: &DataId, count: usize, timeout: Duration, ) -> Result<Vec<RecordedSend>>

Waits until node has sent at least count messages on output.

§Errors

As MockDaemon::wait_for.

Source

pub fn listen_unix(&self, path: impl AsRef<Path>) -> Result<UnixEndpoint>

Available on Unix only.

Listens on a real Unix-domain socket, the way a daemon actually does (§4.2).

Every other entry point here hands a node one end of an in-process duplex; this one exercises the dial, the socket and the greeting a deployed node performs. Nodes that connect this way are admitted from their Register handshake, so a path: dynamic node (§8.3) can attach itself with nothing pre-arranged.

§Errors

NodeError::Testing when the socket cannot be bound.

Source

pub fn shutdown(&self)

Stops the daemon: every waiter wakes and every node’s link ends.

Trait Implementations§

Source§

impl Clone for MockDaemon

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 MockDaemon

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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> 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> MaybeDebug for T

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