Trait testcontainers::Image

pub trait Image: Default where
    <Self::Args as IntoIterator>::Item == String,
    <Self::EnvVars as IntoIterator>::Item == (String, String), {
type Args: Default + IntoIterator;
type EnvVars: Default + IntoIterator;
    fn descriptor(&self) -> String;
    fn wait_until_ready<D>(&self, container: &Container<D, Self>)
    where
        D: Docker;
    fn args(&self) -> Self::Args;
    fn env_vars(&self) -> Self::EnvVars;
    fn with_args(self, arguments: Self::Args) -> Self;
}

Represents a docker image.

Implementations are required to implement Default. The default instance of an Image should have a meaningful configuration! It should be possible to run the default instance of an Image and get back a working container!

Associated Types

type Args: Default + IntoIterator

A type representing the arguments for an Image.

There are a couple of things regarding the arguments of images:

1. Similar to the Default implementation of an Image, the Default instance of its arguments should be meaningful!
2. Implementations should be conservative about which arguments they expose. Many times, users will either go with the default arguments or just override one or two. When defining the arguments of your image, consider that the whole purpose is to facilitate integration testing. Only expose those that actually make sense for this case.

type EnvVars: Default + IntoIterator

A type representing the environment variables for an Image.

There are a couple of things regarding the arguments of images:

1. Similar to the Default implementation of an Image, the Default instance of its environment variables should be meaningful!
2. Implementations should be conservative about which environment variables they expose. Many times, users will either go with the default ones or just override one or two. When defining the environment variables of your image, consider that the whole purpose is to facilitate integration testing. Only expose those that actually make sense for this case.

Loading content...

Required methods

fn descriptor(&self) -> String

The descriptor of the docker image.

This should return a full-qualified descriptor. Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn wait_until_ready<D>(&self, container: &Container<D, Self>) where
    D: Docker, 

Blocks the current thread until the started container is ready.

This method is the 🍞 and butter of the whole testcontainers library. Containers are rarely instantly available as soon as they are started. Most of them take some time to boot up.

Implementations MUST block the current thread until the passed-in container is ready to be interacted with. The container instance provides access to logs of the container.

Most implementations will very likely want to make use of this to wait for a particular message to be emitted.

fn args(&self) -> Self::Args

Returns the arguments this instance was created with.

fn env_vars(&self) -> Self::EnvVars

Returns the environment variables this instance was created with.

fn with_args(self, arguments: Self::Args) -> Self

Re-configures the current instance of this image with the given arguments.

Loading content...

Implementors

impl Image for BitcoinCore

type Args = BitcoinCoreImageArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, BitcoinCore>) where
    D: Docker, 

fn args(&self) -> <BitcoinCore as Image>::Args

fn env_vars(&self) -> <BitcoinCore as Image>::EnvVars

fn with_args(self, arguments: <BitcoinCore as Image>::Args) -> BitcoinCore

impl Image for DynamoDb

type Args = DynamoDbArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, DynamoDb>) where
    D: Docker, 

fn args(&self) -> <DynamoDb as Image>::Args

fn env_vars(&self) -> <DynamoDb as Image>::EnvVars

fn with_args(self, arguments: <DynamoDb as Image>::Args) -> DynamoDb

impl Image for ElasticMQ

type Args = ElasticMQArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, ElasticMQ>) where
    D: Docker, 

fn args(&self) -> <ElasticMQ as Image>::Args

fn env_vars(&self) -> <ElasticMQ as Image>::EnvVars

fn with_args(self, arguments: <ElasticMQ as Image>::Args) -> ElasticMQ

impl Image for GenericImage

type Args = Vec<String>

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, GenericImage>) where
    D: Docker, 

fn args(&self) -> <GenericImage as Image>::Args

fn env_vars(&self) -> <GenericImage as Image>::EnvVars

fn with_args(self, arguments: <GenericImage as Image>::Args) -> GenericImage

impl Image for ParityEthereum

type Args = ParityEthereumArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, ParityEthereum>) where
    D: Docker, 

fn args(&self) -> <ParityEthereum as Image>::Args

fn env_vars(&self) -> <ParityEthereum as Image>::EnvVars

fn with_args(self, arguments: <ParityEthereum as Image>::Args) -> ParityEthereum

impl Image for Postgres

type Args = PostgresArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, Postgres>) where
    D: Docker, 

fn args(&self) -> <Postgres as Image>::Args

fn env_vars(&self) -> <Postgres as Image>::EnvVars

fn with_args(self, arguments: <Postgres as Image>::Args) -> Postgres

impl Image for Redis

type Args = RedisArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, Redis>) where
    D: Docker, 

fn args(&self) -> <Redis as Image>::Args

fn env_vars(&self) -> <Redis as Image>::EnvVars

fn with_args(self, arguments: <Redis as Image>::Args) -> Redis

impl Image for GanacheCli

type Args = GanacheCliArgs

type EnvVars = HashMap<String, String, RandomState>

fn descriptor(&self) -> String

fn wait_until_ready<D>(&self, container: &Container<D, GanacheCli>) where
    D: Docker, 

fn args(&self) -> <GanacheCli as Image>::Args

fn env_vars(&self) -> <GanacheCli as Image>::EnvVars

fn with_args(self, arguments: <GanacheCli as Image>::Args) -> GanacheCli

Loading content...