Playwright Test 并行运行测试。为了实现这一点,它运行多个同时运行的工作进程。默认情况下,测试文件并行运行。单个文件中的测试在同一工作进程中按顺序运行。
你可以使用 test.describe.configure 配置测试以并行运行单个文件中的测试。
你可以将整个项目配置为使用 testProject.fullyParallel 或 testConfig.fullyParallel 并行运行所有文件中的所有测试。
要禁用并行性,请限制 工作线程对一 的数量。
你可以控制整个测试套件中 并行工作进程 和 限制失败次数 的数量以提高效率。
工作进程
所有测试都在工作进程中运行。这些进程是操作系统进程,独立运行,由测试运行器编排。所有工作线程都有相同的环境,并且每个工作线程都启动自己的浏览器。
工作线程之间无法沟通。Playwright Test 尽可能地重用单个 Worker 来提高测试速度,因此多个测试文件通常在单个 Worker 中依次运行。
工作线程在 测试失败 后总是关闭,以保证后续测试的原始环境。
限制工作线程
你可以通过 命令行 或 配置文件 来控制并行工作进程的最大数量。
从命令行:
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() 并行运行它们。
请注意,并行测试在单独的工作进程中执行,不能共享任何状态或全局变量。每个测试只为自己执行所有相关的钩子,包括 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,
},
]
});
串行模式
你可以将相互依赖的测试注释为串行。如果其中一项串行测试失败,则跳过所有后续测试。一组中的所有测试都会一起重试。
注意
不建议使用串口。通常最好将测试隔离起来,这样它们就可以独立运行。
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.nodejs.cn/');
});
test('runs second', async () => {
await page.getByText('Get Started').click();
});
多台机器之间的分片测试
Playwright Test 可以对测试套件进行分片,以便可以在多台机器上执行。详细信息请参见 分片指南。
npx playwright test --shard=2/3
限制失败并快速失败
你可以通过设置 maxFailures 配置选项或传递 --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,
});
Worker 索引和并行索引
每个工作进程分配有两个 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' }],
});
现在,每个测试文件应该从我们的装置文件导入 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 等。