如何调用 Koa.js 应用程序实例进行单元测试

Question

我不知道如何称呼这可能是“对 koa 路由器的静态调用”？如果您从技术上谈论它，这似乎是我真正想要实现的目标的正确措辞吗？

无论如何，我正在使用koa-router 并且正在编写单元测试（不是集成测试）。所以我不想在我的 koa 应用程序上调用 .listen() ，因为这个原因......它会创建一个 http 服务器，现在让我的测试成为集成测试。

在我的测试中，我只是想直接调用应用程序对象实例并调用路由，并且能够不返回任何结果并检查我是否在响应中没有返回任何结果。

你怎么能做到这一点？我找不到示例，我已经尝试了各种伪代码尝试对 koa 应用程序对象。

Answer 1

如果您想测试 koa-router 路由到的函数，那么只需对该函数执行单元测试并将路由排除在外。

对我来说，听起来您有一个 app.js 之类的文件，其中包含您的所有代码。您可以做的是创建一个 router.js 文件来放置您的路由绑定和一个 services.js 文件，您可以在其中放置您的应用程序逻辑。

所以例如 app.js 可能看起来像：

var koa = require("koa");
var app = module.exports = koa();
var router = require('./router.js');

app.use(router.unsecured.middleware());

app.listen(3000);

router.js 可能看起来像：

var router = require("koa-router");
var service = require("./services.js");

var unsecured = module.exports.unsecured = new router();

unsecured.post('/account/signin', service.signinUser);
unsecured.post('/account/register', service.registerUser);

services.js 可能看起来像：

module.exports.signinUser  = function*(signinDetails) {
  // contains your application signin logic
};

module.exports.registerUser  = function*(registerDetails) {
  // contains your application register logic
};

因此，您可以通过这种方式单独测试 services.js。我认为单独测试 router.js 没有任何价值，因为它是如此微不足道。正如@Dan Pantry 所示，您可以使用 supertest 在集成测试中测试路由。

编辑：

所以这是我正在玩的一个小实验测试，以测试路由是否正确。我使用 mocha 作为测试运行器，并使用我在原始代码中发布的代码示例。

// standard library
var assert = require("assert");

// in app objects
var router = require('./router.js');
var service = require('./service.js');

describe("routing tests", function() {

  it("test register routing, POST", function*(done) {
    // arrange
    var unsecured = router.unsecured;
    var path = '/account/register';
    var httpMethod = 'POST';
    var expected = service.register.toString();
    var actual;

    // act
    for (var i = 0; i < unsecured.stack.length; i++)
    {
      var pathMatch = unsecured.stack[i].path === path;
      var methodMatch = unsecured.stack[i].methods.indexOf(httpMethod) >= 0;

      if (pathMatch && methodMatch)
      {
        actual = unsecured.stack[i].middleware.toString();
        break;
      }
    }

    // assert
    try {
      assert.equal(expected, actual);
      done();
    } catch(err) {
      done(err);
    }
  });    
});

可能有一种更简洁的方法（以及测试多条路径的更模块化的方法），但正如我所说，这只是验证路由调用正确服务的基本示例。我正在做的是深入研究 koa-router 对象，以根据 HTTP 方法（例如 POST、GET 等）验证哪些路径绑定到哪些服务代码。

如果您在模块中包含路由和服务，则此测试完全避免处理主要的 koa 应用程序。虽然从技术上讲，这个测试跨越了多个单元（路由和服务代码），所以从技术上讲它是一个集成测试，但这确实意味着你不要靠近app.listen()，这是你不想在测试中调用的。