#3375 - Add current year income question (income appeal) (#3733)

Camunda changes in the parttime-assessment-{program_year}.bpmn ![image](https://github.com/user-attachments/assets/d4817194-8ae1-4dd4-83ab-cb637a693c0d) ![image](https://github.com/user-attachments/assets/d7680b4b-6675-4cad-adb4-c181b5583b70) ![image](https://github.com/user-attachments/assets/317eb4b4-91fc-4316-9cbf-e3fd56ad6e78) ![image](https://github.com/user-attachments/assets/2a30db02-cda2-4313-b989-27652efa13d0) Formio changes in Student Request a change financial information page: ![image](https://github.com/user-attachments/assets/569a72df-c2b3-469b-9ef0-ac7c0fd97554) ![image](https://github.com/user-attachments/assets/0397ffbb-5556-4f1c-afa7-7231bc656ed9) E2E test cases added Launch.json is updated with workflow test running scripts. --------- Co-authored-by: guru-aot <[email protected]>
bcgov · Sep 24, 2024 · 35d826a · 35d826a
1 parent 89d4bde
commit 35d826a
Show file tree

Hide file tree

Showing 10 changed files with 5,434 additions and 3,576 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -196,6 +196,51 @@
         "ENVIRONMENT": "test",
         "TZ": "UTC"
       }
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Workflow - Current test file",
+      "program": "${workspaceFolder}/sources/packages/backend/node_modules/.bin/jest",
+      "args": [
+        "${fileBasenameNoExtension}",
+        "--runInBand",
+        "--config",
+        "./sources/packages/backend/workflow/test/jest-e2e.json",
+        "--forceExit"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "windows": {
+        "program": "${workspaceFolder}/sources/packages/backend/node_modules/jest/bin/jest"
+      },
+      "env": {
+        "ENVIRONMENT": "test",
+        "TZ": "UTC"
+      }
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Workflow - all tests",
+      "program": "${workspaceFolder}/sources/packages/backend/node_modules/.bin/jest",
+      "args": [
+        "--runInBand",
+        "--config",
+        "./sources/packages/backend/workflow/test/jest-e2e.json",
+        "--forceExit"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "windows": {
+        "program": "${workspaceFolder}/sources/packages/backend/node_modules/jest/bin/jest"
+      },
+      "env": {
+        "ENVIRONMENT": "test",
+        "TZ": "UTC"
+      }
     }
   ]
 }
diff --git a/sources/packages/backend/workflow/src/workflow-definitions/assessment-gateway.bpmn b/sources/packages/backend/workflow/src/workflow-definitions/assessment-gateway.bpmn
@@ -351,6 +351,7 @@
           <zeebe:output source="=null" target="parent2TotalIncome" />
           <zeebe:output source="=null" target="partner1TotalIncome" />
           <zeebe:output source="=null" target="studentDataTaxReturnIncome" />
+          <zeebe:output source="=null" target="studentDataCurrentYearIncome" />
           <zeebe:output source="=[]" target="parentSubprocesses" />
         </zeebe:ioMapping>
       </bpmn:extensionElements>

diff --git a/...ces/packages/backend/workflow/src/workflow-definitions/parttime-assessment-2022-2023.bpmn b/...ces/packages/backend/workflow/src/workflow-definitions/parttime-assessment-2022-2023.bpmn
diff --git a/...ces/packages/backend/workflow/src/workflow-definitions/parttime-assessment-2023-2024.bpmn b/...ces/packages/backend/workflow/src/workflow-definitions/parttime-assessment-2023-2024.bpmn
diff --git a/...ces/packages/backend/workflow/src/workflow-definitions/parttime-assessment-2024-2025.bpmn b/...ces/packages/backend/workflow/src/workflow-definitions/parttime-assessment-2024-2025.bpmn
diff --git a/...parttime-assessment/appeals/parttime-assessment-student-financial-information.e2e-spec.ts b/...parttime-assessment/appeals/parttime-assessment-student-financial-information.e2e-spec.ts
@@ -97,6 +97,101 @@ describe(`E2E Test Workflow parttime-assessment-${PROGRAM_YEAR}-student-financia
     },
   );
 
+  it(
+    "Should have calculated student total income from the current year income and not from the the application data or the tax return income " +
+      "when there is a request a change for student financial information with current year income values.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+          currentYearIncome: 500,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      expect(
+        calculatedAssessment.variables.calculatedDataCurrentYearIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataTotalFamilyIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(500);
+    },
+  );
+
+  it(
+    "Should have calculated student total income from the tax return income and not from the the application data tax return income " +
+      "when there is a request a change for student financial information with tax return income values.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataCRAReportedIncome = null;
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      // Application data tax return income submitted by the student.
+      expect(assessmentConsolidatedData.studentDataTaxReturnIncome).toBe(40001);
+      expect(
+        calculatedAssessment.variables.calculatedDataTotalFamilyIncome,
+      ).toBe(1234);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(1234);
+    },
+  );
+
+  it(
+    "Should have calculated student total income from the CRA income " +
+      "when there is an appeal but the current year's income is not provided.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataCRAReportedIncome = 999;
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(999);
+    },
+  );
+
   afterAll(async () => {
     // Closes the singleton instance created during test executions.
     await ZeebeMockedClient.getMockedZeebeInstance().close();

diff --git a/...parttime-assessment/appeals/parttime-assessment-student-financial-information.e2e-spec.ts b/...parttime-assessment/appeals/parttime-assessment-student-financial-information.e2e-spec.ts
@@ -97,6 +97,114 @@ describe(`E2E Test Workflow parttime-assessment-${PROGRAM_YEAR}-student-financia
     },
   );
 
