使用 Supertest、Mocha 和 Sinon 进行单元测试超时

Question

我正在尝试编写一个 unit/integration 测试，我想在其中获取数据库中的事物列表。因为它不仅是 GET，而且这些测试需要扩展到 POST、PUT & DELETE。

到目前为止，我的代码工作正常，我实际上可以从数据库中获取数据，但是一旦我尝试删除负责调用数据库的函数，Mocha 就会超时

1 failing

1) /account_types GET 200 List: Error: timeout of 2000ms exceeded. Ensure the done() callback is being called in this test. at null. (C:\Code\JS\general_admin_service\node_modules\mocha\lib\runnable.js:215:19)

我知道 done() 回调没有被调用，因为代码卡在某个地方，但是，我不明白我做错了什么。

我使用了以下参考资料来找到我所在的位置：

我的代码如下：

测试：

'use strict';

var expect = require('chai').expect,
    request = require('supertest'),
    chance = require('chance').Chance(),
    server = require('../server'),
    sinon = require('sinon'),
    select = require('../../helpers/data_access/select');

describe("/account_types", function () {

    before(function(done){
        sinon
            .stub(select, "query_list")
            .returns([{id: "test"}]);

        done();
    });

    after(function(done){
        select
            .query_list
            .restore();

        done();
    });

    it('GET 200 List', function (done) {

        request(server.baseURL)
            .get('/api/v1/account_types')
            .set('Accept', 'application/json')
            .expect('Content-Type', 'application/json')
            .expect(200)
            .end(function (err, res) {
                /* istanbul ignore if */
                if (err)
                    return done(err);

                expect(res.body).to.include.keys('result');
                expect(res.body.result).to.not.be.null;
                expect(res.body.result).to.not.be.undefined;
                expect(res.body.result).to.be.an('Array');
                expect(res.body.result.length).to.be.above(0);

                //expect(select.query_list).to.have.been.calledOnce;

                return done();
            });
    });

});

重新验证端点：

var select = require('../helpers/data_access/select')

module.exports = function (server) {
        var query = "..."

        return select.query_list(res, next, db_config, query);
    });
};

select.js:

var sql = require('mssql');

module.exports = {
    query_list: function (res, next, config, sql_query) {
        return query(res, next, config, sql_query, true);
    },
    query_single: function (res, next, config, sql_query) {
        return query(res, next, config, sql_query, false);
    }
};

function query(res, next, config, sql_query, isList) {
    var connection = new sql.Connection(config);

    connection.connect(function (err) {
        if (err) {
            return on_error(err, res);
        }

        var request = new sql.Request(connection);

        request.query(sql_query, function (err, response) {
            connection.close();

            if (err) {
                return on_error(err, res);
            }

            if (isList) {
                return return_list(res, response, next);
            } else {
                return return_single(res, response, next);
            }
        });
    });
}

function on_error(error, res, next) {
    res.status(500).send(error);
    return next();
}

function return_list(res, response, next) {
    res.send({result: response});
    return next();
}

function return_single(res, response, next) {
    res.send({result: response[0]});
    return next();
}

我期望发生的事情是，因为我将 query_list 函数存根，如果我希望在期望值之后放置一个 console.log(res.body.result);，我应该看到一个 return 的 [{id: "test"}]，但显然还没有达到这一点。

我做错了什么？

更新：添加了完整的 select.js 文件。

Answer 1

正如您已经在评论中明确指出的那样，很难测试嵌套很深的代码。

使用回调或承诺通常会好得多，这样您的应用程序的每个部分都会处理它负责的部分，但不会（太多）更多。因此，您的路由处理程序将处理请求和响应。显然可以调用其他函数，例如执行数据库查询的函数，但不是让这些函数发回响应，而是使用 "call back" 到路由处理程序和查询结果的回调。

像这样：

server.get('/api/v1/account_types', function(req, res, next) {
  select.query_list(QUERY, function(err, records) {
    if (err) return next(err);
    res.send({ results : records });
    next();
  });
});

就使用 Sinon 来测试这样的东西而言：这实际上取决于具体的实现。我可以提供一个简单示例，说明如何对 select.query_list 的上述用法进行存根，以确保响应包含正确的数据。

基本存根如下所示：

sinon.stub(select, 'query_list').yieldsAsync(null, [ { id : 'test' } ]);

它的作用是，当 select.query_list() 被调用时，它将使用参数 null, [ { id : 'test' } ].

这些是在处理程序中传递的回调函数的 err 和 records 参数。因此，您可以使用它来完全跳过数据库查询并假装查询产生了特定的记录数组。

从那里，res.send() 被调用（这是您最初运行遇到的问题：它根本没有被调用，因为它是在您的应用程序的一部分中执行的因为你的存根而没有被调用），你可以检查你的测试结果响应数据是否符合预期。

如果你想在调用堆栈中更深地存根一个函数，它会变得有点复杂，但使用正确的 Sinon 工具（如 .yields*，或使用间谍而不是存根）通常不会非常困难（前提是你想要stub/spy的所有函数都可以访问，也就是导出）。

使用 Supertest、Mocha 和 Sinon 进行单元测试超时

Unit testing with Supertest, Mocha & Sinon timing out

mocha.js

node.js

sinon