Question

我正在试图弄清楚如何测试nodejs中的内部（即未导出）函数（最好使用mocha或jasmine）。我不知道！

假设我有一个类似的模块：

function exported(i) {
   return notExported(i) + 1;
}

function notExported(i) {
   return i*2;
}

exports.exported = exported;

以下测试（摩卡）：

var assert = require('assert'),
    test = require('../modules/core/test');

describe('test', function(){

  describe('#exported(i)', function(){
    it('should return (i*2)+1 for any given i', function(){
      assert.equal(3, test.exported(1));
      assert.equal(5, test.exported(2));
    });
  });
});

有没有办法对notExported函数进行单元测试而不实际导出它，因为它不打算暴露？

Answer 1

rewire模块绝对是答案。

这是我的代码，用于访问未导出的函数并使用Mocha进行测试。

的application.js：

function logMongoError(){
  console.error('MongoDB Connection Error. Please make sure that MongoDB is running.');
}

test.js：

var rewire = require('rewire');
var chai = require('chai');
var should = chai.should();


var app = rewire('../application/application.js');


logError = app.__get__('logMongoError'); 

describe('Application module', function() {

  it('should output the correct error', function(done) {
      logError().should.equal('MongoDB Connection Error. Please make sure that MongoDB is running.');
      done();
  });
});

Answer 2

诀窍是将NODE_ENV环境变量设置为test，然后有条件地导出它。

假设您没有全局安装mocha，您可以在app目录的根目录中包含Makefile，其中包含以下内容：

REPORTER = dot

test:
    @NODE_ENV=test ./node_modules/.bin/mocha \
        --recursive --reporter $(REPORTER) --ui bbd

.PHONY: test

此make文件在运行mocha之前设置NODE_ENV。然后，您可以在命令行中使用make test运行mocha测试。

现在，您可以有条件地导出通常在您的mocha测试运行时通常不会导出的函数：

function exported(i) {
   return notExported(i) + 1;
}

function notExported(i) {
   return i*2;
}

if (process.env.NODE_ENV === "test") {
   exports.notExported = notExported;
}
exports.exported = exported;

另一个答案建议使用vm模块来评估文件，但这不起作用并抛出错误，指出未定义导出。

Answer 3

编辑：

使用vm加载模块可能会导致意外行为（例如，instanceof运算符不再适用于在此类模块中创建的对象，因为全局原型与正常加载的模块中使用的原型不同与require）。我不再使用以下技术，而是使用rewire模块。它运作得很好。这是我原来的答案：

阐述srosh的答案......

感觉有点hacky，但是我编写了一个简单的“test_utils.js”模块，它可以让你在你的应用程序模块中没有条件导出的情况下做你想做的事情：

var Script = require('vm').Script,
    fs     = require('fs'),
    path   = require('path'),
    mod    = require('module');

exports.expose = function(filePath) {
  filePath = path.resolve(__dirname, filePath);
  var src = fs.readFileSync(filePath, 'utf8');
  var context = {
    parent: module.parent, paths: module.paths, 
    console: console, exports: {}};
  context.module = context;
  context.require = function (file){
    return mod.prototype.require.call(context, file);};
  (new Script(src)).runInNewContext(context);
  return context;};

节点模块的gobal module对象中还包含一些可能还需要进入上面context对象的内容，但这是我需要的最小集合。工作

以下是使用mocha BDD的示例：

var util   = require('./test_utils.js'),
    assert = require('assert');

var appModule = util.expose('/path/to/module/modName.js');

describe('appModule', function(){
  it('should test notExposed', function(){
    assert.equal(6, appModule.notExported(3));
  });
});

Answer 4

我找到了一种非常简单的方法，允许您在测试中测试，监视和模拟内部函数：

假设我们有一个这样的节点模块：

mymodule.js:
------------
"use strict";

function myInternalFn() {

}

function myExportableFn() {
    myInternalFn();   
}

exports.myExportableFn = myExportableFn;

如果我们现在想要测试和间谍和模拟myInternalFn 而不在生产中导出，我们必须改进像这样的文件：

my_modified_module.js:
----------------------
"use strict";

var testable;                          // <-- this is new

function myInternalFn() {

}

function myExportableFn() {
    testable.myInternalFn();           // <-- this has changed
}

exports.myExportableFn = myExportableFn;

                                       // the following part is new
if( typeof jasmine !== "undefined" ) {
    testable = exports;
} else {
    testable = {};
}

testable.myInternalFn = myInternalFn;

