跳转到主要内容

全局设置和拆卸

简介​

有两种方法可以配置全局设置和清理：使用全局设置文件并在配置中使用 globalSetup 选项，或者使用 project dependencies（项目依赖）。通过项目依赖，您可以定义一个在所有其他项目之前运行的项目。这是推荐的方法，因为它与 Playwright 测试运行器集成得更好：您的 HTML 报告将包含全局设置，将记录跟踪信息，并且可以使用 fixtures。有关这两种方法的详细比较，请参阅下表。

功能项目依赖（推荐）globalSetup（配置选项）
在所有测试之前运行✅ 是✅ 是
HTML 报告可见性✅ 显示为独立项目❌ 不显示
跟踪记录✅ 提供完整跟踪❌ 不支持
Playwright fixtures✅ 完全支持❌ 不支持
浏览器管理✅ 通过 browser fixture 实现❌ 完全手动通过 browserType.launch()
并行性和重试✅ 通过标准配置支持❌ 不适用
headless 或 testIdAttribute 等配置选项✅ 自动应用❌ 忽略

选项 1：项目依赖​

项目依赖是运行另一个项目中的测试之前需要运行的项目列表。它们对于配置全局设置操作非常有用，以便一个项目依赖于此设置的先运行。使用依赖项允许全局设置生成跟踪和其他工件。

设置​

首先，我们添加一个名为“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
});

清理​

您可以通过为设置项目添加 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'],
    },
  ]
});

然后，我们在项目测试目录中创建一个 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;