var should = require('should'), sinon = require('sinon'), Promise = require('bluebird'), // Stuff we are testing versioning = require('../../server/data/schema').versioning, db = require('../../server/data/db'), errors = require('../../server/errors'), sandbox = sinon.sandbox.create(); describe('Versioning', function () { afterEach(function () { sandbox.restore(); }); describe('getMigrationVersions', function () { it('should output a single item if the from and to versions are the same', function () { should.exist(versioning.getMigrationVersions); versioning.getMigrationVersions('003', '003').should.eql(['003']); versioning.getMigrationVersions('004', '004').should.eql(['004']); }); it('should output an empty array if the toVersion is higher than the fromVersion', function () { versioning.getMigrationVersions('003', '002').should.eql([]); }); it('should output all the versions between two versions', function () { versioning.getMigrationVersions('003', '004').should.eql(['003', '004']); versioning.getMigrationVersions('003', '005').should.eql(['003', '004', '005']); versioning.getMigrationVersions('003', '006').should.eql(['003', '004', '005', '006']); versioning.getMigrationVersions('010', '011').should.eql(['010', '011']); }); }); describe('getDefaultDatabaseVersion', function () { it('should return the correct version', function () { var currentVersion = require('../../server/data/schema').defaultSettings.core.databaseVersion.defaultValue; // This function has an internal cache, so we call it twice. // First, to check that it fetches the correct version from default-settings.json. versioning.getDefaultDatabaseVersion().should.eql(currentVersion); // Second, to check that it returns the same value from the cache. versioning.getDefaultDatabaseVersion().should.eql(currentVersion); }); }); describe('getDatabaseVersion', function () { var errorSpy, knexStub, knexMock, queryMock; beforeEach(function () { errorSpy = sandbox.spy(errors, 'rejectError'); queryMock = { where: sandbox.stub().returnsThis(), first: sandbox.stub() }; knexMock = sandbox.stub().returns(queryMock); knexMock.schema = { hasTable: sandbox.stub() }; // this MUST use sinon, not sandbox, see sinonjs/sinon#781 knexStub = sinon.stub(db, 'knex', {get: function () { return knexMock; }}); }); afterEach(function () { knexStub.restore(); }); it('should throw error if settings table does not exist', function (done) { // Setup knexMock.schema.hasTable.returns(new Promise.resolve(false)); // Execute versioning.getDatabaseVersion().then(function () { done('Should throw an error if the settings table does not exist'); }).catch(function (err) { should.exist(err); err.message.should.eql('Settings table does not exist'); errorSpy.calledOnce.should.be.true(); knexStub.get.calledOnce.should.be.true(); knexMock.schema.hasTable.calledOnce.should.be.true(); knexMock.schema.hasTable.calledWith('settings').should.be.true(); queryMock.where.called.should.be.false(); queryMock.first.called.should.be.false(); done(); }).catch(done); }); it('should lookup & return version, if settings table exists', function (done) { // Setup knexMock.schema.hasTable.returns(new Promise.resolve(true)); queryMock.first.returns(new Promise.resolve({value: '001'})); // Execute versioning.getDatabaseVersion().then(function (version) { should.exist(version); version.should.eql('001'); errorSpy.called.should.be.false(); knexStub.get.calledTwice.should.be.true(); knexMock.schema.hasTable.calledOnce.should.be.true(); knexMock.schema.hasTable.calledWith('settings').should.be.true(); queryMock.where.called.should.be.true(); queryMock.first.called.should.be.true(); done(); }).catch(done); }); it('should throw error if version does not exist', function (done) { // Setup knexMock.schema.hasTable.returns(new Promise.resolve(true)); queryMock.first.returns(new Promise.resolve()); // Execute versioning.getDatabaseVersion().then(function () { done('Should throw an error if version does not exist'); }).catch(function (err) { should.exist(err); err.message.should.eql('Database version is not recognized'); errorSpy.calledOnce.should.be.true(); knexStub.get.calledTwice.should.be.true(); knexMock.schema.hasTable.calledOnce.should.be.true(); knexMock.schema.hasTable.calledWith('settings').should.be.true(); queryMock.where.called.should.be.true(); queryMock.first.called.should.be.true(); done(); }).catch(done); }); it('should throw error if version is not a number', function (done) { // Setup knexMock.schema.hasTable.returns(new Promise.resolve(true)); queryMock.first.returns(new Promise.resolve('Eyjafjallajökull')); // Execute versioning.getDatabaseVersion().then(function () { done('Should throw an error if version is not a number'); }).catch(function (err) { should.exist(err); err.message.should.eql('Database version is not recognized'); errorSpy.calledOnce.should.be.true(); knexStub.get.calledTwice.should.be.true(); knexMock.schema.hasTable.calledOnce.should.be.true(); knexMock.schema.hasTable.calledWith('settings').should.be.true(); queryMock.where.called.should.be.true(); queryMock.first.called.should.be.true(); done(); }).catch(done); }); }); describe('setDatabaseVersion', function () { var knexStub, knexMock, queryMock; beforeEach(function () { queryMock = { where: sandbox.stub().returnsThis(), update: sandbox.stub().returns(new Promise.resolve()) }; knexMock = sandbox.stub().returns(queryMock); // this MUST use sinon, not sandbox, see sinonjs/sinon#781 knexStub = sinon.stub(db, 'knex', {get: function () { return knexMock; }}); }); afterEach(function () { knexStub.restore(); }); it('should try to update the databaseVersion', function (done) { versioning.setDatabaseVersion().then(function () { knexStub.get.calledOnce.should.be.true(); queryMock.where.called.should.be.true(); queryMock.update.called.should.be.true(); done(); }).catch(done); }); }); describe('showCannotMigrateError', function () { it('should output a detailed error message', function () { var errorStub = sandbox.stub(errors, 'logAndRejectError'); versioning.showCannotMigrateError(); errorStub.calledOnce.should.be.true(); errorStub.calledWith( 'Unable to upgrade from version 0.4.2 or earlier', 'Please upgrade to 0.7.1 first', 'See http://support.ghost.org/how-to-upgrade/ for instructions.' ).should.be.true(); }); }); describe('getUpdateTasks', function () { it('`getUpdateFixturesTasks` returns empty array if no tasks are found', function () { var logStub = sandbox.stub(); versioning.getUpdateFixturesTasks('999', logStub).should.eql([]); logStub.calledOnce.should.be.true(); }); it('`getUpdateFixturesTasks` returns 8 items for 004', function () { var logStub = sandbox.stub(); versioning.getUpdateFixturesTasks('004', logStub).should.be.an.Array().with.lengthOf(8); logStub.calledOnce.should.be.false(); }); it('`getUpdateDatabaseTasks` returns empty array if no tasks are found', function () { var logStub = sandbox.stub(); versioning.getUpdateDatabaseTasks('999', logStub).should.eql([]); logStub.calledOnce.should.be.true(); }); it('`getUpdateDatabaseTasks` returns 5 items for 004', function () { var logStub = sandbox.stub(); versioning.getUpdateDatabaseTasks('004', logStub).should.be.an.Array().with.lengthOf(5); logStub.calledOnce.should.be.false(); }); }); });