Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

4.6 KB
Raw Blame
/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { config as loadEnv } from 'dotenv';
loadEnv({ path: path.join(__dirname, '..', '..', '.env'), override: true, quiet: true });
process.env.PWTEST_UNDER_TEST = '1';

import { type Config, type PlaywrightTestOptions, type PlaywrightWorkerOptions, type ReporterDescription } from '@playwright/test';
import * as path from 'path';
import type { TestModeWorkerOptions } from '../config/testModeFixtures';

const headed = process.argv.includes('--headed');
const trace = !!process.env.PWTEST_TRACE;
const hasDebugOutput = process.env.DEBUG?.includes('pw:');

function firefoxUserPrefs() {
  const defaultPrefs = {
    'network.proxy.allow_hijacking_localhost': true,
    'network.proxy.testing_localhost_is_secure_when_hijacked': true,
    'remote.bidi.dismiss_file_pickers.enabled': true,
  };
  const prefsString = process.env.PWTEST_FIREFOX_USER_PREFS;
  if (!prefsString)
    return defaultPrefs;
  return { ...defaultPrefs, ...JSON.parse(prefsString) };
}
process.env.PLAYWRIGHT_PROXY_BYPASS_FOR_TESTING = '<-loopback>';

const outputDir = path.join(__dirname, '..', '..', 'test-results');
const testDir = path.join(__dirname, '..');
const reporters = () => {
  const result: ReporterDescription[] = process.env.CI ? [
    hasDebugOutput ? ['list'] : ['dot'],
    ['json', { outputFile: path.join(outputDir, 'report.json') }],
    ['blob'],
    ['../config/parquetReporter.ts'],
    ['./csvReporter', { outputFile: path.join(outputDir, 'report.csv') }],
    ['../config/expectationReporter', { rebase: false, expectationsDir: path.join(__dirname, 'expectations') }],
  ] : [
    ['html', { open: 'on-failure' }],
    ['./csvReporter', { outputFile: path.join(outputDir, 'report.csv') }],
    ['../config/expectationReporter', { rebase: false, expectationsDir: path.join(__dirname, 'expectations') }],
  ];
  return result;
};

const config: Config<PlaywrightWorkerOptions & PlaywrightTestOptions & TestModeWorkerOptions> = {
  testDir,
  outputDir,
  expect: {
    timeout: 10000,
  },
  tag: process.env.PW_TAG,
  maxFailures: 0,
  timeout: 15 * 1000,
  globalTimeout: 90 * 60 * 1000,
  workers: undefined,
  fullyParallel: !process.env.CI,
  forbidOnly: !!process.env.CI,
  retries: 0, // No retries even on CI for now.
  reporter: reporters(),
  projects: [],
};

type BrowserName = 'chromium' | 'firefox';

const getExecutablePath = (browserName: BrowserName) => {
  if (browserName === 'chromium')
    return process.env.BIDI_CRPATH;
  if (browserName === 'firefox')
    return process.env.BIDI_FFPATH;
};

const browserToChannels = {
  'chromium': ['bidi-chromium', 'bidi-chrome-canary', 'bidi-chrome'],
  'firefox': ['moz-firefox', 'moz-firefox-beta', 'moz-firefox-nightly'],
};

for (const [key, channels] of Object.entries(browserToChannels)) {
  const browserName: any = key;
  const executablePath = getExecutablePath(browserName);
  if (executablePath && !process.env.TEST_WORKER_INDEX)
    console.error(`Using executable at ${executablePath}`);
  for (const channel of channels) {
    const testIgnore: RegExp[] = [
      /library\/inspector/,
      /page\/page-leaks.spec.ts/,
    ];
    if (browserName.toLowerCase().includes('firefox'))
      testIgnore.push(/chromium/);
    if (browserName.toLowerCase().includes('chromium'))
      testIgnore.push(/firefox/);
    for (const folder of ['library', 'page']) {
      config.projects.push({
        name: `${channel}-${folder}`,
        testDir: path.join(testDir, folder),
        testIgnore,
        snapshotPathTemplate: `{testDir}/{testFileDir}/{testFileName}-snapshots/{arg}-${channel}{ext}`,
        use: {
          browserName,
          headless: !headed,
          channel,
          video: 'off',
          launchOptions: {
            executablePath,
            firefoxUserPrefs: firefoxUserPrefs(),
          },
          trace: trace ? 'on' : undefined,
        },
        metadata: {
          platform: process.platform,
          docker: !!process.env.INSIDE_DOCKER,
          headless: !headed,
          browserName,
          channel,
          trace: !!trace,
        },
      });
    }
  }
}

export default config;