ioredis-mock

What is ioredis-mock?

ioredis-mock is a mock implementation of the ioredis library, which is used for interacting with Redis databases. This package is particularly useful for testing purposes, as it allows developers to simulate Redis operations without needing a real Redis server.

What are ioredis-mock's main functionalities?

Basic Redis Commands

This feature allows you to perform basic Redis commands such as SET and GET. The code sample demonstrates setting a key-value pair and then retrieving the value.

const Redis = require('ioredis-mock');
const redis = new Redis();

redis.set('key', 'value').then(() => {
  return redis.get('key');
}).then(value => {
  console.log(value); // 'value'
});

Pub/Sub

This feature allows you to use the publish/subscribe pattern. The code sample demonstrates subscribing to a channel and publishing a message to that channel.

const Redis = require('ioredis-mock');
const pub = new Redis();
const sub = new Redis();

sub.subscribe('channel', (err, count) => {
  pub.publish('channel', 'message');
});

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

Transactions

This feature allows you to perform transactions using the MULTI command. The code sample demonstrates setting a key-value pair and then retrieving the value within a transaction.

const Redis = require('ioredis-mock');
const redis = new Redis();

redis.multi()
  .set('key', 'value')
  .get('key')
  .exec((err, results) => {
    console.log(results); // [[null, 'OK'], [null, 'value']]
  });

Other packages similar to ioredis-mock

redis-mock

redis-mock is another mock implementation of the Redis API. It provides a similar set of functionalities for testing purposes. However, it is generally considered less feature-rich and less actively maintained compared to ioredis-mock.

fakeredis

fakeredis is a pure Python implementation of the Redis API, which can be used for testing purposes. It is similar to ioredis-mock but is intended for use in Python environments rather than Node.js.

README

ioredis-mock

This library emulates ioredis by performing all operations in-memory. The best way to do integration testing against redis and ioredis is on a real redis-server instance. However, there are cases where mocking the redis-server is a better option.

Cases like:

• Your workflow already use a local redis-server instance for the dev server.
• You're on a platform without an official redis release, that's even worse than using an emulator.
• You're running tests on a CI, setting it up is complicated. If you combine it with CI that also run selenium acceptance testing it's even more complicated, as two redis-server instances on the same CI build is hard.
• The GitHub repo have bots that run the testing suite and is limited through npm package.json install scripts and can't fire up servers. (Having Greenkeeper notifying you when a new release of ioredis is out and wether your code breaks or not is awesome).

Usage

var RedisMock = require('ioredis-mock').default
var redis = new RedisMock({
  data: {
    user_next: '3',
    emails: {
      '[e-mail]': '1',
      '[e-mail]': '2',
    },
    'user:1': { id: '1', username: 'superman', email: '[e-mail]' },
    'user:2': { id: '2', username: 'batman', email: '[e-mail]' },
  }
});
// Basically use it just like ioredis

Mocked ioredis features

• incr
• hsetnx
• hmset
• sadd
• srem
• hget
• hvals
• hgetall
• smembers
• sismember
• hset
• multi
• exec

Todo

This project started off as just an utility in another project and just recently got open sourced to benefit the rest of the ioredis community. This means there's work to do before it's feature complete:

• Setup testing suite for the library itself.
• Implement remaining basic features that read/write data.
• Connection Events
• Offline Queue
• Pub/Sub
• Error Handling

I need a feature not listed here

Just create an issue and tell us all about it or submit a PR with it! :-)

Changelog

[1.0.1] - 2016-06-09

• lodash was missing in the package.json dependencies
• fixes to documentation
• added tonicExample