现在，您可以在myInternalFn处使用它来测试，监视和模拟testable.myInternalFn，并且在生产中不会导出。

Answer 5

使用Jasmine，我尝试根据solution proposed by Anthony Mayfield深入了解rewire。

我实现了以下功能（警告：尚未经过全面测试，只是作为可能的策略共享）：

function spyOnRewired() {
    const SPY_OBJECT = "rewired"; // choose preferred name for holder object
    var wiredModule = arguments[0];
    var mockField = arguments[1];

    wiredModule[SPY_OBJECT] = wiredModule[SPY_OBJECT] || {};
    if (wiredModule[SPY_OBJECT][mockField]) // if it was already spied on...
        // ...reset to the value reverted by jasmine
        wiredModule.__set__(mockField, wiredModule[SPY_OBJECT][mockField]);
    else
        wiredModule[SPY_OBJECT][mockField] = wiredModule.__get__(mockField);

    if (arguments.length == 2) { // top level function
        var returnedSpy = spyOn(wiredModule[SPY_OBJECT], mockField);
        wiredModule.__set__(mockField, wiredModule[SPY_OBJECT][mockField]);
        return returnedSpy;
    } else if (arguments.length == 3) { // method
        var wiredMethod = arguments[2];

        return spyOn(wiredModule[SPY_OBJECT][mockField], wiredMethod);
    }
}

使用这样的函数可以监视非导出对象和非导出顶级函数的两种方法，如下所示：

var dbLoader = require("rewire")("../lib/db-loader");
// Example: rewired module dbLoader
// It has non-exported, top level object 'fs' and function 'message'

spyOnRewired(dbLoader, "fs", "readFileSync").and.returnValue(FULL_POST_TEXT); // method
spyOnRewired(dbLoader, "message"); // top level function

然后你可以设定这样的期望：

expect(dbLoader.rewired.fs.readFileSync).toHaveBeenCalled();
expect(dbLoader.rewired.message).toHaveBeenCalledWith(POST_DESCRIPTION);

Answer 6

你可以使用vm模块创建一个新的上下文并在其中评估js文件，就像repl一样。然后你可以访问它声明的所有内容。

Answer 7

不建议这样做，但是，如果您不能按照@Antoine的建议使用rewire，则始终可以读取文件并使用eval()。

var fs = require('fs');
const JsFileString = fs.readFileSync(fileAbsolutePath, 'utf-8');
eval(JsFileString);

在对遗留系统的客户端JS文件进行单元测试时，我发现这很有用。

JS文件将在window下设置许多全局变量，而没有任何require(...)和module.exports语句（无论如何，没有像Webpack或Browserify这样的模块捆绑器可用于删除这些语句）。

与其重构整个代码库，还不如让我们将单元测试集成到客户端JS中。

Answer 8

本质上，您需要将源上下文与测试用例合并-一种方法是使用包装测试的小型辅助函数。

demo.js

const internalVar = 1;

demo.test.js

const importing = (sourceFile, tests) => eval(`${require('fs').readFileSync(sourceFile)};(${String(tests)})();`);


importing('./demo.js', () => {
    it('should have context access', () => {
        expect(internalVar).toBe(1);
    });
});

Answer 9

eval 本身并不能真正发挥作用（它仅适用于顶级函数或 var 声明），您无法捕获顶级使用 eval 将使用 let 或 const 声明的变量放入当前上下文中，但是，使用 vm 并在当前上下文中运行它将允许您访问 all 顶级执行后的变量...

eval("let local = 42;")
// local is undefined/undeclared here

const vm = require("vm")
vm.runInThisContext("let local = 42;");
// local is 42 here

...尽管“导入”模块中的声明或赋值可能会与 vm 启动时当前上下文中已声明/定义的任何内容发生冲突，如果它们共享相同的名称。

这是一个普通的解决方案。但是，这会为导入的模块/单元添加少量不必要的代码，并且您的测试套件必须直接运行每个文件才能以这种方式运行其单元测试。直接运行你的模块可以做任何事情，但如果没有更多代码，它的运行单元测试是不可能的。

在导入的模块中，检查文件是否是主模块，如果是，运行测试：

const local = {
  doMath() {return 2 + 2}
};

const local2 = 42;

if (require.main === module) {
  require("./test/tests-for-this-file.js")({local, local2});
}

然后在导入目标模块的测试文件/模块中：

module.exports = function(localsObject) {
  // do tests with locals from target module
}

现在直接使用 node MODULEPATH 运行您的目标模块以运行其测试。

如何访问和测试node.js模块中的内部（非导出）功能？

9 个答案: