#1834 - Hierarchical mocks for workflow E2E tests #1865
Conversation
andrewsignori-aot
added
E2E/Unit tests
Camunda Worflow
andrewsignori-aot
requested review from
dheepak-aot,
sh16011993,
guru-aot,
ann-aot,
andrepestana-aot and
JasonCTang
| return createMockedWorkerResult( | ||
| WorkflowServiceTasks.LoadAssessmentConsolidatedData, | ||
| { | ||
| subprocess: |
There was a problem hiding this comment.
pls add comments and review the comments
There was a problem hiding this comment.
Comments updated.
| * - `result`: suffix that identifies the job completed object. | ||
| * @param serviceTaskId service task id that will have the job completed returned. | ||
| * @returns mock identifier for a completed job to be sent to the workflow. | ||
| * - `passthrough`: suffix that identifies the job passthrough identifier. |
There was a problem hiding this comment.
passthrough is just a word change right, logically it is the same right. it represent the passed/completed task/flow
There was a problem hiding this comment.
Yes, I was not so sure at the beginning but it seems to be "The act or process of passing through" (https://en.wiktionary.org/wiki/passthrough#). If it is confusing I can change it.
sources/packages/backend/workflow/BPMN/camunda-8/load-assessment-consolidated-data.bpmn
Outdated
Show resolved
Hide resolved
| @@ -66,7 +56,9 @@ export class ZeebeMockedClient { | |||
| taskType, | |||
| taskHandler: mockTaskHandler, | |||
| })); | |||
| ZeebeMockedClient.mockedZeebeClient = new ZBClient(); | |||
| // Zeebe client logs disabled for a better test summary display. | |||
| // It can be enable as needed for troubleshooting. | |||
sources/packages/backend/workflow/BPMN/camunda-8/assessment-gateway.bpmn
Show resolved
Hide resolved
...workflow/test/2022-2023/assessment-gateway/assessment-gateway.originalAssessment.e2e-spec.ts
Outdated
Show resolved
Hide resolved
| const dataPreAssessment: AssessmentConsolidatedData = { | ||
| assessmentTriggerType: AssessmentTriggerType.OriginalAssessment, | ||
| ...createFakeConsolidatedFulltimeData(PROGRAM_YEAR), | ||
| ...createParentsData({ |
| @@ -28,15 +31,19 @@ describe(`E2E Test Workflow assessment gateway on student appeal for ${PROGRAM_Y | |||
| ...createFakeSingleIndependentStudentData(), | |||
| }; | |||
|
|
|||
| const workersMockedData = createWorkersMockedData([ | |||
| createLoadAssessmentDataTaskMock({ | |||
| assessmentConsolidatedData: assessmentConsolidatedData, | |||
There was a problem hiding this comment.
We are ignoring the subprocess context here, which is great 👍
There was a problem hiding this comment.
Yes, I resolved this comment using the same 😉
#1865 (comment)
| /** | ||
| * Suffix that indicates if a task or subprocess was invoked by the workflow. | ||
| */ | ||
| export const JOB_PASSTHROUGH_SUFFIX = "passthrough"; |
There was a problem hiding this comment.
What was the intention having passthrough suffixed(in the bpmn output value of variable)? to follow the pattern of aligning with it's purpose?
There was a problem hiding this comment.
Without the suffix, we would be actually updating the entire mocked object that is now the root of the mock.
For instance, we would be replacing the below:
"verify_application_exceptions_task": {
"result": {
"applicationExceptionStatus": "Approved"
}
},by
"verify_application_exceptions_task": "verify_application_exceptions_task"
|
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
|
The service task ids are now the root of the mocked objects. When the same service task id exists for multiple subprocesses, these subprocesses are added as a child of the root service task id object. In the below sample,
create_supporting_users_for_parents_taskis not invoked by any subprocess, so the mocked objects forresultandmessageResultare direct properties of the root service task id. On the other hand,create_income_request_taskis invoked by multiple subprocesses, andresultandmessageResultare associated with each one of them.The
load-assessment-data-?subprocess, which is potentially invoked twice, is now treated as a regular subprocess where we should provide mocked data for both subprocesses (the same data can be provided twice).Sample Hierarchical Mocks
Please that some
nullor empty values were removed from consolidated data for better visualization here.The main differences between
load_assessment_data_submit_or_reassessment_subprocessandload_assessment_data_pre_assessment_subprocessare related to the variables prefixed withparent1andparent2.{ "load_assessment_data_task": { "load_assessment_data_submit_or_reassessment_subprocess": { "result": { "assessmentTriggerType": "Original assessment", "studentDataParentValidSinNumber": "yes", "studentDataNumberOfParents": 2, "studentDataSelectedOffering": 1, "studentDataDependantstatus": "dependant", "programYear": "2022-2023", "programYearStartDate": "2022-08-01", "studentDataRelationshipStatus": "single", "studentDataTaxReturnIncome": 40000, "studentDataWhenDidYouGraduateOrLeaveHighSchool": "2017-03-01", "studentDataIndigenousStatus": "no", "studentDataHasDependents": "no", "studentDataLivingWithParents": "no", "studentDataYouthInCare": "no", "studentPDStatus": false, "studentTaxYear": 2021, "programLocation": "BC", "institutionLocationProvince": "BC", "institutionType": "BC Public", "programLength": "1YearToLessThan2Years", "programCredentialType": "undergraduateDegree", "offeringDelivered": "onsite", "offeringProgramRelatedCosts": 5000, "offeringActualTuitionCosts": 20000, "offeringMandatoryFees": 500, "offeringExceptionalExpenses": 500, "offeringWeeks": 16, "offeringIntensity": "Full Time", "offeringStudyStartDate": "2023-02-01", "offeringStudyEndDate": "2023-05-24" } }, "load_assessment_data_pre_assessment_subprocess": { "result": { "assessmentTriggerType": "Original assessment", "studentDataParentValidSinNumber": "yes", "studentDataNumberOfParents": 2, "parent1Contributions": 10000, "parent1Ei": 0, "parent1NetAssests": 300000, "parent1Tax": 0, "parent1TotalIncome": 75000, "parent1CppEmployment": 5000, "parent1CppSelfemploymentOther": 200, "parent2Contributions": 10000, "parent2CppSelfemploymentOther": 200, "parent2Ei": 0, "parent2NetAssests": 300000, "parent2Tax": 0, "parent2TotalIncome": 75000, "parent2CppEmployment": 5000, "studentDataDependantstatus": "dependant", "programYear": "2022-2023", "programYearStartDate": "2022-08-01", "studentDataRelationshipStatus": "single", "studentDataTaxReturnIncome": 40000, "studentDataWhenDidYouGraduateOrLeaveHighSchool": "2017-03-01", "studentDataIndigenousStatus": "no", "studentDataHasDependents": "no", "studentDataLivingWithParents": "no", "studentDataYouthInCare": "no", "studentPDStatus": false, "studentTaxYear": 2021, "programLocation": "BC", "institutionLocationProvince": "BC", "institutionType": "BC Public", "programLength": "1YearToLessThan2Years", "programCredentialType": "undergraduateDegree", "offeringDelivered": "onsite", "offeringProgramRelatedCosts": 5000, "offeringActualTuitionCosts": 20000, "offeringMandatoryFees": 500, "offeringExceptionalExpenses": 500, "offeringWeeks": 16, "offeringIntensity": "Full Time", "offeringStudyStartDate": "2023-02-01", "offeringStudyEndDate": "2023-05-24" } } }, "verify_application_exceptions_task": { "result": { "applicationExceptionStatus": "Approved" } }, "create_supporting_users_for_parents_task": { "result": { "createdSupportingUsersIds": [ 1000, 1001 ] }, "messageResult": [ { "name": "supporting-user-info-received", "correlationKey": "1000", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 10, "valueType": "TYPED_DURATION", "unit": "s" } }, { "name": "supporting-user-info-received", "correlationKey": "1001", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 10, "valueType": "TYPED_DURATION", "unit": "s" } } ] }, "check_supporting_user_response_task": { "retrieve_supporting_info_for_parent_1_subprocess": { "result": { "totalIncome": 1 } }, "retrieve_supporting_info_for_parent_2_subprocess": { "result": { "totalIncome": 1 } } }, "create_income_request_task": { "student_income_verification_subprocess": { "result": { "incomeVerificationCompleted": true, "incomeVerificationId": 1000 }, "messageResult": [ { "name": "income-verified", "correlationKey": "1000", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 10, "valueType": "TYPED_DURATION", "unit": "s" } } ] }, "parent_1_income_verification_subprocess": { "result": { "incomeVerificationCompleted": true, "incomeVerificationId": 1001 }, "messageResult": [ { "name": "income-verified", "correlationKey": "1001", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 10, "valueType": "TYPED_DURATION", "unit": "s" } } ] }, "parent_2_income_verification_subprocess": { "result": { "incomeVerificationCompleted": true, "incomeVerificationId": 1002 }, "messageResult": [ { "name": "income-verified", "correlationKey": "1002", "variables": {}, "timeToLive": { "type": "SECONDS", "value": 10, "valueType": "TYPED_DURATION", "unit": "s" } } ] } }, "check_income_request_task": { "student_income_verification_subprocess": { "result": { "incomeVerificationCompleted": true } }, "parent_1_income_verification_subprocess": { "result": { "incomeVerificationCompleted": true } }, "parent_2_income_verification_subprocess": { "result": { "incomeVerificationCompleted": true } } } }Resuing the same mock for multiple subprocesses.
A mocked object can be reused for multiple tasks under different subprocesses, as shown below.
Test summary readability
To allow better readability of the test summary, the Zeebe logging is disabled.
Varibales naming conventions
The possible change in the naming conventions for the service task ids is not considered for this PR.
WorkflowServiceTasksandWorkflowSubprocessesare now following the same convention, as shown below.Right now service task ids are still using the "-" as separators while Camunda E2E-related variables are using "_", which makes it easier to identify a variable on the workflow that is related to E2E.