Added global setup to reset DB before test run

- We've been seeing weird errors with tables not existing when running tests locally
- This appears to happen after an error causes the tests to abort
- This change includes two fixes:
1. we triggers a full DB reset just before the entire test suite runs
 - this is done by wrapping the override file for tests that use a db, and supplying a mochaGlobalSetup hook
2. catch errors when attempting to do a fast truncation-based reset & init, and do a full reset & init instead

- These two changes should ensure the DB is always in the state we expect when running a new test suite

package.json

@@ -26,20 +26,20 @@
     "setup": "yarn install && knex-migrator init && grunt symlink && grunt init || (exit 0)",
     "main": "grunt shell:main && grunt subgrunt:init",
     "build": "grunt build",
-    "test": "mocha --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js --timeout=60000",
+    "test": "mocha --require=./test/utils/db-overrides.js --exit --trace-warnings --recursive --extension=test.js --timeout=60000",
     "test:all": "yarn test:unit && yarn test:integration && yarn test:e2e && yarn lint",
     "test:debug": "DEBUG=ghost:test* yarn test",
     "test:unit": "c8 yarn test:unit:base",
     "test:unit:base": "mocha --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js './test/unit' --timeout=2000",
-    "test:integration": "mocha --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js  './test/integration' --timeout=5000",
-    "test:e2e": "mocha --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js './test/e2e-api' './test/e2e-frontend' './test/e2e-server' --timeout=10000",
-    "test:regression": "mocha --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js  './test/regression' --timeout=60000",
+    "test:integration": "mocha --require=./test/utils/db-overrides.js --exit --trace-warnings --recursive --extension=test.js  './test/integration' --timeout=5000",
+    "test:e2e": "mocha --require=./test/utils/db-overrides.js --exit --trace-warnings --recursive --extension=test.js './test/e2e-api' './test/e2e-frontend' './test/e2e-server' --timeout=10000",
+    "test:regression": "mocha --require=./test/utils/db-overrides.js --exit --trace-warnings --recursive --extension=test.js  './test/regression' --timeout=60000",
     "test:browser": "playwright test --browser=all test/e2e-browser",
     "test:ci": "yarn test:e2e -b && yarn test:integration -b && yarn test:regression -b",
     "test:unit:slow": "yarn test:unit --reporter=mocha-slow-test-reporter",
     "test:int:slow": "yarn test:integration --reporter=mocha-slow-test-reporter",
     "test:e2e:slow": "yarn test:e2e --reporter=mocha-slow-test-reporter",
-    "test:reg:slow": "mocha --require=./test/utils/overrides.js --exit --trace-warnings --recursive --extension=test.js  './test/regression' --timeout=60000 --reporter=mocha-slow-test-reporter",
+    "test:reg:slow": "yarn test:regression --reporter=mocha-slow-test-reporter",
     "lint:server": "eslint --ignore-path .eslintignore 'core/server/**/*.js' 'core/*.js' '*.js'",
     "lint:shared": "eslint --ignore-path .eslintignore 'core/shared/**/*.js'",
     "lint:frontend": "eslint --ignore-path .eslintignore 'core/frontend/**/*.js'",

test/utils/db-overrides.js

@@ -0,0 +1,17 @@
+/**
+ * This overrides file should be used for all tests that use the DB
+ */
+
+module.exports = require('./overrides');
+
+/**
+ * Global Setup
+ * Guaranteed to only ever run once regardless of whether
+ * mocha is run in serial or parallel
+ */
+module.exports.mochaGlobalSetup = async function () {
+    // Actually delete the database so we start afresh
+    // This protects against DB errors after an aborted test run
+    // This technically only needs to happen before DB-related tests
+    await require('./db-utils').destroy();
+};

test/utils/db-utils.js

@@ -17,6 +17,10 @@ const urlServiceUtils = require('./url-service-utils');
 
 const dbHash = Date.now();
 
+module.exports.destroy = async () => {
+    await knexMigrator.reset({force: true});
+};
+
 module.exports.reset = async ({truncate} = {truncate: false}) => {
     // Only run this copy in CI until it gets fleshed out
     if (process.env.CI && config.get('database:client') === 'sqlite3') {
@@ -37,12 +41,21 @@ module.exports.reset = async ({truncate} = {truncate: false}) => {
             await fs.copyFile(filename, filenameOrig);
         }
     } else {
+        debug('not CI');
         if (truncate) {
-            // Perform a fast reset by tearing down all the tables and
-            // inserting the fixtures
-            await module.exports.teardown();
-            await knexMigrator.init({only: 2});
+            debug('truncate mode');
+            // Perform a fast reset by tearing down all the tables and inserting the fixtures
+            try {
+                await module.exports.teardown();
+                await knexMigrator.init({only: 2});
+            } catch (err) {
+                // If it fails, try a normal reset and init
+                debug('teardown failed, reset and init');
+                await knexMigrator.reset({force: true});
+                await knexMigrator.init();
+            }
         } else {
+            debug('reset and init');
             // Do a full database reset + initialisation
             await knexMigrator.reset({force: true});
             await knexMigrator.init();
@@ -137,6 +150,9 @@ module.exports.teardown = () => {
                 }
 
                 throw err;
+            })
+            .finally(() => {
+                debug('Database teardown end');
             });
     });
 };

test/utils/overrides.js

@@ -1,7 +1,12 @@
 process.env.NODE_ENV = process.env.NODE_ENV || 'testing';
+
+/**
+ * This overrides file should be used for all tests that DO NOT use the DB - e.g. unit tests
+ */
+
 process.env.WEBHOOK_SECRET = process.env.WEBHOOK_SECRET || 'TEST_STRIPE_WEBHOOK_SECRET';
 
 require('../../core/server/overrides');
 
 const {mochaHooks} = require('@tryghost/express-test').snapshot;
-exports.mochaHooks = mochaHooks;
+module.exports.mochaHooks = mochaHooks;