feat(EMS-3828-3876): currency of agent charges - save and back, improve e2e assertions

e2e-tests/insurance/cypress/e2e/journeys/export-contract/currency-of-agent-charges/currency-of-agent-charges.spec.js

@@ -81,14 +81,12 @@ context(
       const { rendering, formSubmission } = assertCurrencyFormFields({
         gbpCurrencyCheckedByDefault: true,
         errors: CURRENCY_ERROR_MESSAGES,
+        expectedRedirectUrl: AGENT_CHARGES,
       });
 
       rendering();
 
-      formSubmission().selectAltRadioButNoAltCurrency({});
-
-      formSubmission().submitASupportedCurrency({ url: AGENT_CHARGES });
-      formSubmission().submitAlternativeCurrency({ url: AGENT_CHARGES });
+      formSubmission({}).executeTests();
     });
 
     describe('form submission', () => {

e2e-tests/insurance/cypress/e2e/journeys/policy/multiple-contract-policy/multiple-contract-policy.spec.js

@@ -115,18 +115,14 @@ context('Insurance - Policy - Multiple contract policy page - As an exporter, I
       legend: CONTRACT_POLICY[CURRENCY_CODE].LEGEND,
       hint: CONTRACT_POLICY[CURRENCY_CODE].HINT,
       errors: CONTRACT_ERROR_MESSAGES,
+      errorIndex: 2,
+      expectedRedirectUrl: MULTIPLE_CONTRACT_POLICY_EXPORT_VALUE,
+      completeNonCurrencyFieldsFunction: () => cy.completeMultipleContractPolicyForm({ chooseCurrency: false }),
     });
 
     rendering();
 
-    formSubmission().selectAltRadioButNoAltCurrency({ errorIndex: 2 });
-
-    formSubmission().submitASupportedCurrency({
-      url: MULTIPLE_CONTRACT_POLICY_EXPORT_VALUE,
-      completeNonCurrencyFields: () => cy.completeMultipleContractPolicyForm({ chooseCurrency: false }),
-    });
-
-    formSubmission().submitAlternativeCurrency({ url: MULTIPLE_CONTRACT_POLICY_EXPORT_VALUE });
+    formSubmission({}).executeTests();
   });
 
   describe('form submission', () => {

e2e-tests/insurance/cypress/e2e/journeys/policy/single-contract-policy/single-contract-policy.spec.js

@@ -116,18 +116,14 @@ context('Insurance - Policy - Single contract policy page - As an exporter, I wa
       legend: CONTRACT_POLICY[CURRENCY_CODE].LEGEND,
       hint: CONTRACT_POLICY[CURRENCY_CODE].HINT,
       errors: CONTRACT_ERROR_MESSAGES,
+      errorIndex: 2,
+      expectedRedirectUrl: SINGLE_CONTRACT_POLICY_TOTAL_CONTRACT_VALUE,
+      completeNonCurrencyFieldsFunction: () => cy.completeSingleContractPolicyForm({ chooseCurrency: false }),
     });
 
     rendering();
 
-    formSubmission().selectAltRadioButNoAltCurrency({ errorIndex: 2 });
-
-    formSubmission().submitASupportedCurrency({
-      url: SINGLE_CONTRACT_POLICY_TOTAL_CONTRACT_VALUE,
-      completeNonCurrencyFields: () => cy.completeSingleContractPolicyForm({ chooseCurrency: false }),
-    });
-
-    formSubmission().submitAlternativeCurrency({ url: SINGLE_CONTRACT_POLICY_TOTAL_CONTRACT_VALUE });
+    formSubmission({}).executeTests();
   });
 
   describe('form submission', () => {

e2e-tests/insurance/cypress/e2e/journeys/your-business/turnover-currency/turnover-currency-page.spec.js

@@ -69,14 +69,13 @@ context(
 
       const { rendering, formSubmission } = assertCurrencyFormFields({
         errors: ERRORS,
+        expectedRedirectUrl: TURNOVER_ROOT,
+        hasSaveAndBack: false,
       });
 
       rendering();
 
-      formSubmission().selectAltRadioButNoAltCurrency({});
-
-      formSubmission().submitASupportedCurrency({ url: TURNOVER_ROOT });
-      formSubmission().submitAlternativeCurrency({ url: TURNOVER_ROOT });
+      formSubmission({}).executeTests();
     });
   },
 );

e2e-tests/insurance/cypress/e2e/journeys/your-buyer/currency-of-late-payments/currency-of-late-payments.spec.js

