Skip to content

Latest commit

 

History

History
727 lines (539 loc) · 22.5 KB

class-testconfig.md

File metadata and controls

727 lines (539 loc) · 22.5 KB
Raw

class: TestConfig

  • langs: js

Playwright Test provides many options to configure how your tests are collected and executed, for example timeout or testDir. These options are described in the [TestConfig] object in the configuration file.

Playwright Test supports running multiple test projects at the same time. Project-specific options should be put to [property: TestConfig.projects], but top-level [TestConfig] can also define base options shared between all projects.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  timeout: 30000,
  globalTimeout: 600000,
  reporter: 'list',
  testDir: './tests',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  timeout: 30000,
  globalTimeout: 600000,
  reporter: 'list',
  testDir: './tests',
};
export default config;

property: TestConfig.expect

  • type: ?<[Object]>
    • timeout ?<[int]> Default timeout for async expect matchers in milliseconds, defaults to 5000ms.
    • toHaveScreenshot ?<[Object]> Configuration for the [method: PageAssertions.toHaveScreenshot#1] method.
      • threshold ?<[float]> an acceptable perceived color difference in the YIQ color space between the same pixel in compared images, between zero (strict) and one (lax). Defaults to 0.2.
      • maxDiffPixels ?<[int]> an acceptable amount of pixels that could be different, unset by default.
      • maxDiffPixelRatio ?<[float]> an acceptable ratio of pixels that are different to the total amount of pixels, between 0 and 1 , unset by default.
      • animations ?<[ScreenshotAnimations]<"allow"|"disable">> See [option: animations] in [method: Page.screenshot]. Defaults to "disable".
      • caret ?<[ScreenshotCaret]<"hide"|"initial">> See [option: caret] in [method: Page.screenshot]. Defaults to "hide".
      • scale ?<[ScreenshotScale]<"css"|"device">> See [option: scale] in [method: Page.screenshot]. Defaults to "css".
    • toMatchSnapshot ?<[Object]> Configuration for the [method: ScreenshotAssertions.toMatchSnapshot#1] method.
      • threshold ?<[float]> an acceptable perceived color difference in the YIQ color space between the same pixel in compared images, between zero (strict) and one (lax). Defaults to 0.2.
      • maxDiffPixels ?<[int]> an acceptable amount of pixels that could be different, unset by default.
      • maxDiffPixelRatio ?<[float]> an acceptable ratio of pixels that are different to the total amount of pixels, between 0 and 1 , unset by default.

Configuration for the expect assertion library. Learn more about various timeouts.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  expect: {
    timeout: 10000,
    toMatchSnapshot: {
      maxDiffPixels: 10,
    },
  },
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  expect: {
    timeout: 10000,
    toMatchSnapshot: {
      maxDiffPixels: 10,
    },
  },
};
export default config;

property: TestConfig.forbidOnly

  • type: ?<[boolean]>

Whether to exit with an error if any tests or groups are marked as [method: Test.only] or [method: Test.describe.only]. Useful on CI.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  forbidOnly: !!process.env.CI,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  forbidOnly: !!process.env.CI,
};
export default config;

property: TestConfig.fullyParallel

  • type: ?<[boolean]>

Playwright Test runs tests in parallel. In order to achieve that, it runs several worker processes that run at the same time. By default, test files are run in parallel. Tests in a single file are run in order, in the same worker process.

You can configure entire test run to concurrently execute all tests in all files using this option.

property: TestConfig.globalSetup

  • type: ?<[string]>

Path to the global setup file. This file will be required and run before all the tests. It must export a single function that takes a [TestConfig] argument.

Learn more about global setup and teardown.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  globalSetup: './global-setup',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig, devices } from '@playwright/test';

const config: PlaywrightTestConfig = {
  globalSetup: './global-setup',
};
export default config;

property: TestConfig.globalTeardown

  • type: ?<[string]>

Path to the global teardown file. This file will be required and run after all the tests. It must export a single function. See also [property: TestConfig.globalSetup].

Learn more about global setup and teardown.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  globalTeardown: './global-teardown',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig, devices } from '@playwright/test';

const config: PlaywrightTestConfig = {
  globalTeardown: './global-teardown',
};
export default config;

