first-commit

tests/e2e/utils_e2e.ts

@@ -0,0 +1,62 @@
+import {expect} from '@playwright/test';
+import {env} from 'node:process';
+import type {Browser, Page, WorkerInfo} from '@playwright/test';
+
+const ARTIFACTS_PATH = `tests/e2e/test-artifacts`;
+const LOGIN_PASSWORD = 'password';
+
+// log in user and store session info. This should generally be
+//  run in test.beforeAll(), then the session can be loaded in tests.
+export async function login_user(browser: Browser, workerInfo: WorkerInfo, user: string) {
+  // Set up a new context
+  const context = await browser.newContext();
+  const page = await context.newPage();
+
+  // Route to login page
+  // Note: this could probably be done more quickly with a POST
+  const response = await page.goto('/user/login');
+  expect(response?.status()).toBe(200); // Status OK
+
+  // Fill out form
+  await page.locator('input[name=user_name]').fill(user);
+  await page.locator('input[name=password]').fill(LOGIN_PASSWORD);
+  await page.click('form button.ui.primary.button:visible');
+
+  await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
+
+  expect(page.url(), {message: `Failed to login user ${user}`}).toBe(`${workerInfo.project.use.baseURL}/`);
+
+  // Save state
+  await context.storageState({path: `${ARTIFACTS_PATH}/state-${user}-${workerInfo.workerIndex}.json`});
+
+  return context;
+}
+
+export async function load_logged_in_context(browser: Browser, workerInfo: WorkerInfo, user: string) {
+  let context;
+  try {
+    context = await browser.newContext({storageState: `${ARTIFACTS_PATH}/state-${user}-${workerInfo.workerIndex}.json`});
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      throw new Error(`Could not find state for '${user}'. Did you call login_user(browser, workerInfo, '${user}') in test.beforeAll()?`);
+    }
+  }
+  return context;
+}
+
+export async function save_visual(page: Page) {
+  // Optionally include visual testing
+  if (env.VISUAL_TEST) {
+    await page.waitForLoadState('networkidle'); // eslint-disable-line playwright/no-networkidle
+    // Mock page/version string
+    await page.locator('footer div.ui.left').evaluate((node) => node.innerHTML = 'MOCK');
+    await expect(page).toHaveScreenshot({
+      fullPage: true,
+      timeout: 20000,
+      mask: [
+        page.locator('.secondary-nav span>img.ui.avatar'),
+        page.locator('.ui.dropdown.jump.item span>img.ui.avatar'),
+      ],
+    });
+  }
+}