如何在 Nodejs 中模拟外部依赖方法回调参数？答案

【问题标题】：How to mock an external dependency method callback params in Nodejs?如何在 Nodejs 中模拟外部依赖方法回调参数？
【发布时间】：2016-08-26 21:41:11
【问题描述】：

假设我有以下内容：

lib/modules/module1.js

var m2 = require('module2');

module.exports = function(){
    return {
        // ...
        get: function(cb){
            m2.someMethod(params, function(error, data){
                if(error){
                    cb(error)
                }

                cb(null, data)
            })
        },
        // ...
    }
}

现在假设我在另一个目录中有一组测试，例如测试/testModule1.js。从这个文件中，我创建了一个module1 的实例来执行一些测试。

我想从文件 testModule1.js 模拟 m2.someMethod 传递给它的回调函数（不是 cb 函数）的对象。

我已经查看了Sinon.js，但我想不出办法来做到这一点。实际上，我什至可能？

谢谢。

【问题讨论】：

回答了可能相关的类似问题stackoverflow.com/a/39181844/594589

标签： javascript node.js unit-testing mocking

【解决方案1】：

您可以使用 proxyquire 之类的东西，但我不喜欢修改内置的 require。

就个人而言，我建议重写您的代码以使用依赖注入：

module.exports = function(m2){
    return {
        // ...
        get: function(cb){
            m2.someMethod(params, function(error, data){
                if(error){
                    cb(error)
                }

                cb(null, data)
            })
        },
        // ...
    }
}

请注意，我将m2 移动为导出函数中的参数。然后在其他地方（应用程序、主程序或其他），您可以这样做：

app.js

var module1Creator = require('module1');
var module2 = require('module2');
var module1 = module1Creator(module2);

那么当你需要测试它的时候......

testModule1.js

var module1Creator = require('module1');
// inject the "fake" version containing test data, spies, etc
var module2Mocked = require('module2mock');
var module1 = module1Creator(module2mocked);

【讨论】：

【解决方案2】：

我通常同意改变设计，正如@dvlsg 所建议的，DI 也是我的选择。

但是，我正在进行的项目已经在进行中，而且规模相当大。进行此更改将意味着巨大的人力成本，特别是在这种情况下，可能不值得这样做。

作为一种解决方案，我意识到，一旦您执行require('someModule')，就会加载 someModule 并将其作为单例存储在某种全局缓存中（我不完全理解这个机制，但我会研究它），不管你是否从另一个文件require('someModule')，你都会收到缓存的版本。

所以，如果在 lib/modules/module1.js 中我执行 require('module2')，module2 被加载并存储在这个缓存中，我可以 require('module2') 和在 tests/testModule1.js 中模拟它。这将反映何时调用来自 lib/modules/module1.js 的 get()。

为此，我使用Sinon.js 在测试文件中创建模拟。

上面的过程实际上解决了我的问题，在某种程度上我不必改变整个设计，并且我能够进行测试。这就是为什么我将其发布为答案。但是，我不会在这里将其设置为正确答案，因为正如我之前所说，我并不完全理解这种机制并且更改所需的模块不是一个好习惯。

我想看看其他开发者对此有什么看法，如果讨论导致接受，我最终会将其设置为正确的。

【讨论】：