项目

简介

项目（Project）是逻辑上归为一组、并使用相同配置运行的测试集合。我们使用项目以便可以在不同的浏览器和设备上运行测试。项目在 playwright.config.ts 文件中进行配置，一旦配置完成，你就可以在所有项目或仅在特定项目上运行测试。你也可以使用项目在不同的配置下运行相同的测试。例如，你可以在登录和未登录状态下运行相同的测试。

通过设置项目，你还可以使用不同的超时时间或重试次数来运行一组测试，或者针对不同的环境（如预发布环境和生产环境）运行一组测试，按包/功能拆分测试等。

为多个浏览器配置项目

通过使用项目，你可以在多个浏览器中运行测试，例如 chromium、webkit 和 firefox，以及品牌浏览器如 Google Chrome 和 Microsoft Edge。Playwright 还可以运行在模拟的平板电脑和移动设备上。请参阅设备参数注册表以获取所选桌面、平板电脑和移动设备的完整列表。

import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
    },

    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'] },
    },

    {
      name: 'webkit',
      use: { ...devices['Desktop Safari'] },
    },

    /* Test against mobile viewports. */
    {
      name: 'Mobile Chrome',
      use: { ...devices['Pixel 5'] },
    },
    {
      name: 'Mobile Safari',
      use: { ...devices['iPhone 12'] },
    },

    /* Test against branded browsers. */
    {
      name: 'Microsoft Edge',
      use: {
        ...devices['Desktop Edge'],
        channel: 'msedge'
      },
    },
    {
      name: 'Google Chrome',
      use: {
        ...devices['Desktop Chrome'],
        channel: 'chrome'
      },
    },
  ],
});

运行项目

Playwright 默认会运行所有项目。

npx playwright test

Running 7 tests using 5 workers

  ✓ [chromium] › example.spec.ts:3:1 › basic test (2s)
  ✓ [firefox] › example.spec.ts:3:1 › basic test (2s)
  ✓ [webkit] › example.spec.ts:3:1 › basic test (2s)
  ✓ [Mobile Chrome] › example.spec.ts:3:1 › basic test (2s)
  ✓ [Mobile Safari] › example.spec.ts:3:1 › basic test (2s)
  ✓ [Microsoft Edge] › example.spec.ts:3:1 › basic test (2s)
  ✓ [Google Chrome] › example.spec.ts:3:1 › basic test (2s)

使用 --project 命令行选项来运行单个项目。

npx playwright test --project=firefox

Running 1 test using 1 worker

  ✓ [firefox] › example.spec.ts:3:1 › basic test (2s)

VS Code 测试运行程序默认会在 Chrome 浏览器中运行你的测试。要运行在其他/多个浏览器上，请点击测试侧边栏中播放按钮的下拉菜单，选择另一个配置文件，或通过点击选择默认配置文件 (Select Default Profile) 并选择你希望运行测试的浏览器来修改默认配置文件。

选择特定的配置文件、多个配置文件或所有配置文件来运行测试。

为多个环境配置项目

通过设置项目，我们还可以使用不同的超时时间或重试次数运行一组测试，或针对不同环境运行一组测试。例如，我们可以针对预发布环境运行测试并设置 2 次重试，同时针对生产环境运行测试并不设置重试。

playwright.config.ts

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

export default defineConfig({
  timeout: 60000, // Timeout is shared between all tests.
  projects: [
    {
      name: 'staging',
      use: {
        baseURL: 'staging.example.com',
      },
      retries: 2,
    },
    {
      name: 'production',
      use: {
        baseURL: 'production.example.com',
      },
      retries: 0,
    },
  ],
});

将测试拆分为项目​

我们可以将测试拆分为项目，并使用过滤器来运行测试的子集。例如，我们可以创建一个项目，使用匹配特定文件名的过滤器来运行测试。然后，我们可以拥有另一组忽略特定测试文件的测试。

这是一个定义了通用超时时间和两个项目的示例。“Smoke”项目运行一小部分不带重试的测试，“Default”项目运行所有其他带有重试的测试。

playwright.config.ts

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

export default defineConfig({
  timeout: 60000, // Timeout is shared between all tests.
  projects: [
    {
      name: 'Smoke',
      testMatch: /.*smoke.spec.ts/,
      retries: 0,
    },
    {
      name: 'Default',
      testIgnore: /.*smoke.spec.ts/,
      retries: 2,
    },
  ],
});

依赖项

依赖项是一个项目列表，这些项目需要在另一个项目中的测试运行之前执行。它们对于配置全局设置操作非常有用，以便一个项目依赖于此操作的先行运行。使用项目依赖时，测试报告器将显示设置测试，追踪查看器 (Trace Viewer) 将记录设置过程的追踪。你可以使用检查器来检查设置测试追踪的 DOM 快照，也可以在设置中使用固件 (Fixtures)。

在此示例中，chromium、firefox 和 webkit 项目依赖于 setup 项目。

playwright.config.ts

import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  projects: [
    {
      name: 'setup',
      testMatch: '**/*.setup.ts',
    },
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
      dependencies: ['setup'],
    },
    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'] },
      dependencies: ['setup'],
    },
    {
      name: 'webkit',
      use: { ...devices['Desktop Safari'] },
      dependencies: ['setup'],
    },
  ],
});

运行顺序

当处理具有依赖项的测试时，依赖项将始终首先运行，并且一旦此项目中的所有测试都已通过，其他项目才会并行运行。

运行顺序

1. 'setup' 项目中的测试运行。一旦该项目中的所有测试都通过，依赖项目中的测试将开始运行。

2. 'chromium'、'webkit' 和 'firefox' 项目中的测试一起运行。默认情况下，这些项目将并行运行，并受最大工作进程限制。

如果存在多个依赖项，则这些项目依赖项将首先并行运行。如果依赖项中的测试失败，则依赖于该项目的测试将不会运行。

运行顺序

1. 'Browser Login' 和 'DataBase' 项目并行运行
   • 'Browser Login' 通过
   • ❌ 'DataBase' 失败！
2. 'e2e tests' 项目未运行！

清理 (Teardown)

你还可以通过向设置项目添加 testProject.teardown 属性来清理设置。清理工作将在所有依赖项目运行完毕后执行。有关更多信息，请参阅清理指南。

测试过滤

所有测试过滤选项，例如 --grep/--grep-invert、--shard，在命令行中直接按位置过滤，或使用 test.only()，都是直接选择要运行的主要测试。如果这些测试属于一个带有依赖项的项目，则这些依赖项中的所有测试也将运行。

你可以传递 --no-deps 命令行选项来忽略所有依赖项和清理操作。仅运行你直接选择的项目。

自定义项目参数

项目还可以用于通过自定义配置参数化测试——请查看这篇单独的指南。