如何测试函数是否调用特定方法/函数？

Question

Mocha中是否有办法测试函数是否调用特定方法或外部函数？

我正在使用Mocha和Chai，但我对任何其他断言库都开放。

---

好的，所以使用sinon来测试是否正在调用methid是非常容易的。我不确定测试是否正在调用外部函数。所以我更新了这些例子来代表一些更真实的世界＆＃34;。我正在开发一个节点应用，因此foo.js和bar.js都是模块。

实施例

foo.js

var bar = require('bar');
var xyz = function () {};

var Foo = module.exports = function () {
  this.bar();
  bar();
  xyz();
};
Foo.prototype.bar = function () {};

bar.js

var bar = module.exports = function () {};

fooSpec.js

var chai      = require('chai');
var sinon     = require('sinon');
var sinonChai = require('sinonChai');
var expect    = chai.expect;
var Foo       = require('../lib/foo');

chai.use('sinonChai');

describe('Foo', function () {

  var method;

  beforeEach(function (done) {
    method = sinon.spy(Foo.prototype, 'bar');
    done();
  });
  afterEach(function (done) {
    method.restore();
    done();
  });

  it('should call Foo.prototype.bar() immediately', function () {

    new Foo();
    expect(method).to.have.been.called;

  });

  it('should call the module bar immediately', function () {
    // ????????????
  });

  it('should call xyz() immediately', function () {
    // ????????????
  });
});

因为你可以看到我已经找到了如何测试Foo.prototype.bar，但我无法找到实现第二和第三次测试的方法。

Answer 1

所以这个问题真的是二合一的。

首先，“如何测试方法是否被调用”： 我在示例中列出了这个代码，但基本上，使用sinon.js，你只需将方法包装在一个“间谍”中，它允许你编写一个期望调用spy的测试。

其次，“如何测试私有函数（未作为模块的一部分导出的函数）是否已被调用”：

基本上，你没有。可以在测试环境中而不是在生产环境中导出这些函数，但这对我来说似乎有点太过分了。

我得出的结论是，当调用另一个模块时，你应该打破TDD周期而不是测试它，因为它可能只是少量的代码，并且模块已经在它自己的测试。

如果您正在调用在您的模块中声明的私有函数并想要测试它，您应该编写一个更广泛的测试来测试调用此函数的结果，而不是测试函数是否被调用或在函数中实际发生了什么。

这是一个非常简单的例子：

foo.js

var _ = require('lodash');

var Foo = module.exports = function (config) {

  this.config = _.merge({
      role: 'user',
      x: '123',
      y: '321'
    },
    config);

  this.config.role = validateRole(this.config.role);
};

var validateRole = function (role) {
  var roles = [
    'user', 'editor', 'admin'
  ];

  if (_.contains(roles, role)) {
    return role;
  } else {
    return 'user'
  }
};

fooSpec.js

var chai = require('chai');
var expect = chai.expect;
var Foo = require('../lib/foo');

describe('Foo', function () {

  it('should set role to \'user\' if role is not valid', function () {

    var foo = new Foo({role: 'invalid'});
    expect(foo.config.role).to.equal('user');

  });

};

Answer 2

我将expect断言库与Mocha一起使用，但Chai可能有类似的方法

第一

您可以使用Spies测试函数是否调用特定方法/函数。你在上面的代码中做到了这一点。

第二

您正在测试的代码的问题是Context。所以我将在这个答案中解决它。您可以测试是否调用了外部函数，但需要上下文，因此您可能需要更改代码。

  

我以bar（模块）为例。对于xyz（函数），请转到第二种方法。两者的解释都是一样的。

1。在对象

中导出bar

bar.js

var bar = module.exports = { 
  bar: function () {}; 
}

foo.js

var Foo = module.exports = function () {
  bar.bar();
  ....
};

这样你就可以监视它：

fooSpec.js

it('should call the module bar immediately', function () {

  //note I'm getting the bar method from the exported object (bar module)
  var bar = expect.spyOn(bar, 'bar'); 

  new Foo();

  expect(bar).toHaveBeenCalled();

2。将bar模块设置为Foo的原型方法

如果您不想更改bar.js，可以将所需模块设置为Foo的原型方法。然后你有一个窥探的背景。

foo.js

var bar = require('./bar');

var Foo = module.exports = function () {
  this.bar();
  this.barModule();
};
Foo.prototype.bar = function () {};
Foo.prototype.barModule = bar; // setting here as barModule

fooSpec.js

it('should call the module bar immediately', function () {
  var barSpy = expect.spyOn(Foo.prototype, 'barModule');

  new Foo();

  expect(barSpy).toHaveBeenCalled();    
});

解释

您必须做的更改是更改变量的上下文。

说清楚：

var bar = require('bar');

var Foo = module.exports = function () {
  this.bar();
  bar();
};
Foo.prototype.bar = function () {};

在此代码段中，您需要bar，然后使用this.bar设置Foo.prototype。那么，如何设置2个具有相同名称的变量并相互引用呢？

答案是上下文和范围。您的this.bar引用了bar上下文中设置的this变量（指向Foo）。另一方面，您的bar - 请注意没有this - 引用功能的（模块）范围中设置的bar变量。

所以，你可以测试你的Foo.prototype.bar，因为它是一个模块方法，有一个上下文，你可能会窥探它。购买你不能监视所需的bar，因为它是作用域的（将其视为私有）。

好读：http://ryanmorr.com/understanding-scope-and-context-in-javascript/