存根模块函数

编辑：更精确一点。

我想测试我们团队创建的Github API包装器扩展的用例。对于测试，我们不想直接使用API包装器扩展，所以我们想要存根它的函数。所有对API包装器的调用都应该为测试清除掉，而不仅仅是创建克隆存根。

我在Node.js中有一个模块"GitHub"：

module.exports = function(args, done) {
    ...
}

我是这样要求的：

var github = require('../services/github');

现在，我想使用Sinon.js：

清除github(...)

var stub_github = sinon.stub(???, "github", function (args, callback) { 
    console.log("the github(...) call was stubbed out!!");
});

但sinon.stub(...)希望我传递对象和方法，而不允许我存根出作为函数的模块。

有什么想法吗？

---

解决方案

可能有一种方法可以用纯SINON来实现这一点，但我怀疑它会很麻烦。然而，proxyquire是为解决这类问题而设计的节点库。

假设您想要测试使用GitHub模块的某个模块foo；您可以编写如下代码：

var proxyquire = require("proxyquire");
var foo = proxyquire(".foo", {"./github", myFakeGithubStub});

其中myFakeGithubStub可以是任何内容；完整的存根，或经过一些调整的实际实现等。

在上面的示例中，如果myFakeGithubStub将属性"@global"设置为True(即，通过执行myFakeGithubStub["@global"] = true)，则GitHub模块不仅在foo模块本身中，而且在foo模块需要的任何模块中都将被替换为存根。但是，正如proxyquire documentation on the global option中所述，一般来说，此功能是设计不佳的单元测试的标志，应避免使用。