Merge pull request #7370 from uktrade/fix/manage-randomness-in-tests

Fix/manage randomness in tests
uktrade · Dec 5, 2024 · c83fe65 · c83fe65
2 parents 589e5fc + 7739532
commit c83fe65
Show file tree

Hide file tree

Showing 63 changed files with 251 additions and 77 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -88,7 +88,17 @@
     ],
     "no-duplicate-imports": "error",
     "import/no-named-as-default": "off",
-    "import/no-named-as-default-member": "off"
+    "import/no-named-as-default-member": "off",
+    "no-restricted-imports": [
+      "error",
+      {
+        "name": "@faker-js/faker",
+        "message": "Use the pseudo-random `faker` from `test/sandbox/utils/random.js`"
+      },
+      {
+        "name": "json-schema-faker",
+        "message": "Use the pseudo-random `jsf` from `test/sandbox/utils/random.js`"
+      }]
   },
   "overrides": [
     {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -208,6 +208,7 @@
     "proxyquire": "^2.1.3",
     "reqres": "^3.0.1",
     "rewire": "^6.0.0",
+    "seedrandom": "^3.0.5",
     "sharp": "^0.33.5",
     "sinon": "^18.0.0",
     "sinon-chai": "^3.7.0",

diff --git a/src/client/components/CompanyLists/tasks/dummy/index.js b/src/client/components/CompanyLists/tasks/dummy/index.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../../../../test/sandbox/utils/random'
 
 const randomLists = ({ length, max = 10 }) =>
   Array(length || faker.number.int(max))

diff --git a/src/client/components/ReferralList/tasks/dummy/index.js b/src/client/components/ReferralList/tasks/dummy/index.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../../../../test/sandbox/utils/random'
 
 const randomAdviser = () => ({
   ...faker.helpers.createCard(),

diff --git a/src/client/components/Task/__stories__/tasks.js b/src/client/components/Task/__stories__/tasks.js
@@ -1,5 +1,6 @@
 import _ from 'lodash'
-import { faker } from '@faker-js/faker'
+
+import { faker } from '../../../../../test/sandbox/utils/random'
 
 const OPTIONS = Array(1000)
   .fill()

diff --git a/test/.eslintrc b/test/.eslintrc
@@ -15,5 +15,6 @@
   },
   "rules": {
     "no-unused-expressions": 0
+
   }
 }
diff --git a/test/component/cypress/specs/Companies/AccountManagement/Objective/ObjectiveForm.cy.jsx b/test/component/cypress/specs/Companies/AccountManagement/Objective/ObjectiveForm.cy.jsx
@@ -1,5 +1,6 @@
 import React from 'react'
-import { faker } from '@faker-js/faker'
+
+import { faker } from '../../../../../../sandbox/utils/random.js'
 
 import ObjectiveForm from '../../../../../../../src/client/modules/Companies/AccountManagement/Objective/ObjectiveForm'
 import { companyFaker } from '../../../../../../functional/cypress/fakers/companies'

diff --git a/...ress/specs/Companies/CompanyInvestments/LargeCapitalProfile/EditProfileDetailsForm.cy.jsx b/...ress/specs/Companies/CompanyInvestments/LargeCapitalProfile/EditProfileDetailsForm.cy.jsx
@@ -1,5 +1,6 @@
 import React from 'react'
-import { faker } from '@faker-js/faker'
+
+import { faker } from '../../../../../../sandbox/utils/random.js'
 
 import { largeInvestorProfileFaker } from '../../../../../../functional/cypress/fakers/large-investor-profile'
 import { ProfileDetailsForm } from '../../../../../../../src/client/modules/Companies/CompanyInvestments/LargeCapitalProfile/EditProfileDetailsForm'

diff --git a/test/component/cypress/specs/ExportWins/CustomerFeedback.cy.jsx b/test/component/cypress/specs/ExportWins/CustomerFeedback.cy.jsx
@@ -8,7 +8,7 @@ import {
 } from '../../../../functional/cypress/support/assertions'
 import CustomerFeedback from '../../../../../src/client/modules/ExportWins/CustomerFeedback'
 import urls from '../../../../../src/lib/urls'
-import { resolve } from '../../../../utils'
+import { resolve } from '../../support/utils'
 
 const toYesNo = (x) => (x ? 'Yes' : 'No')
 

diff --git a/test/component/cypress/specs/Resource/Paginated.cy.jsx b/test/component/cypress/specs/Resource/Paginated.cy.jsx
@@ -4,7 +4,7 @@ import React from 'react'
 
 import PaginatedResource from '../../../../../src/client/components/Resource/Paginated'
 import TabNav from '../../../../../src/client/components/TabNav'
-import { resolve } from '../../../../utils'
+import { resolve } from '../../support/utils'
 
 const PAGE_SIZE = 10
 const COUNT = 35

diff --git a/test/component/cypress/specs/Tasks/TaskForm/TaskFormFields.cy.jsx b/test/component/cypress/specs/Tasks/TaskForm/TaskFormFields.cy.jsx
@@ -1,6 +1,7 @@
 import React from 'react'
 import { capitalize } from 'lodash'
-import { faker } from '@faker-js/faker'
+
+import { faker } from '../../../../../sandbox/utils/random.js'
 
 import {
   assertFieldDate,

diff --git a/test/utils.js → test/component/cypress/support/utils.js b/test/utils.js → test/component/cypress/support/utils.js
diff --git a/test/functional/cypress/fakers/addresses.js b/test/functional/cypress/fakers/addresses.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 const addressFaker = (overrides = {}) => ({
   line_1: faker.location.streetAddress(),

diff --git a/test/functional/cypress/fakers/administrative-areas.js b/test/functional/cypress/fakers/administrative-areas.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/advisers.js b/test/functional/cypress/fakers/advisers.js
@@ -1,5 +1,4 @@
-import jsf from 'json-schema-faker'
-
+import { jsf } from '../../../sandbox/utils/random'
 import apiSchema from '../../../api-schema.json'
 import { listFaker } from './utils'
 import { ditTeamFaker } from './dit-team'

diff --git a/test/functional/cypress/fakers/companies.js b/test/functional/cypress/fakers/companies.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
+import { jsf, faker } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 

diff --git a/test/functional/cypress/fakers/company-activity.js b/test/functional/cypress/fakers/company-activity.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
+import { faker, jsf } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 import { relativeDateFaker } from './dates'

diff --git a/test/functional/cypress/fakers/company-export-win.js b/test/functional/cypress/fakers/company-export-win.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/company-one-list-group-tier.js b/test/functional/cypress/fakers/company-one-list-group-tier.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/contacts.js b/test/functional/cypress/fakers/contacts.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
+import { faker, jsf } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 import { listFaker } from './utils'

diff --git a/test/functional/cypress/fakers/countries.js b/test/functional/cypress/fakers/countries.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/dates.js b/test/functional/cypress/fakers/dates.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { addDays } from '../../../../src/client/utils/date'
 

diff --git a/test/functional/cypress/fakers/dit-team.js b/test/functional/cypress/fakers/dit-team.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/dnb-hierarchy.js b/test/functional/cypress/fakers/dnb-hierarchy.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 import { addressFaker } from './addresses'

diff --git a/test/functional/cypress/fakers/event-types.js b/test/functional/cypress/fakers/event-types.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-
+import { faker } from '../../../sandbox/utils/random'
 import { listFaker } from './utils'
 
 /**

diff --git a/test/functional/cypress/fakers/events.js b/test/functional/cypress/fakers/events.js
@@ -1,6 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
-
+import { faker, jsf } from '../../../sandbox/utils/random'
 import apiSchema from '../../../api-schema.json'
 
 import { listFaker } from './utils'

diff --git a/test/functional/cypress/fakers/export-wins.js b/test/functional/cypress/fakers/export-wins.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { contactFaker } from './contacts'
 import { sectorFaker } from './sectors'

diff --git a/test/functional/cypress/fakers/export.js b/test/functional/cypress/fakers/export.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 import { sectorFaker } from './sectors'

diff --git a/test/functional/cypress/fakers/eyb-leads.js b/test/functional/cypress/fakers/eyb-leads.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import { JSONSchemaFaker } from 'json-schema-faker'
+import { faker, jsf } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 
@@ -63,7 +62,7 @@ const LANDING_TIMEFRAME_CHOICES = [
  * merges in overrides.
  */
 const eybLeadFaker = (overrides = {}) => ({
-  ...JSONSchemaFaker.generate(apiSchema.components.schemas.RetrieveEYBLead),
+  ...jsf.generate(apiSchema.components.schemas.RetrieveEYBLead),
   archived: false,
   archived_on: null,
   archived_reason: null,

diff --git a/test/functional/cypress/fakers/hq-team.js b/test/functional/cypress/fakers/hq-team.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/interactions.js b/test/functional/cypress/fakers/interactions.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
+import { faker, jsf } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 import { listFaker } from './utils'

diff --git a/test/functional/cypress/fakers/investment-project-summary.js b/test/functional/cypress/fakers/investment-project-summary.js
@@ -1,6 +1,7 @@
-import { faker } from '@faker-js/faker'
 import { snakeCase } from 'lodash'
 
+import { faker } from '../../../sandbox/utils/random'
+
 import { INVESTMENT_PROJECT_STAGES_LIST } from './constants'
 
 /**

diff --git a/test/functional/cypress/fakers/investment-projects.js b/test/functional/cypress/fakers/investment-projects.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
+import { faker, jsf } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 

diff --git a/test/functional/cypress/fakers/investor-type.js b/test/functional/cypress/fakers/investor-type.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 const investorTypes = [
   'Angel syndicate',

diff --git a/test/functional/cypress/fakers/large-investor-profile.js b/test/functional/cypress/fakers/large-investor-profile.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 import { investorTypeFaker } from './investor-type'

diff --git a/test/functional/cypress/fakers/numbers.js b/test/functional/cypress/fakers/numbers.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 /**
  * Pad a number with leading zeroes to ensure it has the given length

diff --git a/test/functional/cypress/fakers/objective.js b/test/functional/cypress/fakers/objective.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 import { formatWithoutParsing } from '../../../../src/client/utils/date'

diff --git a/test/functional/cypress/fakers/orders.js b/test/functional/cypress/fakers/orders.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
+import { jsf, faker } from '../../../sandbox/utils/random'
 
 import apiSchema from '../../../api-schema.json'
 import { listFaker } from './utils'

diff --git a/test/functional/cypress/fakers/policy-area.js b/test/functional/cypress/fakers/policy-area.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/policy-issue-type.js b/test/functional/cypress/fakers/policy-issue-type.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/propositions.js b/test/functional/cypress/fakers/propositions.js
@@ -1,7 +1,7 @@
-import { faker } from '@faker-js/faker'
-import jsf from 'json-schema-faker'
 import { startCase } from 'lodash'
 
+import { faker, jsf } from '../../../sandbox/utils/random'
+
 import apiSchema from '../../../api-schema.json'
 
 import { relativeDateFaker } from './dates'

diff --git a/test/functional/cypress/fakers/regions.js b/test/functional/cypress/fakers/regions.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/reminders.js b/test/functional/cypress/fakers/reminders.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { relativeDateFaker } from './dates'
 import { investmentProjectCodeFaker } from './investment-projects'

diff --git a/test/functional/cypress/fakers/required-checks-conducted.js b/test/functional/cypress/fakers/required-checks-conducted.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 const names = [
   'Cleared',

diff --git a/test/functional/cypress/fakers/sectors.js b/test/functional/cypress/fakers/sectors.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/services.js b/test/functional/cypress/fakers/services.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/task.js b/test/functional/cypress/fakers/task.js
@@ -1,6 +1,7 @@
-import { faker } from '@faker-js/faker'
 import { pick } from 'lodash'
 
+import { faker } from '../../../sandbox/utils/random'
+
 import { listFaker } from './utils'
 import { companyFaker } from './companies'
 import { interactionFaker } from './interactions'

diff --git a/test/functional/cypress/fakers/team-type.js b/test/functional/cypress/fakers/team-type.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/team.js b/test/functional/cypress/fakers/team.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 import { listFaker } from './utils'
 

diff --git a/test/functional/cypress/fakers/users.js b/test/functional/cypress/fakers/users.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../sandbox/utils/random'
 
 const userFaker = (overrides) => {
   const first_name = faker.person.firstName()

diff --git a/test/functional/cypress/specs/companies/account-management-spec.js b/test/functional/cypress/specs/companies/account-management-spec.js
@@ -1,6 +1,7 @@
-import { faker } from '@faker-js/faker'
 import { format } from 'date-fns'
 
+import { faker } from '../../../../sandbox/utils/random'
+
 import { companyFaker } from '../../fakers/companies'
 import { userFaker } from '../../fakers/users'
 import objectiveListFaker, { objectiveFaker } from '../../fakers/objective'

diff --git a/test/functional/cypress/specs/dashboard/investment-details-spec.js b/test/functional/cypress/specs/dashboard/investment-details-spec.js
@@ -1,4 +1,4 @@
-import { faker } from '@faker-js/faker'
+import { faker } from '../../../../sandbox/utils/random'
 
 import { formatWithoutParsing } from '../../../../../src/client/utils/date'
 import { investmentProjectFaker } from '../../fakers/investment-projects'

diff --git a/test/functional/cypress/specs/export-pipeline/add-export-spec.js b/test/functional/cypress/specs/export-pipeline/add-export-spec.js
@@ -1,5 +1,4 @@
-import { faker } from '@faker-js/faker'
-
+import { faker } from '../../../../sandbox/utils/random'
 import { contactFaker, contactsListFaker } from '../../fakers/contacts'
 import { exportFaker } from '../../fakers/export'
 import { companyFaker } from '../../fakers/companies'
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,5 +15,6 @@ @@
       },
       "rules": {
         "no-unused-expressions": 0
       }
     }