Redis client mock object for unit testing
npm install @binwus-org/redis-mockredis-mock
============
!Build status
!node-current
!mock-completeness-red)
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)
```bash``
$ npm install redis-mock --save-dev
The below code demonstrates a example of using the redis-mock client in node.js/io.js
`js`
var redis = require("redis-mock"),
client = redis.createClient();
Currently implemented are the following redis commands:
or AGGREGATE yet)
* zinterstore (Partial: no support for WEIGHTS or AGGREGATE yet)
* zscore$3
* 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:``bash
$ npm test:valid
``You will need to have a running instance of
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 issueExample 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:`javascript
module.exports = {
// other properties...
setupFilesAfterEnv: ['./jest.setup.redis-mock.js'],
};
`From this point on, jest will always trigger the content of
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:`javascript
jest.mock('redis', () => jest.requireActual('redis-mock'));
`This will make sure that the actual
is never loaded and whenever any file tries to import/require redis,
redis-mock` will be returned instead.Copyright (c) 2012 Kristian Faeldt
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.