如何对调用另一个返回承诺的函数进行单元测试？

Question

我有一个使用 express 4 的 node.js 应用程序，这是我的控制器：

var service = require('./category.service');

module.exports = {
  findAll: (request, response) => {
    service.findAll().then((categories) => {
      response.status(200).send(categories);
    }, (error) => {
      response.status(error.statusCode || 500).json(error);
    });
  }
};

它调用我的服务返回一个承诺。一切正常，但我在尝试对其进行单元测试时遇到了麻烦。

基本上，我想确保根据我的服务返回的内容，我使用正确的状态代码和正文刷新响应。

所以对于 mocha 和 sinon，它看起来像：

it('Should call service to find all the categories', (done) => {
    // Arrange
    var expectedCategories = ['foo', 'bar'];

    var findAllStub = sandbox.stub(service, 'findAll');
    findAllStub.resolves(expectedCategories);

    var response = {
       status: () => { return response; },
       send: () => {}
    };
    sandbox.spy(response, 'status');
    sandbox.spy(response, 'send');

    // Act
    controller.findAll({}, response);

    // Assert
    expect(findAllStub.called).to.be.ok;
    expect(findAllStub.callCount).to.equal(1);
    expect(response.status).to.be.calledWith(200); // not working
    expect(response.send).to.be.called; // not working
    done();
});

当我正在测试的函数返回一个 Promise 时，我已经测试了我的类似场景，因为我可以在 then 中挂钩我的断言。

我也尝试用 Promise 包装 controller.findAll 并从 response.send 中解决它，但它也没有工作。

Answer 1

您应该将您的断言部分移动到res.send 方法中，以确保所有异步任务在断言之前完成：

var response = {
   status: () => { return response; },
   send: () => {
     try {
       // Assert
       expect(findAllStub.called).to.be.ok;
       expect(findAllStub.callCount).to.equal(1);
       expect(response.status).to.be.calledWith(200); // not working
       // expect(response.send).to.be.called; // not needed anymore
       done();
     } catch (err) {
       done(err);
     }
   },
};

Answer 2

这里的想法是让service.findAll() 返回的承诺可以在测试代码中访问，而无需调用service。据我所知，您可能使用的sinon-as-promised 不允许这样做。所以我只使用了原生的Promise（希望你的节点版本不会太旧）。

const aPromise = Promise.resolve(expectedCategories); 
var findAllStub = sandbox.stub(service, 'findAll');
findAllStub.returns(aPromise);

// response = { .... }

controller.findAll({}, response);

aPromise.then(() => {
    expect(response.status).to.be.calledWith(200);
    expect(response.send).to.be.called;    
});

Answer 3

当代码难以测试时，它可能表明可能有不同的设计可能性可供探索，从而促进轻松测试。跳出来的是service 包含在您的模块中，并且根本没有暴露依赖关系。我觉得目标不应该是找到一种方法来按原样测试您的代码，而是找到一个最佳设计。

IMO 的目标是找到一种公开service 的方法，以便您的测试可以提供存根实现，从而可以隔离、同步地测试findAll 的逻辑。

一种方法是使用像mockery 或rewire 这样的库。两者都相当容易使用，（根据我的经验，随着您的测试套件和模块数量的增加，嘲弄开始退化并且变得非常难以维护）它们将允许您通过为自己的服务对象提供自己的服务对象来修补var service = require('./category.service'); findAll 已定义。

另一种方法是重新构建您的代码，以某种方式将service 公开给调用者。这将允许您的调用者（单元测试）提供自己的service 存根。

一种简单的方法是导出函数构造函数而不是对象。

module.exports = (userService) => {

  // default to the required service
  this.service = userService || service;

  this.findAll = (request, response) => {
    this.service.findAll().then((categories) => {
      response.status(200).send(categories);
    }, (error) => {
      response.status(error.statusCode || 500).json(error);
    });
  }
};

var ServiceConstructor = require('yourmodule');
var service = new ServiceConstructor();

现在测试可以为service 创建一个存根并将其提供给ServiceConstructor 以执行findAll 方法。完全不需要异步测试。