跳转到主要内容

分片

简介​

默认情况下，Playwright 以并行方式运行测试文件，并力求最佳地利用机器的 CPU 核心。为了实现更大的并行化，您可以通过在多台机器上同时运行测试来进一步扩展 Playwright 测试执行。我们将这种操作模式称为“分片”。Playwright 中的分片意味着将测试分成更小的部分，称为“分片”。每个分片都像一个独立的作业，可以独立运行。其主要目的是为了加速测试运行时间而划分测试。

当您对测试进行分片时，每个分片都可以独立运行，利用可用的 CPU 核心。这有助于通过同时执行任务来加快测试过程。

在 CI 流水线中，每个分片都可以作为独立的作业运行，利用 CI 流水线中可用的硬件资源（例如 CPU 核心）来更快地运行测试。

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

要对测试套件进行分片，请在命令行中传递 --shard=x/y。例如，将套件分成四个分片，每个分片运行四分之一的测试

npx playwright test --shard=1/4
npx playwright test --shard=2/4
npx playwright test --shard=3/4
npx playwright test --shard=4/4

现在，如果您在不同的作业中并行运行这些分片，您的测试套件将快四倍完成。

请注意，Playwright 只能分片可并行运行的测试。默认情况下，这意味着 Playwright 将分片测试文件。了解并行指南中的其他选项。

平衡分片​

分片可以根据您是否使用 testProject.fullyParallel 选项以两种粒度级别进行。这会影响测试如何在分片之间进行平衡。

使用 fullyParallel 进行分片

当启用 fullyParallel: true 时，Playwright Test 会在多个分片之间并行运行单个测试，确保每个分片都均匀地分配测试。这允许测试级别的粒度，意味着每个分片都将尝试平衡它运行的单个测试的数量。这是确保分片时负载均匀分布的首选模式，因为 Playwright 可以根据测试总数优化分片执行。

不使用 fullyParallel 进行分片

在没有 fullyParallel 设置的情况下，Playwright Test 默认以文件级粒度进行，这意味着整个测试文件被分配到分片（请注意，同一个文件在不同的项目中可能会被分配到不同的分片）。在这种情况下，每个文件的测试数量可能会极大地影响分片分布。如果您的测试文件大小不均匀（即某些文件包含比其他文件多得多的测试），某些分片最终可能会运行明显更多的测试，而另一些分片可能会运行更少甚至没有测试。

要点

  • 使用 fullyParallel: true：测试在单个测试级别进行拆分，从而实现更平衡的分片执行。
  • 不使用 fullyParallel：测试在文件级别进行拆分，因此要平衡分片，保持测试文件小且大小均匀很重要。
  • 为了确保最有效地利用分片，尤其是在 CI 环境中，当目标是在分片之间实现平衡分布时，建议使用 fullyParallel: true。否则，您可能需要手动组织测试文件以避免不平衡。

合并来自多个分片的报告​

在前面的示例中，每个测试分片都有自己的测试报告。如果您想要一份包含所有分片所有测试结果的合并报告，您可以合并它们。

首先在 CI 上运行时将 blob 报告器添加到配置中

playwright.config.ts
export default defineConfig({
  testDir: './tests',
  reporter: process.env.CI ? 'blob' : 'html',
});

Blob 报告包含所有运行的测试及其结果以及所有测试附件（例如跟踪和屏幕截图差异）的信息。Blob 报告可以合并并转换为任何其他 Playwright 报告。默认情况下，blob 报告将生成到 blob-report 目录中。

要合并来自多个分片的报告，请将 blob 报告文件放入一个目录中，例如 all-blob-reports。Blob 报告名称包含分片编号，因此它们不会冲突。

然后，运行 npx playwright merge-reports 命令

npx playwright merge-reports --reporter html ./all-blob-reports

这将生成一个标准 HTML 报告到 playwright-report 目录中。

GitHub Actions 示例​

GitHub Actions 支持使用 在多个作业之间分片测试，通过 jobs.<job_id>.strategy.matrix 选项。matrix 选项将为所提供选项的每个可能组合运行一个单独的作业。

以下示例向您展示了如何配置一个作业以在四台机器上并行运行测试，然后将报告合并为一个报告。不要忘记将 reporter: process.env.CI ? 'blob' : 'html', 添加到您的 playwright.config.ts 文件中，如上述示例所示。

  1. 首先，我们在作业配置中添加一个 matrix 选项，其中包含 shardTotal: [4] 选项，其中包含我们要创建的分片总数，以及 shardIndex: [1, 2, 3, 4]，其中包含分片编号数组。
  2. 然后，我们使用 --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} 选项运行 Playwright 测试。这将为每个分片运行我们的测试命令。
  3. 最后，我们将 blob 报告上传到 GitHub Actions Artifacts。这将使 blob 报告可用于工作流中的其他作业。
.github/workflows/playwright.yml
name: Playwright Tests
on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  playwright-tests:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2, 3, 4]
        shardTotal: [4]
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-node@v4
      with:
        node-version: lts/*
    - name: Install dependencies
      run: npm ci
    - name: Install Playwright browsers
      run: npx playwright install --with-deps

    - name: Run Playwright tests
      run: npx playwright test --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}

    - name: Upload blob report to GitHub Actions Artifacts
      if: ${{ !cancelled() }}
      uses: actions/upload-artifact@v4
      with:
        name: blob-report-${{ matrix.shardIndex }}
        path: blob-report
        retention-days: 1
  1. 所有分片完成后，您可以运行一个单独的作业，该作业将合并报告并生成一个组合的 HTML 报告。为确保执行顺序，我们通过添加 needs: [playwright-tests] 使 merge-reports 作业依赖于我们分片的 playwright-tests 作业。
.github/workflows/playwright.yml
jobs:
...
  merge-reports:
    # Merge reports after playwright-tests, even if some shards have failed
    if: ${{ !cancelled() }}
    needs: [playwright-tests]

    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-node@v4
      with:
        node-version: lts/*
    - name: Install dependencies
      run: npm ci

    - name: Download blob reports from GitHub Actions Artifacts
      uses: actions/download-artifact@v4
      with:
        path: all-blob-reports
        pattern: blob-report-*
        merge-multiple: true

    - name: Merge into HTML Report
      run: npx playwright merge-reports --reporter html ./all-blob-reports

    - name: Upload HTML report
      uses: actions/upload-artifact@v4
      with:
        name: html-report--attempt-${{ github.run_attempt }}
        path: playwright-report
        retention-days: 14

您现在可以看到报告已合并，并且 GitHub Actions Artifacts 选项卡中提供了组合的 HTML 报告。

image

合并报告 CLI​

npx playwright merge-reports path/to/blob-reports-dir 从传递的目录读取所有 blob 报告并将它们合并为单个报告。

当合并来自不同操作系统的报告时，您需要提供一个明确的合并配置来消除歧义，以确定哪个目录应该用作测试根目录。

支持的选项

  • --reporter reporter-to-use

    要生成的报告。可以是多个报告器，用逗号分隔。

    示例

    npx playwright merge-reports --reporter=html,github ./blob-reports

  • --config path/to/config/file

    指定包含输出报告器的 Playwright 配置文件。使用此选项可向输出报告器传递其他配置。此配置文件可以与创建 blob 报告时使用的配置文件不同。

    示例

    npx playwright merge-reports --config=merge.config.ts ./blob-reports
    merge.config.ts
    export default {
      testDir: 'e2e',
      reporter: [['html', { open: 'never' }]],
    };