Question

在我的代码中，我有：

function handleMessage() {
  const twilio = require('twilio')(process.env.TWILIO_ACCOUNT_SID, process.env.TWILIO_AUTH_TOKEN);
  let recordings = twilio.recordings(foundConference.RecordingSid);
  console.log('recordings', recordings);
  return recordings.remove();
}

在我的存根中，我有：

const sinon = require('sinon');
const twilio = require('twilio')(process.env.TWILIO_ACCOUNT_SID, process.env.TWILIO_AUTH_TOKEN);

exports.twilioRecordings = () => {
  console.log('about to stub', twilio.recordings);
  sinon.stub(twilio, 'recordings').returns('here');
  console.log('finished stub', twilio.recordings);

  return;
};

但是，它实际上并没有创建存根函数。它仍在使用原始的recordings函数。我在做什么错了？

Answer 1

Twilio npm package returns a function which creates a new object on every call，它是not a singleton。因此，您的存根twilio实例仅适用于测试。

也twilio.recordings（和其他所有属性一样）is defined through the getter function in prototype，所以它们是read only：

Object.defineProperty(Twilio.prototype,
  'recordings', {
  get: function() {
    return this.api.account.recordings;
  }
});

因此，存根实际的twilio实例无效。除了您change the instance's prototype，但我认为仅进行单元测试就不值得这样做。

我建议您重构代码以将twilio初始化置于单独的方法中：

function getTwilio() {
   return require('twilio')(process.env.TWILIO_ACCOUNT_SID, process.env.TWILIO_AUTH_TOKEN);
}

接下来，您的hangleMessage将如下所示：

function handleMessage() {
  const twilio = this.getTwilio();
  const recordings = twilio.recordings(...);
  ...
}

接下来，在测试中，您可以对getTwilio()进行存根以返回存根：

const twilioStub = {
    recordings: sinon.stub(),
    remove: sinon.stub()
}
sinon.stub(myAwesomeModule, 'getTwilio').returns(twilioStub);

您还可以考虑使用mock-require软件包：

const sinon = require('sinon');
const mock = require('mock-require');
mock('twilio', () => ({
  recordings: sinon.stub(),
}));

在is a question about how-to mock dependencies，可能还有其他有用的库可以存根所需的模块。

希望有帮助。

为什么我不能用sinon正确地对twilio库进行存根？

1 个答案: