chore(EMS-3790-3791): various minor housekeeping, dry click event cyp…

…ress command (#3001) * chore(EMS-3790): dry cypress command for clicking new application button * chore(nunjucks): remove unused components * chore(docs): align errors documentation * chore(tests): align mock referenceNumber url assertions * chore(business): remove unused nunjucks template, content strings * chore(tests): fix typo * chore(EMS-3791): mapYesNoField - remove unused param * chore(tests): remove unused const from multiple contract policy controller * chore(e2e): fix/update e2e test
UK-Export-Finance · Aug 23, 2024 · 22deb8d · 22deb8d
1 parent 3434e25
commit 22deb8d
Show file tree

Hide file tree

Showing 95 changed files with 152 additions and 376 deletions.
diff --git a/e2e-tests/commands/shared-commands/click-events/click-start-new-application-button.js b/e2e-tests/commands/shared-commands/click-events/click-start-new-application-button.js
@@ -0,0 +1,11 @@
+import partials from '../../../partials';
+
+/**
+ * clickStartNewApplicationButton
+ * Click the "start new application" button
+ */
+const clickStartNewApplicationButton = () => {
+  partials.startNewApplicationButton().click();
+};
+
+export default clickStartNewApplicationButton;
diff --git a/e2e-tests/commands/shared-commands/click-events/index.js b/e2e-tests/commands/shared-commands/click-events/index.js
@@ -11,6 +11,8 @@ Cypress.Commands.add('clickYesRadioInput', require('./click-yes-radio-input'));
 Cypress.Commands.add('clickProvideAlternativeCurrencyLink', require('./click-provide-alternative-currency-link'));
 Cypress.Commands.add('clickAlternativeCurrencyRadioOption', require('./click-alternative-currency-radio-option'));
 
+Cypress.Commands.add('clickStartNewApplicationButton', require('./click-start-new-application-button'));
+
 Cypress.Commands.add('clickTaskBusiness', require('./tasks/click-task-business'));
 Cypress.Commands.add('clickTaskBuyer', require('./tasks/click-task-buyer'));
 Cypress.Commands.add('clickTaskPolicy', require('./tasks/click-task-policy'));

diff --git a/e2e-tests/content-strings/pages/insurance/business/index.js b/e2e-tests/content-strings/pages/insurance/business/index.js
@@ -30,15 +30,6 @@ export const COMPANY_DETAILS = {
   DIFFERENT_TRADING_NAME_HINT: 'Your official trading name will still be on the policy.',
 };
 
-export const CONTACT = {
-  ...SHARED,
-  PAGE_TITLE: 'Your contact details',
-  CONTACT_DETAILS: {
-    LEGEND: 'Contact details',
-    HINT: 'This will be the name on the contract policy',
-  },
-};
-
 export const ALTERNATIVE_TRADING_ADDRESS = {
   ...SHARED,
   PAGE_TITLE: 'Alternative trading address',

diff --git a/.../sign-in/enter-code/account-sign-in-create-code-dashboard-or-application-redirect.spec.js b/.../sign-in/enter-code/account-sign-in-create-code-dashboard-or-application-redirect.spec.js
@@ -1,5 +1,4 @@
 import header from '../../../../../../../partials/header';
-import dashboardPage from '../../../../../../../pages/insurance/dashboard';
 
 context(
   'Insurance - Account - Sign in - I want to go straight to my application if there is exactly one application in progress or the dashboard otherwise',
@@ -43,7 +42,7 @@ context(
           // go to all applications for user
           cy.clickHeaderApplicationsLink();
           // click on start new application page
-          dashboardPage.startNewApplicationButton().click();
+          cy.clickStartNewApplicationButton();
 
           // complete eligibility questions
           cy.submitInsuranceEligibilityAnswersHappyPath();

diff --git a/...sts/insurance/cypress/e2e/journeys/complete-eligibility-answers-for-a-second-time.spec.js b/...sts/insurance/cypress/e2e/journeys/complete-eligibility-answers-for-a-second-time.spec.js
@@ -1,4 +1,3 @@
-import dashboardPage from '../../../../pages/insurance/dashboard';
 import { autoCompleteField, field } from '../../../../pages/shared';
 import { ROUTES, FIELD_IDS } from '../../../../constants';
 
@@ -28,7 +27,7 @@ context('Insurance - Eligibility - start and complete for a second time after cr
 
       cy.clickHeaderApplicationsLink();
 
-      dashboardPage.startNewApplicationButton().click();
+      cy.clickStartNewApplicationButton();
 
       cy.assertUrl(exporterLocationUrl);
     });

diff --git a/...tests/insurance/cypress/e2e/journeys/dashboard/dashboard-create-a-new-application.spec.js b/...tests/insurance/cypress/e2e/journeys/dashboard/dashboard-create-a-new-application.spec.js
@@ -1,4 +1,3 @@
-import dashboardPage from '../../../../../pages/insurance/dashboard';
 import { INSURANCE_ROUTES } from '../../../../../constants/routes/insurance';
 
 const { ROOT: INSURANCE_ROOT, ALL_SECTIONS } = INSURANCE_ROUTES;
@@ -14,7 +13,7 @@ context('Insurance - Dashboard - Start new application button - As an Exporter,
 
       cy.clickHeaderApplicationsLink();
 
-      dashboardPage.startNewApplicationButton().click();
+      cy.clickStartNewApplicationButton();
 
       cy.submitInsuranceEligibilityAnswersHappyPath();
     });

diff --git a/e2e-tests/insurance/cypress/e2e/journeys/dashboard/dashboard-multiple-applications.spec.js b/e2e-tests/insurance/cypress/e2e/journeys/dashboard/dashboard-multiple-applications.spec.js
@@ -36,7 +36,7 @@ context('Insurance - Dashboard - new application', () => {
     let secondReferenceNumber;
 
     before(() => {
-      dashboardPage.startNewApplicationButton().click();
+      cy.clickStartNewApplicationButton();
 
       cy.submitInsuranceEligibilityAnswersFromExporterLocationHappyPath({});
 

diff --git a/e2e-tests/insurance/cypress/e2e/journeys/dashboard/dashboard-no-applications.spec.js b/e2e-tests/insurance/cypress/e2e/journeys/dashboard/dashboard-no-applications.spec.js
@@ -1,4 +1,5 @@
 import dashboardPage from '../../../../../pages/insurance/dashboard';
+import partials from '../../../../../partials';
 import { PAGES } from '../../../../../content-strings';
 import { INSURANCE_ROUTES } from '../../../../../constants/routes/insurance';
 
@@ -43,18 +44,16 @@ context('Insurance - Dashboard - no applications', () => {
     });
 
     it('should render `start new application` link', () => {
-      const selector = dashboardPage.startNewApplicationButton();
-
       const expected = {
         href: ELIGIBILITY.EXPORTER_LOCATION,
         copy: CONTENT_STRINGS.START_NEW_APPLICATION.TEXT,
       };
 
-      cy.checkLink(selector, expected.href, expected.copy);
+      cy.checkLink(partials.startNewApplicationButton(), expected.href, expected.copy);
     });
 
     it(`should redirect to ${ELIGIBILITY.EXPORTER_LOCATION}`, () => {
-      dashboardPage.startNewApplicationButton().click();
+      cy.clickStartNewApplicationButton();
 
       const expectedUrl = `${baseUrl}${ELIGIBILITY.EXPORTER_LOCATION}`;
 
@@ -65,7 +64,7 @@ context('Insurance - Dashboard - no applications', () => {
   describe('when starting and completing insurance eligibility via the `start new` button ', () => {
     it('should create a new application and render in the dashboard', () => {
       cy.navigateToDashboardUrl();
-      dashboardPage.startNewApplicationButton().click();
+      cy.clickStartNewApplicationButton();
 
       cy.submitInsuranceEligibilityAnswersHappyPath();
 

diff --git a/e2e-tests/insurance/cypress/e2e/journeys/dashboard/dashboard.spec.js b/e2e-tests/insurance/cypress/e2e/journeys/dashboard/dashboard.spec.js
@@ -1,4 +1,5 @@
 import dashboardPage from '../../../../../pages/insurance/dashboard';
+import partials from '../../../../../partials';
 import { DEFAULT, PAGES, BUTTONS } from '../../../../../content-strings';
 import { ROUTES } from '../../../../../constants';
 import { INSURANCE_FIELD_IDS } from '../../../../../constants/field-ids/insurance';
@@ -161,14 +162,12 @@ context(
         });
 
         it('should render', () => {
-          const element = dashboardPage.startNewApplicationButton();
-
           const expected = {
             href: expectedUrl,
             text: BUTTONS.START_A_NEW_APPLICATION,
           };
 
-          cy.checkLink(element, expected.href, expected.text);
+          cy.checkLink(partials.startNewApplicationButton(), expected.href, expected.text);
         });
       });
 

diff --git a/...-apply-online/eligible-to-apply-online-already-signed-in-with-eligibility-answers.spec.js b/...-apply-online/eligible-to-apply-online-already-signed-in-with-eligibility-answers.spec.js
@@ -1,4 +1,3 @@
-import dashboardPage from '../../../../../../pages/insurance/dashboard';
 import { INSURANCE_ROUTES } from '../../../../../../constants/routes/insurance';
 
 const { ROOT, ALL_SECTIONS } = INSURANCE_ROUTES;
@@ -12,7 +11,7 @@ context(
     before(() => {
       cy.completeSignInAndGoToDashboard().then(() => {
         // start new application/eligibility flow
-        dashboardPage.startNewApplicationButton().click();
+        cy.clickStartNewApplicationButton();
 
         cy.submitInsuranceEligibilityAnswersFromExporterLocationHappyPath({});
       });

diff --git a/e2e-tests/insurance/cypress/e2e/journeys/header-authenticated-insurance-eligibility.spec.js b/e2e-tests/insurance/cypress/e2e/journeys/header-authenticated-insurance-eligibility.spec.js
@@ -1,5 +1,3 @@
-import dashboardPage from '../../../../pages/insurance/dashboard';
-
 context('Insurance - header - authenticated - complete insurance eligibility', () => {
   let referenceNumber;
 
@@ -11,7 +9,7 @@ context('Insurance - header - authenticated - complete insurance eligibility', (
       cy.clickHeaderApplicationsLink();
 
       // start a new application
-      dashboardPage.startNewApplicationButton().click();
+      cy.clickStartNewApplicationButton();
     });
   });
 

diff --git a/...cial-characters/submit-name-fields-with-special-characters-header-and-page-fields.spec.js b/...cial-characters/submit-name-fields-with-special-characters-header-and-page-fields.spec.js
@@ -1,6 +1,5 @@
 import { INSURANCE_FIELD_IDS } from '../../../../../constants/field-ids/insurance';
 import { field } from '../../../../../pages/shared';
-import dashboardPage from '../../../../../pages/insurance/dashboard';
 import partials from '../../../../../partials';
 import mockAccount from '../../../../../fixtures/account';
 import mockNameWithSpecialCharacters from '../../../../../fixtures/name-with-special-characters';
@@ -51,7 +50,7 @@ context('Insurance - Name fields - Header and page fields should render special
 
     cy.navigateToDashboardUrl();
 
-    dashboardPage.startNewApplicationButton().click();
+    cy.clickStartNewApplicationButton();
 
     cy.submitInsuranceEligibilityAnswersFromExporterLocationHappyPath({});
 

diff --git a/e2e-tests/pages/insurance/dashboard/index.js b/e2e-tests/pages/insurance/dashboard/index.js
@@ -1,6 +1,5 @@
 const dashboardPage = {
   noApplications: () => cy.get('[data-cy="no-applications"]'),
-  startNewApplicationButton: () => cy.get('[data-cy="start-new-application-button"]'),
   getAQuoteButton: () => cy.get('[data-cy="get-a-quote-button"]'),
   table: {
     headers: {

diff --git a/e2e-tests/partials/index.js b/e2e-tests/partials/index.js
@@ -27,6 +27,7 @@ const partials = {
   provideAlternativeCurrencyLink: () => cy.get('[data-cy="provide-alternative-currency-link"]'),
   privateMarketWhyDescription,
   skipLink: () => cy.get('[data-cy="skip-link"]'),
+  startNewApplicationButton: () => cy.get('[data-cy="start-new-application-button"]'),
   ukGoodsOrServicesCalculateDescription,
   ukGoodsOrServicesDescription,
 };

diff --git a/src/api/.keystone/config.js b/src/api/.keystone/config.js
diff --git a/src/api/generate-xlsx/map-application-to-XLSX/helpers/map-yes-no-field/index.test.ts b/src/api/generate-xlsx/map-application-to-XLSX/helpers/map-yes-no-field/index.test.ts
@@ -21,17 +21,7 @@ describe('api/generate-xlsx/map-application-to-xlsx/helpers/map-yes-no-field', (
     });
   });
 
-  describe('when value is undefined and a default value is passed', () => {
-    it('should return the default value', () => {
-      const mockDefaultValue = 'Mock default value';
-
-      const response = mapYesNoField({ defaultValue: mockDefaultValue });
-
-      expect(response).toEqual(mockDefaultValue);
-    });
-  });
-
-  describe('when value is "undefined"', () => {
+  describe('when value is undefined', () => {
     it(`should return ${DEFAULT.EMPTY}`, () => {
       const response = mapYesNoField({});
 

diff --git a/src/api/generate-xlsx/map-application-to-XLSX/helpers/map-yes-no-field/index.ts b/src/api/generate-xlsx/map-application-to-XLSX/helpers/map-yes-no-field/index.ts
@@ -8,10 +8,9 @@ const { YES, NO } = FIELD_VALUES;
  * mapYesNoField
  * Map a "true" or "false" field to Yes/No
  * @param {Boolean} answer: The boolean answer to map into a yes/no string.
- * @param {String} defaultValue: Custom default value.
  * @returns {String} "Yes/No" or DEFAULT.EMPTY
  */
-const mapYesNoField = ({ answer, defaultValue }: MapYesNoFieldParams): string => {
+const mapYesNoField = ({ answer }: MapYesNoFieldParams): string => {
   if (answer === false) {
     return NO;
   }
@@ -20,10 +19,6 @@ const mapYesNoField = ({ answer, defaultValue }: MapYesNoFieldParams): string =>
     return YES;
   }
 
-  if (defaultValue) {
-    return defaultValue;
-  }
-
   return DEFAULT.EMPTY;
 };
 

diff --git a/src/api/test-helpers/applications.ts b/src/api/test-helpers/applications.ts
@@ -104,7 +104,7 @@ const update = async ({ context, applicationId, data }: TestHelperApplicationUpd
 
 /**
  * deleteAll test helper
- * Get all accounts and delete them.
+ * Get all applications and delete them.
  * @param {Context} context: KeystoneJS context API
  * @returns {Array} Accounts that have been deleted
  */

diff --git a/src/ui/server/controllers/insurance/account/create/your-details/validation/rules/email.ts b/src/ui/server/controllers/insurance/account/create/your-details/validation/rules/email.ts
@@ -18,7 +18,7 @@ const {
  * Check submitted form data for errors with the email field
  * Returns generateValidationErrors if there are any errors.
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors}
  */
 const emailRules = (formBody: RequestBody, errors: object) => {

diff --git a/...i/server/controllers/insurance/account/create/your-details/validation/rules/first-name.ts b/...i/server/controllers/insurance/account/create/your-details/validation/rules/first-name.ts
@@ -18,7 +18,7 @@ const {
  * Check submitted form data for errors with the first name field
  * Returns generateValidationErrors if there are any errors.
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors}
  */
 const firstNameRules = (formBody: RequestBody, errors: object) => nameValidation(formBody, FIELD_ID, ERROR_MESSAGE, errors);

diff --git a/...ui/server/controllers/insurance/account/create/your-details/validation/rules/last-name.ts b/...ui/server/controllers/insurance/account/create/your-details/validation/rules/last-name.ts
@@ -18,7 +18,7 @@ const {
  * Check submitted form data for errors with the last name field
  * Returns generateValidationErrors if there are any errors.
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors} nameValidation
  */
 const lastNameRules = (formBody: RequestBody, errors: object) => nameValidation(formBody, FIELD_ID, ERROR_MESSAGE, errors);

diff --git a/src/ui/server/controllers/insurance/account/create/your-details/validation/rules/password.ts b/src/ui/server/controllers/insurance/account/create/your-details/validation/rules/password.ts
@@ -18,7 +18,7 @@ const {
  * Check submitted form data for errors with the password field
  * Returns generateValidationErrors if there are any errors.
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors}
  */
 const passwordRules = (formBody: RequestBody, errors: object) => {

diff --git a/...er/controllers/insurance/account/password-reset/new-password/validation/rules/password.ts b/...er/controllers/insurance/account/password-reset/new-password/validation/rules/password.ts
@@ -18,7 +18,7 @@ const {
  * Check submitted form data for errors with the password field
  * Returns generateValidationErrors if there are any errors.
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors}
  */
 const passwordRules = (formBody: RequestBody, errors: object) => {

diff --git a/src/ui/server/controllers/insurance/account/password-reset/validation/rules/email.ts b/src/ui/server/controllers/insurance/account/password-reset/validation/rules/email.ts
@@ -15,7 +15,7 @@ const {
  * emailRules
  * Returns emailValidation
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors}
  */
 const emailRules = (formBody: RequestBody, errors: object) => {

diff --git a/...i/server/controllers/insurance/account/sign-in/enter-code/validation/rules/access-code.ts b/...i/server/controllers/insurance/account/sign-in/enter-code/validation/rules/access-code.ts
@@ -13,7 +13,7 @@ const {
  * accessCodeRules
  * Returns the result of emptyFieldValidation
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors}
  */
 const accessCodeRules = (formBody: RequestBody, errors: object) => emptyFieldValidation(formBody, FIELD_ID, ERROR_MESSAGE.INCORRECT, errors);

diff --git a/src/ui/server/controllers/insurance/account/sign-in/validation/rules/email.ts b/src/ui/server/controllers/insurance/account/sign-in/validation/rules/email.ts
@@ -23,7 +23,7 @@ const {
  * 3) Check if an email is below the minimum length via maxLengthValidation.
  * If all of the conditions are met, empty errors are returned (via maxLengthValidation).
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {ValidationErrors} emailAndPasswordValidation | maxLengthValidation
  */
 const emailRules = (formBody: RequestBody, errors: object) => {

diff --git a/src/ui/server/controllers/insurance/account/sign-in/validation/rules/password.ts b/src/ui/server/controllers/insurance/account/sign-in/validation/rules/password.ts
@@ -12,7 +12,7 @@ const { PASSWORD: FIELD_ID } = FIELD_IDS;
  * This ensures that a validation error is returned for both EMIL and PASSWORD,
  * to indicate to a user that the credentials are invalid.
  * @param {RequestBody} formBody: Form body
- * @param {Object} Errors object from previous validation errors
+ * @param {Object} errors: Errors from previous validation errors
  * @returns {Function} emailAndPasswordValidation
  */
 const passwordRules = (formBody: RequestBody, errors: object) => {

diff --git a/...er/controllers/insurance/business/alternative-trading-address/save-and-back/index.test.ts b/...er/controllers/insurance/business/alternative-trading-address/save-and-back/index.test.ts
@@ -4,7 +4,7 @@ import { FIELD_IDS } from '..';
 import { ROUTES } from '../../../../../constants';
 import BUSINESS_FIELD_IDS from '../../../../../constants/field-ids/insurance/business';
 import mapAndSave from '../../map-and-save/company-different-trading-address';
-import { mockReq, mockRes, mockApplication, mockSpyPromiseRejection } from '../../../../../test-mocks';
+import { mockReq, mockRes, mockApplication, mockSpyPromiseRejection, referenceNumber } from '../../../../../test-mocks';
 import { Request, Response } from '../../../../../../types';
 
 const {
@@ -40,7 +40,7 @@ describe('controllers/insurance/business/alternative-trading-address/save-and-ba
 
       await post(req, res);
 
-      expect(res.redirect).toHaveBeenCalledWith(`${INSURANCE_ROOT}/${req.params.referenceNumber}${ALL_SECTIONS}`);
+      expect(res.redirect).toHaveBeenCalledWith(`${INSURANCE_ROOT}/${referenceNumber}${ALL_SECTIONS}`);
     });
 
     it('should call mapAndSave.companyDifferentTradingAddress once with data from constructPayload', async () => {
@@ -66,7 +66,7 @@ describe('controllers/insurance/business/alternative-trading-address/save-and-ba
 
       await post(req, res);
 
-      expect(res.redirect).toHaveBeenCalledWith(`${INSURANCE_ROOT}/${req.params.referenceNumber}${ALL_SECTIONS}`);
+      expect(res.redirect).toHaveBeenCalledWith(`${INSURANCE_ROOT}/${referenceNumber}${ALL_SECTIONS}`);
     });
 
     it('should not call mapAndSave.companyDifferentTradingAddress', async () => {