property: TestConfig.globalTimeout

  • type: ?<[int]>

Maximum time in milliseconds the whole test suite can run. Zero timeout (default) disables this behavior. Useful on CI to prevent broken setup from running too long and wasting resources. Learn more about various timeouts.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  globalTimeout: process.env.CI ? 60 * 60 * 1000 : undefined,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  globalTimeout: process.env.CI ? 60 * 60 * 1000 : undefined,
};
export default config;

property: TestConfig.grep

  • type: ?<[RegExp]|[Array]<[RegExp]>>

Filter to only run tests with a title matching one of the patterns. For example, passing grep: /cart/ should only run tests with "cart" in the title. Also available in the command line with the -g option.

grep option is also useful for tagging tests.

property: TestConfig.grepInvert

  • type: ?<[RegExp]|[Array]<[RegExp]>>

Filter to only run tests with a title not matching one of the patterns. This is the opposite of [property: TestConfig.grep]. Also available in the command line with the --grep-invert option.

grepInvert option is also useful for tagging tests.

property: TestConfig.maxFailures

  • type: ?<[int]>

The maximum number of test failures for the whole test suite run. After reaching this number, testing will stop and exit with an error. Setting to zero (default) disables this behavior.

Also available in the command line with the --max-failures and -x options.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  maxFailures: process.env.CI ? 1 : 0,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  maxFailures: process.env.CI ? 1 : 0,
};
export default config;

property: TestConfig.metadata

  • type: ?<[Metadata]>

Metadata that will be put directly to the test report serialized as JSON.

property: TestConfig.name

  • type: ?<[string]>

Config name is visible in the report and during test execution, unless overridden by [property: TestProject.name].

property: TestConfig.outputDir

  • type: ?<[string]>

The output directory for files created during test execution. Defaults to <package.json-directory>/test-results.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  outputDir: './test-results',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig, devices } from '@playwright/test';

const config: PlaywrightTestConfig = {
  outputDir: './test-results',
};
export default config;

This directory is cleaned at the start. When running a test, a unique subdirectory inside the [property: TestConfig.outputDir] is created, guaranteeing that test running in parallel do not conflict. This directory can be accessed by [property: TestInfo.outputDir] and [method: TestInfo.outputPath].

Here is an example that uses [method: TestInfo.outputPath] to create a temporary file.

const { test, expect } = require('@playwright/test');
const fs = require('fs');

test('example test', async ({}, testInfo) => {
  const file = testInfo.outputPath('temporary-file.txt');
  await fs.promises.writeFile(file, 'Put some data to the file', 'utf8');
});
import { test, expect } from '@playwright/test';
import fs from 'fs';

test('example test', async ({}, testInfo) => {
  const file = testInfo.outputPath('temporary-file.txt');
  await fs.promises.writeFile(file, 'Put some data to the file', 'utf8');
});

property: TestConfig.snapshotDir

  • type: ?<[string]>

The base directory, relative to the config file, for snapshot files created with toMatchSnapshot. Defaults to [property: TestConfig.testDir].

The directory for each test can be accessed by [property: TestInfo.snapshotDir] and [method: TestInfo.snapshotPath].

This path will serve as the base directory for each test file snapshot directory. Setting snapshotDir to 'snapshots', the [property: TestInfo.snapshotDir] would resolve to snapshots/a.spec.js-snapshots.

property: TestConfig.preserveOutput

  • type: ?<[PreserveOutput]<"always"|"never"|"failures-only">>

Whether to preserve test output in the [property: TestConfig.outputDir]. Defaults to 'always'.

  • 'always' - preserve output for all tests;
  • 'never' - do not preserve output for any tests;
  • 'failures-only' - only preserve output for failed tests.

property: TestConfig.projects

  • type: ?<[Array]<[TestProject]>>

Playwright Test supports running multiple test projects at the same time. See [TestProject] for more information.

property: TestConfig.quiet

  • type: ?<[boolean]>

Whether to suppress stdio and stderr output from the tests.

property: TestConfig.repeatEach

  • type: ?<[int]>

The number of times to repeat each test, useful for debugging flaky tests.