+  it(
+    "Should have calculated student total income from the current year income and not from the the application data or the tax return income " +
+      "when there is a request a change for student financial information with current year income values.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.Yes;
+      assessmentConsolidatedData.studentDataDependants = [
+        createFakeStudentDependentEligibleForChildcareCost(
+          DependentChildCareEligibility.Eligible0To11YearsOld,
+          assessmentConsolidatedData.offeringStudyStartDate,
+        ),
+        createFakeStudentDependentEligibleForChildcareCost(
+          DependentChildCareEligibility.Eligible12YearsAndOver,
+          assessmentConsolidatedData.offeringStudyStartDate,
+        ),
+      ];
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+          currentYearIncome: 500,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      expect(
+        calculatedAssessment.variables.calculatedDataCurrentYearIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataTotalFamilyIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).not.toBe(1234);
+    },
+  );
+
+  it(
+    "Should have calculated student total income from the tax return income and not from the the application data tax return income " +
+      "when there is a request a change for student financial information with tax return income values.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataCRAReportedIncome = null;
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      // Application data tax return income submitted by the student.
+      expect(assessmentConsolidatedData.studentDataTaxReturnIncome).toBe(40001);
+      expect(
+        calculatedAssessment.variables.calculatedDataTotalFamilyIncome,
+      ).toBe(1234);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(1234);
+    },
+  );
+
+  it(
+    "Should have calculated student total income from the CRA income " +
+      "when there is an appeal but the current year's income is not provided.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataCRAReportedIncome = 999;
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(999);
+    },
+  );
+
   afterAll(async () => {
     // Closes the singleton instance created during test executions.
     await ZeebeMockedClient.getMockedZeebeInstance().close();

diff --git a/...parttime-assessment/appeals/parttime-assessment-student-financial-information.e2e-spec.ts b/...parttime-assessment/appeals/parttime-assessment-student-financial-information.e2e-spec.ts
@@ -97,6 +97,114 @@ describe(`E2E Test Workflow parttime-assessment-${PROGRAM_YEAR}-student-financia
     },
   );
 
+  it(
+    "Should have calculated student total income from the current year income and not from the the application data or the tax return income " +
+      "when there is a request a change for student financial information with current year income values.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.Yes;
+      assessmentConsolidatedData.studentDataDependants = [
+        createFakeStudentDependentEligibleForChildcareCost(
+          DependentChildCareEligibility.Eligible0To11YearsOld,
+          assessmentConsolidatedData.offeringStudyStartDate,
+        ),
+        createFakeStudentDependentEligibleForChildcareCost(
+          DependentChildCareEligibility.Eligible12YearsAndOver,
+          assessmentConsolidatedData.offeringStudyStartDate,
+        ),
+      ];
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+          currentYearIncome: 500,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      expect(
+        calculatedAssessment.variables.calculatedDataCurrentYearIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataTotalFamilyIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(500);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).not.toBe(1234);
+    },
+  );
+
+  it(
+    "Should have calculated student total income from the tax return income and not from the the application data tax return income " +
+      "when there is a request a change for student financial information with tax return income values.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataCRAReportedIncome = null;
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      // Application data tax return income submitted by the student.
+      expect(assessmentConsolidatedData.studentDataTaxReturnIncome).toBe(40001);
+      expect(
+        calculatedAssessment.variables.calculatedDataTotalFamilyIncome,
+      ).toBe(1234);
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(1234);
+    },
+  );
+
+  it(
+    "Should have calculated student total income from the CRA income " +
+      "when there is an appeal but the current year's income is not provided.",
+    async () => {
+      // Arrange
+      const assessmentConsolidatedData =
+        createFakeConsolidatedPartTimeData(PROGRAM_YEAR);
+      assessmentConsolidatedData.studentDataCRAReportedIncome = 999;
+      assessmentConsolidatedData.studentDataHasDependents = YesNoOptions.No;
+      assessmentConsolidatedData.appealsStudentFinancialInformationAppealData =
+        {
+          taxReturnIncome: 1234,
+        };
+
+      // Act
+      const calculatedAssessment =
+        await executePartTimeAssessmentForProgramYear(
+          PROGRAM_YEAR,
+          assessmentConsolidatedData,
+        );
+
+      // Assert
+      expect(
+        calculatedAssessment.variables.calculatedDataStudentTotalIncome,
+      ).toBe(999);
+    },
+  );
+
   afterAll(async () => {
     // Closes the singleton instance created during test executions.
     await ZeebeMockedClient.getMockedZeebeInstance().close();