Struct testcontainers_modules::cockroach_db::CockroachDb

pub struct CockroachDb { /* private fields */ }

Available on crate feature cockroach_db only.

Module to work with [Cockroach DB] inside of tests.

This module is based on the official Cockroach docker image.

Example

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

let cockroach = cockroach_db::CockroachDb::default().start();
let http_port = cockroach.get_host_port_ipv4(26257);

// do something with the started cockroach instance..

Trait Implementations

impl Debug for CockroachDb

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

Formats the value using the given formatter.

impl Default for CockroachDb

fn default() -> Self

Returns the “default value” for a type.

impl Image for CockroachDb

type Args = CockroachDbArgs

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.