如何sinon间谍模块导出实用程序功能

时间:2016-10-05 07:42:39

标签: javascript node.js sinon chai

在javascript(ES6)中,我有一个实用程序模块,它只包含一些函数,然后在文件的最后,我这样导出它们:

module.exports = {
  someFunction1,
  someFunction2,
  someFunction3,
}

然后我想为这些函数编写单元测试。一些功能相互依赖;他们以某种方式相互调用,例如,someFunction1可能会调用someFunction2。没有循环问题。

一切都运作良好,直到我需要监视其中一个函数被调用。我该怎么做?目前我正在使用Chai和Sinon。

在测试文件中,我将整个文件导入为模块:

const wholeModule = require('path/to/the/js/file')

最后,我的测试如下:

it('should call the someFunction2', (done) => {
  const spy = sinon.spy(wholeModule, 'someFunction2')

  wholeModule.someFunction1() // someFunction2 is called inside someFunction1

  assert(spy.calledOnce, 'someFunction2 should be called once')
  done()
})

问题是,测试失败,因为在someFunction1中,someFunction2函数直接使用。我将间谍应用于模块对象的功能。但那是一个不同的对象。这是someFunction1的一个例子:

function someFunction1() {
  someFunction2()
  return 2;
}

我知道它不起作用的原因,但我不知道在这种情况下最佳做法是什么才能使其发挥作用?请帮忙!

1 个答案:

答案 0 :(得分:5)

您可以使用rewire模块。这是一个例子:

源代码:

function someFunction1() {
  console.log('someFunction1 called')
  someFunction2();
}

function someFunction2() {
  console.log('someFunction2 called')
}

module.exports = {
  someFunction1: someFunction1,
  someFunction2: someFunction2
}

测试案例

'use strict';

var expect = require('chai').expect;
var rewire = require('rewire');
var sinon = require('sinon');

var funcs = rewire('../lib/someFunctions');

it('should call the someFunction2', () => {
  var someFunction2Stub = sinon.stub();
  funcs.__set__({
    someFunction2: someFunction2Stub,
  });

  someFunction2Stub.returns(null);

  funcs.someFunction1();

  expect(someFunction2Stub.calledOnce).to.equal(true);
});