Pepper 1251 playwright place an order in mercury

.circleci/export-playwright-env.sh

@@ -9,6 +9,12 @@ echo "export SITE_PASSWORD=$sitePwd" >> playwright-env/envvars
 export bspToken=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.bsp | .[] | select(.env==\"$ENV\") | .token")
 echo "export BSP_TOKEN=$bspToken" >> playwright-env/envvars
 
+export pubsubTopicName=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.mercury | .[] | select(.env==\"$ENV\") | .pubsubTopicName")
+echo "export MERCURY_PUBSUB_TOPIC_NAME=$pubsubTopicName" >> playwright-env/envvars
+
+export pubsubProjectId=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.mercury | .[] | select(.env==\"$ENV\") | .pubsubProjectId")
+echo "export MERCURY_PUBSUB_PROJECT_ID=$pubsubProjectId" >> playwright-env/envvars
+
 export dsmUser1=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.users | .[] | select(.app==\"dsm\") | .users[0] | .userName")
 export dsmUser1Password=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.users | .[] | select(.app==\"dsm\") | .users[0] | .password")
 echo "export DSM_USER1_EMAIL=$dsmUser1" >> playwright-env/envvars

playwright-e2e/.env.sample

@@ -4,6 +4,8 @@ SITE_PASSWORD=
 
 # PEPPER 
 API_BASE_URL=https://pepper-dev.datadonationplatform.org
+MERCURY_PUBSUB_TOPIC_NAME=
+MERCURY_PUBSUB_PROJECT_ID=
 
 # ATCP
 ATCP_BASE_URL=https://atcp.dev.datadonationplatform.org

playwright-e2e/config/.env.dev

@@ -4,6 +4,8 @@ SITE_PASSWORD=
 
 # PEPPER 
 API_BASE_URL=https://pepper-dev.datadonationplatform.org
+MERCURY_PUBSUB_TOPIC_NAME=
+MERCURY_PUBSUB_PROJECT_ID=
 
 # ATCP
 ATCP_BASE_URL=https://atcp.dev.datadonationplatform.org

playwright-e2e/config/.env.test

@@ -4,6 +4,8 @@ SITE_PASSWORD=
 
 # PEPPER 
 API_BASE_URL=https://pepper-test.datadonationplatform.org
+MERCURY_PUBSUB_TOPIC_NAME=
+MERCURY_PUBSUB_PROJECT_ID=
 
 # ATCP
 ATCP_BASE_URL=https://atcp.test.datadonationplatform.org

playwright-e2e/dsm/enums.ts

