chore(EMS-3662-3665): task list - export contract requirements, improve e2e test coverage

CHANGELOG.md

@@ -2,10 +2,9 @@
 
 ## [2.30.0](https://github.com/UK-Export-Finance/exip/compare/v2.29.0...v2.30.0) (2024-08-02)
 
-
 ### Features
 
-* **EMS-3665:** export contract - how was contract awarded - data saving ([#2883](https://github.com/UK-Export-Finance/exip/issues/2883)) ([d91a5d9](https://github.com/UK-Export-Finance/exip/commit/d91a5d9b186209cc07311b6ed0eb53c3f8464287))
+- **EMS-3665:** export contract - how was contract awarded - data saving ([#2883](https://github.com/UK-Export-Finance/exip/issues/2883)) ([d91a5d9](https://github.com/UK-Export-Finance/exip/commit/d91a5d9b186209cc07311b6ed0eb53c3f8464287))
 
 ## [2.29.0](https://github.com/UK-Export-Finance/exip/compare/v2.28.2...v2.29.0) (2024-08-01)
 

e2e-tests/commands/insurance/complete-export-contract-section.js

@@ -7,6 +7,7 @@
  * @param {Boolean} agentChargeMethodPercentage: Agent charge method is "percentage"
  * @param {Boolean} alternativeCurrency: Should submit an "alternative currency". Defaults to false.
  * @param {Boolean} attemptedPrivateMarketCover: Has attempted to insure through the private market
+ * @param {Boolean} contractAwardedOtherMethod: "How was the contract awarded" method as "other"
  * @param {Boolean} finalDestinationKnown: "Final destination known"
  * @param {Boolean} isUsingAgent: Exporter is using an agent
  * @param {Boolean} submitCheckYourAnswers: Click export contract "check your answers" submit button
@@ -20,6 +21,7 @@ const completeExportContractSection = ({
   agentChargeMethodPercentage = false,
   alternativeCurrency = false,
   attemptedPrivateMarketCover = false,
+  contractAwardedOtherMethod = false,
   finalDestinationKnown,
   isUsingAgent = false,
   submitCheckYourAnswers = false,
@@ -28,7 +30,7 @@ const completeExportContractSection = ({
 }) => {
   cy.startInsuranceExportContractSection({ viaTaskList });
 
-  cy.completeAndSubmitHowWasTheContractAwardedForm({});
+  cy.completeAndSubmitHowWasTheContractAwardedForm({ otherMethod: contractAwardedOtherMethod });
 
   cy.completeAndSubmitAboutGoodsOrServicesForm({ finalDestinationKnown });
   cy.completeAndSubmitHowYouWillGetPaidForm({});

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

@@ -17,6 +17,7 @@ const { POLICY_TYPE } = APPLICATION;
  * @param {Boolean} attemptedPrivateMarketCover: Should submit "yes" to "attempted to insure through the private market" form.
  * @param {Boolean} buyerOutstandingPayments: Exporter has outstanding payments with the buyer.
  * @param {Boolean} buyerFailedToPayOnTime: Buyer has failed to pay the exporter on the time.
+ * @param {Boolean} contractAwardedOtherMethod: "How was the contract awarded" method as "other"
  * @param {Boolean} differentPolicyContact: Should submit an application with a different policy contact to the owner.
  * @param {Boolean} differentTradingName: Should submit "yes" to "have a different trading name" in the "company details" form.
  * @param {Boolean} differentTradingAddress: Should submit "yes" to "trade from a different address" in the "company details" form.
@@ -49,6 +50,7 @@ const completePrepareApplicationMultiplePolicyType = ({
   attemptedPrivateMarketCover = false,
   buyerOutstandingPayments = false,
   buyerFailedToPayOnTime = false,
+  contractAwardedOtherMethod = false,
   differentPolicyContact = false,
   differentTradingName = false,
   differentTradingAddress = false,
@@ -110,6 +112,7 @@ const completePrepareApplicationMultiplePolicyType = ({
     agentChargeMethodPercentage,
     alternativeCurrency: alternativeCurrencyExportContract,
     attemptedPrivateMarketCover,
+    contractAwardedOtherMethod,
     finalDestinationKnown,
     isUsingAgent,
     submitCheckYourAnswers,

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

@@ -17,6 +17,7 @@ const { POLICY_TYPE } = FIELD_VALUES;
  * @param {Boolean} attemptedPrivateMarketCover: Should submit "yes" to "attempted to insure through the private market" form.
  * @param {Boolean} buyerOutstandingPayments: Exporter has outstanding payments with the buyer.
  * @param {Boolean} buyerFailedToPayOnTime: Buyer has failed to pay the exporter on the time.
+ * @param {Boolean} contractAwardedOtherMethod: "How was the contract awarded" method as "other"
  * @param {Boolean} differentPolicyContact: Should submit an application with a different policy contact to the owner.
  * @param {Boolean} differentTradingName: Should submit "yes" to "have a different trading name" in the "company details" form.
  * @param {Boolean} differentTradingAddress: Should submit "yes" to "trade from a different address" in the "company details" form.
@@ -38,36 +39,37 @@ const { POLICY_TYPE } = FIELD_VALUES;
  * @param {Boolean} usingBroker: Should submit "yes" or "no" to "using a broker".
  */
 const completePrepareApplicationSinglePolicyType = ({
+  agentChargeMethodFixedSum = false,
+  agentChargeFixedSumAmount,
+  agentChargeMethodPercentage = false,
+  agentIsCharging = false,
   alternativeCurrencyBuyer = false,
   alternativeCurrencyExportContract = false,
   alternativeCurrencyTurnover = false,
   alternativeCurrencyPolicy = false,
+  attemptedPrivateMarketCover = false,
+  buyerOutstandingPayments = false,
+  buyerFailedToPayOnTime = false,
+  contractAwardedOtherMethod = false,
+  differentPolicyContact = false,
   differentTradingName = false,
   differentTradingAddress = false,
-  hasCreditControlProcess = false,
-  hasConnectionToBuyer = false,
+  exporterHasBuyerFinancialAccounts = false,
   exporterHasTradedWithBuyer = false,
-  buyerOutstandingPayments = false,
-  buyerFailedToPayOnTime = false,
+  finalDestinationKnown = false,
   fullyPopulatedBuyerTradingHistory = false,
+  hasCreditControlProcess = false,
+  hasConnectionToBuyer = false,
   hasHadCreditInsuranceCoverWithBuyer = false,
-  exporterHasBuyerFinancialAccounts = false,
-  finalDestinationKnown = false,
-  usingBroker = false,
-  otherCompanyInvolved = false,
   isAppointingLossPayee = false,
+  isUsingAgent = false,
   lossPayeeIsLocatedInUK = false,
-  policyValueOverMvpMaximum = false,
-  differentPolicyContact = false,
   needPreCreditPeriod = false,
+  otherCompanyInvolved = false,
+  policyValueOverMvpMaximum = false,
   totalContractValueOverThreshold = false,
-  attemptedPrivateMarketCover = false,
-  isUsingAgent = false,
-  agentIsCharging = false,
-  agentChargeMethodFixedSum = false,
-  agentChargeFixedSumAmount,
-  agentChargeMethodPercentage = false,
   submitCheckYourAnswers = true,
+  usingBroker = false,
 }) => {
   cy.completeBusinessSection({
     differentTradingName,
@@ -110,6 +112,7 @@ const completePrepareApplicationSinglePolicyType = ({
     agentChargeMethodPercentage,
     alternativeCurrency: alternativeCurrencyExportContract,
     attemptedPrivateMarketCover,
+    contractAwardedOtherMethod,
     finalDestinationKnown,
     isUsingAgent,
     submitCheckYourAnswers,

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

@@ -19,6 +19,7 @@ import completeSignInAndGoToApplication from './account/complete-sign-in-and-go-
  * @param {Boolean} buyerOutstandingPayments: Exporter has outstanding payments with the buyer.
  * @param {Boolean} buyerFailedToPayOnTime: Buyer has failed to pay the exporter on the time.
  * @param {String} companyNumber: Company number/Companies house number
+ * @param {Boolean} contractAwardedOtherMethod: "How was the contract awarded" method as "other"
  * @param {Boolean} createApplicationViaApi: Flag whether to create the application via API instead of going through the eligibility journey.
  * @param {Boolean} differentPolicyContact: Should submit an application with a different policy contact to the owner.
  * @param {Boolean} differentTradingName: Should submit "yes" to "have a different trading name" in the "company details" form.
@@ -54,6 +55,7 @@ const completeSignInAndSubmitAnApplication = ({
   buyerFailedToPayOnTime = false,
   createApplicationViaApi,
   companyNumber,
+  contractAwardedOtherMethod = false,
   differentPolicyContact = false,
   differentTradingName = false,
   differentTradingAddress = false,
@@ -92,6 +94,7 @@ const completeSignInAndSubmitAnApplication = ({
         alternativeCurrencyPolicy,
         buyerOutstandingPayments,
         buyerFailedToPayOnTime,
+        contractAwardedOtherMethod,
         differentPolicyContact,
         differentTradingName,
         differentTradingAddress,
@@ -123,6 +126,7 @@ const completeSignInAndSubmitAnApplication = ({
         attemptedPrivateMarketCover,
         buyerFailedToPayOnTime,
         buyerOutstandingPayments,
+        contractAwardedOtherMethod,
         differentPolicyContact,
         differentTradingName,
         differentTradingAddress,

e2e-tests/insurance/cypress/e2e/journeys/application-submission/multiple-policy-type/export-contract-conditions/submit-an-application-multiple-policy-type-contract-awarded-other-method.spec.js

@@ -0,0 +1,30 @@
+import { APPLICATION } from '../../../../../../../constants';
+
+context('Insurance - submit an application - Multiple policy type, contract awarded with `other` method', () => {
+  let referenceNumber;
+
+  before(() => {
+    cy.completeSignInAndSubmitAnApplication({
+      contractAwardedOtherMethod: true,
+      policyType: APPLICATION.POLICY_TYPE.MULTIPLE,
+    }).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/export-contract-conditions/submit-an-application-multiple-policy-type-export-contract-fully-populated.spec.js

@@ -8,6 +8,7 @@ context('Insurance - submit an application - Multiple policy type, fully populat
       agentIsCharging: true,
       agentChargeMethodFixedSum: true,
       attemptedPrivateMarketCover: true,
+      contractAwardedOtherMethod: true,
       isUsingAgent: true,
       finalDestinationKnown: true,
       policyType: APPLICATION.POLICY_TYPE.MULTIPLE,

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

@@ -23,6 +23,7 @@ context(
         lossPayeeIsLocatedInUK: true,
         totalContractValueOverThreshold: true,
         attemptedPrivateMarketCover: true,
+        contractAwardedOtherMethod: true,
         isUsingAgent: true,
         agentIsCharging: true,
         agentChargeMethodFixedSum: true,

e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/export-contract-conditions/submit-an-application-single-policy-type-contract-awarded-other-method.spec.js

@@ -0,0 +1,25 @@
+context('Insurance - submit an application - Single policy type, contract awarded with `other` method', () => {
+  let referenceNumber;
+
+  before(() => {
+    cy.completeSignInAndSubmitAnApplication({ contractAwardedOtherMethod: true }).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/export-contract-conditions/submit-an-application-single-policy-type-export-contract-fully-populated.spec.js

@@ -6,6 +6,7 @@ context('Insurance - submit an application - Single policy type, fully populated
       agentIsCharging: true,
       agentChargeMethodFixedSum: true,
       attemptedPrivateMarketCover: true,
+      contractAwardedOtherMethod: true,
       isUsingAgent: true,
       finalDestinationKnown: true,
       totalContractValueOverThreshold: true,

e2e-tests/insurance/cypress/e2e/journeys/application-submission/single-policy-type/export-contract-conditions/submit-an-application-single-policy-type-using-an-agent-alternative-currency.spec.js

@@ -1,4 +1,4 @@
-context('Insurance - submit an application - Single policy type, using an agent,  fixed sum method, alternative currency', () => {
+context('Insurance - submit an application - Single policy type, using an agent, fixed sum method, alternative currency', () => {
   let referenceNumber;
 
   before(() => {

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

@@ -20,6 +20,7 @@ context(
         lossPayeeIsLocatedInUK: true,
         totalContractValueOverThreshold: true,
         attemptedPrivateMarketCover: true,
+        contractAwardedOtherMethod: true,
         isUsingAgent: true,
         agentIsCharging: true,
         agentChargeMethodFixedSum: true,

e2e-tests/insurance/cypress/e2e/journeys/export-contract/about-goods-or-services/save-and-back.spec.js

@@ -53,8 +53,8 @@ context('Insurance - Export contract - About goods or services page - Save and g
       cy.assertAllSectionsUrl(referenceNumber);
     });
 
-    it('should retain the `export contract` task status as `not started`', () => {
-      cy.checkTaskExportContractStatusIsNotStartedYet();
+    it('should retain the `export contract` task status as `in progress`', () => {
+      cy.checkTaskExportContractStatusIsInProgress();
     });
   });
 
@@ -71,7 +71,7 @@ context('Insurance - Export contract - About goods or services page - Save and g
       cy.assertAllSectionsUrl(referenceNumber);
     });
 
-    it('should update the `export contract` task status to `in progress`', () => {
+    it('should retain the `export contract` task status as `in progress`', () => {
       cy.checkTaskExportContractStatusIsInProgress();
     });
 
@@ -112,8 +112,8 @@ context('Insurance - Export contract - About goods or services page - Save and g
       cy.assertAllSectionsUrl(referenceNumber);
     });
 
-    it('should update the `export contract` task status to `not started`', () => {
-      cy.checkTaskExportContractStatusIsNotStartedYet();
+    it('should retain the `export contract` task status as `in progress`', () => {
+      cy.checkTaskExportContractStatusIsInProgress();
     });
 
     it(`should have no value in '${FIELD_ID}' when going back to the page`, () => {

src/ui/server/controllers/insurance/all-sections/index.test.ts

@@ -60,6 +60,7 @@ describe('controllers/insurance/all-sections', () => {
       const { buyerTradingHistory, relationship } = buyer;
       const { exporterIsConnectedWithBuyer, exporterHasPreviousCreditInsuranceWithBuyer } = relationship;
       const { outstandingPayments, exporterHasTradedWithBuyer } = buyerTradingHistory;
+      const { awardMethod } = exportContract;
 
       const flatApplicationData = flattenApplicationData(mockApplication);
 
@@ -83,6 +84,7 @@ describe('controllers/insurance/all-sections', () => {
         isUsingAgent,
         agentIsCharging,
         agentChargeMethod,
+        awardMethod?.id,
       );
 
       const expectedTaskListData = generateTaskList(taskListStructure, flatApplicationData);

src/ui/server/controllers/insurance/all-sections/index.ts

@@ -53,6 +53,7 @@ export const get = (req: Request, res: Response) => {
   const { buyerTradingHistory, relationship } = buyer;
   const { exporterIsConnectedWithBuyer, exporterHasPreviousCreditInsuranceWithBuyer } = relationship;
   const { outstandingPayments, exporterHasTradedWithBuyer } = buyerTradingHistory;
+  const { awardMethod } = exportContract;
 
   const flatApplicationData = flattenApplicationData(application);
 
@@ -76,6 +77,7 @@ export const get = (req: Request, res: Response) => {
     isUsingAgent,
     agentIsCharging,
     agentChargeMethod,
+    awardMethod?.id,
   );
 
   const taskListData = generateTaskList(taskListStructure, flatApplicationData);

src/ui/server/controllers/insurance/check-your-answers/export-contract/index.test.ts

@@ -32,6 +32,7 @@ const {
       charge: { method: agentChargeMethod },
     },
   },
+  awardMethod,
 } = exportContract;
 
 describe('controllers/insurance/check-your-answers/export-contract', () => {
@@ -102,6 +103,7 @@ describe('controllers/insurance/check-your-answers/export-contract', () => {
         isUsingAgent,
         agentIsCharging,
         agentChargeMethod,
+        awardMethodId: awardMethod?.id,
       });
 
       const status = sectionStatus(exportContractFields, mockApplication);

src/ui/server/controllers/insurance/check-your-answers/export-contract/index.ts

@@ -60,6 +60,7 @@ export const get = async (req: Request, res: Response) => {
           charge: { method: agentChargeMethod },
         },
       },
+      awardMethod,
     } = exportContract;
 
     const checkAndChange = true;
@@ -75,6 +76,7 @@ export const get = async (req: Request, res: Response) => {
       isUsingAgent,
       agentIsCharging,
       agentChargeMethod,
+      awardMethodId: awardMethod?.id,
     });
 
     const status = sectionStatus(exportContractFields, application);

src/ui/server/graphql/queries/application-by-reference-number.ts

@@ -94,6 +94,11 @@ const applicationByReferenceNumberQuery = gql`
         }
         exportContract {
           id
+          awardMethod {
+            id
+            value
+          }
+          otherAwardMethod
           goodsOrServicesDescription
           finalDestinationKnown
           finalDestinationCountryCode

src/ui/server/helpers/can-access-submit-your-application-routes/index.ts

@@ -9,7 +9,6 @@ import { Application } from '../../../types';
  * Check if an application has submitted previous fields/sections required before accessing the "submit your application" group/sections/routes.
  * The "submit your application" group includes all routes for "check your answers" and "declarations".
  * @param {Application}
- * @param {String} Current URL
  * @returns {Boolean}
  */
 const canAccessSubmitYourApplicationRoutes = (application: Application) => {

src/ui/server/helpers/flatten-application-data/index.test.ts

@@ -164,6 +164,7 @@ describe('server/helpers/flatten-application-data', () => {
         ...contact,
         ...getTrueAndFalseAnswers(declaration),
         ...exportContract,
+        ...exportContract.awardMethod,
         ...getTrueAndFalseAnswers(exportContract),
         ...exportContract.privateMarket,
         ...getTrueAndFalseAnswers(exportContract.privateMarket),

src/ui/server/helpers/flatten-application-data/index.ts

@@ -137,6 +137,7 @@ const flattenApplicationData = (application: Application): ApplicationFlat => {
       ...company,
       ...contact,
       ...exportContract,
+      ...exportContract.awardMethod,
       ...getTrueAndFalseAnswers(exportContract),
       ...exportContract.privateMarket,
       ...getTrueAndFalseAnswers(exportContract.privateMarket),