Restructure 'seeding' to be Knex based

.github/workflows/ci.yml

@@ -39,6 +39,7 @@ jobs:
       POSTGRES_DB_TEST: wabs_system_test
       ENVIRONMENT: dev
       COOKIE_SECRET: 1a1028df-a2af-468a-929b-e3a274be1208
+      DEFAULT_USER_PASSWORD: P@55word
 
     # Service containers to run with `runner-job`
     services:

app/services/data/load/load.service.js

@@ -27,10 +27,7 @@ const CompanyContactHelper = require('../../../../test/support/helpers/company-c
 const CompanyHelper = require('../../../../test/support/helpers/company.helper.js')
 const ContactHelper = require('../../../../test/support/helpers/contact.helper.js')
 const EventHelper = require('../../../../test/support/helpers/event.helper.js')
-const FinancialAgreementHelper = require('../../../../test/support/helpers/financial-agreement.helper.js')
 const GaugingStationHelper = require('../../../../test/support/helpers/gauging-station.helper.js')
-const GroupRoleHelper = require('../../../../test/support/helpers/group-role.helper.js')
-const GroupHelper = require('../../../../test/support/helpers/group.helper.js')
 const LicenceAgreementHelper = require('../../../../test/support/helpers/licence-agreement.helper.js')
 const LicenceDocumentHeaderHelper = require('../../../../test/support/helpers/licence-document-header.helper.js')
 const LicenceDocumentRoleHelper = require('../../../../test/support/helpers/licence-document-role.helper.js')
@@ -40,14 +37,11 @@ const LicenceEntityHelper = require('../../../../test/support/helpers/licence-en
 const LicenceGaugingStationHelper = require('../../../../test/support/helpers/licence-gauging-station.helper.js')
 const LicenceRoleHelper = require('../../../../test/support/helpers/licence-role.helper.js')
 const LicenceSupplementaryYearHelper = require('../../../../test/support/helpers/licence-supplementary-year.helper.js')
-const LicenceVersionPurposeConditionTypeHelper = require('../../../../test/support/helpers/licence-version-purpose-condition-type.helper.js')
 const LicenceVersionPurposeConditionHelper = require('../../../../test/support/helpers/licence-version-purpose-condition.helper.js')
 const LicenceVersionPurposeHelper = require('../../../../test/support/helpers/licence-version-purpose.helper.js')
 const LicenceVersionHelper = require('../../../../test/support/helpers/licence-version.helper.js')
 const LicenceHelper = require('../../../../test/support/helpers/licence.helper.js')
 const PermitLicenceHelper = require('../../../../test/support/helpers/permit-licence.helper.js')
-const PurposeHelper = require('../../../../test/support/helpers/purpose.helper.js')
-const RegionHelper = require('../../../../test/support/helpers/region.helper.js')
 const ReturnLogHelper = require('../../../../test/support/helpers/return-log.helper.js')
 const ReturnRequirementPointHelper = require('../../../../test/support/helpers/return-requirement-point.helper.js')
 const ReturnRequirementPurposeHelper = require('../../../../test/support/helpers/return-requirement-purpose.helper.js')
@@ -61,7 +55,6 @@ const ReviewChargeReferenceHelper = require('../../../../test/support/helpers/re
 const ReviewChargeVersionHelper = require('../../../../test/support/helpers/review-charge-version.helper.js')
 const ReviewLicenceHelper = require('../../../../test/support/helpers/review-licence.helper.js')
 const ReviewReturnHelper = require('../../../../test/support/helpers/review-return.helper.js')
-const RoleHelper = require('../../../../test/support/helpers/role.helper.js')
 const ScheduledNotificationHelper = require('../../../../test/support/helpers/scheduled-notification.helper.js')
 const SessionHelper = require('../../../../test/support/helpers/session.helper.js')
 const TransactionHelper = require('../../../../test/support/helpers/transaction.helper.js')
@@ -92,10 +85,7 @@ const LOAD_HELPERS = {
   companies: { helper: CompanyHelper, test: true, legacy: { schema: 'crm_v2', table: 'companies', id: 'company_id' } },
   contacts: { helper: ContactHelper, test: true, legacy: { schema: 'crm_v2', table: 'contacts', id: 'contact_id' } },
   events: { helper: EventHelper, test: false },
-  financialAgreements: { helper: FinancialAgreementHelper, test: true, legacy: { schema: 'water', table: 'financial_agreement_types', id: 'financial_agreement_type_id' } },
   gaugingStations: { helper: GaugingStationHelper, test: true, legacy: { schema: 'water', table: 'gauging_stations', id: 'gauging_station_id' } },
-  groupRoles: { helper: GroupRoleHelper, test: false },
-  groups: { helper: GroupHelper, test: false },
   licenceAgreements: { helper: LicenceAgreementHelper, test: true, legacy: { schema: 'water', table: 'licence_agreements', id: 'licence_agreement_id' } },
   licenceDocumentHeaders: { helper: LicenceDocumentHeaderHelper, test: false },
   licenceDocumentRoles: { helper: LicenceDocumentRoleHelper, test: true, legacy: { schema: 'crm_v2', table: 'document_roles', id: 'document_role_id' } },
@@ -105,14 +95,11 @@ const LOAD_HELPERS = {
   licenceGaugingStations: { helper: LicenceGaugingStationHelper, test: true, legacy: { schema: 'water', table: 'licence_gauging_stations', id: 'licence_gauging_station_id' } },
   licenceRoles: { helper: LicenceRoleHelper, test: false },
   LicenceSupplementaryYears: { helper: LicenceSupplementaryYearHelper, test: false },
-  licenceVersionPurposeConditionTypes: { helper: LicenceVersionPurposeConditionTypeHelper, test: false },
   licenceVersionPurposeConditions: { helper: LicenceVersionPurposeConditionHelper, test: false },
   licenceVersionPurposes: { helper: LicenceVersionPurposeHelper, test: true, legacy: { schema: 'water', table: 'licence_version_purposes', id: 'licence_version_purpose_id' } },
   licenceVersions: { helper: LicenceVersionHelper, test: true, legacy: { schema: 'water', table: 'licence_versions', id: 'licence_version_id' } },
   licences: { helper: LicenceHelper, test: true, legacy: { schema: 'water', table: 'licences', id: 'licence_id' } },
   permitLicences: { helper: PermitLicenceHelper, test: false },
-  purposes: { helper: PurposeHelper, test: true, legacy: { schema: 'water', table: 'purposes_uses', id: 'purpose_use_id' } },
-  regions: { helper: RegionHelper, test: true, legacy: { schema: 'water', table: 'regions', id: 'region_id' } },
   returnLogs: { helper: ReturnLogHelper, test: true, legacy: { schema: 'returns', table: 'returns', id: 'return_id' } },
   returnRequirementPoints: { helper: ReturnRequirementPointHelper, test: false },
   returnRequirementPurposes: { helper: ReturnRequirementPurposeHelper, test: false },
@@ -126,7 +113,6 @@ const LOAD_HELPERS = {
   reviewChargeVersions: { helper: ReviewChargeVersionHelper, test: false },
   reviewLicences: { helper: ReviewLicenceHelper, test: false },
   reviewReturns: { helper: ReviewReturnHelper, test: false },
-  roles: { helper: RoleHelper, test: false },
   scheduledNotifications: { helper: ScheduledNotificationHelper },
   sessions: { helper: SessionHelper, test: false },
   transactions: { helper: TransactionHelper, test: false },

db/seeds/01-regions.seed.js

@@ -0,0 +1,66 @@
+'use strict'
+
+const { db } = require('../db.js')
+
+const { timestampForPostgres } = require('../../app/lib/general.lib.js')
+const { data: regions } = require('./data/regions.js')
+const RegionModel = require('../../app/models/region.model.js')
+
+const ServerConfig = require('../../config/server.config.js')
+
+async function seed () {
+  for (const region of regions) {
+    const exists = await _exists(region)
+
+    if (exists) {
+      await _update(region)
+    } else {
+      await _insert(region)
+    }
+  }
+}
+
+async function _applyTestFlag (region, id) {
+  if (region.name !== 'Test') {
+    return null
+  }
+
+  return db('regions').withSchema('water').update('isTest', true).where('regionId', id)
+}
+
+async function _exists (region) {
+  const { chargeRegionId, naldRegionId } = region
+
+  const result = await RegionModel.query()
+    .select('id')
+    .where('chargeRegionId', chargeRegionId)
+    .andWhere('naldRegionId', naldRegionId)
+    .limit(1)
+    .first()
+
+  return !!result
+}
+
+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') {
+    return
+  }
+
+  const result = await RegionModel.query().insert(region)
+
+  return _applyTestFlag(region, result.id)
+}
+
+async function _update (region) {
+  const { chargeRegionId, displayName, naldRegionId, name } = region
+
+  return RegionModel.query()
+    .patch({ displayName, name, updatedAt: timestampForPostgres() })
+    .where('chargeRegionId', chargeRegionId)
+    .andWhere('naldRegionId', naldRegionId)
+}
+
+module.exports = {
+  seed
+}

db/seeds/02-purposes.seed.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { timestampForPostgres } = require('../../app/lib/general.lib.js')
+const { data: purposes } = require('./data/purposes.js')
+const PurposeModel = require('../../app/models/purpose.model.js')
+
+async function seed () {
+  for (const purpose of purposes) {
+    await _upsert(purpose)
+  }
+}
+
+async function _upsert (purpose) {
+  return PurposeModel.query()
+    .insert({ ...purpose, updatedAt: timestampForPostgres() })
+    .onConflict('legacyId')
+    .merge(['description', 'lossFactor', 'twoPartTariff', 'updatedAt'])
+}
+
+module.exports = {
+  seed
+}

db/seeds/03-primary-purposes.seed.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { timestampForPostgres } = require('../../app/lib/general.lib.js')
+const { data: primaryPurposes } = require('./data/primary-purposes.js')
+const PrimaryPurposeModel = require('../../app/models/primary-purpose.model.js')
+
+async function seed () {
+  for (const purpose of primaryPurposes) {
+    await _upsert(purpose)
+  }
+}
+
+async function _upsert (primaryPurpose) {
+  return PrimaryPurposeModel.query()
+    .insert({ ...primaryPurpose, updatedAt: timestampForPostgres() })
+    .onConflict('legacyId')
+    .merge(['description', 'updatedAt'])
+}
+
+module.exports = {
+  seed
+}

db/seeds/04-secondary-purposes.seed.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { timestampForPostgres } = require('../../app/lib/general.lib.js')
+const { data: secondaryPurposes } = require('./data/secondary-purposes.js')
+const SecondaryPurposeModel = require('../../app/models/secondary-purpose.model.js')
+
+async function seed () {
+  for (const purpose of secondaryPurposes) {
+    await _upsert(purpose)
+  }
+}
+
+async function _upsert (secondaryPurpose) {
+  return SecondaryPurposeModel.query()
+    .insert({ ...secondaryPurpose, updatedAt: timestampForPostgres() })
+    .onConflict('legacyId')
+    .merge(['description', 'updatedAt'])
+}
+
+module.exports = {
+  seed
+}

db/seeds/05-licence-version-purpose-condition-types.seed.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const { timestampForPostgres } = require('../../app/lib/general.lib.js')
+const { data: licenceVersionPurposeConditionTypes } = require('./data/licence-version-purpose-condition-types.js')
+const LicenceVersionPurposeConditionTypeModel = require('../../app/models/licence-version-purpose-condition-type.model.js')
+
+async function seed () {
+  for (const licenceVersionPurposeConditionType of licenceVersionPurposeConditionTypes) {
+    await _upsert(licenceVersionPurposeConditionType)
+  }
+}
+
+async function _upsert (licenceVersionPurposeConditionType) {
+  return LicenceVersionPurposeConditionTypeModel.query()
+    .insert({ ...licenceVersionPurposeConditionType, updatedAt: timestampForPostgres() })
+    .onConflict(['code', 'subcode'])
+    .merge(['description', 'displayTitle', 'subcodeDescription', 'updatedAt'])
+}
+
+module.exports = {
+  seed
+}