如何使用sinon/mocha模拟npm模块

在使用 sinon 和 mocha 进行单元测试时，模拟 npm 模块是一个常见的需求。以下是如何使用这两个工具来模拟 npm 模块的详细步骤和示例代码。

基础概念

Mocha: 一个流行的 JavaScript 测试框架，用于编写和运行测试用例。
Sinon: 一个测试工具库，主要用于创建模拟对象、存根（stubs）和间谍（spies）。

类型

Mock: 完全自定义的对象，用于替代真实对象。
Stub: 预定义行为的对象，通常用于替代真实对象的方法。
Spy: 记录方法调用的对象，通常用于验证方法是否被调用。

应用场景

网络请求: 模拟 HTTP 请求和响应。
数据库操作: 模拟数据库查询和更新。
第三方库: 模拟外部 npm 模块的行为。

示例代码

假设我们有一个模块 myModule.js，它依赖于一个外部 npm 模块 externalModule：

// myModule.js
const externalModule = require('externalModule');

exports.myFunction = async () => {
  const result = await externalModule.someAsyncFunction();
  return result;
};

我们可以使用 sinon 和 mocha 来模拟 externalModule：

// test/myModule.test.js
const sinon = require('sinon');
const { expect } = require('chai');
const myModule = require('../myModule');
const externalModule = require('externalModule');

describe('myModule', () => {
  let sandbox;

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

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

  it('should call externalModule.someAsyncFunction and return its result', async () => {
    // 创建一个模拟的 Promise 返回值
    const mockResult = { data: 'mocked data' };
    const stub = sandbox.stub(externalModule, 'someAsyncFunction').resolves(mockResult);

    const result = await myModule.myFunction();

    expect(result).to.deep.equal(mockResult);
    expect(stub.calledOnce).to.be.true;
  });

  it('should handle error from externalModule.someAsyncFunction', async () => {
    const errorMessage = 'mocked error';
    const stub = sandbox.stub(externalModule, 'someAsyncFunction').rejects(new Error(errorMessage));

    try {
      await myModule.myFunction();
    } catch (error) {
      expect(error.message).to.equal(errorMessage);
      expect(stub.calledOnce).to.be.true;
    }
  });
});