(test) Create fixtures for automatic setup and teardown in e2e tests (#1640)

Author: gitcliff

e2e/core/test.ts

@@ -1,5 +1,7 @@
 import { type APIRequestContext, type Page, test as base } from '@playwright/test';
 import { api } from '../fixtures';
+import { type Patient } from '../types';
+import { generateRandomPatient, deletePatient } from '../commands';
 
 // This file sets up our custom test harness using the custom fixtures.
 // See https://playwright.dev/docs/test-fixtures#creating-a-fixture for details.
@@ -9,6 +11,7 @@ import { api } from '../fixtures';
 
 export interface CustomTestFixtures {
   loginAsAdmin: Page;
+  patient: Patient;
 }
 
 export interface CustomWorkerFixtures {
@@ -17,4 +20,16 @@ export interface CustomWorkerFixtures {
 
 export const test = base.extend<CustomTestFixtures, CustomWorkerFixtures>({
   api: [api, { scope: 'worker' }],
+  patient: [
+    async ({ api }, use) => {
+      const patient = await generateRandomPatient(api);
+      await use(patient);
+      try {
+        if (patient) await deletePatient(api, patient.uuid);
+      } catch (e) {
+        console.warn('Failed to delete patient:', e);
+      }
+    },
+    { scope: 'test', auto: true },
+  ],
 });

e2e/specs/active-visits.spec.ts

@@ -2,32 +2,22 @@ import { expect } from '@playwright/test';
 import type { Visit } from '@openmrs/esm-framework';
 import { test } from '../core';
 
-import {
-  createEncounter,
-  deleteEncounter,
-  deletePatient,
-  endVisit,
-  generateRandomPatient,
-  getProvider,
-  startVisit,
-} from '../commands';
+import { createEncounter, deleteEncounter, endVisit, getProvider, startVisit } from '../commands';
 import { HomePage } from '../pages';
 import { type Encounter, type Patient, type Provider } from '../types';
 
-let patient: Patient;
 let visit: Visit;
 let encounter: Encounter;
 let provider: Provider;
 const encounterNote = 'This is a test note';
 
-test.beforeEach(async ({ api }) => {
-  patient = await generateRandomPatient(api);
+test.beforeEach(async ({ api, patient }) => {
   visit = await startVisit(api, patient.uuid);
   provider = await getProvider(api);
   encounter = await createEncounter(api, patient.uuid, provider.uuid, encounterNote);
 });
 
-test('View active visits', async ({ page }) => {
+test('View active visits', async ({ page, patient }) => {
   const homePage = new HomePage(page);
   const openmrsIdentifier = patient.identifiers[0].display.split('=')[1].trim();
   const firstName = patient.person.display.split(' ')[0];
@@ -55,8 +45,7 @@ test('View active visits', async ({ page }) => {
   });
 });
 
-test.afterEach(async ({ api }) => {
+test.afterEach(async ({ api, patient }) => {
   await endVisit(api, patient.uuid);
   await deleteEncounter(api, encounter.uuid);
-  await deletePatient(api, patient.uuid);
 });

e2e/specs/appointments.spec.ts

@@ -1,20 +1,17 @@
 import { expect } from '@playwright/test';
 import { type Visit } from '@openmrs/esm-framework';
-import { generateRandomPatient, deletePatient, startVisit, endVisit } from '../commands';
-import { type Patient } from '../types';
+import { startVisit, endVisit } from '../commands';
 import { test } from '../core';
 import { AppointmentsPage } from '../pages';
 import dayjs from 'dayjs';
 
-let patient: Patient;
 let visit: Visit;
 
-test.beforeEach(async ({ api }) => {
-  patient = await generateRandomPatient(api);
+test.beforeEach(async ({ api, patient }) => {
   visit = await startVisit(api, patient.uuid);
 });
 
-test('Add, edit and cancel an appointment', async ({ page, api }) => {
+test('Add, edit and cancel an appointment', async ({ page, patient }) => {
   const appointmentsPage = new AppointmentsPage(page);
 
   await test.step('When I go to the Appointments page in the patient chart', async () => {
@@ -139,5 +136,4 @@ test('Add, edit and cancel an appointment', async ({ page, api }) => {
 
 test.afterEach(async ({ api }) => {
   await endVisit(api, visit.uuid);
-  await deletePatient(api, patient.uuid);
 });

e2e/specs/edit-patient.spec.ts

@@ -1,15 +1,9 @@
 import dayjs from 'dayjs';
 import { expect } from '@playwright/test';
 import { test } from '../core';
-import { deletePatient, generateRandomPatient, getPatient } from '../commands';
+import { getPatient } from '../commands';
 import { RegistrationAndEditPage } from '../pages';
-import { type Patient, type PatientRegistrationFormValues } from '../types';
-
-let patient: Patient;
-
-test.beforeEach(async ({ api }) => {
-  patient = await generateRandomPatient(api);
-});
+import { type PatientRegistrationFormValues } from '../types';
 
 const formValues: PatientRegistrationFormValues = {
   givenName: `Johnny`,
@@ -27,7 +21,7 @@ const formValues: PatientRegistrationFormValues = {
   email: 'johnnyronny@example.com',
 };
 
-test('Edit a patient', async ({ page, api }) => {
+test('Edit a patient', async ({ page, api, patient }) => {
   test.setTimeout(5 * 60 * 1000);
   const patientEditPage = new RegistrationAndEditPage(page);
 
@@ -101,7 +95,3 @@ test('Edit a patient', async ({ page, api }) => {
     expect(person.attributes[0].display).toBe(formValues.phone);
   });
 });
-
-test.afterEach(async ({ api }) => {
-  await deletePatient(api, patient.uuid);
-});

e2e/specs/patient-list.spec.ts

@@ -2,23 +2,14 @@
 import { test } from '../core';
 import { PatientListsPage } from '../pages';
 import { expect } from '@playwright/test';
-import {
-  addPatientToCohort,
-  deleteCohort,
-  deletePatient,
-  generateRandomCohort,
-  generateRandomPatient,
-  removePatientFromCohort,
-} from '../commands';
+import { addPatientToCohort, deleteCohort, generateRandomCohort, removePatientFromCohort } from '../commands';
 import { type Cohort, type CohortMember, type Patient } from '../types';
 
 let cohortMember: CohortMember;
 let cohortUuid: string;
 let cohort: Cohort;
-let patient: Patient;
 
 test.beforeEach(async ({ api }) => {
-  patient = await generateRandomPatient(api);
   cohort = await generateRandomCohort(api);
 });
 
@@ -67,7 +58,7 @@ test.skip('Create and edit a patient list', async ({ page }) => {
   });
 });
 
-test.skip('Manage patients in a list', async ({ api, page }) => {
+test.skip('Manage patients in a list', async ({ api, page, patient }) => {
   const patientListPage = new PatientListsPage(page);
 
   await test.step("When I visit a specific patient list's page", async () => {
@@ -94,6 +85,5 @@ test.afterEach(async ({ api }) => {
     await removePatientFromCohort(api, cohortMember.uuid);
   }
   await deleteCohort(api, cohortUuid);
-  await deletePatient(api, patient.uuid);
   await deleteCohort(api, cohort.uuid);
 });

e2e/specs/patient-search.spec.ts

@@ -1,16 +1,8 @@
 import { expect } from '@playwright/test';
 import { test } from '../core';
 import { HomePage } from '../pages';
-import { generateRandomPatient, deletePatient } from '../commands';
-import { type Patient } from '../types';
 
-let patient: Patient;
-
-test.beforeEach(async ({ api }) => {
-  patient = await generateRandomPatient(api);
-});
-
-test('Search patient by patient identifier', async ({ page, api }) => {
+test('Search patient by patient identifier', async ({ page, patient }) => {
   // extract details from the created patient
   const openmrsIdentifier = patient.identifiers[0].display.split('=')[1].trim();
   const firstName = patient.person.display.split(' ')[0];
@@ -43,7 +35,7 @@ test('Search patient by patient identifier', async ({ page, api }) => {
   });
 });
 
-test('Search patient by full name', async ({ page, api }) => {
+test('Search patient by full name', async ({ page, patient }) => {
   // extract details from the created patient
   const openmrsIdentifier = patient.identifiers[0].display.split('=')[1].trim();
   const firstName = patient.person.display.split(' ')[0];
@@ -84,7 +76,3 @@ test('Search patient by full name', async ({ page, api }) => {
     await expect(page).toHaveURL(`${process.env.E2E_BASE_URL}/spa/home`);
   });
 });
-
-test.afterEach(async ({ api }) => {
-  await deletePatient(api, patient.uuid);
-});

e2e/specs/return-to-patient-list.spec.ts

@@ -2,27 +2,18 @@
 import { test } from '../core';
 import { PatientListsPage } from '../pages';
 import { expect } from '@playwright/test';
-import {
-  addPatientToCohort,
-  deleteCohort,
-  deletePatient,
-  generateRandomCohort,
-  generateRandomPatient,
-  removePatientFromCohort,
-} from '../commands';
+import { addPatientToCohort, deleteCohort, generateRandomCohort, removePatientFromCohort } from '../commands';
 import { type Cohort, type CohortMember, type Patient } from '../types';
 
 let cohortMembership: CohortMember;
 let cohort: Cohort;
-let patient: Patient;
 
-test.beforeEach(async ({ api }) => {
-  patient = await generateRandomPatient(api);
+test.beforeEach(async ({ api, patient }) => {
   cohort = await generateRandomCohort(api);
   cohortMembership = await addPatientToCohort(api, cohort.uuid, patient.uuid);
 });
 
-test.skip('Return to patient list from the patient chart', async ({ page }) => {
+test.skip('Return to patient list from the patient chart', async ({ page, patient }) => {
   const patientListPage = new PatientListsPage(page);
 
   await test.step('When I navigate to the patient list', async () => {
@@ -48,7 +39,10 @@ test.skip('Return to patient list from the patient chart', async ({ page }) => {
   });
 });
 
-test.skip('Return to patient list after navigating to visits page from the patient chart', async ({ page }) => {
+test.skip('Return to patient list after navigating to visits page from the patient chart', async ({
+  page,
+  patient,
+}) => {
   const patientListPage = new PatientListsPage(page);
 
   await test.step('When I navigate to the patient list', async () => {
@@ -82,7 +76,7 @@ test.skip('Return to patient list after navigating to visits page from the patie
   });
 });
 
-test.skip('Return to patient list after navigating to visits and refreshing the page', async ({ page }) => {
+test.skip('Return to patient list after navigating to visits and refreshing the page', async ({ page, patient }) => {
   const patientListPage = new PatientListsPage(page);
 
   await test.step('When I navigate to the patient list', async () => {
@@ -120,7 +114,7 @@ test.skip('Return to patient list after navigating to visits and refreshing the
   });
 });
 
-test.skip('Return to patient list from the patient chart on a new tab', async ({ page, context }) => {
+test.skip('Return to patient list from the patient chart on a new tab', async ({ page, context, patient }) => {
   const patientListPage = new PatientListsPage(page);
   const locator = page.locator('table tbody tr td:nth-child(1) a');
   const pagePromise = context.waitForEvent('page');
@@ -163,6 +157,5 @@ test.skip('Return to patient list from the patient chart on a new tab', async ({
 
 test.afterEach(async ({ api }) => {
   await removePatientFromCohort(api, cohortMembership.uuid);
-  await deletePatient(api, patient.uuid);
   await deleteCohort(api, cohort.uuid);
 });