forgejo/tests/e2e/utils_e2e.ts

import {expect, test as baseTest, type Browser, type BrowserContextOptions, type APIRequestContext, type TestInfo, type Page} from '@playwright/test';

import * as path from 'node:path';

const AUTH_PATH = 'tests/e2e/.auth';

type AuthScope = 'logout' | 'shared' | 'webauthn';

export type TestOptions = {
  forEachTest: void
  user: string | null;
  authScope: AuthScope;
};

export const test = baseTest.extend<TestOptions>({
  context: async ({browser, user, authScope, contextOptions}, use, {project}) => {
    if (user && authScope) {
      const browserName = project.name.toLowerCase().replace(' ', '-');
      contextOptions.storageState = path.join(AUTH_PATH, `state-${browserName}-${user}-${authScope}.json`);
    } else {
      // if no user is given, ensure to have clean state
      contextOptions.storageState = {cookies: [], origins: []};
    }

    return use(await test_context(browser, contextOptions));
  },
  user: null,
  authScope: 'shared',
});

export async function test_context(browser: Browser, options?: BrowserContextOptions) {
  const context = await browser.newContext(options);

  context.on('page', (page) => {
    page.on('pageerror', (err) => expect(err).toBeUndefined());
  });

  return context;
}

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: TestInfo, user: string) {
  test.setTimeout(60000);
  // Set up a new context
  const context = await test_context(browser);
  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.fill('input[name=user_name]', user);
  await page.fill('input[name=password]', LOGIN_PASSWORD);
  await page.click('form button.ui.primary.button:visible');

  await page.waitForLoadState();

  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: TestInfo, user: string) {
  try {
    return await test_context(browser, {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()?`);
    }
  }
}

export async function login({browser}: {browser: Browser}, workerInfo: TestInfo) {
  const context = await load_logged_in_context(browser, workerInfo, 'user2');
  return await context?.newPage();
}

export async function save_visual(page: Page) {
  // Optionally include visual testing
  if (process.env.VISUAL_TEST) {
    await page.waitForLoadState('domcontentloaded');
    // Mock/replace dynamic content which can have different size (and thus cannot simply be masked below)
    await page.locator('footer .left-links').evaluate((node) => node.innerHTML = 'MOCK');
    // replace timestamps in repos to mask them later down
    await page.locator('.flex-item-body > relative-time').filter({hasText: /now|minute/}).evaluateAll((nodes) => {
      for (const node of nodes) node.outerHTML = 'relative time in repo';
    });
    // dynamically generated UUIDs
    await page.getByText('dyn-id-').evaluateAll((nodes) => {
      for (const node of nodes) node.innerHTML = node.innerHTML.replaceAll(/dyn-id-[a-f0-9-]+/g, 'dynamic-id');
    });
    // repeat above, work around https://github.com/microsoft/playwright/issues/34152
    await page.getByText('dyn-id-').evaluateAll((nodes) => {
      for (const node of nodes) node.innerHTML = node.innerHTML.replaceAll(/dyn-id-[a-f0-9-]+/g, 'dynamic-id');
    });
    await page.locator('relative-time').evaluateAll((nodes) => {
      for (const node of nodes) node.outerHTML = 'time element';
    });
    // used for instance for security keys
    await page.locator('absolute-date').evaluateAll((nodes) => {
      for (const node of nodes) node.outerHTML = 'time element';
    });
    await expect(page).toHaveScreenshot({
      fullPage: true,
      timeout: 20000,
      mask: [
        page.locator('.ui.avatar'),
        page.locator('.sha'),
        page.locator('#repo_migrating'),
        // update order of recently created repos is not fully deterministic
        page.locator('.flex-item-main').filter({hasText: 'relative time in repo'}),
        page.locator('#activity-feed'),
        page.locator('#user-heatmap'),
        // dynamic IDs in fixed-size inputs
        page.locator('input[value*="dyn-id-"]'),
      ],
    });
  }
}

// Create a temporary user and login to that user and store session info.
// This should ideally run on a per test basis.
export async function create_temp_user(browser: Browser, workerInfo: TestInfo, request: APIRequestContext) {
  const username = globalThis.crypto.randomUUID();
  const newUser = await request.post(`/api/v1/admin/users`, {
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Basic ${btoa(`user1:${LOGIN_PASSWORD}`)}`,
    },
    data: {
      username,
      email: `${username}@host.invalid`,
      password: LOGIN_PASSWORD,
      must_change_password: false,
    },
  });
  expect(newUser.ok()).toBeTruthy();

  return {context: await login_user(browser, workerInfo, username), username};
}

// returns a random string with a pattern that can be filtered for screenshots automatically
export function dynamic_id() {
  return `dyn-id-${globalThis.crypto.randomUUID()}`;
}