Struct TestSandbox

pub struct TestSandbox { /* private fields */ }

A test sandbox backed by a fnetemul::SandboxProxy.

TestSandbox provides various utility methods to set up network realms for use in testing. The lifetime of the TestSandbox is tied to the netemul sandbox itself, dropping it will cause all the created realms, networks, and endpoints to be destroyed.

Implementations

impl TestSandbox

pub fn new() -> Result<TestSandbox, Error>

Creates a new empty sandbox.

pub fn create_realm<'a, I>( &'a self, name: impl Into<Cow<'a, str>>, children: I, ) -> Result<TestRealm<'a>, Error>

where I: IntoIterator, I::Item: Into<ChildDef>,

Creates a realm with name and children.

pub fn create_empty_realm<'a>( &'a self, name: impl Into<Cow<'a, str>>, ) -> Result<TestRealm<'a>, Error>

Creates a realm with no components.

pub fn get_network_manager(&self) -> Result<NetworkManagerProxy, Error>

Connects to the sandbox’s NetworkManager.

pub fn get_endpoint_manager(&self) -> Result<EndpointManagerProxy, Error>

Connects to the sandbox’s EndpointManager.

pub async fn create_network<'a>( &'a self, name: impl Into<Cow<'a, str>>, ) -> Result<TestNetwork<'a>, Error>

Creates a new empty network with default configurations and name.

pub async fn setup_networks<'a>( &'a self, networks: Vec<NetworkSetup>, ) -> Result<TestNetworkSetup<'a>, Error>

Creates new networks and endpoints as specified in networks.

pub async fn create_endpoint<'a, S>( &'a self, name: S, ) -> Result<TestEndpoint<'a>, Error>

where S: Into<Cow<'a, str>>,

Creates a new unattached endpoint with default configurations and name.

Characters may be dropped from the front of name if it exceeds the maximum length.

pub async fn create_endpoint_with<'a>( &'a self, name: impl Into<Cow<'a, str>>, config: EndpointConfig, ) -> Result<TestEndpoint<'a>, Error>

Creates a new unattached endpoint with the provided configuration.

Characters may be dropped from the front of name if it exceeds the maximum length.