为 Mongoose 运行多个 Mocha 测试文件已损坏

Posted 2023-03-07

【中文标题】为 Mongoose 运行多个 Mocha 测试文件已损坏

【英文标题】：Running multiple Mocha test files for Mongoose are broken

【发布时间】：2016-05-12 06:30:00

【问题描述】：

根据 Alexey B. 的评论，我修改了我的测试代码，发现导致我的测试代码出现相同错误的情况。当我尝试测试单个测试文件时，它运行良好。但是，如果我尝试同时测试多个测试文件，它就会损坏。常见的错误消息是Error: Trying to open unclosed connection.。看来我的数据库连接代码有问题。

这是我修改后的代码。

utils.js:

var mongoose = require('mongoose');
module.exports = function(models) 
    return function(done) 
        for(var i in models) 
            models[i].remove(, function() );
        
        done();
    ;
;

---

user.server.model.tests.js:

var should = require('should'),
    mongoose = require('mongoose'),
    utils = require('./utils');

require('../config/mongoose')();
var User = mongoose.model('User'),
    user;

describe('User Model Tests:', function() 
    afterEach(utils([User]));

    describe('#create()', function() 
        beforeEach(function(done) 
            user = new User(
                email:'[e-mail]',
                username: 'test1',
                password: '1234'
            );
            done();
        );

        it('create a new user', function(done) 
            user.save(function(err, user) 
                should.not.exist(err);
                user.email.should.equal('[e-mail]');
                user.username.should.equal('test1');
                done();
            );
        );

        it('create a new user with an existing email', function(done) 
            user.save(function(err) 
                should.not.exist(err);
            );

            var userDUP = new User(
                email:'[e-mail]',
                username:'test2',
                password: '1234'
            );

            userDUP.save(function(err) 
                should.exist(err);
                done();
            );
        );
    );
);

---

product.server.model.tests.js:

var should = require('should'),
    mongoose = require('mongoose'),
    utils = require('./utils');

require('../config/mongoose')();

var Product = mongoose.model('Product'),
    User = mongoose.model('User');

describe('Product Model Tests:', function()
    afterEach(utils([User, Product]));
    describe('#create()', function()
        it('create a new product', function(done) 
            var user = new User(
                email:'[e-mail]',
                username: 'test',
                password: '1234'
            );

            user.save(function(err) 
                should.not.exist(err);
            );

            var product = new Product(
                name: 'Product1',
                user: user
            );

            product.save(function(err, product) 
                should.not.exist(err);
                User.findOne('_id':product.user, function(err, user) 
                    should.not.exist(err);
                    user.username.should.equal('test');
                );
                product.name.should.equal('Product1');
                product.ordered.should.equal(0);
                product.stock.should.equal(0);

                done();
            );
        );

        it('create a new product without a user', function(done) 
            var product = new Product(
                name: 'Product'
            );

            product.save(function(err)
                should.exist(err);
                done();
            );
        );
    );
);

我还有两个测试文件，但是它们的结构是一样的。

另外，我与 DB 的连接是在 ../config/mongoose.js 中定义的。这是代码。

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

module.exports = function() 
    var db = mongoose.connect(config.db);
    console.log('MongoDB is successfully connected.');

    require('../models/user.server.model');
    require('../models/product.server.model');
    require('../models/sale.server.model');
    require('../models/dcompany.server.model');
    require('../models/customer.server.model');

    return db;
;

我尝试使用createConnect 而不是connect 连接数据库，但它引发了另一个名为timeout 的错误。

下面是这个问题的旧版本。

我有两个测试文件（'product.server.model.tests.js' 和 'user.server.model.tests.js'），并且都调用了包含 beforeEach 和 afterEach 的“utils.js”，其中连接/断开了数据库。

当我对 Mocha 测试进行运行/调试配置并尝试在 Webstorm 11 上对其进行测试时，测试因错误 (Error: Trying to open unclosed connection.) 而中断，如下所示。当 Mocha 尝试测试 user.server.model.js 时会发生这种情况。

但是，当我在终端上运行这些测试时，它通过了所有测试！ （见下文）另外，如果我为每个测试文件进行单独的运行/调试配置，也没有问题。

我在 Webstorm 11 上的运行/调试配置如下所示。

这是 Webstorm 11 的 bug 吗？或者我在设置运行/调试配置或我的测试代码时有什么问题吗？我在下面附上了我的测试代码。

---

utils.js:

var mongoose = require('mongoose');

beforeEach(function(done) 
    require('../config/mongoose')();

    for(var i in mongoose.connection.collections) 
        mongoose.connection.collections[i].remove(function() );
    

    done();
);

afterEach(function(done) 
    mongoose.disconnect();
    done();
);

---

user.server.model.test.js:

require('./utils');
var should = require('should'),
    mongoose = require('mongoose');

