Replace Hapi Lab with node-test for test runner

DEFRA/water-abstraction-team#130

We as a team would love to move the [water-abstraction-system](https://github.com/DEFRA/water-abstraction-system) project to use [ECMAScript Modules (ESM)](https://nodejs.org/api/esm.html). The one thing that has held us back is our test framework [Hapi Lab](https://hapi.dev/module/lab/).

We've worked hard over the last year restructuring how we build our tests and [moving away from our dependence on the database](DEFRA/water-abstraction-team#124).

This means we are now ready to make the switch to a test framework that natively supports ESM. We've opted for [node-test](https://nodejs.org/api/test.html#test-runner).

In this change we

- remove the **Hapi Lab** dependency
- update all tests to require **node-test**
- update our scripts to use **node-test**

package.json

@@ -20,8 +20,10 @@
     "seed": "knex seed:run --knexfile knexfile.application.js",
     "lint": "eslint .",
     "pretest": "NODE_ENV=test node db/clean.js",
-    "test": "lab --silent-skips --shuffle",
-    "test:skip": "lab --silent-skips --shuffle",
+    "test": "NODE_ENV=test node --experimental-test-coverage --test-coverage-exclude 'test/**/*.js' --test-coverage-exclude 'db/migrations/**/*.js' --test-coverage-exclude 'db/seeds/**/*.js'  --test-coverage-exclude 'app/plugins/**/*.js' --test '**/*.test.js'",
+    "test:check": "NODE_ENV=test node --experimental-test-coverage --test-coverage-exclude 'test/**/*.js' --test-coverage-exclude 'db/migrations/**/*.js' --test-coverage-exclude 'db/seeds/**/*.js'  --test-coverage-exclude 'app/plugins/**/*.js' --test 'test/services/**/*.test.js'",
+    "test:skip": "NODE_ENV=test node --experimental-test-coverage --test-coverage-exclude 'test/**/*.js' --test-coverage-exclude 'db/migrations/**/*.js' --test-coverage-exclude 'db/seeds/**/*.js' --test-coverage-exclude 'app/plugins/**/*.js' --test '**/*.test.js'",
+    "test:lcov": "NODE_ENV=test node --experimental-test-coverage --test-coverage-exclude 'test/**/*.js' --test-coverage-exclude 'db/migrations/**/*.js' --test-coverage-exclude 'db/seeds/**/*.js' --test-coverage-exclude 'app/plugins/**/*.js' --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=lcov.info --test '**/*.test.js'",
     "postinstall": "npm run build",
     "version": "npx --yes auto-changelog -p --commit-limit false && git add CHANGELOG.md"
   },

test/controllers/bill-licences.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/bill-runs-review.controller.test.js

@@ -1,14 +1,12 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach, after } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
+const { closeConnection } = require('../support/database.js')
 const { postRequestOptions } = require('../support/general.js')
 
 // Things we need to stub
@@ -55,6 +53,10 @@ describe('Bill Runs Review controller', () => {
     Sinon.restore()
   })
 
+  after(async () => {
+    await closeConnection()
+  })
+
   describe('/bill-runs/review/{billRunId}', () => {
     beforeEach(() => {
       path = '97db1a27-8308-4aba-b463-8a6af2558b28'

test/controllers/bill-runs-setup.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/bill-runs.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/billing-accounts.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Things we need to stub
 const Boom = require('@hapi/boom')
 const ChangeAddressService = require('../../app/services/billing-accounts/change-address.service.js')

test/controllers/bills.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/data.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/health.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Things we need to stub
 const DatabaseHealthCheckService = require('../../app/services/health/database-health-check.service.js')
 const InfoService = require('../../app/services/health/info.service.js')

test/controllers/jobs.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Things we need to stub
 const ExportService = require('../../app/services/jobs/export/export.service.js')
 const ImportLicence = require('../../app/services/jobs/import/import-licences.service.js')

test/controllers/licences.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const Boom = require('@hapi/boom')
 const { postRequestOptions } = require('../support/general.js')

test/controllers/monitoring-stations.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Things we need to stub
 const ViewService = require('../../app/services/monitoring-stations/view.service.js')
 

test/controllers/notifications-ad-hoc-returns.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/notifications-setup.controller.test.js

@@ -1,13 +1,11 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
+// Test helpers
 const { postRequestOptions } = require('../support/general.js')
 
 // Things we need to stub

test/controllers/return-versions-setup.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const { postRequestOptions } = require('../support/general.js')
 

test/controllers/return-versions.controller.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, before, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Things we need to stub
 const ViewService = require('../../app/services/return-versions/view.service.js')
 

test/controllers/root.controller.test.js

@@ -1,11 +1,8 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
-
-const { describe, it, before } = (exports.lab = Lab.script())
-const { expect } = Code
+const { describe, it, before } = require('node:test')
+const { expect } = require('@hapi/code')
 
 // For running our service
 const { init } = require('../../app/server.js')

test/errors/expanded.error.test.js

@@ -1,11 +1,8 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
-
-const { describe, it, beforeEach } = (exports.lab = Lab.script())
-const { expect } = Code
+const { describe, it, beforeEach } = require('node:test')
+const { expect } = require('@hapi/code')
 
 // Thing under test
 const ExpandedError = require('../../app/errors/expanded.error.js')

test/lib/base-notifier.lib.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Thing under test
 const BaseNotifierLib = require('../../app/lib/base-notifier.lib.js')
 

test/lib/boom-notifier.lib.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Thing under test
 const BoomNotifierLib = require('../../app/lib/boom-notifier.lib.js')
 

test/lib/dates.lib.test.js

@@ -1,11 +1,8 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
-
-const { describe, it, before } = (exports.lab = Lab.script())
-const { expect } = Code
+const { describe, it, before } = require('node:test')
+const { expect } = require('@hapi/code')
 
 // Thing under test
 const DateLib = require('../../app/lib/dates.lib.js')

test/lib/general.lib.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Test helpers
 const TransactionHelper = require('../support/helpers/transaction.helper.js')
 

test/lib/global-notifier.lib.test.js

@@ -1,13 +1,10 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
+const { describe, it, beforeEach, afterEach } = require('node:test')
+const { expect } = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, beforeEach, afterEach } = (exports.lab = Lab.script())
-const { expect } = Code
-
 // Things we need to stub
 const BaseNotifierLib = require('../../app/lib/base-notifier.lib.js')
 

test/lib/legacy-db-snake-case-mappers.lib.test.js

@@ -1,11 +1,8 @@
 'use strict'
 
 // Test framework dependencies
-const Lab = require('@hapi/lab')
-const Code = require('@hapi/code')
-
-const { describe, it } = (exports.lab = Lab.script())
-const { expect } = Code
+const { describe, it } = require('node:test')
+const { expect } = require('@hapi/code')
 
 // Thing under test
 const LegacyDbSnakeCaseMappersLib = require('../../app/lib/legacy-db-snake-case-mappers.lib.js')