Struct testcontainers_modules::redis::Redis

pub struct Redis;

Available on crate feature redis only.

Module to work with Redis inside of tests.

Starts an instance of Redis based on the official Redis docker image.

By default Redis is exposed on Port 6379 (REDIS_PORT) and has no access control. Please refer to the Redis reference guide for more informations on how to interact with the API.

Example

use redis::Commands;
use testcontainers::clients;
use testcontainers_modules::redis::{Redis, REDIS_PORT};

let docker = clients::Cli::default();
let redis_instance = docker.run(Redis::default());
let host_port = redis_instance.get_host_port_ipv4(REDIS_PORT);

let url = format!("redis://127.0.0.1:{host_port}");
let client = redis::Client::open(url.as_ref()).unwrap();
let mut con = client.get_connection().unwrap();

con.set::<_, _, ()>("my_key", 42).unwrap();
let result: i64 = con.get("my_key").unwrap();

Trait Implementations

impl Debug for Redis

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

Formats the value using the given formatter.

impl Default for Redis

fn default() -> Redis

Returns the “default value” for a type.

impl Image for Redis

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 volumes(&self) -> Box<dyn Iterator<Item = (&String, &String)> + '_>

There are a couple of things regarding the volumes 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.