全局设置和拆卸

简介

有两种方法可以配置全局设置和拆卸：使用全局设置文件并在配置下的 globalSetup 中设置它，或者使用项目依赖项。使用项目依赖项，您可以定义一个在所有其他项目之前运行的项目。这是配置全局设置的推荐方法，因为使用项目依赖项，您的 HTML 报告将显示全局设置，跟踪查看器将记录设置的跟踪，并且可以使用夹具。

选项 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'],
    },
  ]
});

然后，我们在项目的 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
});

选项 2：配置 globalSetup 和 globalTeardown

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

类似地，使用 globalTeardown 在所有测试之后运行一些内容。或者，让 globalSetup 返回一个用作全局拆卸的函数。您可以通过环境变量将端口号、身份验证令牌等数据从全局设置传递到您的测试。

注意

使用 globalSetup 和 globalTeardown 不会生成跟踪或工件，并且配置文件中指定的 headless 或 testIdAttribute 等选项不会应用。如果您想生成跟踪和工件并尊重配置选项，请使用项目依赖项。

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://127.0.0.1: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：项目依赖项​

设置​

拆卸​

更多示例​

选项 2：配置 globalSetup 和 globalTeardown​

示例​

捕获全局设置期间的失败跟踪​

简介

选项 1：项目依赖项

设置

拆卸

更多示例

选项 2：配置 globalSetup 和 globalTeardown

示例

捕获全局设置期间的失败跟踪