property: TestConfig.reporter

  • type: ?<[string]|[Array]<[Object]>|[BuiltInReporter]<"list"|"dot"|"line"|"github"|"json"|"junit"|"null"|"html">>
    • 0 <[string]> Reporter name or module or file path
    • 1 <[Object]> An object with reporter options if any

The list of reporters to use. Each reporter can be:

  • A builtin reporter name like 'list' or 'json'.
  • A module name like 'my-awesome-reporter'.
  • A relative path to the reporter like './reporters/my-awesome-reporter.js'.

You can pass options to the reporter in a tuple like ['json', { outputFile: './report.json' }].

Learn more in the reporters guide.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  reporter: 'line',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  reporter: 'line',
};
export default config;

property: TestConfig.reportSlowTests

  • type: ?<[null]|[Object]>
    • max <[int]> The maximum number of slow test files to report. Defaults to 5.
    • threshold <[float]> Test duration in milliseconds that is considered slow. Defaults to 15 seconds.

Whether to report slow test files. Pass null to disable this feature.

Test files that took more than threshold milliseconds are considered slow, and the slowest ones are reported, no more than max number of them. Passing zero as max reports all test files that exceed the threshold.

property: TestConfig.retries

  • type: ?<[int]>

The maximum number of retry attempts given to failed tests. By default failing tests are not retried. Learn more about test retries.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  retries: 2,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  retries: 2,
};
export default config;

property: TestConfig.screenshotsDir

  • experimental
  • type: ?<[string]>

The base directory, relative to the config file, for screenshot files created with [method: PageAssertions.toHaveScreenshot#1]. Defaults to

<directory-of-configuration-file>/__screenshots__/<platform name>/<project name>

This path will serve as the base directory for each test file screenshot directory. For example, the following test structure:

smoke-tests/
└── basic.spec.ts

will result in the following screenshots folder structure:

__screenshots__/
└── darwin/
    ├── Mobile Safari/
    │   └── smoke-tests/
    │       └── basic.spec.ts/
    │           └── screenshot-expectation.png
    └── Desktop Chrome/
        └── smoke-tests/
            └── basic.spec.ts/
                └── screenshot-expectation.png

where:

  • darwin/ - a platform name folder
  • Mobile Safari and Desktop Chrome - project names

property: TestConfig.shard

  • type: ?<[null]|[Object]>
    • total <[int]> The total number of shards.
    • current <[int]> The index of the shard to execute, one-based.

Shard tests and execute only the selected shard. Specify in the one-based form like { total: 5, current: 2 }.

Learn more about parallelism and sharding with Playwright Test.

property: TestConfig.testDir

  • type: ?<[string]>

Directory that will be recursively scanned for test files. Defaults to the directory of the configuration file.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  testDir: './tests/playwright',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  testDir: './tests/playwright',
};
export default config;

property: TestConfig.testIgnore

  • type: ?<[string]|[RegExp]|[Array]<[string]|[RegExp]>>

Files matching one of these patterns are not executed as test files. Matching is performed against the absolute file path. Strings are treated as glob patterns.

For example, '**/test-assets/**' will ignore any files in the test-assets directory.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  testIgnore: '**/test-assets/**',
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig, devices } from '@playwright/test';

const config: PlaywrightTestConfig = {
  testIgnore: '**/test-assets/**',
};
export default config;

property: TestConfig.testMatch

  • type: ?<[string]|[RegExp]|[Array]<[string]|[RegExp]>>

Only the files matching one of these patterns are executed as test files. Matching is performed against the absolute file path. Strings are treated as glob patterns.

By default, Playwright Test looks for files matching .*(test|spec)\.(js|ts|mjs).

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  testMatch: /.*\.e2e\.js/,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig, devices } from '@playwright/test';

const config: PlaywrightTestConfig = {
  testMatch: /.*\.e2e\.js/,
};
export default config;

property: TestConfig.timeout

  • type: ?<[int]>

Timeout for each test in milliseconds. Defaults to 30 seconds.

This is a base timeout for all tests. In addition, each test can configure its own timeout with [method: Test.setTimeout]. Learn more about various timeouts.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  timeout: 5 * 60 * 1000,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  timeout: 5 * 60 * 1000,
};
export default config;

