[Playwright] new e2e test for atcp self-consent enrollment (#2158)

* new playwright test for atcp self-consent enrollment

Author: aweng98

.circleci/config.yml

@@ -707,7 +707,7 @@ jobs:
             TESTS_FILE=$(circleci tests split --split-by=timings --timings-type=classname e2e_tests.txt)
             echo $TESTS_FILE
             npm run test:ci $TESTS_FILE
-          no_output_timeout: 3m # Default is 10m. Set shorter time to ensure CI fails faster if test hangs
+          no_output_timeout: 5m # Default is 10m. Set shorter time to ensure CI fails faster if test hangs
       - store_test_results:
           path: playwright-e2e/junit
       - store_artifacts:

.circleci/export-playwright-env.sh

@@ -77,3 +77,19 @@ export lmsUser=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".da
 export lmsUserPassword=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.users | .[] | select(.app==\"lms\") | .password")
 echo "export LMS_USER_PASSWORD=$lmsUserPassword" >> playwright-env/envvars
 echo "export LMS_USER_EMAIL=$lmsUser" >> playwright-env/envvars
+
+# ATCP
+export atcpUser=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.users | .[] | select(.app==\"atcp\") | .userName")
+export atcpUserPassword=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.users | .[] | select(.app==\"atcp\") | .password")
+echo "export ATCP_USER_EMAIL=$atcpUser" >> playwright-env/envvars
+echo "export ATCP_USER_PASSWORD=$atcpUserPassword" >> playwright-env/envvars
+
+# Read Auth0 ATCP client credentials
+export atcpDomain=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.auth0 | .[] | select(.app==\"atcp\" and .env==\"$ENV\") | .domain")
+export atcpAudience=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.auth0 | .[] | select(.app==\"atcp\" and .env==\"$ENV\") | .audience")
+export atcpClientId=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.auth0 | .[] | select(.app==\"atcp\" and .env==\"$ENV\") | .clientId")
+export atcpClientSecret=$(vault read --format=json secret/pepper/test/v1/e2e | jq -r ".data.auth0 | .[] | select(.app==\"atcp\" and .env==\"$ENV\") | .clientSecret")
+echo "export ATCP_AUTH0_DOMAIN=$atcpDomain" >> playwright-env/envvars
+echo "export ATCP_AUTH0_AUDIENCE=$atcpAudience" >> playwright-env/envvars
+echo "export ATCP_AUTH0_CLIENT_ID=$atcpClientId" >> playwright-env/envvars
+echo "export ATCP_AUTH0_CLIENT_SECRET=$atcpClientSecret" >> playwright-env/envvars

playwright-e2e/.env.sample

@@ -2,6 +2,17 @@
 
 SITE_PASSWORD=
 
+# ATCP
+ATCP_BASE_URL=https://atcp.dev.datadonationplatform.org
+ATCP_USER_EMAIL=
+ATCP_USER_PASSWORD=
+
+# ATCP Auth0 settings required to set email validated = true
+ATCP_AUTH0_DOMAIN=
+ATCP_AUTH0_AUDIENCE=
+ATCP_AUTH0_CLIENT_ID=
+ATCP_AUTH0_CLIENT_SECRET=
+
 # Singular
 SINGULAR_BASE_URL=
 SINGULAR_USER_EMAIL=

playwright-e2e/authentication/auth-atcp.ts

@@ -0,0 +1,50 @@
+import { Page } from '@playwright/test';
+import AtcpRegistrationPage from 'dss/pages/atcp/atcp-registration-page';
+import { generateEmailAlias } from 'utils/faker-utils';
+
+const { ATCP_USER_EMAIL, ATCP_USER_PASSWORD } = process.env;
+
+export async function login(page: Page, opts: { email?: string; password?: string } = {}): Promise<AtcpRegistrationPage> {
+  const { email = ATCP_USER_EMAIL, password = ATCP_USER_PASSWORD } = opts;
+  if (!email) {
+    throw Error('Invalid ATCP email');
+  }
+  if (!password) {
+    throw Error('Invalid ATCP password');
+  }
+  const loginLocator = '.Header a >> text="Sign In"';
+  await page.locator(loginLocator).click();
+
+  await page.locator('#login input#email').fill(email);
+  await page.locator('#login input#password').fill(password);
+  await page.click('button >> text="Sign In"');
+
+  const registrationPage = new AtcpRegistrationPage(page);
+  await registrationPage.waitForReady();
+  return registrationPage;
+}
+
+export async function createAccountWithEmailAlias(
+  page: Page,
+  opts: { email: string | undefined; password: string | undefined }
+): Promise<string> {
+  const { email, password } = opts;
+  if (!email) {
+    throw Error('Invalid parameters: User email is undefined or null.');
+  }
+  if (!password) {
+    throw Error('Invalid parameters: User password is undefined or null.');
+  }
+
+  const emailInput = page.locator('.sign-up input[name="email"][id="email"]');
+  const passwordInput = page.locator('.sign-up input[name="password"][id="password"]');
+  const passwordConfirmInput = page.locator('.sign-up input[name="password_confirm"][id="password_confirm"]');
+
+  const emailAlias = generateEmailAlias(email);
+  await emailInput.fill(emailAlias);
+  await passwordInput.fill(password);
+  await passwordConfirmInput.fill(password);
+  await page.locator('button#join-us').click();
+
+  return emailAlias;
+}

playwright-e2e/authentication/auth-base.ts

@@ -19,8 +19,8 @@ export async function fillInEmailPassword(
   await emailInput.fill(email);
   await passwordInput.fill(password);
 
-  const authPromise = waitForAuth ? page.locator('.auth0-loading').first().waitFor({ state: 'visible' }) : Promise.resolve();
-  const navigationPromise = waitForNavigation ? page.waitForNavigation({ waitUntil: 'load' }) : Promise.resolve();
+  const authPromise = waitForAuth ? page.locator('.auth0-loading').first().waitFor({ state: 'visible', timeout: 2000 }).catch() : Promise.resolve();
+  const navigationPromise = waitForNavigation ? page.waitForLoadState('load') : Promise.resolve();
   await Promise.all([authPromise, navigationPromise, page.locator('button[name="submit"]:visible, button[type="submit"]:visible').click()]);
 }
 

playwright-e2e/config/.env.dev

@@ -2,6 +2,17 @@
 
 SITE_PASSWORD=
 
+# ATCP
+ATCP_BASE_URL=https://atcp.dev.datadonationplatform.org
+ATCP_USER_EMAIL=
+ATCP_USER_PASSWORD=
+
+# ATCP Auth0 settings required to set email validated = true
+ATCP_AUTH0_DOMAIN=
+ATCP_AUTH0_AUDIENCE=
+ATCP_AUTH0_CLIENT_ID=
+ATCP_AUTH0_CLIENT_SECRET=
+
 # Singular
 SINGULAR_BASE_URL=https://singular.dev.datadonationplatform.org
 SINGULAR_USER_EMAIL=[email protected]

playwright-e2e/config/.env.staging

@@ -2,6 +2,17 @@
 
 SITE_PASSWORD=
 
+# ATCP
+ATCP_BASE_URL=https://atcp.staging.datadonationplatform.org
+ATCP_USER_EMAIL=
+ATCP_USER_PASSWORD=
+
+# ATCP Auth0 settings required to set email validated = true
+ATCP_AUTH0_DOMAIN=
+ATCP_AUTH0_AUDIENCE=
+ATCP_AUTH0_CLIENT_ID=
+ATCP_AUTH0_CLIENT_SECRET=
+
 # Singular
 SINGULAR_BASE_URL=https://singular.staging.datadonationplatform.org
 SINGULAR_USER_EMAIL=[email protected]

playwright-e2e/config/.env.test

@@ -2,6 +2,17 @@
 
 SITE_PASSWORD=
 
+# ATCP
+ATCP_BASE_URL=https://atcp.test.datadonationplatform.org
+ATCP_USER_EMAIL=
+ATCP_USER_PASSWORD=
+
+# ATCP Auth0 settings required to set email validated = true
+ATCP_AUTH0_DOMAIN=
+ATCP_AUTH0_AUDIENCE=
+ATCP_AUTH0_CLIENT_ID=
+ATCP_AUTH0_CLIENT_SECRET=
+
 # Singular
 SINGULAR_BASE_URL=https://singular.test.datadonationplatform.org
 SINGULAR_USER_EMAIL=[email protected]

playwright-e2e/data/fake-user.json

@@ -64,7 +64,10 @@
     "phone": "6177147000"
   },
   "secondDoctor": {
-    "name": "John Stack",
+    "firstName": "E2E",
+    "middleName": "PlaywrightTest",
+    "lastName": "Stark",
+    "fullName": "E2E PlaywrightTest Stark",
     "specialty": "PRIMARY_CARE",
     "phone": "6187247123",
     "hospital": "Brigham and Women's Hospital",

playwright-e2e/dsm/pages/kitUpload-page/kitUpload-page.ts

@@ -7,6 +7,7 @@ import {KitUploadInfo} from 'dsm/pages/kitUpload-page/models/kitUpload-model';
 import {StudyEnum} from 'dsm/component/navigation/enums/selectStudyNav-enum';
 import {KitUploadResponse} from 'dsm/pages/kitUpload-page/interfaces/kitUpload';
 import {kitUploadResponseEnum} from 'dsm/pages/kitUpload-page/enums/kitUploadResponse-enum';
+import path from 'path';
 
 export default class KitUploadPage {
   private readonly PAGE_TITLE = 'Kit Upload';
@@ -28,9 +29,9 @@ export default class KitUploadPage {
 
   public async uploadFile(kitType: KitTypeEnum, kitInfo: KitUploadInfo[], study: StudyEnum, testResultDir?: string) {
     const dir = testResultDir ? testResultDir : __dirname;
-    const path = `${dir}/${kitType}_${study}-${new Date().getTime()}.txt`;
-    createTextFileSync(path, this.T_HEAD + this.createKitUploadBody(kitInfo));
-    await this.fileInput.setInputFiles(path);
+    const filePath = path.join(dir, `${kitType}_${study}-${new Date().getTime()}.txt`);
+    createTextFileSync(dir, filePath, this.T_HEAD + this.createKitUploadBody(kitInfo));
+    await this.fileInput.setInputFiles(filePath);
 
     await expect(this.uploadKitsBtn, 'Kit Upload page - Upload Kits button is disabled').toBeEnabled();
 
@@ -42,7 +43,7 @@ export default class KitUploadPage {
       .textContent(), "Kit Upload page - Couldn't upload kits - something went wrong")
       .toEqual('All participants were uploaded.');
 
-    deleteFileSync(path);
+    deleteFileSync(filePath);
   }
 
   /* Helper functions */