Структура проекта Playwright

После успешной инициализации проекта Playwright в каталоге вашего проекта будет создан ряд файлов и папок. В этой главе подробно объясняется назначение каждой части.


Обзор структуры инициализированного проекта

Запуститеnpm init playwright@latestПосле этого в каталоге проекта будет создана следующая структура:

your-project/
├── playwright.config.ts      # Playwright 配置文件
├── package.json              # 项目依赖与脚本
├── package-lock.json         # 依赖锁定文件
├── tests/                    # 测试文件目录
│   └── example.spec.ts       # 示例测试文件
├── tests-examples/           # 更多示例测试(可选)
│   └── demo-todo-app.spec.ts
├── .github/                  # GitHub Actions 配置(可选)
│   └── workflows/
│       └── playwright.yml
└── node_modules/             # npm 依赖包

playwright.config.ts — файл конфигурации

Это основной файл конфигурации Playwright, управляющий всеми аспектами запуска тестов.

Пример

// Путь к файлу: playwright.config.ts
import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  // Каталог тестовых файлов, относительно этого файла конфигурации
  testDir: './tests',

  // Запускать все тесты полностью параллельно
  fullyParallel: true,

  // Если test.only остаётся в исходном коде, сборка завершается с ошибкой на CI
  forbidOnly: !!process.env.CI,

  // Повторять 2 раза при сбое в окружении CI, локально без повторов
  retries: process.env.CI ? 2 : 0,

  // Использовать один воркер в окружении CI и несколько воркеров по умолчанию локально
  workers: process.env.CI ? 1 : undefined,

  // Использовать HTML-репортер
  reporter: 'html',

  // Конфигурация, общая для всех тестов
  использовать: {
    // Базовый URL, в тестах используйте только относительные пути
    baseURL: 'http://localhost:3000',

    // Собирать трассировку при повторной попытке после сбоя
    trace: 'on-first-retry',
  },

  // Конфигурация проекта для нескольких браузеров/устройств
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
    },
    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'] },
    },
    {
      name: 'webkit',
      use: { ...devices['Desktop Safari'] },
    },
  ],

  // Запустить локальный сервер разработки перед началом тестов (необязательно)
  // webServer: {
  // command: 'npm run start',
  // url: 'http://localhost:3000',
  // reuseExistingServer: !process.env.CI,
  // },
});

playwright.config.tsЭто основной входной файл, управляющий поведением Playwright. В главе 15 каждый параметр конфигурации будет подробно объяснён.


package.json — Зависимости и скрипты

После инициализации,package.jsonБудет добавлено содержимое, связанное с Playwright:

Пример

{
  "devDependencies": {
    "@playwright/test": "^1.52.0"    // Playwright Test как зависимость для разработки
  },
  "scripts": {
    "test": "playwright test"         // Вы можете напрямую запустить npm test
  }
}

Вы также можете добавить дополнительные пользовательские скрипты:

Пример

{
  "scripts": {
    "test": "playwright test",
    "test:ui": "playwright test --ui",
    "test:headed": "playwright test --headed",
    "test:chromium": "playwright test --project=chromium",
    "test:debug": "playwright test --debug",
    "codegen": "playwright codegen"
  }
}

каталог tests/ — Тестовые файлы

tests/Этот каталог — расположение по умолчанию для тестовых файлов (указанное вtestDirконфигурации).

Инициализированный пример тестового файла выглядит следующим образом:

Пример

// Путь к файлу: tests/example.spec.ts
import { test, expect } from '@playwright/test';

test('имеет заголовок', async ({ page }) => {
  // Перейти на сайт Playwright
  await page.goto('https://playwright.dev/');

  // Проверить, что заголовок страницы содержит "Playwright"
  await expect(page).toHaveTitle(/Playwright/);
});

test('ссылка «Get started»', async ({ page }) => {
  // Перейти на сайт Playwright
  await page.goto('https://playwright.dev/');

  // Кликнуть по ссылке "Get started"
  await page.getByRole('link', { name: 'Get started' }).click();

  // Проверить, что заголовок "Installation" отображается на странице
  await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();
});

Соглашение об именовании тестовых файлов: используйте.spec.ts(TypeScript) или.spec.js(JavaScript) суффикс.


каталог tests-examples/ — дополнительные примеры

Если вы выбрали включение примеров тестов при инициализации,tests-examples/то каталог будет содержать более полный пример теста:

demo-todo-app.spec.tsОн демонстрирует полные тестовые сценарии для реального Todo-приложения, включая добавление задач, переключение статуса выполнения, функциональность фильтрации и многое другое.

Это отличный учебный пример. Вы можете запустить его, чтобы увидеть результат:

npx playwright test tests-examples/

.github/workflows/ — конфигурация CI

Если вы выбрали добавление GitHub Actions при инициализации,.github/workflows/playwright.ymlфайл будет создан автоматически.

Этот рабочий процесс автоматически запускает тесты Playwright каждый раз при отправке кода или создании PR.


Расположение хранилища браузера

Браузерные бинарники, устанавливаемые Playwright, находятся не в каталоге проекта, а хранятся в каталоге кэша операционной системы:

Операционная системаПуть хранения браузеров
macOS
~/Library/Caches/ms-playwright/
Windows
%USERPROFILE%\AppData\Local\ms-playwright\
Linux
~/.cache/ms-playwright/

Вы также можете задать пользовательский путь хранения:

# 设置浏览器安装路径
export PLAYWRIGHT_BROWSERS_PATH=/your/custom/path
npx playwright install

node_modules/ — пакеты зависимостей

Основные зависимости Playwright@playwright/testустанавливаютсяnode_modules/в каталоге node_modules/.

Зависимость внутренне содержит полную среду выполнения Playwright, включая протокольный слой для связи с браузерами.

Помимо пакетов Node.js, установленных через npm, Playwright также зависит от бинарников браузеров (хранящихся в системном кэше); оба компонента незаменимы.

Другие расширения