使用mocha和node.js对私有函数进行单元测试

Question

我正在使用mocha来单元测试为node.js编写的应用程序

我想知道是否可以对未在模块中导出的单元测试功能进行单元测试.

例:

我有很多像这样定义的函数 foobar.js

function private_foobar1(){
    ...
}

function private_foobar2(){
    ...
}

以及一些出口为公共的功能:

exports.public_foobar3 = function(){
    ...
}

测试用例的结构如下:

describe("private_foobar1", function() {
    it("should do stuff", function(done) {
        var stuff = foobar.private_foobar1(filter);
        should(stuff).be.ok;
        should(stuff).....

显然这不起作用,因为private_foobar1没有导出.

对私有方法进行单元测试的正确方法是什么？摩卡有没有一些内置的方法呢？

Answer 1

检查重新布线模块.它允许您获取(和操作)模块中的私有变量和函数.

所以在你的情况下,用法将是这样的:

var rewire = require('rewire'),
    foobar = rewire('./foobar'); // Bring your module in with rewire

describe("private_foobar1", function() {

    // Use the special '__get__' accessor to get your private function.
    var private_foobar1 = foobar.__get__('private_foobar1');

    it("should do stuff", function(done) {
        var stuff = private_foobar1(filter);
        should(stuff).be.ok;
        should(stuff).....

Answer 2

如果模块未导出该功能,则模块外部的测试代码无法调用该功能.这是由于JavaScript如何工作,而Mocha本身无法绕过这一点.

在我决定测试私有函数是做正确的事的少数情况下,我做了什么设置一些环境变量,我的模块检查,以确定它是否是在测试设置或不运行.如果它在测试设置中运行,那么它会导出我可以在测试期间调用的其他函数.

这里使用了"环境"这个词.这可能意味着检查process.env或其他可以与模块通信的内容"您现在正在测试".我必须这样做的实例是在RequireJS环境中,我已经用于module.config此目的.

Answer 3

这是一个非常好的工作流程来测试您的私人方法,这是由Google工程师Philip Walton在其博客上解释的.

原理

• 正常编写代码
• 将您的私有方法绑定到单独的代码块中的对象,_例如将其标记为
• 通过开始和结束注释围绕代码块

然后使用构建任务或您自己的构建系统(例如grunt-strip-code)来剥离生产构建的集合.

您的测试版本可以访问您的私有API,而您的生产版本则没有.

片段

把你的代码写成:

var myModule = (function() {

  function foo() {
    // private function `foo` inside closure
    return "foo"
  }

  var api = {
    bar: function() {
      // public function `bar` returned from closure
      return "bar"
    }
  }

  /* test-code */
  api._foo = foo
  /* end-test-code */

  return api
}())

还有那样的笨拙的任务

grunt.registerTask("test", [
  "concat",
  "jshint",
  "jasmine"
])
grunt.registerTask("deploy", [
  "concat",
  "strip-code",
  "jshint",
  "uglify"
])

更深入

在后面的文章中,它解释了"测试私有方法"的"原因"

Answer 4

如果您希望保持简单,只需导出私有成员,但明确地与公共API分开一些约定,例如在它们前面加上一个私有对象_或将它们嵌套在一个私有对象下.

var privateWorker = function() {
    return 1
}

var doSomething = function() {
    return privateWorker()
}

module.exports = {
    doSomething: doSomething,
    _privateWorker: privateWorker
}

Answer 5

我添加了一个名为Internal()的额外函数，并从那里返回所有私有函数。然后导出此Internal()函数。例子：

function Internal () {
  return { Private_Function1, Private_Function2, Private_Function2}
}

// Exports --------------------------
module.exports = { PublicFunction1, PublicFunction2, Internal }

您可以像这样调用内部函数：

let test = require('.....')
test.Internal().Private_Function1()

我最喜欢这个解决方案，因为：

• 只有一个函数Internal()总是被导出。此Internal()函数始终用于测试私有函数。
• 实施起来很简单
• 对生产代码影响小（只有一项额外功能）

Answer 6

为此，我制作了一个npm软件包，您可能会发现它很有用：require-from

基本上，您可以通过以下方式公开非公共方法：

module.testExports = {
    private_foobar1: private_foobar1,
    private_foobar2: private_foobar2,
    ...
}

注意：当然 testExports可以是您想要的任何有效名称exports。

从另一个模块：

var requireFrom = require('require-from');
var private_foobar1 = requireFrom('testExports', './path-to-module').private_foobar1;