用 sinon 和 bluebird 存入一个 promisified 函数

Question

在我要测试的文件中，我有以下代码：

var httpGet = Promise.promisify(require("request").get);
httpGet(endpoint, {
    auth: {bearer: req.body.access_token},
    json: true
})
    .then(...)

现在，在我的测试中，我想确保调用了一次 httpGet，并确保参数有效。在被承诺之前，我的测试是这样的：

beforeEach(function () {
    request.get = sinon.stub()
        .yields(null, null, {error: "test error", error_description: "fake google error."});
});

afterEach(function () {
    expect(request.get).to.have.been.calledOnce();
    var requestArgs = request.get.args[0];
    var uri = requestArgs[0];

    expect(uri).to.equal(endpoint);
    //...
});

不幸的是，当 request.get 被承诺时，这不再有效。我尝试用 request.getAsync 代替（因为 bluebird 将 "Async" 附加到 promisified 函数），但这也不起作用。有什么想法吗？

Answer 1

Promise.promisify 不修改对象，它只是接受一个函数和 returns 一个新函数，完全不知道该函数甚至属于 "request".

"Async"使用promisify时对象添加后缀方法All

Promise.promisifyAll(require("request"));

request.getAsync = sinon.stub()
        .yields(null, null, {error: "test error", error_description: "fake google error."});

expect(request.getAsync).to.have.been.calledOnce();

Answer 2

任何人都遇到过这个。我有小实用功能

function stubCBForPromisify(stub) {
  let cbFn = function() {
    let args = [...arguments];
    args.shift();
    return stub(...args);
  };
  return cbFn.bind(cbFn, () => ({}));
}

测试中

var getStub = sinon.stub().yields(null, {error: "test error", error_description: "fake google error."})
sinon.stub(require("request"), 'get', stubCBForPromisify(getStub))
expect(getStub).to.have.been.calledOnce();

Answer 3

我运行使用 tape 和 proxyquire 测试这个时遇到了麻烦。我不确定 pattern/framework 人们使用什么允许他们直接修改 required 的 request 对象，如已接受的答案所示。就我而言，在我要测试的文件中 require('jsonFile')，然后调用 bluebird.promisifyAll(jsonFile)。在正常情况下，这会创建一个我想要存根的 readFileAsync 方法。但是，如果在测试期间我尝试使用 proxyquire 来传递存根，则对 promisifyAll 的调用会覆盖我的存根。

我能够通过将 promisifyAll 设为空操作来解决此问题。如图所示，如果您依赖某些按原样创建的异步方法，这可能太粗糙了。

core.js:

var jsonFile = require('jsonfile');
var Promise = require('bluebird');
Promise.promisifyAll(jsonFile);

exports.getFile = function(path) {
  // I want to stub this method during tests. It is
  // created by promisifyAll
  return jsonFile.readFileAsync(path);
}

core-test.js:

var proxyquire = require('proxyquire');
var tape = require('tape');
var sinon = require('sinon');
require('sinon-as-promised');

tape('stub readFileAsync', function(t) {
  var core = proxyquire('./core', {
    'jsonfile': {
      readFileAsync: sinon.stub().resolves({})
    },
    'bluebird': { promisifyAll: function() {} }
  });
  // Now core.getFile() will use my stubbed function, and it
  // won't be overwritten by promisifyAll.
});

Answer 4

仅供将来参考，我以不同的方式解决了这个问题，而且我认为更简洁一些。这是打字稿，但基本上是一样的。

fileBeingTested.ts

import * as Bluebird from 'bluebird';
import * as needsPromise from 'needs-promise';

const methodAsync = Bluebird.promisify(needsPromise.method);

export function whatever() {
    methodAsync().then(...).catch(...);
}

test.spec.ts

import * as needsPromise from 'needs-promise';
import * as sinon form 'sinon';

const methodStub = sinon.stub(needsPromise, method);
import { whatever } from './fileBeingTested';

然后您使用 methodStub 来管理发生的呼叫。您可以忽略它正在被承诺并只管理它的正常行为。例如，如果你需要它出错。

methodStub.callsFake((arg, callback) => {
    callback({ error: 'Error' }, []);
});

promisified 版本会抛出错误，你会发现它。

用 sinon 和 bluebird 存入一个 promisified 函数

Stubbing a promisified function with sinon and bluebird

javascript

node.js

promise

sinon

bluebird