Remove DatabaseSupport.clean() from unit tests

app/services/bill-runs/reissue/reissue-bills.service.js

@@ -22,9 +22,8 @@ const TransactionModel = require('../../../models/transaction.model.js')
  *
  * @param {module:BillRunModel} reissueBillRun - The bill run that the reissued bills will be created on
  *
- * @returns {boolean} `true` if any bills were reissued; `false` if not
-*/
-
+ * @returns {Promise<boolean>} `true` if any bills were reissued; `false` if not
+ */
 async function go (reissueBillRun) {
   const sourceBills = await FetchBillsToBeReissuedService.go(reissueBillRun.regionId)
 
@@ -49,9 +48,7 @@ async function go (reissueBillRun) {
   return true
 }
 
-/**
- * Adds the data held in each key of `newData` to the corresponding keys in `dataToPersist`
- */
+// Adds the data held in each key of `newData` to the corresponding keys in `dataToPersist`
 function _addNewDataToDataToPersist (dataToPersist, newData) {
   dataToPersist.bills.push(...newData.bills)
   dataToPersist.billLicences.push(...newData.billLicences)

app/services/licences/view-licence-set-up.service.js

@@ -28,8 +28,7 @@ async function go (licenceId, auth) {
   const workflows = await FetchWorkflowsService.go(licenceId)
   const returnVersions = await FetchReturnVersionsService.go(licenceId)
 
-  const licenceSetUpData = SetUpPresenter
-    .go(chargeVersions, workflows, agreements, returnVersions, auth, commonData)
+  const licenceSetUpData = SetUpPresenter.go(chargeVersions, workflows, agreements, returnVersions, auth, commonData)
 
   return {
     activeTab: 'set-up',

db/seeds/01-regions.seed.js

@@ -42,8 +42,8 @@ async function _exists (region) {
 }
 
 async function _insert (region) {
-  // The Test region is only intended to be seeded in our non-production environments
-  if (region.name === 'Test' && ServerConfig.environment === 'production') {
+  // The Bill Run & Test regions are only intended to be seeded in our non-production environments
+  if ((region.name === 'Bill Run' || region.name === 'Test') && ServerConfig.environment === 'production') {
     return
   }
 

db/seeds/13-charge-categories.seed.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const { timestampForPostgres } = require('../../app/lib/general.lib.js')
-const { data: chargeCategories } = require('./data/charge-categories.js')
 const ChargeCategoryModel = require('../../app/models/charge-category.model.js')
+const { data: chargeCategories } = require('./data/charge-categories.js')
+const { timestampForPostgres } = require('../../app/lib/general.lib.js')
 
 async function seed () {
   for (const chargeCategory of chargeCategories) {

db/seeds/data/regions.js

@@ -63,6 +63,13 @@ const data = [
     naldRegionId: 9,
     name: 'Test',
     displayName: 'Test Region'
+  },
+  {
+    id: 'c502e4ca-9ae9-469d-8180-9f347d8e2bfd',
+    chargeRegionId: 'S',
+    naldRegionId: 10,
+    name: 'Bill Run',
+    displayName: 'Bill Run Testing Region'
   }
 ]
 

test/requests/charging-module/create-bill-run.request.test.js

@@ -9,7 +9,6 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const DatabaseSupport = require('../../support/database.js')
 const RegionHelper = require('../../support/helpers/region.helper.js')
 
 // Things we need to stub
@@ -22,8 +21,6 @@ describe('Charging Module Create Bill Run request', () => {
   let testRegion
 
   beforeEach(async () => {
-    await DatabaseSupport.clean()
-
     testRegion = RegionHelper.select()
   })
 

test/services/bill-runs/annual/fetch-billing-accounts.service.test.js

@@ -40,7 +40,7 @@ describe('Fetch Billing Accounts service', () => {
     minimumChargeChangeReason = ChangeReasonHelper.select(CHANGE_REASON_NEW_LICENCE_PART_INDEX)
   })
 
-  describe('when there are no billing accounts that should be considered for the annual bill run', () => {
+  describe('when the billing account should NOT be considered for the annual bill run', () => {
     before(() => {
       region = RegionHelper.select(REGION_MIDLANDS_INDEX)
     })
@@ -59,10 +59,14 @@ describe('Fetch Billing Accounts service', () => {
         })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
 
@@ -75,10 +79,14 @@ describe('Fetch Billing Accounts service', () => {
         })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
 
@@ -94,10 +102,14 @@ describe('Fetch Billing Accounts service', () => {
         })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
 
@@ -113,10 +125,14 @@ describe('Fetch Billing Accounts service', () => {
         })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
 
@@ -128,10 +144,14 @@ describe('Fetch Billing Accounts service', () => {
         await ChargeVersionHelper.add({ billingAccountId: billingAccount.id, licenceId })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
 
@@ -143,10 +163,14 @@ describe('Fetch Billing Accounts service', () => {
         await ChargeVersionHelper.add({ billingAccountId: billingAccount.id, licenceId })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
 
@@ -156,10 +180,14 @@ describe('Fetch Billing Accounts service', () => {
         await WorkflowHelper.add({ licenceId: licence.id })
       })
 
-      it('returns empty results', async () => {
+      it('does not return the billing account', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        expect(results).to.be.empty()
+        const hasBillingAccountId = results.some((result) => {
+          return result.id === billingAccount.id
+        })
+
+        expect(hasBillingAccountId).to.be.false()
       })
     })
   })
@@ -192,21 +220,26 @@ describe('Fetch Billing Accounts service', () => {
       chargeElement = await ChargeElementHelper.add({ chargeReferenceId: chargeReference.id })
     })
 
-    it('returns the applicable billing accounts', async () => {
+    it('returns the applicable billing account', async () => {
       const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-      expect(results).to.have.length(1)
+      const billingAccountRecord = results.find((result) => {
+        return result.id === billingAccount.id
+      })
 
-      expect(results[0]).to.be.instanceOf(BillingAccountModel)
-      expect(results[0].id).to.equal(billingAccount.id)
-      expect(results[0].accountNumber).to.equal(billingAccount.accountNumber)
+      expect(billingAccountRecord).to.be.instanceOf(BillingAccountModel)
+      expect(billingAccountRecord.accountNumber).to.equal(billingAccount.accountNumber)
     })
 
     describe('that have applicable related charge versions', () => {
       it('includes the charge versions in each result', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        const { chargeVersions } = results[0]
+        const billingAccountRecord = results.find((result) => {
+          return result.id === billingAccount.id
+        })
+
+        const { chargeVersions } = billingAccountRecord
 
         expect(chargeVersions[0].id).to.equal(chargeVersion.id)
         expect(chargeVersions[0].scheme).to.equal('sroc')
@@ -219,7 +252,11 @@ describe('Fetch Billing Accounts service', () => {
       it('includes the licence and region in each result', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        const { licence } = results[0].chargeVersions[0]
+        const billingAccountRecord = results.find((result) => {
+          return result.id === billingAccount.id
+        })
+
+        const { licence } = billingAccountRecord.chargeVersions[0]
 
         expect(licence.id).to.equal(licence.id)
         expect(licence.licenceRef).to.equal(licence.licenceRef)
@@ -233,7 +270,11 @@ describe('Fetch Billing Accounts service', () => {
       it('includes the change reason in each result', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        const { changeReason } = results[0].chargeVersions[0]
+        const billingAccountRecord = results.find((result) => {
+          return result.id === billingAccount.id
+        })
+
+        const { changeReason } = billingAccountRecord.chargeVersions[0]
 
         expect(changeReason.id).to.equal(changeReason.id)
         expect(changeReason.triggersMinimumCharge).to.equal(changeReason.triggersMinimumCharge)
@@ -242,7 +283,11 @@ describe('Fetch Billing Accounts service', () => {
       it('includes the charge references, charge category and charge elements in each result', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        const { chargeReferences } = results[0].chargeVersions[0]
+        const billingAccountRecord = results.find((result) => {
+          return result.id === billingAccount.id
+        })
+
+        const { chargeReferences } = billingAccountRecord.chargeVersions[0]
 
         expect(chargeReferences).to.have.length(1)
 
@@ -288,7 +333,11 @@ describe('Fetch Billing Accounts service', () => {
       it('excludes the charge versions in each result', async () => {
         const results = await FetchBillingAccountsService.go(region.id, billingPeriod)
 
-        const { chargeVersions } = results[0]
+        const billingAccountRecord = results.find((result) => {
+          return result.id === billingAccount.id
+        })
+
+        const { chargeVersions } = billingAccountRecord
 
         expect(chargeVersions.length).to.equal(1)
         expect(chargeVersions[0].id).to.equal(chargeVersion.id)

test/services/bill-runs/annual/process-billing-period.service.test.js

@@ -9,7 +9,6 @@ const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
 const { expect } = Code
 
 // Test helpers
-const DatabaseSupport = require('../../../support/database.js')
 const { generateUUID } = require('../../../../app/lib/general.lib.js')
 const { determineCurrentFinancialYear } = require('../../../../app/lib/general.lib.js')
 
@@ -25,18 +24,16 @@ const ProcessBillingPeriodService = require('../../../../app/services/bill-runs/
 
 describe('Annual Process billing period service', () => {
   const billingPeriod = determineCurrentFinancialYear()
-  const billRun = {
-    id: '8e0d4c8b-e9fe-4238-8f3e-dfca743316ef',
-    externalId: 'f6e052f5-37f9-43f3-a649-ff6398cec1a3'
-  }
 
   let billingAccount
+  let billRun
   let chargingModuleCreateTransactionRequestStub
 
   beforeEach(async () => {
-    // NOTE: Although we don't rely on the helpers to create the data we pass into the service it does persist the
-    // results. If we don't clean the DB it causes the tests to fail because of unique constraints on the legacy tables.
-    await DatabaseSupport.clean()
+    billRun = {
+      id: generateUUID(),
+      externalId: generateUUID()
+    }
 
     chargingModuleCreateTransactionRequestStub = Sinon.stub(ChargingModuleCreateTransactionRequest, 'send')
   })

test/services/bill-runs/calculate-authorised-and-billable-days.service.test.js

@@ -10,7 +10,6 @@ const { expect } = Code
 // Test helpers
 const ChargeReferenceHelper = require('../../support/helpers/charge-reference.helper.js')
 const ChargeElementHelper = require('../../support/helpers/charge-element.helper.js')
-const DatabaseSupport = require('../../support/database.js')
 
 // Thing under test
 const CalculateAuthorisedAndBillableDaysService = require('../../../app/services/bill-runs/calculate-authorised-and-billable-days.service.js')
@@ -33,8 +32,6 @@ describe('Calculate Authorised and Billable days service', () => {
   let chargeReference
 
   beforeEach(async () => {
-    await DatabaseSupport.clean()
-
     chargeReference = await ChargeReferenceHelper.add()
   })
 

test/services/bill-runs/cancel-bill-run.service.test.js

@@ -9,7 +9,6 @@ const { expect } = Code
 
 // Test helpers
 const BillRunHelper = require('../../support/helpers/bill-run.helper.js')
-const DatabaseSupport = require('../../support/database.js')
 const RegionHelper = require('../../support/helpers/region.helper.js')
 
 // Thing under test
@@ -20,8 +19,6 @@ describe('Cancel Bill Run service', () => {
   let testBillRunId
 
   beforeEach(async () => {
-    await DatabaseSupport.clean()
-
     region = RegionHelper.select()
     const billRun = await BillRunHelper.add({
       billRunNumber: 10101,