repository·master·Indexed 25 days ago
https://github.com/alicebob/miniredisA pure Go implementation of a Redis server designed for unit testing. It provides an in-memory, lightweight replacement for Redis with a real TCP interface, allowing developers to test Redis-dependent code without an external installation. It includes a direct access API to manipulate the database without the network stack, tools for managing TTLs and time simulation via FastForward, and support for a wide range of Redis commands across strings, hashes, lists, sets, sorted sets, streams, and HyperLogLog.
Miniredis uses math/rand's global RNG by default. To ensure deterministic behavior in tests involving randomness, call m.Seed(seed) to provide a specific seed. This affects commands that rely on randomness, such as:
RANDOMKEYSPOPSRANDMEMBERMiniredis is a pure Go Redis test server designed for Go unittests. It provides an in-memory Redis replacement with a real TCP interface, allowing you to test Redis-dependent code without external dependencies or complex integration tests.
To use it, import the v2 package:
import "github.com/alicebob/miniredis/v2"import "github.com/alicebob/miniredis/v2"In miniredis, TTLs (Time To Live) do not decrease automatically. To simulate the passage of time and trigger key expiration, use the following methods:
m.FastForward(d): Decrements all TTLs by the duration d. Any keys with a TTL $\le 0$ after this operation are removed.m.SetTime(t): Sets the base time for EXPIREAT and PEXPIREAT conversions and sets the value returned by the Redis TIME command. Defaults to time.Now().m.TTL(key): Returns the remaining TTL of a key as a time.Duration. Returns 0 if no TTL is set.Addr(). You can also use Host() and Port() separately.NewServer(addr string). To create a server with TLS support, use NewServerTLS(addr string, cfg *tls.Config). Use .Close() to shut down the server and wait for all connected clients to finish.You can start a Miniredis server in several ways depending on your use case:
testing.T: Use RunT(t). This automatically handles server shutdown via t.Cleanup() when the test finishes.Run() to start a server and manually call Close() when finished.RunTLS(cfg) for a TLS-enabled server.StartAddr(addr) to listen on a specific address (e.g., "127.0.0.1:6379").Use miniredis.RunT(t) to start a miniredis server that is automatically cleaned up when the test finishes. You can then use the server's address (s.Addr()) to connect your application via a standard Redis client (like redigo or go-redis).
Because the server lives in the same process, you can also use the miniredis instance directly to inspect or set values for assertions, bypassing the network stack.
func TestSomething(t *testing.T) {
s := miniredis.RunT(t)
// Optionally set some keys your code expects:
s.Set("foo", "bar")
s.HSet("some", "other", "key")
// Run your code and see if it behaves.
// Example using redigo:
c, err := redis.Dial("tcp", s.Addr())
_, err = c.Do("SET", "foo", "bar")
// Optionally check values in redis...
if got, err := s.Get("foo"); err != nil || got != "bar" {
t.Error("'foo' has the wrong value")
}
// ... or use a helper for that:
s.CheckGet(t, "foo", "bar")
// TTL and expiration:
s.Set("foo", "bar")
s.SetTTL("foo", 10*time.Second)
s.FastForward(11 * time.Second)
if s.Exists("foo") {
t.Fatal("'foo' should not have existed anymore")
}
}Miniredis implements a wide range of Redis commands across several categories. Note that some commands are only partially implemented (e.g., DUMP, RESTORE, INFO, XINFO).
Command Groups:
AUTH, ECHO, HELLO, PING, SELECT, SWAPDB, QUITCOPY, DEL, DUMP, EXISTS, EXPIRE, EXPIREAT, EXPIRETIME, KEYS, MOVE, PERSIST, PEXPIRE, PEXPIREAT, PEXPIRETIME, PTTL, RANDOMKEY, RENAME, RENAMENX, RESTORE, SCAN, TOUCH, TTL, TYPE, UNLINK, WAITDISCARD, EXEC, MULTI, UNWATCH, WATCHDBSIZE, FLUSHALL, FLUSHDB, TIME, COMMAND, INFOAPPEND, BITCOUNT, BITOP, BITPOS, DECR, DECRBY, DELEX, GET, GETBIT, GETDEL, GETEX, GETRANGE, GETSET, INCR, INCRBY, INCRBYFLOAT, MGET, MSET, MSETNX, PSETEX, SET, SETBIT, SETEX, SETNX, SETRANGE, STRLENHDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS, HLEN, HMGET, HMSET, HRANDFIELD, HSET, HSETNX, HSTRLEN, HVALS, HSCANBLPOP, BRPOP, BRPOPLPUSH, LINDEX, LINSERT, LLEN, LPOP, LPUSH, LPUSHX, LRANGE, LREM, LSET, LTRIM, RPOP, RPOPLPUSH, RPUSH, RPUSHX, LMOVE, BLMOVEPSUBSCRIBE, PUBLISH, PUBSUB, PUNSUBSCRIBE, SUBSCRIBE, UNSUBSCRIBESADD, SCARD, SDIFF, SDIFFSTORE, SINTER, SINTERSTORE, SINTERCARD, SISMEMBER, SMEMBERS, SMISMEMBER, SMOVE, SPOP, SRANDMEMBER, SREM, SSCAN, SUNION, SUNIONSTOREZADD, ZCARD, ZCOUNT, ZINCRBY, ZINTER, ZINTERSTORE, ZLEXCOUNT, ZPOPMIN, ZPOPMAX, ZRANDMEMBER, ZRANGE, ZRANGEBYLEX, ZRANGEBYSCORE, ZRANK, ZREM, ZREMRANGEBYLEX, ZREMRANGEBYRANK, ZREMRANGEBYSCORE, ZREVRANGE, ZREVRANGEBYLEX, ZREVRANGEBYSCORE, ZREVRANK, ZSCORE, ZUNION, ZUNIONSTORE, ZSCANXACK, XADD, XAUTOCLAIM, XCLAIM, XDEL, XGROUP CREATE, XGROUP CREATECONSUMER, XGROUP DESTROY, XGROUP DELCONSUMER, XINFO STREAM, XINFO GROUPS, XINFO CONSUMERS, XLEN, XRANGE, XREAD, XREADGROUP, XREVRANGE, XPENDING, XTRIMEVAL, EVALSHA, SCRIPT LOAD, SCRIPT EXISTS, SCRIPT FLUSHGEOADD, GEODIST, GEOPOS, GEORADIUS, GEORADIUS_RO, GEORADIUSBYMEMBER, GEORADIUSBYMEMBER_ROCLUSTER SLOTS, CLUSTER KEYSLOT, CLUSTER NODES, CLUSTER SHARDSPFADD, PFCOUNT, PFMERGERead() method reads the next available response from the client's buffer and returns it as a string.Subscriber to programmatically listen to published messages in Miniredis.Miniredis allows you to manipulate data directly without a Redis client by accessing its internal RedisDB instances.
DB(id) to get a pointer to a specific database.Select(id) to change the currently selected database for direct commands.Get(key) or Set(key, value) directly on the Miniredis or RedisDB instances.Close() method closes the underlying network connection used by the Client.