describe('User Model Tests:', function() 
    describe('#create()', function() 
        it('create a new user', function(done) 
            var User = mongoose.model('User');

            var user = new User(
                email:'[e-mail]',
                username: 'test1',
                password: '1234'
            );

            user.save(function(err, user) 
                should.not.exist(err);
                user.email.should.equal('[e-mail]');
                user.username.should.equal('test1');
                done();
            );
        );

        it('duplication: email', function(done) 
            var User = mongoose.model('User');

            var user = new User(
                email:'[e-mail]',
                username: 'test1',
                password: '1234'
            );

            user.save(function(err) 
                should.not.exist(err);
            );

            var userDUP = new User(
                email:'[e-mail]',
                username:'test2',
                password: '1234'
            );

            userDUP.save(function(err) 
                should.exist(err);
                done();
            );
        );
    );
);

---

product.server.model.tests.js:

require('./utils');
var should = require('should'),
    mongoose = require('mongoose');

describe('Product Model Tests:', function()
    describe('#create()', function()
        it('create a new product', function(done) 
            var Product = mongoose.model('Product');
            var User = mongoose.model('User');

            var user = new User(
                email:'[e-mail]',
                username: 'test',
                password: '1234'
            );

            user.save(function(err) 
                should.not.exist(err);
            );

            var product = new Product(
                name: 'Product1',
                user: user
            );

            product.save(function(err, product) 
                should.not.exist(err);
                User.findOne('_id':product.user, function(err, user) 
                    should.not.exist(err);
                    user.username.should.equal('test');
                );
                product.name.should.equal('Product1');
                product.ordered.should.equal(0);
                product.stock.should.equal(0);

                done();
            );
        );

        it('create a new product without a user', function(done) 
            var Product = mongoose.model('Product');

            var product = new Product(
                name: 'Product'
            );

            product.save(function(err)
                should.exist(err);
                done();
            );
        );
    );
);

【参考方案1】：

我发现捕捉错误为我解决了这个问题。应该是摩卡虫吧？无论如何，这是可行的，不值得我花时间进一步调查。我希望这可以解除对其他人的阻止。

注意我如何将回调传递给连接函数：

var mongoose = require('mongoose');

...

before(function (done) 
    mongoose.connect('mongodb://localhost/test', function(err) 
        done();
    );
);

after(function (done) 
    mongoose.connection.close();
    done();
);

describe('some tests', function() 
   it('can do something', function (done) 
   );
)

【讨论】：

我也在为此使用createConnection。但是添加错误回调有帮助。

【参考方案2】：

不能确切地说这是这里的问题，但是在单独的文件中实现 mocha 挂钩是一种不好的做法。例如，然后您向项目中添加更多测试，您不能为某些不需要数据库连接的测试禁用该挂钩。

这里的正确方法是制作一些辅助模块

module.exports = 
    connect: function (done) 
        require('../config/mongoose')();

        for(var i in mongoose.connection.collections) 
            mongoose.connection.collections[i].remove(function() );
        

        done();
    ,

    disconnect: function (done) 
        mongoose.disconnect();
        done();
    
;

并在测试中应用它

var should = require('should'),
    mongoose = require('mongoose'),
    helper = require('./utils');

describe('User Model Tests:', function() 
    beforeEach(helper.connect);
    afterEach(helper.disconnect);
    describe('#create()', function() 
        ...
    );
);

【讨论】：

感谢您的建议。我修改了我的代码和问题。

【参考方案3】：

我参考问题“joining tests from multiple files with mocha.js”重构了我的测试代码。我建立了一个test.js 来加入所有不同的测试文件，并且在test.js 的开头，已经尝试连接到数据库。这是我的工作测试代码。

test/test.js:

var mongoose = require('mongoose');

var importTest = function(name, path) 
    describe(name, function() 
        require(path);
    );
;

//Connecting to the DB
require('../../app/config/mongoose')();

describe("Model Testing:", function() 
    before(function() 
        console.log('Start a model testing!\n');
    );

    importTest('User Model Testing:', './models/user.server.model.tests');
    importTest('Sale Model Testing:', './models/sale.server.model.tests');
    importTest('Product Model Testing:', './models/product.server.model.tests');
    importTest('DCompany Model Testing:', './models/dcompany.server.model.tests');

    after(function() 
        mongoose.disconnect();
        console.log("Disconnect to the DB.\n");
    )
);

---

/test/models/user.server.model.tests.js:

var should = require('should'),
    mongoose = require('mongoose'),
    utils = require('./utils');

var User = mongoose.model('User'),
    user;

afterEach(utils([User]));
describe('#create()', function() 
    beforeEach(function(done) 
        user = new User(
            email:'[e-mail]',
            username: 'test1',
            password: '1234'
        );
        done();
    );

    it('create a new user', function(done) 
        user.save(function(err, user) 
            should.not.exist(err);
            user.email.should.equal('[e-mail]');
            user.username.should.equal('test1');
            done();
        );
    );

    it('create a new user with an existing email', function(done) 
        user.save(function(err) 
            should.not.exist(err);
        );

        var userDUP = new User(
            email:'[e-mail]',
            username:'test2',
            password: '1234'
        );

        userDUP.save(function(err) 
            should.exist(err);
            done();
        );
    );
);

其他测试文件的结构与user.server.model.tests.js类似。