全局设置和拆卸

简介

配置全局设置（setup）和拆除（teardown）有两种方式：使用全局设置文件并在配置中设置 globalSetup，或者使用项目依赖。使用项目依赖，你可以定义一个在所有其他项目之前运行的项目。这是推荐的方法，因为它能更好地与 Playwright 测试运行器集成：你的 HTML 报告将包含全局设置过程、支持录制追踪（trace）并可以使用夹具（fixtures）。有关这两种方法的详细比较，请参阅下表。

特性	项目依赖 (推荐)	`globalSetup` (配置选项)
在所有测试前运行	✅ 是	✅ 是
HTML 报告可见性	✅ 显示为独立项目	❌ 不显示
追踪（Trace）录制	✅ 支持完整追踪	❌ 不支持
Playwright 夹具（Fixtures）	✅ 完全支持	❌ 不支持
浏览器管理	✅ 通过 `browser` 夹具	❌ 完全手动通过 `browserType.launch()`
并行与重试	✅ 通过标准配置支持	❌ 不适用
配置选项（如 `headless` 或 `testIdAttribute`）	✅ 自动应用	❌ 被忽略

方案 1：项目依赖

项目依赖是一系列需要在其他项目测试运行之前先运行的项目。它们对于配置全局设置操作非常有用，可以确保某个项目依赖于这些操作先完成。使用依赖项允许全局设置生成追踪和其他工件。

设置（Setup）

首先，我们添加一个名为 'setup db' 的新项目。然后，我们为其提供一个 testProject.testMatch 属性，以匹配名为 global.setup.ts 的文件。

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

export default defineConfig({
  testDir: './tests',
  // ...
  projects: [
    {
      name: 'setup db',
      testMatch: /global\.setup\.ts/,
    },
    // {
    //   other project
    // }
  ]
});

然后，我们将 testProject.dependencies 属性添加到依赖于该设置项目的项目中，并将我们在上一步中定义的依赖项目名称传入数组中。

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

export default defineConfig({
  testDir: './tests',
  // ...
  projects: [
    {
      name: 'setup db',
      testMatch: /global\.setup\.ts/,
    },
    {
      name: 'chromium with db',
      use: { ...devices['Desktop Chrome'] },
      dependencies: ['setup db'],
    },
  ]
});

在这个示例中，'chromium with db' 项目依赖于 'setup db' 项目。接着，我们在项目根目录下创建一个设置测试（注意：设置和拆除代码必须通过调用 test() 函数定义为常规测试）。

tests/global.setup.ts
import { test as setup } from '@playwright/test';

setup('create new database', async ({ }) => {
  console.log('creating new database...');
  // Initialize the database
});

tests/menu.spec.ts
import { test, expect } from '@playwright/test';

test('menu', async ({ page }) => {
  // Your test that depends on the database
});

拆除（Teardown）

你可以通过向设置项目添加 testProject.teardown 属性来拆除你的设置。这将在所有依赖项目运行完毕后执行。

首先，我们向设置项目添加 testProject.teardown 属性，名称为 'cleanup db'，即我们在上一步中为拆除项目指定的名称。

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

export default defineConfig({
  testDir: './tests',
  // ...
  projects: [
    {
      name: 'setup db',
      testMatch: /global\.setup\.ts/,
      teardown: 'cleanup db',
    },
    {
      name: 'cleanup db',
      testMatch: /global\.teardown\.ts/,
    },
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
      dependencies: ['setup db'],
    },
  ]
});

然后，在项目的 tests 目录下创建一个 global.teardown.ts 文件。它将用于在所有测试运行完成后从数据库中删除数据。

tests/global.teardown.ts
import { test as teardown } from '@playwright/test';

teardown('delete database', async ({ }) => {
  console.log('deleting test database...');
  // Delete the database
});

测试过滤

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

你可以通过命令行传入 --no-deps 选项来忽略所有依赖项和拆除操作。此时仅会运行你直接选定的项目。

方案 2：配置 globalSetup 和 globalTeardown

