#2322 - IER12 E2E Tests - First scenarios #2461

andrewsignori-aot · 2023-10-30T21:06:42Z

Followed a similar idea used for MSFAA E2E tests where a controlled data set was created to allow easy file record validation with minimal variables. So, in the same way, MSFAA is using saveMSFAATestInputData, the IER12 E2E is using saveIER12TestInputData.

Small helper methods were created in separate files with the idea of sharing with other E2E test files for IER12.

The payload is supposed to be expressive and clearly define the IER12 data, as shown below. Constants like JOHN_DOE_FROM_CANADA or JANE_MONONYMOUS_FROM_OTHER_COUNTRY were created to allow the reuse of some basic data sets.

const testInputData = {
  student: JOHN_DOE_FROM_CANADA,
  application: {
    applicationNumber: defaultApplicationNumber,
    studentNumber: "12345678",
    relationshipStatus: RelationshipStatus.Single,
    applicationStatus: ApplicationStatus.Completed,
    applicationStatusUpdatedOn: undefined,
  },
  assessment: {
    triggerType: AssessmentTriggerType.OriginalAssessment,
    assessmentDate: undefined,
    workflowData: WORKFLOW_DATA_SINGLE_INDEPENDENT_WITH_NO_DEPENDENTS,
    assessmentData: ASSESSMENT_DATA_SINGLE_INDEPENDENT,
    disbursementSchedules: [
      {
        coeStatus: COEStatus.completed,
        disbursementScheduleStatus: DisbursementScheduleStatus.Sent,
        disbursementDate: undefined,
        updatedAt: undefined,
        dateSent: undefined,
        disbursementValues: AWARDS_ONE_OF_TWO_DISBURSEMENT,
      },
      {
        coeStatus: COEStatus.required,
        disbursementScheduleStatus: DisbursementScheduleStatus.Pending,
        disbursementDate: undefined,
        updatedAt: undefined,
        dateSent: undefined,
        disbursementValues: AWARDS_TWO_OF_TWO_DISBURSEMENT,
      },
    ],
  },
educationProgram: PROGRAM_UNDERGRADUATE_CERTIFICATE_WITHOUT_INSTITUTION_PROGRAM_CODE,
offering: OFFERING_FULL_TIME,
};

As much as possible the IR12 models use the DB models as a reference (e.g. using Pick<>) and the overall idea is that these models represent the specific set of properties that would impact the IER12 file content directly or participate in its calculations.

First E2E scenarios for IER12.

Should generate an IER12 file with two records for a single student with no dependents and two disbursements, one sent and one pending.
Should generate an IER12 file with one record for a married student (mononymous) with dependents, applications still in assessment, and one pending disbursement.
Should generate an IER12 file with one record for a dependant and living with parents student with no dependents and one sent disbursement with no BC funding.
Should generate an IER12 file with one record for a student with one pending disbursement due to a restriction.

Refactors

Changed the student number source from application dynamic data to the application table.

Upcoming PR

A closer look at the expect for the line assertion (need further review with documentation.).
More scenarios like (to be done as per time allows):
- Generate records from multiple institutions/locations.
- Has multiple application submissions.
- Has full-time disbursement feedback errors.
- Do not select part-time applications.
- Has a disbursement that withheld funding.

PS.: The acceptance criteria Create factory to generate the workflow_data information was replaced by the idea of creating a factory for the entire IER12, the saveIER12TestInputData. Please let me know if there is a concern that this is not achieving the goal for the IER12 effort.

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts

ann-aot · 2023-10-31T20:18:22Z

sources/packages/backend/libs/test-utils/src/factories/program-year.ts

