跳至主要内容

并行处理

简介​

Playwright Test 以并行方式运行测试。为了实现这一点，它会同时运行多个工作进程。默认情况下，测试文件是并行运行的。而单个文件中的测试则按顺序在同一个工作进程中运行。

您可以控制并行工作进程的数量，并限制整个测试套件中的失败次数以提高效率。

工作进程​

所有测试都在工作进程中运行。这些进程是操作系统进程，独立运行，由测试运行器协调。所有工作进程具有相同的环境，每个进程都会启动自己的浏览器。

你无法在工作进程之间进行通信。Playwright Test会尽可能重复使用单个工作进程以加快测试速度，因此多个测试文件通常会在同一个工作进程中依次运行。

在测试失败后，Workers总是会被关闭，以确保后续测试环境的纯净性。

限制工作线程数​

您可以通过命令行或在配置文件中控制并行工作进程的最大数量。

从命令行：

npx playwright test --workers 4

在配置文件中：

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

export default defineConfig({
  // Limit the number of workers on CI, use default locally
  workers: process.env.CI ? 2 : undefined,
});

禁用并行处理​

您可以通过限制任何时候只允许一个工作线程来禁用任何并行处理。可以在配置文件中设置workers: 1选项，或者在命令行中传入--workers=1参数。

npx playwright test --workers=1

在单个文件中并行化测试​

默认情况下，单个文件中的测试是按顺序运行的。如果您在一个文件中有许多独立的测试，您可能希望使用test.describe.configure()来并行运行它们。

请注意，并行测试在独立的worker进程中执行，无法共享任何状态或全局变量。每个测试仅为自己执行所有相关的钩子，包括beforeAll和afterAll。

import { test } from '@playwright/test';

test.describe.configure({ mode: 'parallel' });

test('runs in parallel 1', async ({ page }) => { /* ... */ });
test('runs in parallel 2', async ({ page }) => { /* ... */ });

或者，您可以在配置文件中选择将所有测试加入这个完全并行模式：

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

export default defineConfig({
  fullyParallel: true,
});

您也可以仅为少数项目选择完全并行模式：

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

export default defineConfig({
  // runs all tests in all files of a specific project in parallel
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
      fullyParallel: true,
    },
  ]
});

串行模式​

您可以将相互依赖的测试标注为串行。如果其中一个串行测试失败，所有后续测试将被跳过。组中的所有测试会一起重试。

note

不建议使用串行模式。通常更好的做法是让您的测试相互隔离，这样它们可以独立运行。

import { test, type Page } from '@playwright/test';

// Annotate entire file as serial.
test.describe.configure({ mode: 'serial' });

let page: Page;

test.beforeAll(async ({ browser }) => {
  page = await browser.newPage();
});

test.afterAll(async () => {
  await page.close();
});

test('runs first', async () => {
  await page.goto('https://playwright.dev/');
});

test('runs second', async () => {
  await page.getByText('Get Started').click();
});

在多台机器之间分片测试​

Playwright Test 可以将测试套件分片，以便在多台机器上执行。详情请参阅分片指南。

npx playwright test --shard=2/3

限制失败并快速失败​

您可以通过设置maxFailures配置选项或传递--max-failures命令行标志来限制整个测试套件中的失败测试数量。

当设置了"max failures"运行时，Playwright Test 将在达到这个失败测试数量后停止，并跳过任何尚未执行的测试。这对于避免在损坏的测试套件上浪费资源非常有用。

传递命令行选项：

npx playwright test --max-failures=10

在配置文件中设置：

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

export default defineConfig({
  // Limit the number of failures on CI to save resources
  maxFailures: process.env.CI ? 10 : undefined,
});

工作线程索引与并行索引​

每个工作进程被分配两个ID：一个从1开始的唯一工作索引，以及一个介于0和workers - 1之间的并行索引。当工作进程重启时（例如在失败后），新的工作进程具有相同的parallelIndex和一个新的workerIndex。

