/redisenv

A docker-based wrapping tool, for making redis environments

Primary LanguagePythonMIT LicenseMIT

redisenv

MIT licensed pypi

redisenv is library that makes generating redis test environments easier. This tool generates docker-compose files, and runs all instances within docker. Generated docker instances select a random port, based on the available free ports, and when running redisenv ports, a JSON parse-able string of the build connections is outputted.

Currently redisenv supports:

  • Redis standalone

  • Redis Sentinel

  • Redis Clusters

  • Redis masters with replicas

  • Redis Enterprise Clusters

    Note: These require ports 8443, 9443, and can pick a random port per database. As a result, these two ports must be free in order to start a cluster. This is a temporary limitation, for now.

Note: Today Redis Standalone supports redis-stack, but nothing else does

Installation

Requirements

  • Python >= 3.7

  • docker-compose

  • docker

pip install redisenv

Usage

List options. Note, each sub command accepts its own --help

redisenv --help

Start an environment named foo, with one container:

redisenv --name foo standalone create --nodes 1

Start an environment with the redisbloom module, downloaded into a folder named modules. Note - you need the full local path to the directory.

redisenv --name foo standalone create -n 1 -M `pwd`/modules /modules -o "--loadmodule /modules/redisbloom.so"

Destroy the environment named foo:

redisenv --name foo destroy