如何在 Hapi/Lab 测试中使用 Sinon 删除 knex 调用？答案

【问题标题】：How to use Sinon to stub out knex calls in Hapi/Lab test?如何在 Hapi/Lab 测试中使用 Sinon 删除 knex 调用？
【发布时间】：2018-03-15 07:04:09
【问题描述】：

我正在尝试为新的 Hapi 应用设置测试模式。我过去在 Express 中使用过 Mocha 和 Chai，但我正在尝试使用 Lab 和 Code 留在 Hapi 生态系统中。我还使用 Bookshelf 和 Knex 来处理数据库交互。

所以我想测试一个简单的健康端点。

'use strict';

const controller = require('../controller/healthController');

module.exports = [
  {
    method: 'GET',
    path: '/health',
    config: {
      handler: controller.health,
      description: 'The health endpoint returns 200',
      tags: ['api', 'health']
    }
  }
];

在处理程序中，它只是进行快速查询以确保它可以连接到数据库。

'use strict';

const bookshelf = require('../config/db');
const knex = bookshelf.knex;

module.exports = {
  health: function (request, reply) {
    knex.raw('SELECT version()').then(() => {
      reply('service is running');
    }).catch((err) => {
      reply({err: err, code: 500});
    });
  }
};

据我所知，需要服务器然后使用 server.inject 实际上并没有启动服务器，所以我不相信我应该有一个数据库连接，这意味着我应该模拟它数据库调用。奇怪的是，这个测试通过了：

'use strict';
const Code = require('code');
const Lab = require('lab');

const lab = exports.lab = Lab.script();
const describe = lab.describe;
const it = lab.test;
const expect = Code.expect;
const before = lab.before;

let server;

describe('health controller', () => {

  before((done) => {
    server = require('../../server');
    done();
  });

  it('health check replies 200 when successful call to db', (done) => {

    const options = {
      method: 'GET',
      url: '/health'
    };

    server.inject(options, (res) => {
      expect(res.payload).to.include('is running');
      expect(res.statusCode).to.equal(200);

      done();
    });

  });

});

所以我有两个问题。首先，我觉得上面的测试不应该真正通过。除非它正在加载所有内容并因此连接到我想的数据库。也许我应该只测试控制器/处理程序方法？但我还没有找到任何例子。

其次，无论如何，我都尝试将 knex.raw 调用存根，当我尝试像下面那样执行此操作时，我收到 500 错误。

'use strict';
const Code = require('code');
const Lab = require('lab');
const Sinon = require('sinon');

const lab = exports.lab = Lab.script();
const describe = lab.describe;
const it = lab.test;
const expect = Code.expect;
const before = lab.before;

let server;
let knex = require('../../app/config/db').knex;

describe('health controller', () => {

  before((done) => {
    server = require('../../server');
    done();
  });

  it('health check replies 200 when successful call to db', (done) => {

    const stub = Sinon.stub(knex, 'raw').returns({});

    const options = {
      method: 'GET',
      url: '/health'
    };

    server.inject(options, (res) => {
      expect(res.payload).to.include('is running');
      expect(res.statusCode).to.equal(200);
      expect(stub.calledOnce).to.be.true();
      done();
    });

  });

});

我不太确定为什么会这样。

【问题讨论】：

您的require('../../app/config/db') 怎么样？在第一阶段，尝试内联测试用例文件中的所有查询代码，以确保模拟按预期工作，然后将代码逐个移动到正确的位置以找到无法按预期工作的确切位置.
请附上'../../server'的源代码。请包含 500 错误的消息以及来自您的控制台的任何日志。
我的回答对您有任何帮助吗？

标签： sinon hapijs knex.js bookshelf.js lab

【解决方案1】：

我认为Sinon.stub(knex, 'raw').resolves({}); 是一个更好的解决方案

【讨论】：

【解决方案2】：

server.inject 的工作原理就像您向真实服务器发出请求一样。因此，如果在运行测试时您的数据库已启动，那么端点将从数据库返回数据，就像您手动启动服务器时一样。

Sinon.stub(knex, 'raw').returns({}); 不起作用。 knex.raw(…) 应该返回一个 Promise，而不是一个空对象。请尝试以下方法：

Sinon.stub(knex, 'raw').returns(Promise.resolve({}));

附注：请记住在每次测试后调用server.stop()，以确保测试之间没有持续存在的状态。一般来说，我认为您可以查看Hapi University repository 中的示例测试文件。

【讨论】：