Structure de projet Playwright

Après avoir initialisé avec succès un projet Playwright, une série de fichiers et de dossiers sera générée dans le répertoire de votre projet. Ce chapitre explique en détail le rôle de chaque partie.


Aperçu de la structure du projet initialisé

Exécuteznpm init playwright@latestEnsuite, la structure suivante sera générée dans le répertoire du projet :

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 — Fichier de configuration

Il s'agit du fichier de configuration principal de Playwright, qui contrôle tous les aspects de l'exécution des tests.

Exemple

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

export default defineConfig({
  // Répertoire des fichiers de test, relatif à ce fichier de configuration
  testDir: './tests',

  // Exécuter tous les tests entièrement en parallèle
  fullyParallel: true,

  // Si test.only est laissé dans le code source, la compilation échoue sur CI
  forbidOnly: !!process.env.CI,

  // Réessayer 2 fois en cas d'échec dans l'environnement CI, aucun réessai en local
  retries: process.env.CI ? 2 : 0,

  // Utiliser un seul worker dans l'environnement CI, et par défaut plusieurs workers en local
  workers: process.env.CI ? 1 : undefined,

  // Utiliser le reporter HTML
  reporter: 'html',

  // Configuration partagée par tous les tests
  use: {
    // URL de base, utilisez simplement des chemins relatifs dans les tests
    baseURL: 'http://localhost:3000',

    // Collecter la trace lors d'un réessai après échec
    trace: 'on-first-retry',
  },

  // Configuration de projet pour plusieurs navigateurs/appareils
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
    },
    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'] },
    },
    {
      name: 'webkit',
      use: { ...devices['Desktop Safari'] },
    },
  ],

  // Démarrer un serveur de développement local avant le début des tests (facultatif)
  // webServer: {
  // command: 'npm run start',
  // url: 'http://localhost:3000',
  // reuseExistingServer: !process.env.CI,
  // },
});

playwright.config.tsC'est le point d'entrée principal qui contrôle le comportement de Playwright. Le chapitre 15 expliquera chaque option de configuration en détail.


package.json — Dépendances et scripts

Après l'initialisation,package.jsonDu contenu lié à Playwright sera ajouté :

Exemple

{
  "devDependencies": {
    "@playwright/test": "^1.52.0"    // Playwright Test comme dépendance de développement
  },
  "scripts": {
    "test": "playwright test"         // Vous pouvez directement exécuter npm test
  }
}

Vous pouvez également ajouter d'autres scripts personnalisés :

Exemple

{
  "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"
  }
}

répertoire tests/ — Fichiers de test

tests/Ce répertoire est l'emplacement par défaut des fichiers de test (spécifié partestDirla configuration).

Le fichier de test d'exemple initialisé est le suivant :

Exemple

// Chemin du fichier : tests/example.spec.ts
import { test, expect } from '@playwright/test';

test('a un titre', async ({ page }) => {
  // Naviguer vers le site Web Playwright
  await page.goto('https://playwright.dev/');

  // Vérifier que le titre de la page contient "Playwright"
  await expect(page).toHaveTitle(/Playwright/);
});

test('lien de démarrage', async ({ page }) => {
  // Naviguer vers le site Web Playwright
  await page.goto('https://playwright.dev/');

  // Cliquer sur le lien "Get started"
  await page.getByRole('link', { name: 'Get started' }).click();

  // Vérifier que le titre "Installation" apparaît sur la page
  await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();
});

Convention de nommage pour les fichiers de test : utilisez.spec.ts(TypeScript) ou.spec.js(JavaScript) suffixe.


répertoire tests-examples/ — Plus d'exemples

Si vous avez choisi d'inclure des exemples de tests lors de l'initialisation,tests-examples/alors le répertoire contiendra un exemple de test plus complet :

demo-todo-app.spec.tsIl démontre des scénarios de test complets pour une véritable application Todo, y compris l'ajout de tâches, le basculement du statut d'achèvement, la fonctionnalité de filtrage, et plus encore.

C'est une excellente référence d'apprentissage. Vous pouvez l'exécuter pour voir l'effet :

npx playwright test tests-examples/

.github/workflows/ — configuration CI

Si vous avez choisi d'ajouter GitHub Actions lors de l'initialisation,.github/workflows/playwright.ymlle fichier sera généré automatiquement.

Ce workflow exécute automatiquement les tests Playwright à chaque fois que du code est poussé ou qu'une PR est créée.


Emplacement de stockage du navigateur

Les binaires de navigateur installés par Playwright ne se trouvent pas dans le répertoire du projet, mais sont stockés dans le répertoire de cache du système d'exploitation :

Système d'exploitationChemin de stockage du navigateur
macOS
~/Library/Caches/ms-playwright/
Windows
%USERPROFILE%\AppData\Local\ms-playwright\
Linux
~/.cache/ms-playwright/

Vous pouvez également définir un chemin de stockage personnalisé :

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

node_modules/ — Paquets de dépendances

Dépendances principales de Playwright@playwright/testsont installéesnode_modules/dans le répertoire node_modules/.

La dépendance contient en interne le runtime complet de Playwright, y compris la couche de protocole pour communiquer avec les navigateurs.

En plus des paquets Node.js installés via npm, Playwright dépend également de binaires de navigateur (stockés dans le cache système) ; les deux sont indispensables.

Autres extensions