property: TestConfig.updateSnapshots

  • type: ?<[UpdateSnapshots]<"all"|"none"|"missing">>

Whether to update expected snapshots with the actual results produced by the test run. Defaults to 'missing'.

  • 'all' - All tests that are executed will update snapshots.
  • 'none' - No snapshots are updated.
  • 'missing' - Missing snapshots are created, for example when authoring a new test and running it for the first time. This is the default.

Learn more about snapshots.

property: TestConfig.use

  • type: ?<[TestOptions]>

Global options for all tests, for example [property: TestOptions.browserName]. Learn more about configuration and see [available options][TestOptions].

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  use: {
    browserName: 'chromium',
  },
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  use: {
    browserName: 'chromium',
  },
};
export default config;

property: TestConfig.webServer

  • type: ?<[Object]>
    • command <[string]> Shell command to start. For example npm run start..
    • port ?<[int]> The port that your http server is expected to appear on. It does wait until it accepts connections. Exactly one of port or url is required.
    • url ?<[string]> The url on your http server that is expected to return a 2xx status code when the server is ready to accept connections. Exactly one of port or url is required.
    • ignoreHTTPSErrors ?<[boolean]> Whether to ignore HTTPS errors when fetching the url. Defaults to false.
    • timeout ?<[int]> How long to wait for the process to start up and be available in milliseconds. Defaults to 60000.
    • reuseExistingServer ?<[boolean]> If true, it will re-use an existing server on the port or url when available. If no server is running on that port or url, it will run the command to start a new server. If false, it will throw if an existing process is listening on the port or url. This should be commonly set to !process.env.CI to allow the local dev server when running tests locally.
    • cwd ?<[string]> Current working directory of the spawned process, defaults to the directory of the configuration file.
    • env ?<[Object]<[string], [string]>> Environment variables to set for the command, process.env by default.

Launch a development web server during the tests.

If the port is specified, the server will wait for it to be available on 127.0.0.1 or ::1, before running the tests. If the url is specified, the server will wait for the URL to return a 2xx status code before running the tests.

For continuous integration, you may want to use the reuseExistingServer: !process.env.CI option which does not use an existing server on the CI. To see the stdout, you can set the DEBUG=pw:webserver environment variable.

The port (but not the url) gets passed over to Playwright as a [property: TestOptions.baseURL]. For example port 8080 produces baseURL equal http://localhost:8080.

:::note It is also recommended to specify [property: TestOptions.baseURL] in the config, so that tests could use relative urls. :::

// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';
const config: PlaywrightTestConfig = {
  webServer: {
    command: 'npm run start',
    port: 3000,
    timeout: 120 * 1000,
    reuseExistingServer: !process.env.CI,
  },
  use: {
    baseURL: 'http://localhost:3000/',
  },
};
export default config;
// playwright.config.js
// @ts-check
/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  webServer: {
    command: 'npm run start',
    port: 3000,
    timeout: 120 * 1000,
    reuseExistingServer: !process.env.CI,
  },
  use: {
    baseURL: 'http://localhost:3000/',
  },
};
module.exports = config;

Now you can use a relative path when navigating the page:

// test.spec.ts
import { test } from '@playwright/test';

test('test', async ({ page }) => {
  // This will result in http://localhost:3000/foo
  await page.goto('/foo');
});
// test.spec.js
const { test } = require('@playwright/test');

test('test', async ({ page }) => {
  // This will result in http://localhost:3000/foo
  await page.goto('/foo');
});

property: TestConfig.workers

  • type: ?<[int]>

The maximum number of concurrent worker processes to use for parallelizing tests.

Playwright Test uses worker processes to run tests. There is always at least one worker process, but more can be used to speed up test execution.

Defaults to one half of the number of CPU cores. Learn more about parallelism and sharding with Playwright Test.

// playwright.config.js
// @ts-check

/** @type {import('@playwright/test').PlaywrightTestConfig} */
const config = {
  workers: 3,
};

module.exports = config;
// playwright.config.ts
import { PlaywrightTestConfig } from '@playwright/test';

const config: PlaywrightTestConfig = {
  workers: 3,
};
export default config;