Struct testcontainers_modules::cncf_distribution::CncfDistribution

pub struct CncfDistribution;

Available on crate feature cncf_distribution only.

Module to work with a custom Docker registry inside of tests.

Starts an instance of CNCF Distribution, an easy-to-use registry for container images.

Example

use testcontainers_modules::{cncf_distribution, testcontainers::runners::SyncRunner};

let registry = cncf_distribution::CncfDistribution.start();

let image_name = "test";
let image_tag = format!("{}:{}/{image_name}", registry.get_host_ip_address(), registry.get_host_port_ipv4(5000));

// now you can push an image tagged with `image_tag` and pull it afterward

Trait Implementations

impl Clone for CncfDistribution

fn clone(&self) -> CncfDistribution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CncfDistribution

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

Formats the value using the given formatter.

impl Default for CncfDistribution

fn default() -> CncfDistribution

Returns the “default value” for a type.

impl Image for CncfDistribution

type Args = ()

A type representing the arguments for an Image.

fn name(&self) -> String

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> String

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 ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the environment variables of images:

fn mounts(&self) -> Box<dyn Iterator<Item = &Mount> + '_>

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

fn entrypoint(&self) -> Option<String>

Returns the entrypoint this instance was created with.

fn expose_ports(&self) -> Vec<u16>

Returns the ports that needs to be exposed when a container is created.

fn exec_after_start(&self, cs: ContainerState) -> Vec<ExecCommand>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.