Merge pull request #5654 from masslight/vmolastau/otr-1192-add-smoke-testing-automation

Vmolastau/otr 1192 add smoke testing automation

Author: VladMstv

.github/workflows/e2e-ehr.yml

@@ -21,6 +21,14 @@ on:
           - staging
           - demo
         default: 'local'
+      mode:
+        description: 'Tests running mode'
+        required: false
+        type: choice
+        options:
+          - normal
+          - smoke
+        default: 'normal'
   workflow_call:
     inputs:
       environment:
@@ -158,7 +166,12 @@ jobs:
           if [ "$ENV" == "local" ] || [ "$ENV" == "e2e" ]; then
             npm run ehr:e2e:$ENV:integration
           else
-            npm run ehr:e2e:$ENV
+            MODE="${{ inputs.mode }}"
+            if [ "$MODE" == "smoke" ]; then
+              npm run ehr:e2e:$ENV:smoke
+            else
+              npm run ehr:e2e:$ENV
+            fi
           fi
         env:
           CI: true

.github/workflows/e2e-intake.yml

@@ -23,6 +23,14 @@ on:
           - staging
           - demo
         default: 'local'
+      mode:
+        description: 'Tests running mode'
+        required: false
+        type: choice
+        options:
+          - normal
+          - smoke
+        default: 'normal'
   workflow_call:
     inputs:
       environment:
@@ -396,7 +404,12 @@ jobs:
           if [ "$ENV" == "local" ]; then
             npm run intake:e2e:local:specs
           else
-            npm run intake:e2e:$ENV:specs
+            MODE="${{ inputs.mode }}"
+            if [ "$MODE" == "smoke" ]; then
+              npm run intake:e2e:$ENV:smoke
+            else
+              npm run intake:e2e:$ENV:specs
+            fi
           fi
         env:
           CI: true

E2E_README.md

@@ -207,6 +207,7 @@ export class ResourceHandler {
 
 - **ENV**: Determines configuration set (`local`, `demo`, `staging`, `testing`) and cascades through entire system
 - **INTEGRATION_TEST**: Controls resource creation method (batch vs application endpoints)
+- **SMOKE TEST**:  Controls picking the right patient and avoid cleanup (for production environments)
 - **CI**: Auto-detected, affects retry logic, worker count, and artifact capture settings
 - **UI Flag**: Enables headed mode for debugging instead of headless execution
 - **Auth Credentials**: System automatically uses enhanced test credentials when available

apps/ehr/tests/e2e-utils/resource-handler.ts

@@ -1,9 +1,11 @@
 import Oystehr, { BatchInputPostRequest } from '@oystehr/sdk';
+import { Page } from '@playwright/test';
 import {
   Address,
   Appointment,
   ClinicalImpression,
   Consent,
+  ContactPoint,
   DocumentReference,
   Encounter,
   FhirResource,
@@ -20,8 +22,10 @@ import {
 import { readFileSync } from 'fs';
 import { DateTime } from 'luxon';
 import { dirname, join } from 'path';
+import { VisitDetailsPage } from 'tests/e2e/page/VisitDetailsPage';
 import { fileURLToPath } from 'url';
 import {
+  CancellationReasonOptionsInPerson,
   cleanAppointmentGraph,
   CreateAppointmentResponse,
   createFetchClientWithOystehrAuth,
@@ -30,6 +34,7 @@ import {
   FHIR_APPOINTMENT_INTAKE_HARVESTING_COMPLETED_TAG,
   FHIR_APPOINTMENT_PREPROCESSED_TAG,
   formatPhoneNumber,
+  genderMap,
   GetPaperworkAnswers,
   RelationshipOption,
   ServiceMode,
@@ -65,18 +70,22 @@ export function getAccessTokenFromUserJson(): string {
   return token;
 }
 
+const IS_SMOKE_TEST = process.env.SMOKE_TEST === 'true' || false;
+
 const EightDigitsString = '20250519';
 
-export const PATIENT_FIRST_NAME = 'Jon';
-export const PATIENT_LAST_NAME = 'Snow';
-export const PATIENT_GENDER = 'Male';
+export const PATIENT_FIRST_NAME = IS_SMOKE_TEST ? 'Katie' : 'Jon';
+export const PATIENT_LAST_NAME = IS_SMOKE_TEST ? 'Patient' : 'Snow';
+export const PATIENT_GENDER = IS_SMOKE_TEST ? 'Female' : 'Male';
 
 export const PATIENT_BIRTHDAY = '2002-07-07';
 export const PATIENT_BIRTH_DATE_SHORT = '07/07/2002';
 export const PATIENT_BIRTH_DATE_LONG = 'July 07, 2002';
 
 export const PATIENT_PHONE_NUMBER = '21' + EightDigitsString;
-export const PATIENT_EMAIL = `john.doe.${EightDigitsString}3@example.com`;
+export const PATIENT_EMAIL = IS_SMOKE_TEST
+  ? `ykulik+${PATIENT_FIRST_NAME}${PATIENT_LAST_NAME}@masslight.com`
+  : `john.doe.${EightDigitsString}3@example.com`;
 export const PATIENT_CITY = 'New York';
 export const PATIENT_LINE = `${EightDigitsString} Test Line`;
 export const PATIENT_LINE_2 = 'Apt 4B';
@@ -171,6 +180,25 @@ export class ResourceHandler {
     });
   }
 
+  private async findTestPatientResource(): Promise<Patient | null> {
+    const oystehr = await this.apiClient;
+    const patientSearchResults = await oystehr.fhir.search<Patient>({
+      resourceType: 'Patient',
+      params: [
+        {
+          name: 'given',
+          value: 'Katie',
+        },
+        {
+          name: 'family',
+          value: 'Patient',
+        },
+      ],
+    });
+    const patient = patientSearchResults.unbundle()[0] as Patient;
+    return patient;
+  }
+
   public async createAppointment(inputParams?: CreateTestAppointmentInput): Promise<CreateAppointmentResponse> {
     try {
       const address: Address = {
@@ -180,17 +208,53 @@ export class ResourceHandler {
         postalCode: inputParams?.postalCode ?? PATIENT_POSTAL_CODE,
       };
 
-      const patientData = {
-        firstNames: [inputParams?.firstName ?? PATIENT_FIRST_NAME],
-        lastNames: [inputParams?.lastName ?? PATIENT_LAST_NAME],
-        numberOfAppointments: 1,
-        reasonsForVisit: [inputParams?.reasonsForVisit ?? PATIENT_REASON_FOR_VISIT],
-        phoneNumbers: [inputParams?.phoneNumber ?? PATIENT_PHONE_NUMBER],
-        emails: [inputParams?.email ?? PATIENT_EMAIL],
-        gender: inputParams?.gender ?? PATIENT_GENDER.toLowerCase(),
-        birthDate: inputParams?.birthDate ?? PATIENT_BIRTHDAY,
-        address: [address],
-      };
+      let patientData = {};
+      let phoneNumber = formatPhoneNumber(PATIENT_PHONE_NUMBER)!;
+
+      console.log('Initial phone number:', phoneNumber);
+
+      if (IS_SMOKE_TEST) {
+        console.log('In SMOKE_TEST mode using Katie Patient');
+        // if it's SMOKE_TEST mode - find Katie Patient patient resource and use it to create appointment
+        const testPatient = await this.findTestPatientResource();
+
+        if (!testPatient) {
+          console.log('Katie Patient not found, will create new patient for Katie Patient');
+        } else {
+          patientData = {
+            firstNames: [testPatient?.name?.[0]?.given?.[0] ?? ''],
+            lastNames: [testPatient?.name?.[0]?.family ?? ''],
+            numberOfAppointments: 1,
+            reasonsForVisit: [inputParams?.reasonsForVisit ?? PATIENT_REASON_FOR_VISIT],
+            phoneNumbers: [
+              testPatient?.telecom
+                ?.find((telecom: ContactPoint) => telecom.system === 'phone')
+                ?.value?.replace('+1', '') || PATIENT_PHONE_NUMBER,
+            ],
+            emails: [testPatient?.telecom?.find((telecom: ContactPoint) => telecom.system === 'email')?.value ?? ''],
+            gender: testPatient?.gender ?? genderMap.female,
+            birthDate: testPatient?.birthDate ?? '',
+          };
+          phoneNumber = formatPhoneNumber(
+            testPatient?.telecom?.find((telecom: ContactPoint) => telecom.system === 'phone')?.value ||
+              PATIENT_PHONE_NUMBER
+          )!;
+        }
+      }
+
+      if (!IS_SMOKE_TEST || Object.keys(patientData).length === 0) {
+        patientData = {
+          firstNames: [inputParams?.firstName ?? PATIENT_FIRST_NAME],
+          lastNames: [inputParams?.lastName ?? PATIENT_LAST_NAME],
+          numberOfAppointments: 1,
+          reasonsForVisit: [inputParams?.reasonsForVisit ?? PATIENT_REASON_FOR_VISIT],
+          phoneNumbers: [inputParams?.phoneNumber ?? PATIENT_PHONE_NUMBER],
+          emails: [inputParams?.email ?? PATIENT_EMAIL],
+          gender: inputParams?.gender ?? PATIENT_GENDER.toLowerCase(),
+          birthDate: inputParams?.birthDate ?? PATIENT_BIRTHDAY,
+          address: [address],
+        };
+      }
 
       if (!process.env.PROJECT_API_ZAMBDA_URL) {
         throw new Error('PROJECT_API_ZAMBDA_URL is not set');
@@ -208,11 +272,13 @@ export class ResourceHandler {
         throw new Error('PROJECT_ID is not set');
       }
 
+      console.log(formatPhoneNumber(PATIENT_PHONE_NUMBER)!, phoneNumber);
+
       // Create appointment and related resources using zambda
       const appointmentData = await createSampleAppointments({
         oystehr: await this.apiClient,
         authToken: getAccessTokenFromUserJson(),
-        phoneNumber: formatPhoneNumber(PATIENT_PHONE_NUMBER)!,
+        phoneNumber,
         createAppointmentZambdaId: this.#createAppointmentZambdaId,
         zambdaUrl: process.env.PROJECT_API_ZAMBDA_URL,
         serviceMode: this.#flow === 'telemed' ? ServiceMode.virtual : ServiceMode['in-person'],
@@ -347,7 +413,19 @@ export class ResourceHandler {
     };
   }
 
-  public async cleanupResources(): Promise<void> {
+  public async cleanupResources(page?: Page): Promise<void> {
+    if (process.env.SMOKE_TEST === 'true') {
+      console.log('Smoke test mode detected, canceling visits through UI');
+      if (!page) {
+        throw new Error('Page instance parameter is required to cancel visit in smoke test mode');
+      }
+      await page?.goto(`/visit/${this.appointment.id!}`);
+      const visitDetails = new VisitDetailsPage(page!);
+      await visitDetails.clickCancelVisitButton();
+      await visitDetails.selectCancelationReason(CancellationReasonOptionsInPerson['Patient improved']);
+      await visitDetails.clickCancelButtonFromDialogue();
+      return;
+    }
     console.log('------------------------------------------------------------');
     console.log('Starting resource cleanup');
     // TODO: here we should change appointment id to encounter id when we'll fix this bug in frontend,

apps/ehr/tests/e2e/specs/in-person/inPersonVisit.spec.ts

@@ -64,7 +64,7 @@ test.describe('In-person visit', async () => {
   //   await patientInfoPage.inPersonHeader().verifyStatus('ready for provider');
   // });
 
-  test.describe('happy path', () => {
+  test.describe('happy path', { tag: '@smoke' }, () => {
     const PROCESS_ID = `inPersonVisit.spec.ts-${DateTime.now().toMillis()}`;
     let insuranceCarrier1: QuestionnaireItemAnswerOption | undefined;
     let insuranceCarrier2: QuestionnaireItemAnswerOption | undefined;
@@ -147,7 +147,7 @@ test.describe('In-person visit', async () => {
     });
 
     test.afterAll(async () => {
-      await resourceHandler.cleanupResources();
+      await resourceHandler.cleanupResources(page);
       await page.close();
       await context.close();
     });

apps/ehr/tests/e2e/specs/in-person/visitDetailsPage.spec.ts

@@ -0,0 +1,32 @@
+import { BrowserContext, Page, test } from '@playwright/test';
+import { DateTime } from 'luxon';
+import { ResourceHandler } from 'tests/e2e-utils/resource-handler';
+
+const PROCESS_ID = `visitDetailsPage.spec.ts-${DateTime.now().toMillis()}`;
+const resourceHandler = new ResourceHandler(PROCESS_ID, 'in-person');
+
+test.describe('Visit details page', { tag: '@smoke' }, async () => {
+  let page: Page;
+  let context: BrowserContext;
+  // let visitDetailsPage: VisitDetailsPage;
+
+  test.beforeAll(async ({ browser }) => {
+    await resourceHandler.setResources();
+    await resourceHandler.waitTillHarvestingDone(resourceHandler.appointment.id!);
+
+    context = await browser.newContext();
+    page = await context.newPage();
+    await page.goto(`/visit/${resourceHandler.appointment.id!}`);
+    // visitDetailsPage = await expectVisitDetailsPage(page, resourceHandler.appointment.id!);
+  });
+
+  test.afterAll(async () => {
+    await resourceHandler.cleanupResources(page);
+    await page.close();
+    await context.close();
+  });
+
+  test.describe.configure({ mode: 'serial' });
+
+  test('should display visit details page correctly', async () => {});
+});

apps/ehr/tests/e2e/specs/patientRecordPage.spec.ts

@@ -262,7 +262,7 @@ const populateAllRequiredFields = async (patientInformationPage: PatientInformat
   }
 };
 
-test.describe('Patient Record Page tests', () => {
+test.describe('Patient Record Page tests', { tag: '@smoke' }, () => {
   const PROCESS_ID = `patientRecordPage-mutating-patient-info-fields-${DateTime.now().toMillis()}`;
   const resourceHandler = new ResourceHandler(PROCESS_ID);
 
@@ -276,9 +276,9 @@ test.describe('Patient Record Page tests', () => {
     page = await context.newPage();
   });
   test.afterAll(async () => {
+    await resourceHandler.cleanupResources(page);
     await page.close();
     await context.close();
-    await resourceHandler.cleanupResources();
   });
   let patientInformationPage: PatientInformationPage;
 
@@ -1729,7 +1729,7 @@ test.describe('Patient Record Page tests', () => {
   });
 });
 
-test.describe('Patient Record Page tests with zero patient data filled in', async () => {
+test.describe('Patient Record Page tests with zero patient data filled in', { tag: '@smoke' }, async () => {
   const PROCESS_ID = `patientRecordPage-zero-data-${DateTime.now().toMillis()}`;
   const resourceHandler = new ResourceHandler(PROCESS_ID);
 
@@ -1743,7 +1743,9 @@ test.describe('Patient Record Page tests with zero patient data filled in', asyn
   });
 
   test.afterAll(async () => {
-    await resourceHandler.cleanupResources();
+    await resourceHandler.cleanupResources(page);
+    await page.close();
+    await context.close();
   });
 
   test('Check state, ethnicity, race, relationship to patient are required', async () => {

apps/intake/tests/specs/0_paperworkSetup/setup.spec.ts

@@ -145,7 +145,7 @@ function writeTestData(filename: string, data: unknown): void {
 //       fill in any paperwork.
 // ---------------------------------------------------------------------------------------------------------------------
 
-test.describe.parallel('In-Person: Create test patients and appointments', () => {
+test.describe.parallel('In-Person: Create test patients and appointments', { tag: '@smoke' }, () => {
   test('Create patient without responsible party, with card payment, filling only required fields', async ({
     page,
   }) => {
@@ -309,7 +309,7 @@ test.describe.parallel('In-Person: Create test patients and appointments', () =>
   });
 });
 
-test.describe.parallel('Telemed: Create test patients and appointments', () => {
+test.describe.parallel('Telemed: Create test patients and appointments', { tag: '@smoke' }, () => {
   test('Create patient with responsible party, with insurance payment, filling all fields', async ({ page }) => {
     const { flowClass, paperwork } = await test.step('Set up playwright', async () => {
       addAppointmentToIdsAndAddMetaTag(page, processId);