如何用 sinon/mocha 模拟 npm 模块

Question

我正在尝试测试调用模块cors 的函数。我想测试是否会调用cors。为此，我必须对它进行存根/模拟。

这里是函数 cors.js

const cors = require("cors");

const setCors = () => cors({origin: 'http//localhost:3000'});
module.exports = { setCors }

我测试这种功能的想法是这样的

cors.test.js

  describe("setCors", () => {
    it("should call cors", () => {
      sinon.stub(cors)

      setCors();
      expect(cors).to.have.been.calledOnce;

    });
  });

知道如何存根 npm 模块吗？

Answer 1

您可以使用mock-require 或proxyquire

以mock-require 为例

const mock = require('mock-require')
const sinon = require('sinon')

describe("setCors", () => {
  it("should call cors", () => {
    const corsSpy = sinon.spy();
    mock('cors', corsSpy);

    // Here you might want to reRequire setCors since the dependancy cors is cached by require
    // setCors = mock.reRequire('./setCors');

    setCors();
    expect(corsSpy).to.have.been.calledOnce;
    // corsSpy.callCount should be 1 here

    // Remove the mock
    mock.stop('cors');
  });
});

如果您愿意，您可以在 describe 之上定义模拟，并在每个测试之间使用 corsSpy.reset() 重置间谍，而不是模拟和停止每个测试的模拟。