node.js - 无论如何， Mocha 超时已超过

Question

我目前正在 mocha 中为我的 Nodejs 应用程序编写测试。我的 api 调用要求我登录，因此我想创建一个包装测试套件来创建测试用户，然后调用实际的测试套件。代码如下:

var request = require('supertest');

var config = require('../config/config');

var AdminUser = require('../models/Authmodel');



function configureAuth(test_suite) {
    var url = "localhost:" + config.port;

    var email = "test@test.com";
    var password = "test_password";

    var admin;
    var token;

    describe("Signup User", function() {
      it("should signup new user", function(done) {
        request(url)
          .post('/auth/signup')
          .send({
            email: email,
            password: password
          })
          .expect(200)
          .end(function(){
            done();
          });
      });

      it("should login the user", function(done) {
        request(url)
          .post('/auth/login')
          .send({
            email: email,
            password: password
          })
          .expect(200)
          .end(function(err,res){
            if(err)
              throw(err);
            res.body.should.have.property('token');
            token = res.body.token;
            done();
          });
      });

      it("should retrieve admin document", function(done) {
        AdminUser.findOne({email: email}, function(err, dbAdmin) {
          if(err)
            throw(err);
          admin = dbAdmin;
          done();
        });
      });
    });

    // Call the actual test suite, pass it the auth credentials.
    describe("Test Suite", function() {
        it("should run the test suite", function(done) {
            // No matter what the timeout is set to it still exceeds it
            this.timeout(5000);
            test_suite({
                email: email,
                password: password,
                token: token,
                admin: admin
            }, done);
        });
    });

    describe("Clear Admins", function() {
    it("should clear the admin table", function(done) {
      AdminUser.remove({email: email}, function(err) {
        if(err)
          throw(err);

        done();
      });
    });
  });

};

module.exports = configureAuth;

这是使用包装器的测试套件:

var request = require('supertest');

var config = require('../config/config');

// Wrapper that creates admin user to allow api calls
var ConfigureAuth = require('./ConfigureAuth');


// Test data
var templateForm = {...}
var submittedForm = {...}

ConfigureAuth(
  function(credentials, exit) {

    var url = "localhost:" + config.port;

    var templateFormId = null;
    describe("Form Templates", function() {
      describe('POST /api/form/template', function(){
        it('should save the template', function(done){
          request(url)
            .post('/api/form/template')
            .query({email: credentials.email, token: credentials.token})
            .send({
              _admin_id: credentials.admin._id,
              template: templateForm,
            })
            .end(function(err, res){
              templateFormId = res.body._id;
              res.body.should.have.property('_admin_id').and.be.equal(''+credentials.admin._id);
              res.body.should.have.property('template').and.be.instanceof(Object);
              done();
            });
        });
      });

      describe('GET /api/form/template/:id', function(){
        it('Should respond with template data', function(done){
          request(url)
            .get('/api/form/template/' + templateFormId)
            .query({email: credentials.email, token: credentials.token})
            .end(function(err, res){
              ...
              done();
            });
        });
      });

      describe('GET /api/form/template/company/:id', function(){
        it('Should respond with company template data', function(done){
          request(url)
            .get('/api/form/template/company/' + credentials.admin._id)
            .query({email: credentials.email, token: credentials.token})
            .end(function(err, res){
              ...
              done();
            });
        });
      });

      describe('DELETE /api/form/template/:template_id', function(){
        it('Should delete the template data', function(done){
          request(url)
            .delete('/api/form/template/' + templateFormId)
            .query({email: credentials.email, token: credentials.token})
            .end(function(err, res){
              ...
              done();
            });
        });
      });
    });


    describe("Submitted Forms", function() {
      describe('POST /api/form/patient', function(){
        it('should save submitted form', function(done){
          request(url)
            .post('/api/form/patient')
            .query({email: credentials.email, token: credentials.token})
            .send({
              _admin_id: credentials.admin._id,
              form: submittedForm,
              firstName: "Jimbo",
              lastName: "Cruise",
              patientEmail: "jcruise@tomcruise.com",
            })
            .end(function(err, res){
              ...
              submittedFormId = res.body._id;
              done();
            });
        });
      });

      describe('GET /api/form/:form_id', function(){
        it('should respond with submitted form data', function(done){
          request(url)
            .get('/api/form/patient/' + submittedFormId)
            .query({email: credentials.email, token: credentials.token})
            .end(function(err, res){
              res.body.should.have.property('_id');

              ...

              done();
            });
        });
      });
    });


    after(function() {
      exit();
    });
});

无论我给测试套件设置什么超时，它都会给出“错误:超时超过 5000 毫秒”。除了“它应该运行测试套件”之外，所有测试都通过。我还要指出的是，我还有其他不使用包装器的测试文件。上面的测试套件首先被调用，创建管理员用户，测试套件超时，然后清除管理文档，然后继续进行其他测试。最后，它打印出包含在ConfigureAdmin 函数中的测试。

Answer 1

在你的包装中，你有这个:

// Call the actual test suite, pass it the auth credentials.
describe("Test Suite", function() {
    it("should run the test suite", function(done) {
        // No matter what the timeout is set to it still exceeds it
        this.timeout(5000);
        test_suite({
            email: email,
            password: password,
            token: token,
            admin: admin
        }, done);
    });
});

并且 test_suite 函数包含更多对 describe 和 it 的调用。 如果您这样做，Mocha 不会引发任何错误，但它不会按照您期望的方式工作。Mocha 执行如下测试:

1. Mocha 发现了测试。 describe 调用向 Mocha 注册新套件。它们的回调立即执行。 it 调用向 Mocha 注册新测试。它们的回调在 Mocha 运行测试时执行。钩子(Hook)调用(before、after 等)也会向 Mocha 注册钩子(Hook)，稍后在 Mocha 运行测试时执行。

2. Mocha 运行已注册的测试。

当您将 describe 放入 it 中时，会出现一个问题:这个 describe 将会被执行，而 Mocha >将注册一个新套件，但在注册时，执行流程位于所有describe回调之外。因此，这个新套件在匿名顶级套件(Mocha 自动创建)上注册，并从该顶级套件继承其超时值。看看这个例子:

describe("top", function () {
    it("test", function () {
        this.timeout(5000);
        describe("inner", function () {
            it("inner test", function (done) {
                setTimeout(function () {
                    done();
                }, 6000);
            });
        });
    });

    describe("inner 2", function () {
        it("inner test 2", function () {});
    });

});

describe("top 2", function (){
    it("test 3", function () {});
});

如果你运行它，你会得到:

  top
    ✓ test 
    inner 2
      ✓ inner test 2 

  top 2
    ✓ test 3 

  inner
    1) inner test


  3 passing (2s)
  1 failing

  1) inner inner test:
     Error: timeout of 2000ms exceeded
     [... etc ...]

请注意 inner 套件，即使它出现在 JavaScript 代码中的 top 内部，在 Mocha 的报告中却显示在它的外部。 (inner 2，另一方面，出现在它应该出现的地方。)这就是我上面解释的:当 Mocha 注册这个套件时，执行流程已经在 top 之外了。 和 top 2 describe 调用。另请注意 timeout 调用是无用的。

如果您运行上面相同的代码，但使用 mocha --timeout 7000，则测试将通过，因为默认超时值(包括 Mocha 创建的匿名套件)现在为 7000。

此外，您的套件当前需要测试之间有一定的顺序。 Mocha 并不是为此而设计的。为测试设置固定装置应在 before 或 beforeEach Hook 中完成，而拆除它们应在 after 和 中完成afterEach。因此，这不仅仅是将 describe 从 it 调用中取出的问题。