Skip to main content

TestHarness

Struct TestHarness 

Source
pub struct TestHarness {
    pub node: Node,
    pub events: EventStream,
    pub daemon: MockDaemon,
}
Expand description

A node, its event stream, and the daemon it is talking to.

Fields§

§node: Node

The node under test.

§events: EventStream

Its event stream.

§daemon: MockDaemon

The daemon on the other end.

Implementations§

Source§

impl TestHarness

Source

pub const DEFAULT_NODE: &'static str = "node-under-test"

The node id TestHarness::start uses.

Source

pub const DEFAULT_INPUT: &'static str = "in"

The input TestHarness::start declares.

Source

pub const DEFAULT_OUTPUT: &'static str = "out"

The output TestHarness::start declares.

Source

pub fn start() -> Result<Self>

Starts a daemon and one node with a single input and output.

§Errors

NodeError::Testing when the harness cannot be started.

Source

pub fn with_spec(spec: NodeSpawnSpec) -> Result<Self>

Starts a daemon and one node with an explicit specification.

§Errors

As TestHarness::start.

Source

pub fn pair( producer: &str, output: &str, consumer: &str, input: &str, ) -> Result<(Self, Self)>

Starts a daemon with a producer and a consumer wired to each other.

producer publishes on output; consumer reads it as input. The returned pair is (producer, consumer).

§Errors

As TestHarness::start.

Source

pub fn default_spec(daemon: &MockDaemon) -> Result<NodeSpawnSpec>

The default specification: one input, one output, both wired to a notional peer.

§Errors

NodeError::Id when the built-in names fail the grammar, which they cannot.

Source

pub fn node_id(&self) -> NodeId

The node’s id.

Source

pub fn feed(&self, payload: Vec<u8>) -> Result<()>

Delivers one message to the node’s default input.

§Errors

As MockDaemon::send_input.

Source

pub fn feed_input(&self, input: &str, payload: Vec<u8>) -> Result<()>

Delivers one message to a named input.

§Errors

NodeError::Id for a malformed name, plus whatever MockDaemon::send_input reports.

Source

pub fn next_event(&mut self) -> Result<Event>

Reads the next event, failing rather than hanging.

§Errors

NodeError::Timeout when nothing arrives in DEFAULT_WAIT, and NodeError::Stopped when the stream has ended.

Source

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

Stops the node and drains the stop event.

§Errors

As MockDaemon::stop.

Source

pub fn shutdown(&mut self)

Shuts the harness down.

Trait Implementations§

Source§

impl Debug for TestHarness

Source§

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

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

impl Drop for TestHarness

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> 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, 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