Struct dockertest::DockerTest

pub struct DockerTest { /* private fields */ }

The main entry point to specify a test.

Implementations

impl DockerTest

pub fn new() -> Self

Start the configuration process of a new DockerTest instance.

pub fn with_default_source(self, default_source: Source) -> Self

Sets the default Source for all Images.

All images without a specified source will be pulled from the default source. DockerTest will default to Source::Local if not configured.

pub fn with_namespace<T: ToString>(self, name: T) -> Self

Sets the namespace for all containers created by DockerTest.

All container names will be prefixed with this namespace. DockerTest defaults to the namespace “dockertest-rs”.

pub fn with_network(self, network: Network) -> Self

Sets the network configuration

pub fn provide_container( &mut self, specification: impl ContainerSpecification, ) -> &mut DockerTest

Append a container specification as part of this specific test.

The order of which container specifications are added to DockerTest is significant for the start-up order for strict order dependencies.

Please refer to one of the following variants to construct your container specification:

• TestBodySpecification
• DynamicSpecification
• ExternalSpecification

pub fn source(&self) -> &Source

Retrieve the default source for Images unless explicitly specified per Image.

pub fn run<T, Fut>(self, test: T)

where T: FnOnce(DockerOperations) -> Fut, Fut: Future<Output = ()> + Send + 'static,

Execute the test with the constructed environment in full operation.

Synchronous

This non-async version creates its own runtime to execute the test.

pub async fn run_async<T, Fut>(self, test: T)

where T: FnOnce(DockerOperations) -> Fut, Fut: Future<Output = ()> + Send + 'static,

Async version of DockerTest::run.

Asynchronous

This version allows the caller to provide the runtime to execute this test within. This can be useful if the test executable is wrapped with a runtime macro, e.g., #[tokio::test].

Trait Implementations

impl Default for DockerTest

fn default() -> Self

Returns the “default value” for a type.