跳到主要内容

测试生成器

简介​

Playwright 带有为您生成测试的能力，当您在浏览器中执行操作时，这是一种快速开始测试的好方法。Playwright 将查看您的页面并找出最佳的定位器，优先考虑 role、text 和 test id 定位器。如果生成器找到多个与定位器匹配的元素，它将改进定位器，使其具有唯一识别目标元素的弹性。

在 VS Code 中生成测试​

安装 VS Code 扩展程序并直接从 VS Code 生成测试。该扩展程序可在 VS Code Marketplace 上找到。请查看我们的 VS Code 入门指南。

录制新测试​

要录制测试，请单击测试侧边栏中的录制新按钮。这将创建一个 test-1.spec.ts 文件，并打开一个浏览器窗口。

record new in vs code

在浏览器中，转到您要测试的 URL，然后开始点击以录制您的用户操作。

generating user actions

Playwright 将记录您的操作，并在 VS Code 中直接生成测试代码。您还可以通过选择工具栏中的图标之一，然后单击页面上的元素进行断言来生成断言。可以生成以下断言

  • 'assert visibility' 以断言元素可见
  • 'assert text' 以断言元素包含特定文本
  • 'assert value' 以断言元素具有特定值

generating assertions

完成录制后，单击取消按钮或关闭浏览器窗口。然后，您可以检查您的 test-1.spec.ts 文件，并在需要时手动改进它。

code from a generated test

在光标处录制​

要从测试中的特定点开始录制，请将光标移动到您要录制更多操作的位置，然后单击测试侧边栏中的在光标处录制按钮。如果您的浏览器窗口尚未打开，请首先选中“显示浏览器”运行测试，然后单击在光标处录制按钮。

record at cursor in vs code

在浏览器窗口中，开始执行您要录制的操作。

add feed the dog to todo app

在 VS Code 中的测试文件中，您将看到新的生成操作添加到测试中的光标位置。

code from a generated test

生成定位器​

您可以使用测试生成器生成定位器。

  • 单击测试侧边栏中的选择定位器按钮，然后将鼠标悬停在浏览器窗口中的元素上，以查看每个元素下方突出显示的定位器。
  • 单击您需要的元素，它现在将显示在 VS Code 中的选择定位器框中。
  • 按键盘上的 Enter 键将定位器复制到剪贴板，然后粘贴到代码中的任何位置。或者，如果您想取消，请按 'escape' 键。
Pick locators in VS code

使用 Playwright Inspector 生成测试​

运行 codegen 命令时，将打开两个窗口，一个浏览器窗口，您可以在其中与要测试的网站进行交互，另一个 Playwright Inspector 窗口，您可以在其中录制测试，然后将其复制到编辑器中。

运行 Codegen​

使用 codegen 命令运行测试生成器，后跟您要为其生成测试的网站的 URL。URL 是可选的，您可以始终在不带 URL 的情况下运行该命令，然后直接将 URL 添加到浏览器窗口中。

npx playwright codegen demo.playwright.dev/todomvc

录制测试​

运行 codegen 命令并在浏览器窗口中执行操作。Playwright 将生成用户交互的代码，您可以在 Playwright Inspector 窗口中看到。完成录制测试后，停止录制并按复制按钮将生成的测试复制到您的编辑器中。

使用测试生成器，您可以录制

  • 诸如单击或填充之类的操作，只需与页面交互即可
  • 通过单击工具栏中的图标之一，然后单击页面上的元素进行断言来生成断言。您可以选择
    • 'assert visibility' 以断言元素可见
    • 'assert text' 以断言元素包含特定文本
    • 'assert value' 以断言元素具有特定值

Recording a test

​

完成与页面的交互后，按录制按钮停止录制，并使用复制按钮将生成的代码复制到您的编辑器中。

使用清除按钮清除代码以重新开始录制。完成后，关闭 Playwright inspector 窗口或停止终端命令。

生成定位器​

您可以使用测试生成器生成 定位器。

  • 按“'录制'”按钮停止录制，然后将出现“'选择定位器'”按钮。
  • 单击“'选择定位器'”按钮，然后将鼠标悬停在浏览器窗口中的元素上，以查看每个元素下方突出显示的定位器。
  • 要选择定位器，请单击您要定位的元素，该定位器的代码将出现在“选择定位器”按钮旁边的字段中。
  • 然后，您可以在此字段中编辑定位器以对其进行微调，或使用复制按钮复制它并将其粘贴到您的代码中。
​

picking a locator

模拟​

您可以使用测试生成器来生成使用模拟的测试，以便为特定的视口、设备、配色方案生成测试，以及模拟地理位置、语言或时区。测试生成器还可以在保留身份验证状态的同时生成测试。

模拟视口大小​

Playwright 打开一个浏览器窗口，其视口设置为特定的宽度和高度，并且不是响应式的，因为测试需要在相同的条件下运行。使用 --viewport 选项生成具有不同视口大小的测试。

npx playwright codegen --viewport-size="800,600" playwright.dev
​
Codegen generating code for tests for playwright.dev website with a specific viewport js

模拟设备​

使用 --device 选项录制脚本和测试，同时模拟移动设备，该选项设置视口大小和用户代理等。

npx playwright codegen --device="iPhone 13" playwright.dev
​
Codegen generating code for tests for playwright.dev website emulated for iPhone 13 js

模拟配色方案​

使用 --color-scheme 选项录制脚本和测试，同时模拟配色方案。

npx playwright codegen --color-scheme=dark playwright.dev
​
Codegen generating code for tests for playwright.dev website in dark mode js

模拟地理位置、语言和时区​

使用 --timezone、--geolocation 和 --lang 选项录制脚本和测试，同时模拟时区、语言和位置。页面打开后

  1. 接受 Cookie
  2. 在右上角，单击“定位我”按钮以查看地理位置的实际效果。
npx playwright codegen --timezone="Europe/Rome" --geolocation="41.890221,12.492348" --lang="it-IT" bing.com/maps
​
Codegen generating code for tests for bing maps showing timezone, geolocation as Rome, Italy and in Italian language

保留身份验证状态​

运行带有 --save-storage 的 codegen 以在会话结束时保存 cookies、localStorage 和 IndexedDB 数据。这对于单独记录身份验证步骤并在以后录制更多测试时重用它非常有用。

npx playwright codegen github.com/microsoft/playwright --save-storage=auth.json
​
github page before logging in js

登录​

执行身份验证并关闭浏览器后，auth.json 将包含存储状态，然后您可以在测试中重用它。

login to GitHub screen

确保您仅在本地使用 auth.json，因为它包含敏感信息。将其添加到您的 .gitignore 或在完成生成测试后将其删除。

加载身份验证状态​

运行带有 --load-storage 的命令以使用先前从 auth.json 加载的存储。这样，所有 cookies、localStorage 和 IndexedDB 数据都将被恢复，从而使大多数 Web 应用程序无需再次登录即可进入身份验证状态。这意味着您可以从登录状态继续生成测试。

npx playwright codegen --load-storage=auth.json github.com/microsoft/playwright
​
github signed in showing use of load storage js

使用自定义设置录制​

如果您想在某些非标准设置中使用 codegen（例如，使用 browserContext.route()），则可以调用 page.pause()，这将打开一个带有 codegen 控件的单独窗口。

const { chromium } = require('@playwright/test');

(async () => {
  // Make sure to run headed.
  const browser = await chromium.launch({ headless: false });

  // Setup context however you like.
  const context = await browser.newContext({ /* pass any options */ });
  await context.route('**/*', route => route.continue());

  // Pause the page, and start recording manually.
  const page = await context.newPage();
  await page.pause();
})();