+ * would create a program year 2000-2001.
+ * @returns program year with the prefix.
+ */
+export async function ensureProgramYearExists(


how about the method name getOrCreateProgramYear

Either way would work for me. Lest see if there is any input from other devs and please let me know if it would be a blocker 😉

no, its a suggestion

sources/packages/backend/libs/test-utils/src/factories/program-year.ts

ann-aot · 2023-10-31T20:21:11Z

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts

+  const createSecondDisbursement =
+    testInputData.assessment.disbursementSchedules.length === 2;
+  // Set the number of weeks to some number beyond 17 if there are two disbursements
+  // since two disbursements are supposed to be create to offerings longer than 17 weeks.


...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts

guru-aot

LGTM, very nice work on creating the factories and arranging them. @andrewsignori-aot

dheepak-aot · 2023-11-01T17:32:18Z

...nstitution-integration/ier12-integration/_tests_/e2e/ier12-integration.scheduler.e2e-spec.ts

+
+    // Act
+    const ier12Results = await processor.processIER12File(job);
+    db.application.createQueryBuilder();


left over to be removed?

Removed, nice catch 😉

dheepak-aot · 2023-11-01T17:37:01Z

...nstitution-integration/ier12-integration/_tests_/e2e/ier12-integration.scheduler.e2e-spec.ts

+    const [line1] = uploadedFile.fileLines;
+    const [firstDisbursement] =
+      application.currentAssessment.disbursementSchedules;
+    const assessmentId = numberToText(application.currentAssessment.id);


Why didn't we re-use the string builder(or specialized string builder) methods here?

To avoid using the code that would also potentially be validated. If we introduce an error in the StringBuilder we may end up not catching it in the E2Es. Same reason that we reuse code from the application but with caution, try to keep the E2E assertion validations as "raw" as possible.

dheepak-aot · 2023-11-01T17:38:27Z

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts

+    testInputData.assessment.disbursementSchedules.length === 2;
+  // Set the number of weeks to some number beyond 17 if there are two disbursements
+  // since two disbursements are supposed to be create to offerings longer than 17 weeks.
+  const offeringEndDateWeeks = createSecondDisbursement ? 18 : 10;


dheepak-aot · 2023-11-01T17:40:06Z

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts

+  );
+  // Location
+  const institutionLocation = createFakeInstitutionLocation();
+  institutionLocation.institutionCode = "ZZZY";


Minor. ZZZY could be constant

It can be, but taking a look at the factories we do assign the values directly almost all the time, I just did not see a benefit here. It would be a different conversation if it was a production code.

dheepak-aot · 2023-11-01T17:41:04Z

...ages/backend/libs/integrations/src/services/student-assessment/student-assessment.service.ts

@@ -42,6 +42,7 @@ export class StudentAssessmentService extends RecordDataModelService<StudentAsse
          submittedDate: true,
          applicationStatus: true,
          applicationStatusUpdatedOn: true,
+          studentNumber: true,


Thanks for taking care of this.

...cessors/schedulers/institution-integration/ier12-integration/_tests_/e2e/utils/date-utils.ts

dheepak-aot · 2023-11-01T17:46:40Z

...n-integration/ier12-integration/_tests_/e2e/models/data-inputs/disbursement-values-inputs.ts

