Struct 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().unwrap();
let http_port = cockroach.get_host_port_ipv4(26257).unwrap();

// do something with the started cockroach instance..

Implementations

impl CockroachDb

pub fn new(cmd: CockroachDbCmd) -> Self

Create a new instance of a CockroachDb image.

Trait Implementations

impl Clone for CockroachDb

fn clone(&self) -> CockroachDb

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CockroachDb

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

Formats the value using the given formatter.

impl Default for CockroachDb

fn default() -> CockroachDb

Returns the “default value” for a type.

impl Image for CockroachDb

fn name(&self) -> &str

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

fn tag(&self) -> &str

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 cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn env_vars( &self, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

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

fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer>

Returns the files to be copied into the container at startup.

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

Returns the entrypoint this image needs to be created with.

fn expose_ports(&self) -> &[ContainerPort]

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

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

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

fn exec_before_ready( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns commands that will be executed after the container has started, but before the Image::ready_conditions are awaited for.