@@ -75,14 +75,13 @@ context(
 
       const { rendering, formSubmission } = assertCurrencyFormFields({
         errors: ERRORS,
+        expectedRedirectUrl: OUTSTANDING_OR_OVERDUE_PAYMENTS,
+        hasSaveAndBack: false,
       });
 
       rendering();
 
-      formSubmission().selectAltRadioButNoAltCurrency({});
-
-      formSubmission().submitASupportedCurrency({ url: OUTSTANDING_OR_OVERDUE_PAYMENTS });
-      formSubmission().submitAlternativeCurrency({ url: OUTSTANDING_OR_OVERDUE_PAYMENTS });
+      formSubmission({}).executeTests();
     });
   },
 );

e2e-tests/shared-test-assertions/currency-form-fields/assertions.js

@@ -111,36 +111,50 @@ const assertCurrencyFormFields = ({
     const expectedValue = `${NON_STANDARD_CURRENCY_NAME} (${NON_STANDARD_CURRENCY_CODE})`;
     checkAutocompleteInput.allowsUserToRemoveCountryAndSearchAgain(alternativeCurrencyFieldId, DZA.NAME, NON_STANDARD_CURRENCY_NAME, expectedValue);
   },
-  rendersAlternativeCurrencyValidationError: ({ errorIndex = 0 }) => {
+  rendersAlternativeCurrencyValidationError: ({ errorIndex = 0, viaSaveAndBack }) => {
     cy.clickAlternativeCurrencyRadioOption();
 
-    cy.clickSubmitButton();
+    if (viaSaveAndBack) {
+      cy.clickSaveAndBackButton();
+    } else {
+      cy.clickSubmitButton();
+    }
 
     cy.checkText(partials.errorSummaryListItems().eq(errorIndex), errors[alternativeCurrencyFieldId].IS_EMPTY);
 
     cy.checkText(fieldSelector(alternativeCurrencyFieldId).errorMessage(), `Error: ${errors[alternativeCurrencyFieldId].IS_EMPTY}`);
   },
-  submitRadioAndAssertUrl: ({ currency, url, completeNonCurrencyFields }) => {
-    if (completeNonCurrencyFields) {
-      completeNonCurrencyFields();
+  submitRadioAndAssertUrl: ({ currency, completeNonCurrencyFieldsFunction, url, viaSaveAndBack }) => {
+    if (completeNonCurrencyFieldsFunction) {
+      completeNonCurrencyFieldsFunction();
     }
 
     const option = currencyRadio({ fieldId, currency });
 
     option.label().click();
-    cy.clickSubmitButton();
+
+    if (viaSaveAndBack) {
+      cy.clickSaveAndBackButton();
+    } else {
+      cy.clickSubmitButton();
+    }
 
     cy.url().should('include', url);
   },
-  submitAndAssertRadioIsChecked: ({ currency, completeNonCurrencyFields }) => {
-    if (completeNonCurrencyFields) {
-      completeNonCurrencyFields();
+  submitAndAssertRadioIsChecked: ({ currency, completeNonCurrencyFieldsFunction, viaSaveAndBack }) => {
+    if (completeNonCurrencyFieldsFunction) {
+      completeNonCurrencyFieldsFunction();
     }
 
     const option = currencyRadio({ fieldId, currency });
 
     option.label().click();
-    cy.clickSubmitButton();
+
+    if (viaSaveAndBack) {
+      cy.clickSaveAndBackButton();
+    } else {
+      cy.clickSubmitButton();
+    }
 
     cy.go('back');
 
@@ -154,7 +168,7 @@ const assertCurrencyFormFields = ({
 
     cy.url().should('include', url);
   },
-  submitAlternativeCurrencyAndAssertInput: () => {
+  submitAlternativeCurrencyAndAssertInput: ({ viaSaveAndBack }) => {
     const option5 = currencyRadio({ alternativeCurrencyFieldId });
 
     // clicks alternative currency radio
@@ -163,7 +177,11 @@ const assertCurrencyFormFields = ({
     // search for currency
     cy.autocompleteKeyboardInput(alternativeCurrencyFieldId, NON_STANDARD_CURRENCY_NAME);
 
-    cy.clickSubmitButton();
+    if (viaSaveAndBack) {
+      cy.clickSaveAndBackButton();
+    } else {
+      cy.clickSubmitButton();
+    }
 
     cy.go('back');
 

e2e-tests/shared-test-assertions/currency-form-fields/form-submission/index.js

@@ -0,0 +1,76 @@
+import { INSURANCE_ROUTES } from '../../../constants/routes/insurance';
+import selectAltRadioButNoAltCurrency from './select-alt-radio-but-no-alt-currency';
+import submitAlternativeCurrency from './submit-alternative-currency';
+import submitASupportedCurrency from './submit-a-supported-currency';
+
+const { ALL_SECTIONS } = INSURANCE_ROUTES;
+
+/**
+ * formSubmissionAssertions
+ * Form submission assertions for currency form fields.
+ * @param {Number} errorIndex: Index of the currency field error.
+ * @param {String} expectedRedirectUrl: Page URL to assert after successful form submission
+ * @param {Function} rendersAlternativeCurrencyValidationError: Assert alternative currency input validation error.
+ * @param {Function} submitAndAssertRadioIsChecked: Submit a radio option and assert the radio is checked.
+ * @param {Function} submitRadioAndAssertUrl: Submit a radio option and assert the URL.
+ * @param {Function} submitAlternativeCurrencyAndAssertUrl: Submit an alternative currency and assert the URL.
+ * @param {Function} submitAlternativeCurrencyAndAssertInput: Submit an alternative currency and assert the input.
+ * @param {Function} completeNonCurrencyFieldsFunction: Optional function to complete non-currency form fields.
+ * @param {Boolean} hasSaveAndBack: Temporary Flag for if the form has "save and back" functionality
+ * @returns {Object} Object with Mocha describe blocks and assertions for particular scenarios.
+ */
+const formSubmissionAssertions = ({
+  errorIndex,
+  expectedRedirectUrl,
+  rendersAlternativeCurrencyValidationError,
+  submitAndAssertRadioIsChecked,
+  submitRadioAndAssertUrl,
+  submitAlternativeCurrencyAndAssertUrl,
+  submitAlternativeCurrencyAndAssertInput,
+  completeNonCurrencyFieldsFunction,
+  hasSaveAndBack,
+}) => {
+  const executeTests = () => {
+    describe('currency form fields - form submission', () => {
+      describe('via `continue` button', () => {
+        selectAltRadioButNoAltCurrency({ errorIndex, rendersAlternativeCurrencyValidationError });
+
+        submitASupportedCurrency({
+          completeNonCurrencyFieldsFunction,
+          submitRadioAndAssertUrl,
+          submitAndAssertRadioIsChecked,
+          expectedRedirectUrl,
+        });
+
+        submitAlternativeCurrency({
+          expectedRedirectUrl,
+          submitAlternativeCurrencyAndAssertUrl,
+          submitAlternativeCurrencyAndAssertInput,
+        });
+      });
+
+      if (hasSaveAndBack) {
+        describe('via `save and back` button', () => {
+          submitASupportedCurrency({
+            completeNonCurrencyFieldsFunction,
+            submitRadioAndAssertUrl,
+            submitAndAssertRadioIsChecked,
+            expectedRedirectUrl: ALL_SECTIONS,
+            viaSaveAndBack: true,
+          });
+
+          submitAlternativeCurrency({
+            expectedRedirectUrl: ALL_SECTIONS,
+            submitAlternativeCurrencyAndAssertUrl,
+            submitAlternativeCurrencyAndAssertInput,
+            viaSaveAndBack: true,
+          });
+        });
+      }
+    });
+  };
+
+  return { executeTests };
+};
+
+export default formSubmissionAssertions;

e2e-tests/shared-test-assertions/currency-form-fields/form-submission/select-alt-radio-but-no-alt-currency.js

@@ -0,0 +1,18 @@
+/**
+ * selectAltRadioButNoAltCurrency
+ * Mocha describe block and assertion for selecting the "alternative currency" radio
+ * and then NOT entering a currency via the autocomplete input.
+ * @param {Number} errorIndex: Index of the currency field error.
+ * @param {Function} rendersAlternativeCurrencyValidationError: Assert alternative currency input validation error.
+ * @param {Boolean} viaSaveAndBack: Flag whether to submit the form via the "save and back" button.
+ * @returns {Object} Object with Mocha describe block and assertion
+ */
+const selectAltRadioButNoAltCurrency = ({ errorIndex = 0, rendersAlternativeCurrencyValidationError, viaSaveAndBack = false }) => {
+  describe('when selecting the alternative currency radio and NOT entering an alternative currency via the autocomplete input', () => {
+    it('should pre-select the alternative currency option and render validation errors', () => {
+      rendersAlternativeCurrencyValidationError({ errorIndex, viaSaveAndBack });
+    });
+  });
+};
+
+export default selectAltRadioButNoAltCurrency;