const should = require('should'); const _ = require('lodash'); const yaml = require('js-yaml'); const crypto = require('crypto'); const fs = require('fs-extra'); const path = require('path'); const {config} = require('../../../../utils/configUtils'); const schema = require('../../../../../core/server/data/schema/schema'); const fixtures = require('../../../../../core/server/data/schema/fixtures/fixtures.json'); const defaultSettings = require('../../../../../core/server/data/schema/default-settings/default-settings.json'); // Routes are yaml so we can require the file directly const routeSettings = require('../../../../../core/server/services/route-settings'); routeSettings.init(); const validateRouteSettings = require('../../../../../core/server/services/route-settings/validate'); /** * @NOTE * * If this test fails for you, you have modified one of: * - the database schema * - fixtures * - default settings * - routes.yaml * * When you make a change, please test that: * * 1. A new blog get's installed and the database looks correct and complete. * 2. A blog get's updated from a lower Ghost version and the database looks correct and complete. * * Typical cases: * You have to add a migration script if you've added/modified permissions. * You have to add a migration script if you've add a new table. * You have to add a migration script if you've added new settings to populate group/flags column. */ describe('DB version integrity', function () { // Only these variables should need updating const currentSchemaHash = 'b7867be4de694b4592d748c0367064b5'; const currentFixturesHash = 'f4dd2a454e1999b6d149cc26ae52ced4'; const currentSettingsHash = '71fa38d0c805c18ceebe0fda80886230'; const currentRoutesHash = '3d180d52c663d173a6be791ef411ed01'; // If this test is failing, then it is likely a change has been made that requires a DB version bump, // and the values above will need updating as confirmation it('should not change without fixing this test', function () { const routesPath = path.join(config.get('paths').defaultRouteSettings, 'default-routes.yaml'); const defaultRoutes = validateRouteSettings(yaml.load(fs.readFileSync(routesPath, 'utf-8'))); const tablesNoValidation = _.cloneDeep(schema); let schemaHash; let fixturesHash; let settingsHash; let routesHash; _.each(tablesNoValidation, function (table) { return _.each(table, function (column, name) { table[name] = _.omit(column, 'validations'); }); }); schemaHash = crypto.createHash('md5').update(JSON.stringify(tablesNoValidation), 'binary').digest('hex'); fixturesHash = crypto.createHash('md5').update(JSON.stringify(fixtures), 'binary').digest('hex'); settingsHash = crypto.createHash('md5').update(JSON.stringify(defaultSettings), 'binary').digest('hex'); routesHash = crypto.createHash('md5').update(JSON.stringify(defaultRoutes), 'binary').digest('hex'); schemaHash.should.eql(currentSchemaHash); fixturesHash.should.eql(currentFixturesHash); settingsHash.should.eql(currentSettingsHash); routesHash.should.eql(currentRoutesHash); routesHash.should.eql(routeSettings.getDefaultHash()); }); });