redis-mock

What is redis-mock?

The redis-mock npm package is a mock implementation of the Redis API, which allows developers to test their applications without needing a real Redis server. It is particularly useful for unit testing and development environments where setting up a real Redis server might be cumbersome or unnecessary.

What are redis-mock's main functionalities?

Basic Redis Commands

This feature allows you to use basic Redis commands like SET and GET. The mock client behaves like a real Redis client, making it easy to test code that interacts with Redis.

const redis = require('redis-mock');
const client = redis.createClient();

client.set('key', 'value', (err, reply) => {
  console.log(reply); // OK
});

client.get('key', (err, reply) => {
  console.log(reply); // value
});

Pub/Sub

This feature allows you to use the publish/subscribe (Pub/Sub) pattern. You can subscribe to channels and publish messages to those channels, which is useful for testing real-time messaging in your application.

const redis = require('redis-mock');
const pub = redis.createClient();
const sub = redis.createClient();

sub.on('message', (channel, message) => {
  console.log(channel, message); // channel1 message1
});

sub.subscribe('channel1');

pub.publish('channel1', 'message1');

Hash Operations

This feature allows you to perform hash operations like HSET and HGET. It is useful for testing code that deals with Redis hashes.

const redis = require('redis-mock');
const client = redis.createClient();

client.hset('hash', 'field1', 'value1', (err, reply) => {
  console.log(reply); // 1
});

client.hget('hash', 'field1', (err, reply) => {
  console.log(reply); // value1
});

Other packages similar to redis-mock

ioredis-mock

ioredis-mock is a mock implementation of the ioredis library. It provides a similar API to ioredis, making it easy to switch between the mock and the real ioredis client. It is useful for testing applications that use ioredis.

fakeredis

fakeredis is another mock Redis server for testing purposes. It aims to be a drop-in replacement for the redis-py library, providing a similar API. It is useful for testing Python applications that use Redis.

README

redis-mock

The goal of the redis-mock project is to create a feature-complete mock of node_redis, which may be used interchangeably when writing unit tests for code that depends on redis.

All operations are performed in-memory, so no Redis installation is required.

100% Redis-compatible (see Cross Verification)

Installation

$ npm install redis-mock --save-dev

Usage

node.js/io.js

The below code demonstrates a example of using the redis-mock client in node.js/io.js

var redis = require("redis-mock"),
    client = redis.createClient();

API

Currently implemented are the following redis commands:

General

• createClient
• duplicate
• auth
• end
• multi
  • exec
  • discard
  • exec_atomic
• batch

Events

• ready
• connect
• end
• quit
• subscribe
• unsubscribe
• message
• psubscribe
• punsubscribe
• pmessage

Publish/subscribe

• publish
• subscribe
• unsubscribe
• psubscribe
• punsubscribe

Keys

• del
• keys
• scan
• exists
• type
• expire
• ttl
• incr
• incrby
• incrbyfloat
• decr
• decrby
• rename
• dbsize
• renamenx

Strings

• get
• set
• append
• getset
• mget
• mset
• msetnx
• setex
• setnx
• ping

Hashing

• hset
• hsetnx
• hget
• hexists
• hdel
• hlen
• hgetall
• hscan
• hmset
• hmget
• hkeys
• hvals
• hincrby
• hincrbyfloat

Lists

• llen
• lpush
• rpush
• lpushx
• rpushx
• lpop
• rpop
• blpop
• brpop
• lindex
• lrange
• lrem
• lset

Sets

• sadd
• srem
• smembers
• scard
• sismember
• sscan

Sorted Sets

• zadd
• zcard
• zcount
• zincrby
• zrange
• zrangebyscore
• zrank
• zrem
• zremrangebyrank
• zremrangebyscore
• zrevrange
• zrevrangebyscore
• zrevrank
• zunionstore (Partial: no support for WEIGHTS or AGGREGATE yet)
• zinterstore (Partial: no support for WEIGHTS or AGGREGATE yet)
• zscore

Server

• flushdb
• flushall
• time

Cross verification

If you want to add new tests to the test base it is important that they work too on node_redis (we are creating a mock...). You can therefore run the tests using redis instead of redis-mock. To do so:

$ npm test:valid

You will need to have a running instance of redis on you machine and our tests use flushdb a lot so make sure you don't have anything important on it.

Roadmap

redis-mock is work in progress, feel free to report an issue

Example usage

Jest

In order to make sure that your tests use the redis-mock instead of the actual redis implementation, update your jest.config.js, by adding setupFileAfterEnv, as follows:

module.exports = {
    // other properties...
    setupFilesAfterEnv: ['./jest.setup.redis-mock.js'],
};

From this point on, jest will always trigger the content of jest.setup.redis-mock.js before the execution of all tests.

Now, let's create the file jest.setup.redis-mock.js in the same directory as jest.config.js and paste the following content:

jest.mock('redis', () => jest.requireActual('redis-mock'));

This will make sure that the actual redis is never loaded and whenever any file tries to import/require redis, redis-mock will be returned instead.

LICENSE - "MIT License"

Copyright (c) 2012 Kristian Faeldt [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.