feat(EMS-3979): broker details - task list logic

e2e-tests/commands/insurance/complete-and-submit-broker-addresses-form.js

@@ -0,0 +1,12 @@
+/**
+ * completeAndSubmitBrokerAddressesForm
+ * Complete and submit "broker addresses" form
+ * @param {String} optionValue: Address option value
+ */
+const completeAndSubmitBrokerAddressesForm = ({ optionValue }) => {
+  cy.completeBrokerAddressesForm({ optionValue });
+
+  cy.clickSubmitButton();
+};
+
+export default completeAndSubmitBrokerAddressesForm;

e2e-tests/commands/insurance/complete-and-submit-broker-form.js

@@ -1,7 +1,7 @@
 /**
  * completeAndSubmitBrokerForm
  * Complete and submit "using broker" form
- * @param {Boolean} usingBroker: Should submit "yes" or "no" to "using a broker". Defaults to "no".
+ * @param {Boolean} usingBroker: Should submit "yes" or "no" to "using a broker". Defaults to false.
  */
 const completeAndSubmitBrokerForm = ({ usingBroker = false }) => {
   if (usingBroker) {

e2e-tests/commands/insurance/complete-and-submit-loss-payee-form.js

@@ -1,7 +1,7 @@
 /**
  * completeAndSubmitLossPayeeForm
  * Complete and submit "loss payee" form
- * @param {Boolean} isAppointingLossPayee: Should submit "yes" or "no" to "appointing a loss payee". Defaults to "no".
+ * @param {Boolean} isAppointingLossPayee: Should submit "yes" or "no" to "appointing a loss payee". Defaults to false.
  */
 const completeAndSubmitLossPayeeForm = ({ isAppointingLossPayee = false }) => {
   if (isAppointingLossPayee) {

e2e-tests/commands/insurance/complete-broker-addresses-form.js

@@ -0,0 +1,19 @@
+import { radios } from '../../pages/shared';
+import { POLICY as POLICY_FIELD_IDS } from '../../constants/field-ids/insurance/policy';
+
+const {
+  BROKER_ADDRESSES: { SELECT_THE_ADDRESS: FIELD_ID },
+} = POLICY_FIELD_IDS;
+
+/**
+ * completeBrokerAddressesForm
+ * Complete "broker addresses" form
+ * @param {String} optionValue: Address option value
+ */
+const completeBrokerAddressesForm = ({ optionValue = 'BRITISH BROADCASTING CORPORATION WOGAN HOUSE PORTLAND PLACE' }) => {
+  const optionId = `${FIELD_ID}-${optionValue}`;
+
+  radios(optionId).option.label().click();
+};
+
+export default completeBrokerAddressesForm;

e2e-tests/commands/insurance/complete-buyer-section.js

@@ -2,7 +2,7 @@
  * completeBuyerSection
  * Complete the "Buyer" section
  * @param {Boolean} viaTaskList: Start the "buyer" section from the task list.
- * @param {Boolean} hasConnectionToBuyer: Should submit "yes" to "have connection to buyer" radio. Defaults to "no".
+ * @param {Boolean} hasConnectionToBuyer: Should submit "yes" to "have connection to buyer" radio. Defaults to false.
  * @param {Boolean} exporterHasTradedWithBuyer: Submit "yes" to "have traded with buyer before" in the "working with buyer" form.
  * @param {Boolean} outstandingPayments: Exporter has outstanding payments with the buyer
  * @param {Boolean} failedToPay: Buyer has failed to pay the exporter on the time

e2e-tests/commands/insurance/complete-declarations.js

@@ -4,7 +4,7 @@ import { FIELD_VALUES } from '../../constants';
  * completeDeclarations
  * Runs through the full declarations journey
  * @param {Object} Object with flags on how to complete specific declaration forms.
- * - exportingWithCodeOfConduct: Should submit "yes" in the "exporting with code of conduct" form. Defaults to "yes".
+ * - exportingWithCodeOfConduct: Should submit "yes" in the "exporting with code of conduct" form. Defaults to true.
  */
 const completeDeclarations = ({ hasAntiBriberyCodeOfConduct = true, exportingWithCodeOfConduct = true }) => {
   cy.clickTaskDeclarationsAndSubmit();

e2e-tests/commands/insurance/complete-policy-section.js

@@ -12,9 +12,10 @@ const { POLICY_TYPE } = APPLICATION;
  * @param {Boolean} alternativeCurrency: Select the "alternative currency" option
  * @param {Boolean} sameName: If name on policy is the same as the signed in user - defaults to true
  * @param {Boolean} needPreCreditPeriod: If the user needs a pre-credit period - defaults to false
- * @param {Boolean} usingBroker: If "using broker" on  - defaults to false
- * @param {Boolean} otherCompanyInvolved: If "another company to be insured" is on  - defaults to false
- * @param {Boolean} isAppointingLossPayee: Should submit "yes" or "no" to "appointing a loss payee". Defaults to "no".
+ * @param {Boolean} usingBroker: If "using broker" - defaults to false
+ * @param {Boolean} brokerIsBasedInUk: Broker is based in the UK - defaults to false
+ * @param {Boolean} otherCompanyInvolved: Should submit "yes" to "another company to be insured". Defaults to false.
+ * @param {Boolean} isAppointingLossPayee: Should submit "yes" or "no" to "appointing a loss payee". Defaults to false.
  * @param {Boolean} lossPayeeIsLocatedInUK: Should submit "UK" to "loss payee details". Defaults to false.
  * @param {Boolean} submitCheckYourAnswers: Click policy "check your answers" submit button
  */
@@ -27,6 +28,7 @@ const completePolicySection = ({
   sameName = true,
   needPreCreditPeriod = false,
   usingBroker = false,
+  brokerIsBasedInUk = false,
   otherCompanyInvolved = false,
   isAppointingLossPayee = false,
   lossPayeeIsLocatedInUK = false,
@@ -69,9 +71,16 @@ const completePolicySection = ({
   cy.completeAndSubmitBrokerForm({ usingBroker });
 
   if (usingBroker) {
-    cy.completeAndSubmitBrokerDetailsForm({});
+    cy.completeAndSubmitBrokerDetailsForm({ isBasedInUk: brokerIsBasedInUk });
 
-    cy.completeAndSubmitBrokerManualAddressForm({});
+    if (brokerIsBasedInUk) {
+      cy.completeAndSubmitBrokerAddressesForm({});
+
+      cy.completeAndSubmitBrokerManualAddressForm({});
+    } else {
+      // submit the "confirm broker address" form
+      cy.clickSubmitButton();
+    }
   }
 
   cy.completeAndSubmitLossPayeeForm({ isAppointingLossPayee });

e2e-tests/commands/insurance/complete-prepare-application-section-multiple-policy-type.js

@@ -41,6 +41,7 @@ const { POLICY_TYPE } = APPLICATION;
  * @param {Boolean} submitCheckYourAnswers: Should click each section's "check your answers" submit button.
  * @param {Boolean} totalContractValueOverThreshold: If total contract value in eligibility should be over threshold.
  * @param {Boolean} usingBroker: Should submit "yes" or "no" to "using a broker".
+ * @param {Boolean} brokerIsBasedInUk: Should submit "yes or "no" to "broker is based in the UK".
  */
 const completePrepareApplicationMultiplePolicyType = ({
   agentChargeMethodFixedSum = false,
@@ -78,6 +79,7 @@ const completePrepareApplicationMultiplePolicyType = ({
   totalContractValueOverThreshold = false,
   submitCheckYourAnswers = true,
   usingBroker = false,
+  brokerIsBasedInUk = false,
 }) => {
   cy.completeBusinessSection({
     differentTradingName,
@@ -106,6 +108,7 @@ const completePrepareApplicationMultiplePolicyType = ({
     policyValueOverMvpMaximum,
     submitCheckYourAnswers,
     usingBroker,
+    brokerIsBasedInUk,
     otherCompanyInvolved,
     needPreCreditPeriod,
     isAppointingLossPayee,

e2e-tests/commands/insurance/complete-prepare-application-section-single-policy-type.js

@@ -41,6 +41,7 @@ const { POLICY_TYPE } = FIELD_VALUES;
  * @param {Boolean} submitCheckYourAnswers: Should click each section's "check your answers" submit button.
  * @param {Boolean} totalContractValueOverThreshold: If total contract value in eligibility should be over threshold.
  * @param {Boolean} usingBroker: Should submit "yes" or "no" to "using a broker".
+ * @param {Boolean} brokerIsBasedInUk: Should submit "yes or "no" to "broker is based in the UK".
  */
 const completePrepareApplicationSinglePolicyType = ({
   agentChargeMethodFixedSum = false,
@@ -78,6 +79,7 @@ const completePrepareApplicationSinglePolicyType = ({
   totalContractValueOverThreshold = false,
   submitCheckYourAnswers = true,
   usingBroker = false,
+  brokerIsBasedInUk = false,
 }) => {
   cy.completeBusinessSection({
     differentTradingName,
@@ -106,6 +108,7 @@ const completePrepareApplicationSinglePolicyType = ({
     policyValueOverMvpMaximum,
     submitCheckYourAnswers,
     usingBroker,
+    brokerIsBasedInUk,
     otherCompanyInvolved,
     needPreCreditPeriod,
     isAppointingLossPayee,

e2e-tests/commands/insurance/complete-sign-in-and-submit-an-application.js

@@ -35,11 +35,12 @@ import completeSignInAndGoToApplication from './account/complete-sign-in-and-go-
  * @param {Boolean} isUsingAgent: Should submit "yes" to "using an agent" form.
  * @param {Boolean} lossPayeeIsLocatedInUK: Should submit "UK" to "loss payee details".
  * @param {Boolean} needPreCreditPeriod: If the user needs a pre-credit period.
- * @param {Boolean} otherCompanyInvolved: If "another company to be insured" is on.
+ * @param {Boolean} otherCompanyInvolved: Should submit "yes" to "another company to be insured".
  * @param {Boolean} policyValueOverMvpMaximum: Should submit an application with the value over the MVP maximum amount.
  * @param {Boolean} submitCheckYourAnswers: Should click each section's "check your answers" submit button.
  * @param {Boolean} totalContractValueOverThreshold: If total contract value in eligibility should be over threshold.
  * @param {Boolean} usingBroker: Should submit "yes" or "no" to "using a broker".
+ * @param {Boolean} brokerIsBasedInUk: Should submit "yes or "no" to "broker is based in the UK".
  * @return {String} Application reference number
  */
 const completeSignInAndSubmitAnApplication = ({
@@ -76,6 +77,7 @@ const completeSignInAndSubmitAnApplication = ({
   policyValueOverMvpMaximum = false,
   totalContractValueOverThreshold = false,
   usingBroker = false,
+  brokerIsBasedInUk = false,
 }) => {
   completeSignInAndGoToApplication({
     companyNumber,
@@ -113,6 +115,7 @@ const completeSignInAndSubmitAnApplication = ({
         referenceNumber,
         totalContractValueOverThreshold,
         usingBroker,
+        brokerIsBasedInUk,
       });
     } else {
       cy.completePrepareApplicationSinglePolicyType({
@@ -145,6 +148,7 @@ const completeSignInAndSubmitAnApplication = ({
         referenceNumber,
         totalContractValueOverThreshold,
         usingBroker,
+        brokerIsBasedInUk,
       });
     }
     cy.completeAndSubmitCheckYourAnswers();

e2e-tests/commands/insurance/your-buyer/complete-and-submit-buyer-financial-information-form.js

@@ -2,7 +2,7 @@
  * completeAndSubmitBuyerFinancialInformationForm
  * Completes and submits the "buyer financial information" form.
  * @param {Object} Object with flags on how to complete the form.
- * - exporterHasBuyerFinancialAccounts: Should submit "yes" to "buyer financial information" radio. Defaults to "no".
+ * - exporterHasBuyerFinancialAccounts: Should submit "yes" to "buyer financial information" radio. Defaults to false.
  */
 const completeAndSubmitBuyerFinancialInformationForm = ({ exporterHasBuyerFinancialAccounts = false }) => {
   cy.completeBuyerFinancialInformationForm({ exporterHasBuyerFinancialAccounts });

e2e-tests/commands/insurance/your-buyer/complete-and-submit-connection-with-the-buyer-form.js

@@ -1,7 +1,7 @@
 /**
  * completeAndSubmitConnectionWithTheBuyerForm
  * Complete and submit the "connection with the buyer" form.
- * @param {Boolean} hasConnectionToBuyer: Should submit "yes" to "have connection to buyer" radio. Defaults to "no".
+ * @param {Boolean} hasConnectionToBuyer: Should submit "yes" to "have connection to buyer" radio. Defaults to false.
  * @param {String} description: "Connection with buyer" description.
  */
 const completeAndSubmitConnectionWithTheBuyerForm = ({ hasConnectionToBuyer = false, description }) => {

e2e-tests/commands/insurance/your-buyer/complete-and-submit-traded-with-buyer-form.js

@@ -2,7 +2,7 @@
  * completeAndSubmitConnectionToTheBuyerForm
  * Completes and submits the "traded with buyer" form.
  * @param {Object} Object with flags on how to complete the form.
- * - exporterHasTradedWithBuyer: Should submit "yes" to "traded with buyer" radio. Defaults to "no".
+ * - exporterHasTradedWithBuyer: Should submit "yes" to "traded with buyer" radio. Defaults to false.
  */
 const completeAndSubmitTradedWithBuyerForm = ({ exporterHasTradedWithBuyer = false }) => {
   cy.completeTradedWithBuyerForm({ exporterHasTradedWithBuyer });

e2e-tests/commands/insurance/your-buyer/complete-buyer-financial-information-form.js

@@ -2,7 +2,7 @@
  * completeBuyerFinancialInformationForm
  * Completes the "buyer financial information" form.
  * @param {Object} Object with flags on how to complete the form.
- * - exporterHasBuyerFinancialAccounts: Should submit "yes" to "buyer financial information" radio. Defaults to "no".
+ * - exporterHasBuyerFinancialAccounts: Should submit "yes" to "buyer financial information" radio. Defaults to false.
  */
 const completeBuyerFinancialInformationForm = ({ exporterHasBuyerFinancialAccounts = false }) => {
   if (exporterHasBuyerFinancialAccounts) {

e2e-tests/commands/insurance/your-buyer/complete-connection-with-the-buyer-form.js

@@ -7,7 +7,7 @@ const { CONNECTION_WITH_BUYER_DESCRIPTION } = INSURANCE_FIELD_IDS.YOUR_BUYER;
 /**
  * completeConnectionWithTheBuyerForm
  * Complete the "connection with the buyer" form.
- * @param {Boolean} hasConnectionToBuyer: Should submit "yes" to "have connection to buyer" radio. Defaults to "no".
+ * @param {Boolean} hasConnectionToBuyer: Should submit "yes" to "have connection to buyer" radio. Defaults to false.
  * @param {String} description: "Connection with buyer" description.
  */
 const completeConnectionWithTheBuyerForm = ({ hasConnectionToBuyer = false, description = application.BUYER[CONNECTION_WITH_BUYER_DESCRIPTION] }) => {

e2e-tests/commands/insurance/your-buyer/complete-traded-with-buyer-form.js

@@ -2,7 +2,7 @@
  * completeTradedWithBuyerForm
  * Completes the "traded with buyer" form.
  * @param {Object} Object with flags on how to complete the form.
- * - exporterHasTradedWithBuyer: Should submit "yes" to "traded with buyer" radio. Defaults to "no".
+ * - exporterHasTradedWithBuyer: Should submit "yes" to "traded with buyer" radio. Defaults to false.
  */
 const completeTradedWithBuyerForm = ({ exporterHasTradedWithBuyer = false }) => {
   if (exporterHasTradedWithBuyer) {

e2e-tests/constants/field-ids/insurance/policy/index.js

@@ -62,8 +62,12 @@ export const POLICY = {
     EMAIL: SHARED.EMAIL,
     BROKER_EMAIL: 'broker.email',
     IS_BASED_IN_UK: 'isBasedInUk',
-    POSTCODE: 'postcode',
     BUILDING_NUMBER_OR_NAME: 'buildingNumberOrName',
+    ADDRESS_LINE_1: 'addressLine1',
+    ADDRESS_LINE_2: 'addressLine2',
+    TOWN: 'town',
+    COUNTY: 'county',
+    POSTCODE: 'postcode',
   },
   BROKER_ADDRESSES: {
     SELECT_THE_ADDRESS: 'selectTheAddress',

e2e-tests/insurance/cypress/e2e/journeys/application-submission/multiple-policy-type/policy-conditions/submit-an-application-multiple-policy-type-policy-fully-populated.spec.js

@@ -13,6 +13,7 @@ context('Insurance - submit an application - Multiple policy type - fully popula
       totalContractValueOverThreshold: true,
       hasHadCreditInsuranceCoverWithBuyer: true,
       usingBroker: true,
+      brokerIsBasedInUk: true,
     }).then((refNumber) => {
       referenceNumber = refNumber;
     });

e2e-tests/insurance/cypress/e2e/journeys/application-submission/multiple-policy-type/policy-conditions/submit-an-application-multiple-policy-type-with-broker.spec.js → e2e-tests/insurance/cypress/e2e/journeys/application-submission/multiple-policy-type/policy-conditions/submit-an-application-multiple-policy-type-with-broker-based-in-uk.spec.js

@@ -1,14 +1,15 @@
 import { APPLICATION } from '../../../../../../../constants';
 
 context(
-  'Insurance - submit an application - Multiple policy type with a broker - As an Exporter, I want to submit my completed credit insurance application, So that UKEF can process and make a decision on my application',
+  'Insurance - submit an application - Multiple policy type with a broker - based in UK - As an Exporter, I want to submit my completed credit insurance application, So that UKEF can process and make a decision on my application',
   () => {
     let referenceNumber;
 
     before(() => {
       cy.completeSignInAndSubmitAnApplication({
         policyType: APPLICATION.POLICY_TYPE.MULTIPLE,
         usingBroker: true,
+        brokerIsBasedInUk: true,
       }).then((refNumber) => {
         referenceNumber = refNumber;
       });

e2e-tests/insurance/cypress/e2e/journeys/application-submission/multiple-policy-type/policy-conditions/submit-an-application-multiple-policy-type-with-broker-not-based-in-uk.spec.js

@@ -0,0 +1,34 @@
+import { APPLICATION } from '../../../../../../../constants';
+
+context(
+  'Insurance - submit an application - Multiple policy type with a broker - not based in UK - As an Exporter, I want to submit my completed credit insurance application, So that UKEF can process and make a decision on my application',
+  () => {
+    let referenceNumber;
+
+    before(() => {
+      cy.completeSignInAndSubmitAnApplication({
+        policyType: APPLICATION.POLICY_TYPE.MULTIPLE,
+        usingBroker: true,
+        brokerIsBasedInUk: false,
+      }).then((refNumber) => {
+        referenceNumber = refNumber;
+      });
+    });
+
+    beforeEach(() => {
+      cy.saveSession();
+    });
+
+    after(() => {
+      cy.deleteApplication(referenceNumber);
+    });
+
+    it('should successfully submit the application and redirect to `application submitted`', () => {
+      cy.assertApplicationSubmittedUrl(referenceNumber);
+    });
+
+    it('should render in a `submitted` state in the dashboard', () => {
+      cy.assertDashboardApplicationSubmitted(referenceNumber);
+    });
+  },
+);

e2e-tests/insurance/cypress/e2e/journeys/application-submission/multiple-policy-type/submit-an-application-multiple-policy-type-fully-populated.spec.js

@@ -16,6 +16,7 @@ context(
         exportingWithCodeOfConduct: true,
         policyValueOverMvpMaximum: true,
         usingBroker: true,
+        brokerIsBasedInUk: true,
         otherCompanyInvolved: true,
         differentPolicyContact: true,
         needPreCreditPeriod: true,

e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/policy-conditions/submit-an-application-single-policy-type-policy-fully-populated.spec.js

@@ -10,6 +10,7 @@ context('Insurance - submit an application - Single policy type - fully populate
       totalContractValueOverThreshold: true,
       hasHadCreditInsuranceCoverWithBuyer: true,
       usingBroker: true,
+      brokerIsBasedInUk: true,
     }).then((refNumber) => {
       referenceNumber = refNumber;
     });

e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/policy-conditions/submit-an-application-single-policy-type-with-broker.spec.js → e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/policy-conditions/submit-an-application-single-policy-type-with-broker-based-in-uk.spec.js

@@ -1,10 +1,13 @@
 context(
-  'Insurance - submit an application - Single policy type with a broker - As an Exporter, I want to submit my completed credit insurance application, So that UKEF can process and make a decision on my application',
+  'Insurance - submit an application - Single policy type with a broker - based in UK - As an Exporter, I want to submit my completed credit insurance application, So that UKEF can process and make a decision on my application',
   () => {
     let referenceNumber;
 
     before(() => {
-      cy.completeSignInAndSubmitAnApplication({ usingBroker: true }).then((refNumber) => {
+      cy.completeSignInAndSubmitAnApplication({
+        usingBroker: true,
+        brokerIsBasedInUk: true,
+      }).then((refNumber) => {
         referenceNumber = refNumber;
       });
     });

e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/policy-conditions/submit-an-application-single-policy-type-with-broker-not-based-in-uk.spec.js

@@ -0,0 +1,31 @@
+context(
+  'Insurance - submit an application - Single policy type with a broker - not based in UK - As an Exporter, I want to submit my completed credit insurance application, So that UKEF can process and make a decision on my application',
+  () => {
+    let referenceNumber;
+
+    before(() => {
+      cy.completeSignInAndSubmitAnApplication({
+        usingBroker: true,
+        brokerIsBasedInUk: false,
+      }).then((refNumber) => {
+        referenceNumber = refNumber;
+      });
+    });
+
+    beforeEach(() => {
+      cy.saveSession();
+    });
+
+    after(() => {
+      cy.deleteApplication(referenceNumber);
+    });
+
+    it('should successfully submit the application and redirect to `application submitted`', () => {
+      cy.assertApplicationSubmittedUrl(referenceNumber);
+    });
+
+    it('should render in a `submitted` state in the dashboard', () => {
+      cy.assertDashboardApplicationSubmitted(referenceNumber);
+    });
+  },
+);

e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/submit-an-application-single-policy-type-fully-populated.spec.js

@@ -13,6 +13,7 @@ context(
         exportingWithCodeOfConduct: true,
         policyValueOverMvpMaximum: true,
         usingBroker: true,
+        brokerIsBasedInUk: true,
         otherCompanyInvolved: true,
         differentPolicyContact: true,
         needPreCreditPeriod: true,