Struct zebra_network::peer::client::tests::ClientTestHarness

pub struct ClientTestHarness {
    client_request_receiver: Option<Receiver<ClientRequest>>,
    shutdown_receiver: Option<Receiver<CancelHeartbeatTask>>,
    inv_receiver: Option<Receiver<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>,
    error_slot: ErrorSlot,
    remote_version: Version,
    connection_aborter: AbortHandle,
    heartbeat_aborter: AbortHandle,
}

A harness with mocked channels for testing a Client instance.

Fields

client_request_receiver: Option<Receiver<ClientRequest>>

shutdown_receiver: Option<Receiver<CancelHeartbeatTask>>

inv_receiver: Option<Receiver<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>

error_slot: ErrorSlot

remote_version: Version

connection_aborter: AbortHandle

heartbeat_aborter: AbortHandle

Implementations

impl ClientTestHarness

pub fn build() -> ClientTestHarnessBuilder

Create a ClientTestHarnessBuilder instance to help create a new Client instance and a ClientTestHarness to track it.

pub fn remote_version(&self) -> Version

Gets the remote peer protocol version reported by the Client.

pub fn wants_connection_heartbeats(&mut self) -> bool

Returns true if the Client instance still wants connection heartbeats to be sent.

Checks that the client:

• has not been dropped,
• has not closed or dropped the mocked heartbeat task channel, and
• has not asked the mocked heartbeat task to shut down.

pub fn drop_heartbeat_shutdown_receiver(&mut self)

Drops the mocked heartbeat shutdown receiver endpoint.

pub fn close_outbound_client_request_receiver(&mut self)

Closes the receiver endpoint of ClientRequests that are supposed to be sent to the remote peer.

The remote peer that would receive the requests is mocked for testing.

pub fn drop_outbound_client_request_receiver(&mut self)

Drops the receiver endpoint of ClientRequests, forcefully closing the channel.

The remote peer that would receive the requests is mocked for testing.

pub(crate) fn try_to_receive_outbound_client_request( &mut self, ) -> ReceiveRequestAttempt

Tries to receive a ClientRequest sent by the Client instance.

The remote peer that would receive the requests is mocked for testing.

pub fn drop_inventory_change_receiver(&mut self)

Drops the receiver endpoint of InventoryChanges, forcefully closing the channel.

The inventory registry that would track the changes is mocked for testing.

Note: this closes the broadcast receiver, it doesn’t have a separate close() method.

pub(crate) fn try_to_receive_inventory_change( &mut self, ) -> Option<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>

Tries to receive an InventoryChange sent by the Client instance.

This method acts like a mock inventory registry, allowing tests to track the changes.

TODO: make ReceiveRequestAttempt generic, and use it here.

pub fn current_error(&self) -> Option<SharedPeerError>

Returns the current error in the ErrorSlot, if there is one.

pub fn set_error(&self, error: impl Into<SharedPeerError>)

Sets the error in the ErrorSlot, assuming there isn’t one already.

Panics

If there’s already an error in the ErrorSlot.

pub async fn stop_connection_task(&self)

Stops the mock background task that handles incoming remote requests and replies.

pub async fn stop_heartbeat_task(&self)

Stops the mock background task that sends periodic heartbeats.