Serverless Lambda单元测试中Mock connectToService函数失效的问题求助

我来帮你搞定这个Mock失效的问题！你遇到的情况其实是Node.js模块缓存机制和Mocha钩子使用错误共同导致的，下面给你拆解原因和具体解决方案：

问题根源分析 #

1. Mocha钩子位置错误：你把before()放在了it()测试用例内部，这会导致Stub代码在测试执行之后才运行（Mocha的钩子函数是在所属的describe/it块执行前触发，放在it里的before完全起不到提前Stub的作用），所以测试时调用的还是原始的connectToService函数。
2. 模块缓存导致引用不一致：当你先导入handler模块，再去StubmsConnector时，handler已经加载了原始的msConnector实例并缓存了它的引用，后续的Stub操作不会影响到handler内部已经使用的那个函数版本。

解决方案 #

下面提供两种可靠的解决方式，推荐第二种更简洁的方案：

方案1：修正钩子位置 + 清除模块缓存 #

通过调整钩子位置，并在每次测试前清除模块缓存，确保handler加载的是被Stub后的依赖：

require('dotenv').config();
const { expect } = require('chai');
const sinon = require('sinon');
const LambdaTester = require('lambda-tester');
const path = require('path');

describe('Testing handler', () => {
  let sandbox;
  let handler;
  let msConnector;

  // 在所有测试前初始化sandbox
  before(() => {
    sandbox = sinon.createSandbox();
  });

  // 每个测试前清除缓存、重新加载模块并Stub
  beforeEach(() => {
    // 清除handler和msConnector的模块缓存
    delete require.cache[path.resolve('../../../handler')];
    delete require.cache[path.resolve('../../../services/connectToService/connectToService')];
    
    // 先加载msConnector并Stub目标函数
    msConnector = require('../../../services/connectToService/connectToService');
    sandbox.stub(msConnector, 'connectToService').resolves('some-token');
    
    // 再加载handler，此时它会使用被Stub后的msConnector
    handler = require('../../../handler');
  });

  // 每个测试后恢复sandbox
  afterEach(() => {
    sandbox.restore();
  });

  describe('endpoint someEndpoint returns 200', () => {
    it('Should resolve with 200 and mock token', async () => {
      await LambdaTester(handler.someEndpoint)
        .expectResult((result) => {
          expect(result.statusCode).to.equal(200);
          expect(result.body).to.equal('some-token'); // 验证返回Mock的token
        });
    });
  });
});

方案2：使用proxyquire替换依赖（更推荐） #

proxyquire是专门用于测试Node.js模块的工具，它可以在导入模块时直接替换其依赖，完全避开模块缓存的问题，用法更简洁：

首先安装依赖：

npm install proxyquire --save-dev

然后修改测试代码：

require('dotenv').config();
const { expect } = require('chai');
const sinon = require('sinon');
const LambdaTester = require('lambda-tester');
const proxyquire = require('proxyquire');

describe('Testing handler', () => {
  let sandbox;
  let mockMsConnector;
  let handler;

  before(() => {
    sandbox = sinon.createSandbox();
  });

  beforeEach(() => {
    // 创建Mock的服务模块，Stub目标函数
    mockMsConnector = {
      connectToService: sandbox.stub().resolves('some-token')
    };

    // 使用proxyquire导入handler，替换它的msConnector依赖
    // 注意：这里的路径要和handler.js中require的路径完全一致
    handler = proxyquire('../../../handler', {
      '../services/connectToService/connectToService': mockMsConnector
    });
  });

  afterEach(() => {
    sandbox.restore();
  });

  describe('endpoint someEndpoint returns 200', () => {
    it('Should resolve with 200 and mock token', async () => {
      await LambdaTester(handler.someEndpoint)
        .expectResult((result) => {
          expect(result.statusCode).to.equal(200);
          expect(result.body).to.equal('some-token');
          // 额外验证：确保Mock函数被调用过
          expect(mockMsConnector.connectToService.calledOnce).to.be.true;
        });
    });

    // 可以扩展测试错误场景
    it('Should return 500 when service throws error', async () => {
      // 修改Stub让它抛出错误
      mockMsConnector.connectToService.rejects(new Error('Connection failed'));

      await LambdaTester(handler.someEndpoint)
        .expectResult((result) => {
          expect(result.statusCode).to.equal(500);
          expect(result.body).to.include('Issue connecting to service - Connection failed');
        });
    });
  });
});

额外提示 #

• 确保proxyquire中替换的路径和handler.js里require('../services/connectToService/connectToService')的路径完全一致，否则替换不会生效。
• 可以添加对Mock函数调用情况的断言（比如calledOnce），让测试更健壮，确保逻辑流程符合预期。

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