Struct dockertest_server::test::Test

pub struct Test {
    pub configs: TypeMap,
    pub compositions: Vec<Composition>,
}

A single test which brings up one or more Servers.

A Test receives Configs via register which determines the servers that will be brought up when the test is executed. The run method is used to bring up the Servers and then run the given test body.

The body of a test is determined by an async closure passed to the run method. The closure will receive a TestInstance which can be used to access the Servers that were created when the test was setup.

Fields

configs: TypeMap

compositions: Vec<Composition>

Implementations

impl Test

pub fn new() -> Self

Creates an empty Test.

pub fn register(&mut self, config: impl Config + 'static)

Registers a Config with this test.

A Test can be configured with any number of Configs for determining which Servers are brought up in a test. Each Config passed will have it’s respective Server created before the test body is ran.

pub fn run<T, F>(self, fun: T) where
    T: FnOnce(TestInstance) -> F + Send + 'static,
    F: Future<Output = ()> + Send + 'static, 

Brings up the Servers registered with this test and then runs the given test body.

The test body receives a TestInstance which can be used for accessing any configured Servers through the server method. The test body is guaranteed to not execute until all configured Servers are verified to be running and available. The scope of the test body determines the life of the Servers: they are created before the closure is run and destroyed after the closure exits.

Trait Implementations

impl Default for Test

fn default() -> Self

Returns the “default value” for a type.