Node.js Redis库单元测试：如何Mock client.hgetall方法？

当然可以Mock Redis客户端的hgetall方法，这样你就能完全控制单元测试中的Redis交互逻辑，不需要依赖真实的Redis服务。下面以Jest和Sinon这两个常用测试框架为例，给出具体实现方案：

使用Jest Mock Redis模块 #

Jest内置了模块Mock功能，可以直接拦截redis模块的createClient方法，返回一个带有Mock方法的假客户端：

1. 全局Mock Redis模块 #

在测试文件顶部添加以下代码，Mock整个Redis模块：

jest.mock('redis', () => {
  // 定义Mock的客户端方法
  const mockClient = {
    hgetall: jest.fn(),
    quit: jest.fn()
  };
  return {
    createClient: jest.fn(() => mockClient)
  };
});

2. 编写测试用例 #

针对authorizeRequest的不同分支编写测试，控制hgetall的回调行为：

const { createClient } = require('redis');
const { authorizeRequest } = require('./your-module-path'); // 替换为你的模块路径
const responseMessages = require('./response-messages'); // 引入你的消息常量模块

describe('authorizeRequest', () => {
  const mockClient = createClient(); // 获取Mock的客户端实例

  beforeEach(() => {
    // 重置所有Mock的调用记录
    jest.clearAllMocks();
  });

  // 测试Redis返回数据的情况
  test('处理Redis返回有效数据的场景', (done) => {
    const mockRedisData = { sid: 'test-sid' };
    // 模拟hgetall成功返回数据
    mockClient.hgetall.mockImplementation((key, callback) => {
      callback(null, mockRedisData);
    });

    // 模拟全局的decoded变量（如果你的代码中decoded是全局的）
    global.decoded = { payload: { id: 'test-id', sid: 'test-sid' } };
    // Mock isTheLast函数（如果该函数是模块内的导出）
    const isTheLastMock = jest.spyOn(require('./your-module-path'), 'isTheLast').mockReturnValue(true);

    authorizeRequest('test-token', '/api/test', 'GET', {}, () => {
      expect(mockClient.hgetall).toHaveBeenCalledWith('test-id', expect.any(Function));
      expect(isTheLastMock).toHaveBeenCalledWith('test-sid', 'test-sid');
      expect(mockClient.quit).toHaveBeenCalled();
      done();
    });
  });

  // 测试Redis报错的场景
  test('处理Redis查询出错的场景', (done) => {
    const mockError = new Error('Redis连接失败');
    mockClient.hgetall.mockImplementation((key, callback) => {
      callback(mockError, null);
    });

    global.decoded = { payload: { id: 'test-id' } };

    authorizeRequest('test-token', '/api/test', 'GET', {}, (result) => {
      expect(result).toBe(responseMessages.INTERNAL_ERROR);
      expect(mockClient.hgetall).toHaveBeenCalledWith('test-id', expect.any(Function));
      expect(mockClient.quit).toHaveBeenCalled();
      done();
    });
  });

  // 测试Redis无返回数据的场景
  test('处理Redis无数据返回的场景', (done) => {
    mockClient.hgetall.mockImplementation((key, callback) => {
      callback(null, null);
    });

    global.decoded = { payload: { id: 'test-id' } };

    authorizeRequest('test-token', '/api/test', 'GET', {}, (result) => {
      expect(result).toBe(responseMessages.NOT_FOUND);
      expect(mockClient.hgetall).toHaveBeenCalledWith('test-id', expect.any(Function));
      expect(mockClient.quit).toHaveBeenCalled();
      done();
    });
  });
});

使用Sinon Mock Redis客户端 #

如果你用Sinon作为测试工具，可以通过Stub的方式拦截Redis的方法：

1. 准备Stub #

在测试的beforeEach中创建Redis客户端的Stub：

const sinon = require('sinon');
const redis = require('redis');
const { authorizeRequest } = require('./your-module-path');

describe('authorizeRequest', () => {
  let mockClient;
  let createClientStub;

  beforeEach(() => {
    // 创建Mock客户端
    mockClient = {
      hgetall: sinon.stub(),
      quit: sinon.stub()
    };
    // Stub createClient方法，返回Mock客户端
    createClientStub = sinon.stub(redis, 'createClient').returns(mockClient);
  });

  afterEach(() => {
    // 恢复所有Stub
    sinon.restore();
  });

2. 编写测试用例 #

test('处理Redis返回有效数据的场景', (done) => {
    const mockData = { sid: 'test-sid' };
    // 设置hgetall调用时触发回调，返回数据
    mockClient.hgetall.callsArgWith(1, null, mockData);

    global.decoded = { payload: { id: 'test-id', sid: 'test-sid' } };
    // Stub isTheLast函数
    const isTheLastStub = sinon.stub(require('./your-module-path'), 'isTheLast').returns(true);

    authorizeRequest('test-token', '/api/test', 'GET', {}, () => {
      sinon.assert.calledWith(mockClient.hgetall, 'test-id');
      sinon.assert.calledWith(isTheLastStub, 'test-sid', 'test-sid');
      sinon.assert.called(mockClient.quit);
      done();
    });
  });

  // 其他错误场景、无数据场景的测试用例逻辑类似，这里不再赘述
});

额外注意事项 #

1. 你的代码中decoded是全局变量，这会增加测试的耦合度，建议将其作为参数传入authorizeRequest函数，这样测试时可以更灵活地控制输入。
2. 当前代码的成功分支中没有调用callback，这可能导致测试时回调无法触发，建议补充完整逻辑，确保所有分支都能正确调用回调函数。

内容的提问来源于stack exchange，提问作者Andres Felipe Erazo Ramos