#1864 - MSFAA Send File E2E Test Automation #1905
Conversation
andrewsignori-aot
requested review from
dheepak-aot,
andrepestana-aot,
guru-aot,
JasonCTang,
ann-aot and
sh16011993
and removed request for
andrepestana-aot
...sumers/src/processors/schedulers/esdc-integration/msfaa-integration/_tests_/msfaa-factory.ts
Outdated
Show resolved
Hide resolved
...nsumers/src/processors/schedulers/esdc-integration/msfaa-integration/_tests_/msfaa-helper.ts
Outdated
Show resolved
Hide resolved
...ntegration/msfaa-integration/_tests_/msfaa-part-time-process-integration.scheduler.models.ts
Outdated
Show resolved
Hide resolved
...packages/backend/apps/queue-consumers/test/helpers/testing-modules/testing-modules-helper.ts
Show resolved
Hide resolved
| gender: string; | ||
| maritalStatus: RelationshipStatus; | ||
| addressLine1: string; | ||
| addressLine2: string; |
There was a problem hiding this comment.
Looking at the file-details, few of these inputs could be optional right? May be that could become a scenario in future if needed
There was a problem hiding this comment.
They can be test scenarios but not necessarily E2E scenarios. The idea is to have some E2E and focus more on the unit tests for the queue consumers, as per my understanding, to compensate also the decision to have E2E running sequentially.
| newMSFAANumber.dateRequested = null; | ||
| newMSFAANumber.dateSigned = null; | ||
| newMSFAANumber.serviceProviderReceivedDate = null; | ||
| newMSFAANumber.cancelledDate = null; | ||
| newMSFAANumber.newIssuingProvince = null; |
There was a problem hiding this comment.
IMO, I feel like this logic can be kept inside the factory createFakeMSFAANumber based on an optional parameter provided to the factory. As it is setting bunch of values to null.
There was a problem hiding this comment.
It follows the idea of having the factory create the record and adjust the test as needed.
Keep in mind that these "nulls" are also set once inside a "factory".
Is the idea to create options like "pending", "canceled", or "signed" states?
...egration/msfaa-integration/_tests_/msfaa-part-time-process-integration.scheduler.e2e-spec.ts
Show resolved
Hide resolved
...egration/msfaa-integration/_tests_/msfaa-part-time-process-integration.scheduler.e2e-spec.ts
Outdated
Show resolved
Hide resolved
...egration/msfaa-integration/_tests_/msfaa-part-time-process-integration.scheduler.e2e-spec.ts
Outdated
Show resolved
Hide resolved
| * part of the MSFAA file generation. | ||
| * @param db data source helper. | ||
| * @param msfaa test input data. | ||
| * @returns a saved MSFAA record that used th input |
There was a problem hiding this comment.
please correct the return comment to "@return a saved MSFAA record that uses the input test data to be created."
| "test:e2e:queue-consumers": "npm run migration:run && cross-env ENVIRONMENT=test jest --collect-coverage --verbose --config ./apps/queue-consumers/test/jest-e2e.json --forceExit", | ||
| "test:e2e:queue-consumers:local": "cross-env ENVIRONMENT=test jest --verbose --config ./apps/queue-consumers/test/jest-e2e.json --forceExit", | ||
| "test:e2e:queue-consumers": "npm run migration:run && cross-env ENVIRONMENT=test jest --collect-coverage --verbose --config ./apps/queue-consumers/test/jest-e2e.json --runInBand --forceExit", | ||
| "test:e2e:queue-consumers:local": "cross-env ENVIRONMENT=test TZ=UTC jest --verbose --config ./apps/queue-consumers/test/jest-e2e.json --runInBand --forceExit", |
|
Kudos, SonarCloud Quality Gate passed!
|
Backend Unit Tests Coverage Report
|
E2E Workflow Workers Coverage Report
|
E2E Queue Consumers Coverage Report
|
E2E SIMS API Coverage Report
|
| @@ -11,7 +11,7 @@ import { | |||
| overrideImportsMetadata, | |||
| } from "@sims/test-utils"; | |||
| import * as Client from "ssh2-sftp-client"; | |||
| import { createMock } from "@golevelup/ts-jest"; | |||
| import { DeepMocked, createMock } from "@golevelup/ts-jest"; | |||
There was a problem hiding this comment.
Not a part of the PR, I have question on line 45
Will this automatically mock the client.put which uploads the file?
const sshClientMock = createMock<Client>();
There was a problem hiding this comment.
Yes, createMock<Client>(); is a helper to do a "deep" mock.
|
Thanks for setting up the E2E tests for file integration. Added few minor comments/questions. |
| @@ -102,7 +104,7 @@ export class MSFAARequestProcessingService extends ESDCFileHandler { | |||
| const msfaaNumberRepo = entityManager.getRepository(MSFAANumber); | |||
| this.msfaaNumberService.updateRecordsInSentFile( | |||
| msfaaRecordIds, | |||
| getUTCNow(), | |||
| processDate, | |||
getUploadedFileto allow access to the supposed-to-be uploaded file.saveMSFAATestInputData) to generate the MSFAA records that could be used for all the MSFAA file-related tests.processDateused for MSFAA records, MSFAA file name, and MSFAA sequence group.getPendingMSFAARequestto ensure that the records are consistently retrieved in the same order and as a consequence, the file records will be generated using the same order also.createE2EDataSourcesto be used specifically for E2E tests and reduce the amount of code needed when saving to DB multiple entities. The intention is to be used as below. Open for discussions and opinions.This is related to the idea shared on the DEVs chat on April 11th