您可以从环境变量process.env.TEST_WORKER_INDEX和process.env.TEST_PARALLEL_INDEX中读取索引，或者通过testInfo.workerIndex和testInfo.parallelIndex访问它们。

在并行工作进程之间隔离测试数据​

您可以利用上面提到的process.env.TEST_WORKER_INDEX或testInfo.workerIndex来隔离不同工作线程上运行的测试之间的数据库用户数据。由同一工作线程运行的所有测试都会复用相同的用户。

创建playwright/fixtures.ts文件，该文件将创建dbUserName夹具并在测试数据库中初始化一个新用户。使用testInfo.workerIndex来区分不同的工作进程。

playwright/fixtures.ts
import { test as baseTest, expect } from '@playwright/test';
// Import project utils for managing users in the test database.
import { createUserInTestDatabase, deleteUserFromTestDatabase } from './my-db-utils';

export * from '@playwright/test';
export const test = baseTest.extend<{}, { dbUserName: string }>({
  // Returns db user name unique for the worker.
  dbUserName: [async ({ }, use) => {
    // Use workerIndex as a unique identifier for each worker.
    const userName = `user-${test.info().workerIndex}`;
    // Initialize user in the database.
    await createUserInTestDatabase(userName);
    await use(userName);
    // Clean up after the tests are done.
    await deleteUserFromTestDatabase(userName);
  }, { scope: 'worker' }],
});

现在，每个测试文件应该从我们的fixtures文件中导入test，而不是@playwright/test。

tests/example.spec.ts
// Important: import our fixtures.
import { test, expect } from '../playwright/fixtures';

test('test', async ({ dbUserName }) => {
  // Use the user name in the test.
});

控制测试顺序​

Playwright Test 默认按照声明顺序运行单个文件中的测试，除非您在单个文件中并行化测试。

无法保证跨文件测试执行的顺序，因为Playwright Test默认并行运行测试文件。但是，如果您禁用并行执行，则可以通过按字母顺序命名文件或使用"测试列表"文件来控制测试顺序。

按字母顺序排序测试文件​

当您禁用并行测试执行时，Playwright Test会按字母顺序运行测试文件。您可以使用一些命名约定来控制测试顺序，例如001-user-signin-flow.spec.ts、002-create-new-document.spec.ts等。

使用"测试列表"文件​

warning

不建议使用测试列表，仅作为尽力而为的支持。某些功能（如VS Code扩展和跟踪）可能无法与测试列表正常工作。

您可以将测试放在多个文件的辅助函数中。考虑以下示例，其中测试不是直接在文件中定义的，而是在一个包装函数中定义的。

feature-a.spec.ts
import { test, expect } from '@playwright/test';

export default function createTests() {
  test('feature-a example test', async ({ page }) => {
    // ... test goes here
  });
}

feature-b.spec.ts
import { test, expect } from '@playwright/test';

export default function createTests() {
  test.use({ viewport: { width: 500, height: 500 } });

  test('feature-b example test', async ({ page }) => {
    // ... test goes here
  });
}

您可以创建一个测试列表文件来控制测试的顺序 - 首先运行feature-b测试，然后运行feature-a测试。注意每个测试文件是如何被包裹在调用测试定义函数的test.describe()代码块中的。这样test.use()调用就只会影响单个文件中的测试。

test.list.ts
import { test } from '@playwright/test';
import featureBTests from './feature-b.spec.ts';
import featureATests from './feature-a.spec.ts';

test.describe(featureBTests);
test.describe(featureATests);

现在通过将workers设置为1来禁用并行执行，并指定您的测试列表文件。

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

export default defineConfig({
  workers: 1,
  testMatch: 'test.list.ts',
});
note

不要在辅助文件中直接定义测试。这可能导致意外结果，因为您的测试现在依赖于import/require语句的顺序。相反，应将测试包装在一个函数中，由测试列表文件显式调用，如上例所示。