Struct dockertest::OperationalContainer

pub struct OperationalContainer { /* private fields */ }

Represent a docker container that has passed its WaitFor implementation and available is to the test body. The state of the container will depend on what WaitFor implementation was used, e.g. using the ExitedWait will result in a container in an exited state.

Implementations

impl OperationalContainer

pub fn name(&self) -> &str

Return the generated name on the docker container object for this OperationalContainer.

pub fn id(&self) -> &str

Return the docker assigned identifier for this OperationalContainer.

pub fn ip(&self) -> &Ipv4Addr

Return the IPv4 address for this container on the local docker network adapter. Use this address to contact the OperationalContainer in the test body.

This property is retrieved from the docker daemon prior to entering the test body. It is cached internally and not updated between invocations. This means that if the docker container enters an exited state, this function will still return the original ip assigned to the container.

If the ExitedWait for strategy is employed, the OperationalContainer will be in an exited status when the test body is entered. For this scenarion, this function will return Ipv4Addr::UNSPECIFIED.

On Windows this method always returns 127.0.0.1 due to Windows not supporting using container IPs outside a container-context.

pub fn host_port(&self, exposed_port: u32) -> Option<&(Ipv4Addr, u32)>

Returns host ip/port binding for the given container port. Useful in MacOS where there is no network connectivity between Mac system and containers.

pub fn host_port_unchecked(&self, exposed_port: u32) -> &(Ipv4Addr, u32)

Same as host_port, but panics if the mapping could not be found.

pub async fn pause(&self)

Pauses the container

Panics

Will panic if the container was in any state but Runnning prior to calling this method or if we fail the docker operation.

pub async fn kill(&self)

Kills the container

Panics

Will panic if the container was in any state but Runnning or Paused prior to calling this method or if we fail the docker operation.

pub async fn unpause(&self)

Unpauses the container

Panics

Will panic if the container was in any state but Paused prior to calling this method or if we fail the docker operation.

pub async fn assert_message<T>( &self, message: T, source: MessageSource, timeout: u16, )

where T: Into<String> + Serialize,

Inspect the output of this container and await the presence of a log line.

Panics

This function panics if the log message is not present on the log output within the specified timeout.

Trait Implementations

impl Clone for OperationalContainer

fn clone(&self) -> OperationalContainer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OperationalContainer

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

Formats the value using the given formatter.

impl From<PendingContainer> for OperationalContainer

fn from(container: PendingContainer) -> OperationalContainer

Converts to this type from the input type.