jest-redis

Jest preset for Redis in-memory server

Usage

1. Install

1$ yarn add redis-memory-server jest-redis --dev

2. Create a jest.config.js file

1module.exports = {
2	preset: 'jest-redis',
3}

3. Customizing Redis Server, create a jest-redis.config.js

See redis-memory-server to learn more about the optional configuraitons.

1module.exports = {
2	redisMemoryServerOptions: {
3		instance: {
4			port: number, // by default, choose any free port
5			ip: string, // by default, '127.0.0.1'; for binding to all IP addresses set it to `::,0.0.0.0`,
6			args: [], // by default, no additional arguments; any additional command line arguments for `redis-server`
7		},
8		binary: {
9			version: string, // by default, 'stable'
10			downloadDir: string, // by default, 'node_modules/.cache/redis-memory-server/redis-binaries'
11			systemBinary: string, // by default, undefined
12		},
13		autoStart: boolean, // by default, true
14	},
15	useSharedDBForAllJestWorkers: boolean, // enables seperated database for each test worker. This disables the exported environment variable.
16	redisURLEnvName: string, // the exported environment variable name
17}

4. Configure Redis Client

This library sets the process.env[options.redisURLEnvName] (by default process.env.REDIS_URL) for your convenience. However, it's preferable to use global.__REDIS_URL__ as is works with useSharedDBForAllJestWorkers.

1const Redis = require('ioredis')
2
3describe('set', () => {
4	let client
5
6	beforeAll(async () => {
7		client = new Redis(global.__REDIS_URL__)
8		await client.connect()
9	})
10
11	afterAll(async () => {
12		await client.disconnect()
13	})
14})

Jest watch mode

This package creates the file redisGlobals.json in the project root when using jest --watch flag. Changes to this file can cause issues. In order to avoid unwanted behaviour, add the redisGlobals.json to your ignore files and in jest.config.js, add:

1// jest.config.js
2module.exports = {
3	watchPathIgnorePatterns: ['redisGlobals']
4}