add basic playwright tests

Author: devksingh4

.github/workflows/deploy-dev.yml

@@ -92,3 +92,8 @@ jobs:
         run: make dev_health_check
       - name: Run live testing
         run: make test_live_integration
+      - name: Run E2E testing
+        run: make test_e2e
+        env:
+          PLAYWRIGHT_USERNAME: ${{ secrets.PLAYWRIGHT_USERNAME }}
+          PLAYWRIGHT_PASSWORD: ${{ secrets.PLAYWRIGHT_PASSWORD }}

.github/workflows/deploy-prod.yml

@@ -90,6 +90,11 @@ jobs:
           python-version: 3.11
       - name: Run live testing
         run: make test_live_integration
+      - name: Run E2E testing
+        run: make test_e2e
+        env:
+          PLAYWRIGHT_USERNAME: ${{ secrets.PLAYWRIGHT_USERNAME }}
+          PLAYWRIGHT_PASSWORD: ${{ secrets.PLAYWRIGHT_PASSWORD }}
 
   deploy-prod:
     runs-on: ubuntu-latest

.gitignore

@@ -137,3 +137,7 @@ dist_ui/
 
 *.pyc
 __pycache__
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

Makefile

@@ -74,6 +74,9 @@ test_unit: install_test_deps
 	yarn prettier
 	yarn test:unit
 
+test_e2e: install_test_deps
+	yarn test:e2e
+
 dev_health_check:
 	curl -f https://$(application_key).aws.qa.acmuiuc.org/api/v1/healthz && curl -f https://manage.qa.acmuiuc.org
 

e2e/base.ts

@@ -0,0 +1,56 @@
+import { test as base } from '@playwright/test';
+import {
+  SecretsManagerClient,
+  GetSecretValueCommand,
+} from "@aws-sdk/client-secrets-manager";
+
+export const getSecretValue = async (
+  secretId: string,
+): Promise<Record<string, string | number | boolean> | null> => {
+  const smClient = new SecretsManagerClient();
+  const data = await smClient.send(
+    new GetSecretValueCommand({ SecretId: secretId }),
+  );
+  if (!data.SecretString) {
+    return null;
+  }
+  try {
+    return JSON.parse(data.SecretString) as Record<
+      string,
+      string | number | boolean
+    >;
+  } catch {
+    return null;
+  }
+};
+
+async function getSecrets() {
+  let response = { PLAYWRIGHT_USERNAME: '', PLAYWRIGHT_PASSWORD: '' }
+  let keyData;
+  if (!process.env.PLAYWRIGHT_USERNAME || !process.env.PLAYWRIGHT_PASSWORD || !process.env.JwtSigningKey) {
+    keyData = await getSecretValue('infra-core-api-config')
+  }
+  response['PLAYWRIGHT_USERNAME'] = process.env.PLAYWRIGHT_USERNAME || keyData ? keyData['playwright_username'] : '';
+  response['PLAYWRIGHT_PASSWORD'] = process.env.PLAYWRIGHT_PASSWORD || keyData ? keyData['playwright_password'] : '';
+  return response;
+}
+
+const secrets = await getSecrets();
+
+async function becomeUser(page) {
+  await page.goto('https://manage.qa.acmuiuc.org/login');
+  await page.getByRole('button', { name: 'Sign in with Illinois NetID' }).click();
+  await page.getByPlaceholder('[email protected]').click();
+  await page.getByPlaceholder('[email protected]').fill(secrets['PLAYWRIGHT_USERNAME']);
+  await page.getByPlaceholder('[email protected]').press('Enter');
+  await page.getByPlaceholder('Password').click();
+  await page.getByPlaceholder('Password').fill(secrets['PLAYWRIGHT_PASSWORD']);
+  await page.getByRole('button', { name: 'Sign in' }).click();
+  await page.getByRole('button', { name: 'No' }).click();
+}
+
+export const test = base.extend<{ becomeUser: (page) => Promise<void> }>({
+  becomeUser: async ({ }, use) => {
+    use(becomeUser)
+  },
+});

e2e/tests/login.spec.ts

@@ -0,0 +1,20 @@
+
+import { expect } from '@playwright/test';
+import { test } from '../base';
+import { describe } from 'node:test';
+
+describe("Login tests", () => {
+  test('A user can login and view the home screen', async ({ page, becomeUser }) => {
+    await becomeUser(page);
+    await expect(page.locator('a').filter({ hasText: 'Management Portal DEV ENV' })).toBeVisible();
+    await expect(page.locator('a').filter({ hasText: 'Events' })).toBeVisible();
+    await expect(page.locator('a').filter({ hasText: 'Ticketing/Merch' })).toBeVisible();
+    await expect(page.locator('a').filter({ hasText: 'IAM' })).toBeVisible();
+    await expect(page.getByRole('link', { name: 'ACM Logo Management Portal' })).toBeVisible();
+    await expect(page.getByRole('link', { name: 'P', exact: true })).toBeVisible();
+    await page.getByRole('link', { name: 'P', exact: true }).click();
+    await expect(page.getByLabel('PMy Account')).toContainText('Name Playwright Core User');
+    await expect(page.getByLabel('PMy Account')).toContainText('[email protected]');
+    expect(page.url()).toEqual('https://manage.qa.acmuiuc.org/home');
+  });
+})

package.json

@@ -21,7 +21,9 @@
     "test:unit-ui": "yarn test:unit --ui",
     "test:unit-watch": "vitest tests/unit",
     "test:live": "vitest tests/live",
-    "test:live-ui": "yarn test:live --ui"
+    "test:live-ui": "yarn test:live --ui",
+    "test:e2e": "playwright test",
+    "test:e2e-ui": "playwright test --ui"
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.624.0",
@@ -49,6 +51,7 @@
   },
   "devDependencies": {
     "@eslint/compat": "^1.1.1",
+    "@playwright/test": "^1.49.1",
     "@tsconfig/node20": "^20.1.4",
     "@types/node": "^22.1.0",
     "@types/pluralize": "^0.0.33",

playwright.config.ts

@@ -0,0 +1,43 @@
+import { defineConfig, devices } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './e2e/tests',
+  /* Run tests in files in parallel */
+  fullyParallel: false,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

src/common/config.ts

@@ -70,6 +70,7 @@ const environmentConfig: EnvironmentConfigType = {
     },
     UserRoleMapping: {
       "[email protected]": [AppRoles.TICKETS_SCANNER],
+      "kLkvWTYwNnJfBkIK7mBi4niXXHYNR7ygbV8utlvFxjw": allAppRoles
     },
     AzureRoleMapping: { AutonomousWriters: [AppRoles.EVENTS_MANAGER] },
     ValidCorsOrigins: [