+import { DisbursementValueType } from "@sims/sims-db";
+import { IERAward } from "@sims/integrations/institution-integration/ier12-integration";
+
+export const AWARDS_SINGLE_DISBURSEMENT: IERAward[] = [


I see almost a full fledged QA work happening in an E2E. Great work.

dheepak-aot · 2023-11-01T17:48:21Z

Great and exhaustive work @andrewsignori-aot . I see you have addressed most of the comments. added little more.

sh16011993

Nice work @andrewsignori-aot 👍

sonarqubecloud · 2023-11-01T18:15:17Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
1.9% Duplication

github-actions · 2023-11-01T18:16:54Z

Backend Unit Tests Coverage Report

Totals
Statements:	18.18% ( 2341 / 12879 )
Methods:	9.28% ( 151 / 1628 )
Lines:	20.7% ( 2016 / 9741 )
Branches:	11.52% ( 174 / 1510 )

github-actions · 2023-11-01T18:17:46Z

E2E Workflow Workers Coverage Report

Totals
Statements:	52.62% ( 341 / 648 )
Methods:	50% ( 40 / 80 )
Lines:	56.85% ( 282 / 496 )
Branches:	26.39% ( 19 / 72 )

github-actions · 2023-11-01T18:18:34Z

E2E Queue Consumers Coverage Report

Totals
Statements:	76.94% ( 564 / 733 )
Methods:	71.59% ( 63 / 88 )
Lines:	78.75% ( 493 / 626 )
Branches:	42.11% ( 8 / 19 )

github-actions · 2023-11-01T18:26:15Z

E2E SIMS API Coverage Report

Totals
Statements:	55.59% ( 4088 / 7354 )
Methods:	52.88% ( 505 / 955 )
Lines:	60.3% ( 3313 / 5494 )
Branches:	29.83% ( 270 / 905 )

dheepak-aot

Thanks for making the changes. 👍

- Created two more scenarios from the previous PR (#2461) to-do list. - Has full-time disbursement feedback errors (DISE). - Has a disbursement that withheld funding due to a restriction (DISW). - The first E2E above is invoking the processor without specifying the date as per [previous PR comment](#2461 (comment)). - New E2E factory created `createDisbursementFeedbackError`. - Added an exception in case `getUploadedFile` was invoked but it was never called. The tests were failing with a not-so-clear error. - Fixed an error in the IER12 query `BETWEEN` operator and removed a code TODO.

andrewsignori-aot added 5 commits October 20, 2023 16:53

Created the first data load for IER12

20eee68

Changing test input data E2E model

d68d35a

E2E test passing and Monday TODOs.

4aa37be

Merge branch 'main' into feature/#2322-ier12-e2e-tests

074ebf2

Improvements and more E2E scenarios

f8a2c0f

andrewsignori-aot added Queue Consumers E2E/Unit tests labels Oct 30, 2023

andrewsignori-aot self-assigned this Oct 30, 2023

andrewsignori-aot added 7 commits October 30, 2023 14:24

Pre PR review adjustments.

d375e6f

Application number fix

53ed107

Changed student number source.

d408316

Testing new disbursement values

53d178f

Assertions fixes due to disbursements changes

90b1436

TODO checked

2148f68

Pre PR review

be0683c

andrewsignori-aot marked this pull request as ready for review October 31, 2023 17:30

andrewsignori-aot requested review from dheepak-aot, guru-aot, sh16011993, cditcher, ann-aot, JasonCTang and andrepestana-aot October 31, 2023 17:30

ann-aot reviewed Oct 31, 2023

View reviewed changes

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts Outdated Show resolved Hide resolved

ann-aot reviewed Oct 31, 2023

View reviewed changes

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts Outdated Show resolved Hide resolved

ann-aot reviewed Oct 31, 2023

View reviewed changes

sources/packages/backend/libs/test-utils/src/factories/program-year.ts Outdated Show resolved Hide resolved

ann-aot reviewed Oct 31, 2023

View reviewed changes

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts Outdated Show resolved Hide resolved

ann-aot reviewed Oct 31, 2023

View reviewed changes

...processors/schedulers/institution-integration/ier12-integration/_tests_/e2e/ier12-factory.ts Show resolved Hide resolved

Comment improvement

15324d2

guru-aot approved these changes Nov 1, 2023

View reviewed changes

dheepak-aot reviewed Nov 1, 2023

View reviewed changes

...cessors/schedulers/institution-integration/ier12-integration/_tests_/e2e/utils/date-utils.ts Outdated Show resolved Hide resolved

dheepak-aot reviewed Nov 1, 2023

View reviewed changes

sh16011993 approved these changes Nov 1, 2023

View reviewed changes

PR review comments

1af142c

andrewsignori-aot removed the request for review from andrepestana-aot November 1, 2023 18:14

dheepak-aot approved these changes Nov 1, 2023

View reviewed changes

andrewsignori-aot merged commit 5283a12 into main Nov 1, 2023

andrewsignori-aot deleted the feature/#2322-ier12-e2e-tests branch November 1, 2023 19:16

andrewsignori-aot temporarily deployed to DEV November 1, 2023 19:27 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV November 1, 2023 19:29 — with GitHub Actions Inactive

andrewsignori-aot temporarily deployed to DEV November 1, 2023 19:31 — with GitHub Actions Inactive

andrewsignori-aot mentioned this pull request Nov 3, 2023

#2322 - IER12 E2E Tests Additional Scenarios #2474

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2322 - IER12 E2E Tests - First scenarios #2461

#2322 - IER12 E2E Tests - First scenarios #2461

andrewsignori-aot commented Oct 30, 2023 •

edited

Loading

ann-aot Oct 31, 2023

andrewsignori-aot Oct 31, 2023

ann-aot Oct 31, 2023

ann-aot Oct 31, 2023

guru-aot left a comment

dheepak-aot Nov 1, 2023

andrewsignori-aot Nov 1, 2023

dheepak-aot Nov 1, 2023

andrewsignori-aot Nov 1, 2023

dheepak-aot Nov 1, 2023

dheepak-aot Nov 1, 2023

andrewsignori-aot Nov 1, 2023

dheepak-aot Nov 1, 2023

dheepak-aot Nov 1, 2023

dheepak-aot commented Nov 1, 2023

sh16011993 left a comment

sonarqubecloud bot commented Nov 1, 2023

github-actions bot commented Nov 1, 2023

github-actions bot commented Nov 1, 2023

github-actions bot commented Nov 1, 2023

github-actions bot commented Nov 1, 2023

dheepak-aot left a comment

#2322 - IER12 E2E Tests - First scenarios #2461

#2322 - IER12 E2E Tests - First scenarios #2461

Conversation

andrewsignori-aot commented Oct 30, 2023 • edited Loading

First E2E scenarios for IER12.

Refactors

Upcoming PR

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guru-aot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dheepak-aot commented Nov 1, 2023

sh16011993 left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 1, 2023

github-actions bot commented Nov 1, 2023

Backend Unit Tests Coverage Report

github-actions bot commented Nov 1, 2023

E2E Workflow Workers Coverage Report

github-actions bot commented Nov 1, 2023

E2E Queue Consumers Coverage Report

github-actions bot commented Nov 1, 2023

E2E SIMS API Coverage Report

dheepak-aot left a comment

Choose a reason for hiding this comment

andrewsignori-aot commented Oct 30, 2023 •

edited

Loading