跳至主要内容

库

简介​

Playwright 库提供了用于启动和与浏览器交互的统一 API，而 Playwright Test 则在此基础上提供了完全管理的端到端测试运行器和体验。

在大多数情况下，对于端到端测试，您将希望使用 @playwright/test（Playwright Test），而不是直接使用 playwright（Playwright 库）。要开始使用 Playwright Test，请遵循入门指南。

使用库时的差异​

库示例​

以下是直接使用 Playwright 库启动 Chromium、访问页面并检查其标题的示例

import { chromium, devices } from 'playwright';
import assert from 'node:assert';

(async () => {
  // Setup
  const browser = await chromium.launch();
  const context = await browser.newContext(devices['iPhone 11']);
  const page = await context.newPage();

  // The actual interesting bit
  await context.route('**.jpg', route => route.abort());
  await page.goto('https://example.com/');

  assert(await page.title() === 'Example Domain'); // 👎 not a Web First assertion

  // Teardown
  await context.close();
  await browser.close();
})();

使用 node my-script.js 运行它。

测试示例​

实现类似行为的测试将如下所示

import { expect, test, devices } from '@playwright/test';

test.use(devices['iPhone 11']);

test('should be titled', async ({ page, context }) => {
  await context.route('**.jpg', route => route.abort());
  await page.goto('https://example.com/');

  await expect(page).toHaveTitle('Example');
});

使用 npx playwright test 运行它。

主要区别​

需要注意的主要区别如下

库测试
安装npm install playwrightnpm init playwright@latest - 注意 install 与 init 的区别
安装浏览器安装 @playwright/browser-chromium、@playwright/browser-firefox 和/或 @playwright/browser-webkitnpx playwright install 或 npx playwright install chromium 用于安装单个浏览器
从以下位置导入playwright@playwright/test
初始化需要显式
  1. 选择要使用的浏览器，例如 chromium
  2. 使用 browserType.launch() 启动浏览器
  3. 使用 browser.newContext() 创建上下文，*并*显式传递任何上下文选项，例如 devices['iPhone 11']
  4. 使用 browserContext.newPage() 创建页面
每个测试都会开箱即用地提供一个隔离的 page 和 context，以及其他内置夹具。无需显式创建。如果测试在其参数中引用了这些内容，则测试运行器将为测试创建它们。（即延迟初始化）
断言没有内置的 Web-First 断言Web-First 断言，例如它们会自动等待并重试，直到条件满足。
清理需要显式
  1. 使用 browserContext.close() 关闭上下文
  2. 使用 browser.close() 关闭浏览器
无需显式关闭内置夹具；测试运行器将负责处理它。
运行使用库时，您将代码作为 Node 脚本运行，可能需要先进行一些编译。使用测试运行器时，您将使用 npx playwright test 命令。除了您的配置之外，测试运行器还将处理任何编译以及选择要运行的内容以及如何运行它。

除了上述内容外，Playwright Test 作为一个功能齐全的测试运行器，还包括

用法​

使用 npm 或 Yarn 将 Playwright 库安装到您的 Node.js 项目中。请参阅系统要求。

npm i -D playwright

您还需要安装浏览器 - 可以手动安装，也可以添加一个软件包来自动安装。

# Download the Chromium, Firefox and WebKit browser
npx playwright install chromium firefox webkit

# Alternatively, add packages that will download a browser upon npm install
npm i -D @playwright/browser-chromium @playwright/browser-firefox @playwright/browser-webkit

有关更多选项，请参阅管理浏览器。

安装完成后，您可以在 Node.js 脚本中导入 Playwright，并启动任意 3 个浏览器（chromium、firefox 和 webkit）。

const { chromium } = require('playwright');

(async () => {
  const browser = await chromium.launch();
  // Create pages, interact with UI elements, assert values
  await browser.close();
})();

Playwright API 是异步的，并返回 Promise 对象。我们的代码示例使用async/await 模式 来简化可读性。代码包装在一个未命名的异步箭头函数中，该函数正在自调用。

(async () => { // Start of async arrow function
  // Function code
  // ...
})(); // End of the function and () to invoke itself

第一个脚本​

在我们的第一个脚本中，我们将导航到 https://playwright.net.cn/ 并在 WebKit 中截取屏幕截图。

const { webkit } = require('playwright');

(async () => {
  const browser = await webkit.launch();
  const page = await browser.newPage();
  await page.goto('https://playwright.net.cn/');
  await page.screenshot({ path: `example.png` });
  await browser.close();
})();

默认情况下，Playwright 在无头模式下运行浏览器。要查看浏览器 UI，请在启动浏览器时传递 headless: false 标志。您还可以使用 slowMo 来减慢执行速度。在调试工具部分中了解详细信息。

firefox.launch({ headless: false, slowMo: 50 });

录制脚本​

命令行工具 可用于录制用户交互并生成 JavaScript 代码。

npx playwright codegen wikipedia.org

浏览器下载​

要下载 Playwright 浏览器，请运行

# Explicitly download browsers
npx playwright install

或者，您可以添加 @playwright/browser-chromium、@playwright/browser-firefox 和 @playwright/browser-webkit 软件包，以便在软件包安装期间自动下载相应的浏览器。

# Use a helper package that downloads a browser on npm install
npm install @playwright/browser-chromium

在防火墙或代理后面下载

传递 HTTPS_PROXY 环境变量以通过代理下载。

# Manual
HTTPS_PROXY=https://192.0.2.1 npx playwright install

# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
HTTPS_PROXY=https://192.0.2.1 npm install

从工件存储库下载

默认情况下，Playwright 从 Microsoft 的 CDN 下载浏览器。传递 PLAYWRIGHT_DOWNLOAD_HOST 环境变量以改为从内部工件存储库下载。

# Manual
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install

# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install

跳过浏览器下载

在某些情况下，希望完全避免浏览器下载，因为浏览器二进制文件将单独管理。这可以通过在安装软件包之前设置 PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD 变量来实现。

# When using @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm install

TypeScript 支持​

Playwright 包含对 TypeScript 的内置支持。类型定义将自动导入。建议使用类型检查来改善 IDE 体验。

在 JavaScript 中​

将以下内容添加到 JavaScript 文件的顶部，以便在 VS Code 或 WebStorm 中进行类型检查。

// @ts-check
// ...

或者，您可以使用 JSDoc 为变量设置类型。

/** @type {import('playwright').Page} */
let page;

在 TypeScript 中​

TypeScript 支持将开箱即用。类型也可以显式导入。

let page: import('playwright').Page;