@@ -11,16 +11,17 @@ export enum KitSampleType {
 }
 
 export enum DataFilter {
-  NOT_EMPTY = 'Not Empty',
-  EXACT_MATCH = 'Exact Match',
-  RANGE = 'Range',
   EMPTY = 'Empty',
   ENROLLED = 'Enrolled',
-  REQUEST = 'Request',
-  RECEIVED = 'Received',
+  EXACT_MATCH = 'Exact Match',
+  LOST_TO_FOLLOWUP = 'Lost to Followup',
   NO = 'No',
-  YES = 'Yes',
+  NOT_EMPTY = 'Not Empty',
+  RANGE = 'Range',
+  RECEIVED = 'Received',
   REGISTERED = 'Registered',
+  REQUEST = 'Request',
+  YES = 'Yes',
 }
 
 export enum FieldSettingInputType {
@@ -787,3 +788,24 @@ export enum ParticipantListPageOptions {
   SAVE_CURRENT_VIEW = 'Save Current View',
   SAVED_FILTERS = 'Saved Filters',
 }
+
+export enum SequencingOrderColumn {
+  SAMPLE_TYPE = 'Sample Type',
+  SAMPLE = 'Sample',
+  SAMPLE_STATUS = 'Sample Status',
+  COLLECTION_DATE = 'Collection Date',
+  LATEST_SEQUENCING_ORDER_DATE = 'Latest Sequencing Order Date',
+  LATEST_ORDER_STATUS = 'Latest Order Status',
+  LATEST_ORDER_NUMBER = 'Latest Order Number',
+  LATEST_PDO_NUMBER = 'Latest PDO Number',
+}
+
+export enum ClinicalOrdersColumn {
+  SHORT_ID = 'Short ID',
+  SAMPLE_TYPE = 'Sample Type',
+  SAMPLE = 'Sample',
+  ORDER_NUMBER = 'Order Number',
+  ORDER_DATE = 'Order Date',
+  STATUS = 'Status',
+  STATUS_DETAIL = 'Status Detail'
+}

playwright-e2e/dsm/pages/clinical-orders-page.ts

@@ -2,20 +2,30 @@ import { expect, Locator, Page } from '@playwright/test';
 
 export default class ClinicalOrdersPage {
   protected PAGE_TITLE = 'Clinical Orders';
+  private readonly DOWNLOAD_INFO = 'Download list includes additional fields "Order Message & Status Message"';
 
   constructor(private readonly page: Page) {}
 
   public async waitForReady(): Promise<void> {
     const downloadListButton = this.getDownloadListButton();
     const reloadListButton = this.getReloadListButton();
+    const downloadHelpText = this.getDownloadHelpText();
     const clinicalOrdersTable = await this.getClinicalOrdersTable();
     const amountOfClinicalOrders = clinicalOrdersTable.length;
 
     await expect(downloadListButton, 'Clinical Orders Page -> Download List button is not visible').toBeVisible();
     await expect(reloadListButton, 'Clinical Orders Page -> Reload List button is not visible').toBeVisible();
+    await expect(downloadHelpText, `Clinical Orders Page -> help text: "${this.DOWNLOAD_INFO}" is not visible`).toBeVisible();
     expect.soft(amountOfClinicalOrders).toBeGreaterThanOrEqual(1); //Just in case there's times where there aren't clinical orders
   }
 
+  public getClinicalOrderRow(opts: { sampleType: 'Normal' | 'Tumor', orderNumber: string }): Locator {
+    const { sampleType, orderNumber } = opts;
+    return this.page.locator(
+      `//app-clinical-page//td[contains(text(), '${orderNumber}')]/preceding-sibling::td[contains(text(), '${sampleType}')]/parent::tr`
+    );
+  }
+
   /* Locators */
   private getDownloadListButton(): Locator {
     return this.page.getByRole('button', { name: 'Download list' });
@@ -28,4 +38,8 @@ export default class ClinicalOrdersPage {
   private async getClinicalOrdersTable(): Promise<Locator[]> {
     return this.page.locator('//table//tbody//tr').all();
   }
+
+  private getDownloadHelpText(): Locator {
+    return this.page.getByText(this.DOWNLOAD_INFO);
+  }
 }

playwright-e2e/dsm/pages/participant-list-page.ts

@@ -730,4 +730,14 @@ export default class ParticipantListPage extends DsmPageBase {
     const { optionName } = opts;
     return this.page.locator(`//text()[normalize-space()='${optionName}']/preceding-sibling::button`);
   }
+
+  public async refreshParticipantListUsingShortID(opts: { ID: string }): Promise<void> {
+    const { ID } = opts;
+    const searchPanel = this.filters.searchPanel;
+    await searchPanel.open();
+    const shortIDField = this.page.locator(`//app-filter-column//input[contains(@data-placeholder, 'Short ID')]`);
+    await expect(shortIDField, 'Search Panel -> Short ID column is not visible, it may need to be added to the Participant List').toBeVisible();
+    await searchPanel.text(Label.SHORT_ID, { textValue: ID });
+    await searchPanel.search();
+  }
 }

playwright-e2e/dsm/pages/tablist/sequencing-order-tab.ts

@@ -1,12 +1,14 @@
 import { Locator, Page, expect } from '@playwright/test';
-import { getDate } from 'utils/date-utils';
+import { getDate, getDateinISOFormat, getToday } from 'utils/date-utils';
 import TabBase from './tab-base';
-import { Tab } from 'dsm/enums';
+import { SequencingOrderColumn, Tab } from 'dsm/enums';
+import { getColumnHeaderIndex } from 'utils/test-utils';
 
 export default class SequeuncingOrderTab extends TabBase {
   private readonly SAMPLE_ROW_XPATH = '//app-sequencing-order//tr';
   private readonly DATE_FIELD_XPATH = `//input[@data-placeholder='mm/dd/yyyy']`;
   private readonly NOT_ELIGIBLE_DUE_TO_RESIDENCE = `Error: Participant lives in New York or Canada and is not eligible for clinical sequencing`;
+  private readonly PLACE_CLINICAL_ORDER_MODAL_TEXT = `Are you sure you want to place a clinical sequencing order for the following samples:`;
 
   constructor(page: Page) {
     super(page, Tab.SEQUENCING_ORDER);
@@ -38,11 +40,35 @@ export default class SequeuncingOrderTab extends TabBase {
     await expect(placeOrderButton).not.toBeVisible();
   }
 
+  public async assertPlaceOrderButtonDisplayed(): Promise<void> {
+    const placeOrderButton = this.getPlaceOrderButton();
+    await placeOrderButton.scrollIntoViewIfNeeded();
+    await expect(placeOrderButton, 'The Place Order button is not visible to the current DSM user').toBeVisible();
+  }
+
   public async assertParticipantNotEligibleForClinicalSequencing(): Promise<void> {
     const validationMessage = this.page.getByText(this.NOT_ELIGIBLE_DUE_TO_RESIDENCE);
     await expect(validationMessage).toBeVisible();
   }
 
+  public async assertClinicalOrderModalDisplayed(): Promise<void> {
+    const placeOrderModal = this.page.locator(`//div[contains(text(), '${this.PLACE_CLINICAL_ORDER_MODAL_TEXT}')]`);
+    await placeOrderModal.scrollIntoViewIfNeeded();
+    await expect(placeOrderModal, 'Place Order modal is not visible - clinical order cannot be placed').toBeVisible();
+  }
+
+  public async closeClinicalOrderModal(): Promise<void> {
+    const button = this.page.locator(`//div[@class='modal-content']/div[@class='modal-footer']//button[normalize-space(text())='Close']`);
+    await expect(button, 'Clinical Order modal -> [Close] button is not visible').toBeVisible();
+    await button.click();
+  }
+
+  public async submitClinicalOrder(): Promise<void> {
+    const button = this.page.locator(`//div[@class='modal-content']/div[@class='modal-footer']//button[normalize-space(text())='Submit']`);
+    await expect(button, 'Clinical Order modal -> [Submit] button is not visible').toBeVisible();
+    await button.click();
+  }
+
   public async fillAvailableCollectionDateFields(opts: {canPlaceClinicalOrder?: boolean}): Promise<void> {
     const { canPlaceClinicalOrder = true } = opts;
     const collectionDateIndex = canPlaceClinicalOrder ? 5 : 4; //Index depending on whether test user has permission to place clinical order
@@ -95,6 +121,25 @@ export default class SequeuncingOrderTab extends TabBase {
     return this.toLocator.getByRole('button', { name: 'Place order' });
   }
 
+  public async selectSampleCheckbox(sample: Locator): Promise<void> {
+    const checkbox = sample.locator('//mat-checkbox');
+    await checkbox.click();
+  }
+
+  public async fillCollectionDateIfNeeded(normalSample: Locator): Promise<void> {
+    const collectionDateColumnIndex = await getColumnHeaderIndex(SequencingOrderColumn.COLLECTION_DATE, this.page);
+    const unfilledCollectionDateColumn = normalSample.locator(`//td[${collectionDateColumnIndex}]/app-field-datepicker//input`);
+    if (await unfilledCollectionDateColumn.isVisible()) {
+      await normalSample.locator(`//td[${collectionDateColumnIndex}]//button[normalize-space(text())='Today']`).click();
+
+      //Assert that the correct date was inputted
+      const today = getToday();
+      const collectionDateInISOFormat = getDateinISOFormat(today);
+      const collectionDateColumn = normalSample.locator(`//td[${collectionDateColumnIndex}]`);
+      await expect(collectionDateColumn).toHaveText(collectionDateInISOFormat);
+    }
+  }
+
   private getCheckboxOfSample(sample: Locator): Locator {
     return sample.locator('//mat-checkbox');
   }