是否可以使用 sinon 在 CommonJS 模块中存根导出函数？

Question

快到2021年了，有没有办法mock单个函数呢？我的意思是没有对象的函数。

// demo.js
module.exports = () => {
  return 'real func demo';
};

// demo.test.js
const demo = require("./demo");
// ...
sinon.stub(demo).callsFake(() => {
  return 'mocked function';
});
expect(demo()).to.eq('mocked function')

Answer 1

我在这里只引用我自己的话：

您无法在 ES2015 兼容模块 (ESM) 中或 Node.js 中的 CommonJS 模块中存根独立导出函数。这就是这些模块系统的工作原理。只有将它们转化为其他东西之后，你才可能实现你想要的。如何替换模块完全是环境特定的，这就是为什么 Sinon 将自己标榜为“JavaScript 的独立测试间谍、存根和模拟”，而不是模块替换工具，因为最好留给环境特定的实用程序（proxyquire、各种 webpack 加载器、Jest）等）无论您所处的环境如何。

要更深入地了解为什么在使用解构时这在 CommonJS 中永远不起作用，请参阅我的回答here。您需要注入一个模块加载器来拦截加载。

这就是在符合规范的环境中尝试使用 Sinon 来删除 ESM 模块的情况：

$ node esm-stubbing.mjs
/private/tmp/test/node_modules/sinon/lib/sinon/stub.js:72
        throw new TypeError("ES Modules cannot be stubbed");
              ^

TypeError: ES Modules cannot be stubbed
    at Function.stub (/private/tmp/test/node_modules/sinon/lib/sinon/stub.js:72:15)
    at Sandbox.stub (/private/tmp/test/node_modules/sinon/lib/sinon/sandbox.js:388:37)
    at file:///private/tmp/test/esm-stubbing.mjs:4:7

$ cat esm-stubbing.mjs
import sinon from "sinon";
import * as myModule from "./module.mjs";

sinon.stub(myModule, "foo").returns(42);

这只是 Sinon 本身在看到模块的命名空间是只读时抛出错误，而不是让 Node 抛出更神秘的错误消息。