如何使用Jest编写单元测试Mock Redis Cluster及相关实现求助

针对你用ioredis + bluebird实现的Redis Cluster缓存更新代码，下面是用ioredis-mock配合Jest编写单元测试的具体方案：

1. 准备依赖 #

确保安装必要的开发依赖：

npm install --save-dev ioredis-mock jest

2. Mock Redis Cluster的两种实现方式 #

方式一：直接Mock ioredis模块 #

在测试文件中，用jest.mock将ioredis替换为ioredis-mock，同时保留原有的Promise配置逻辑：

// 引入被测试的模块（假设你的代码在cache.js中）
const { updateCache } = require('./cache');
const Redis = require('ioredis');

// Mock整个ioredis模块，用ioredis-mock替代
jest.mock('ioredis', () => {
  const RedisMock = require('ioredis-mock');
  return {
    ...RedisMock,
    Promise: require('bluebird')
  };
});

describe('updateCache', () => {
  let clusterMock;

  beforeEach(() => {
    // 获取Mock的Cluster实例
    clusterMock = Redis.Cluster.mock.instances[0];
    // 重置所有mock调用，避免用例污染
    jest.clearAllMocks();
  });

  test('成功更新缓存', async () => {
    // 模拟hset返回成功结果
    clusterMock.hset.mockResolvedValue(1);
    
    const result = await updateCache('test-id', { name: 'test' });
    
    // 验证hset调用参数是否正确
    expect(clusterMock.hset).toHaveBeenCalledWith(
      'TESTINDEX',
      'test-id',
      JSON.stringify({ name: 'test' })
    );
    expect(result).toBe(1);
  });

  test('缓存更新超时', async () => {
    // 模拟hset延迟超过2000ms，触发timeout
    clusterMock.hset.mockImplementation(() => 
      new Promise(resolve => setTimeout(() => resolve(1), 3000))
    );
    
    await expect(updateCache('test-id', { name: 'test' })).rejects.toThrow();
    expect(clusterMock.hset).toHaveBeenCalled();
  });
});

方式二：手动替换Cluster实例 #

如果你的代码中Cluster是直接实例化导出的，可以手动替换为Mock实例：

const { updateCache } = require('./cache');
const RedisMock = require('ioredis-mock');

// 替换原代码中的cluster实例
jest.mock('./cache', () => {
  const originalModule = jest.requireActual('./cache');
  const clusterMock = new RedisMock.Cluster([{ port: '123', host: 'https://host' }]);
  return {
    ...originalModule,
    cluster: clusterMock
  };
});

describe('updateCache', () => {
  let clusterMock;

  beforeEach(() => {
    clusterMock = require('./cache').cluster;
    jest.clearAllMocks();
  });

  test('成功更新缓存', async () => {
    clusterMock.hset.mockResolvedValue(1);
    const result = await updateCache('test-id', { name: 'test' });
    
    expect(clusterMock.hset).toHaveBeenCalledWith(
      'TESTINDEX',
      'test-id',
      JSON.stringify({ name: 'test' })
    );
    expect(result).toBe(1);
  });
});

3. 关键注意事项 #

• ioredis-mock的Cluster实现与真实Cluster API对齐，大部分Redis命令可直接Mock
• 测试超时场景时，需模拟Promise延迟超过代码中设置的2000ms阈值
• 每次测试前调用jest.clearAllMocks()，确保用例之间无状态污染

内容的提问来源于stack exchange，提问作者Chelampalem Sampreeth