你可以在配置文件中使用 globalSetup 选项，在运行所有测试之前执行一次设置。全局设置文件必须导出一个接受配置对象的单一函数。此函数将在所有测试开始前运行一次。

同样，使用 globalTeardown 在所有测试运行后执行一次清理工作。或者，让 globalSetup 返回一个函数，该函数将用作全局拆除。你可以通过环境变量将端口号、身份验证令牌等数据从全局设置传递给测试。

注意

请注意，globalSetup 和 globalTeardown 缺少某些功能——详见简介部分的详细比较。建议考虑使用项目依赖以获得完整的功能支持。

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

export default defineConfig({
  globalSetup: require.resolve('./global-setup'),
  globalTeardown: require.resolve('./global-teardown'),
});

示例

以下是一个全局设置示例，它进行一次身份验证并在测试中重用身份验证状态。它使用了配置文件中的 baseURL 和 storageState 选项。

global-setup.ts
import { chromium, type FullConfig } from '@playwright/test';

async function globalSetup(config: FullConfig) {
  const { baseURL, storageState } = config.projects[0].use;
  const browser = await chromium.launch();
  const page = await browser.newPage();
  await page.goto(baseURL!);
  await page.getByLabel('User Name').fill('user');
  await page.getByLabel('Password').fill('password');
  await page.getByText('Sign in').click();
  await page.context().storageState({ path: storageState as string });
  await browser.close();
}

export default globalSetup;

在配置文件中指定 globalSetup、baseURL 和 storageState。

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  globalSetup: require.resolve('./global-setup'),
  use: {
    baseURL: 'https://:3000/',
    storageState: 'state.json',
  },
});

测试启动时即已通过身份验证，因为我们指定了由全局设置填充的 storageState。

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

test('test', async ({ page }) => {
  await page.goto('/');
  // You are signed in!
});

你可以通过 process.env 将任意数据设置为环境变量，从而在测试中使用这些来自全局设置文件的数据。

global-setup.ts
import type { FullConfig } from '@playwright/test';

async function globalSetup(config: FullConfig) {
  process.env.FOO = 'some data';
  // Or a more complicated data structure as JSON:
  process.env.BAR = JSON.stringify({ some: 'data' });
}

export default globalSetup;

测试可以访问在全局设置中设置的 process.env 属性。

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

test('test', async ({ page }) => {
  // environment variables which are set in globalSetup are only available inside test().
  const { FOO, BAR } = process.env;

  // FOO and BAR properties are populated.
  expect(FOO).toEqual('some data');

  const complexData = JSON.parse(BAR);
  expect(BAR).toEqual({ some: 'data' });
});

在全局设置过程中捕获失败追踪

在某些情况下，捕获全局设置期间遇到的失败追踪可能很有用。为此，你必须在设置中启动追踪，并确保在抛出错误之前停止追踪。这可以通过将设置代码包装在 try...catch 块中来实现。以下是一个扩展了全局设置并捕获追踪的示例。

global-setup.ts
import { chromium, type FullConfig } from '@playwright/test';

async function globalSetup(config: FullConfig) {
  const { baseURL, storageState } = config.projects[0].use;
  const browser = await chromium.launch();
  const context = await browser.newContext();
  const page = await context.newPage();
  try {
    await context.tracing.start({ screenshots: true, snapshots: true });
    await page.goto(baseURL!);
    await page.getByLabel('User Name').fill('user');
    await page.getByLabel('Password').fill('password');
    await page.getByText('Sign in').click();
    await context.storageState({ path: storageState as string });
    await context.tracing.stop({
      path: './test-results/setup-trace.zip',
    });
    await browser.close();
  } catch (error) {
    await context.tracing.stop({
      path: './test-results/failed-setup-trace.zip',
    });
    await browser.close();
    throw error;
  }
}

export default globalSetup;

简介​

方案 1：项目依赖​

设置（Setup）​

拆除（Teardown）​

测试过滤​

更多示例​

方案 2：配置 globalSetup 和 globalTeardown​

示例​

在全局设置过程中捕获失败追踪​

简介