IntelliJ IDEA 2025.1 Help

Playwright

Playwright 是一个开源的测试自动化框架。 它提供了一个高级 API,用于自动化 Chrome、 Firefox 和 Safari 等网络浏览器。

创建一个新的 Playwright 项目

  1. 在主菜单中,前往 文件 | 新建 | 项目

    或者, 如果您在 欢迎 屏幕上, 点击 新建项目

  2. 从左侧列表中选择 Playwright

    创建一个新的 Playwright 项目
  3. 如果需要,请命名新项目并更改其位置。

  4. 请指定 Node 解释器

  5. 指定安装 Playwright 的命令。

  6. 点击 创建

  1. 在主菜单中,前往 文件 | 新建 | 项目

    或者, 如果您在 欢迎 屏幕上, 点击 新建项目

  2. 从左侧列表中选择 适用于 JVM 的 Playwright

    创建新的 Playwright for JVM 项目
  3. 如果需要,请命名新项目并更改其位置。

  4. (可选)启用 创建Git 仓库 选项,将新项目置于版本控制之下。 如果您现在不想做,您可以随时稍后再做。

  5. 请选择您要使用的 语言

  6. 请选择您想在项目中使用的构建系统: MavenGradle

  7. 请选择您要用于测试用例管理的测试框架: JUnitTestNG

  8. (可选)修改 分组工件 参数。

  9. JDK 列表中选择您想在项目中使用的 JDK

    如果 JDK 已安装在您的计算机上,但未在 IDE 中定义,请选择 添加 JDK 并指定 JDK 主目录的路径。

    如果您的计算机上没有必要的 JDK,请选择 下载JDK

  10. (可选)启用 添加示例代码 参数。

  11. 点击 下一步

  12. 点击 创建

  1. 在主菜单中,前往 文件 | 新建 | 项目

    或者, 如果您在 欢迎 屏幕上, 点击 新建项目

  2. 从左侧列表中选择 适用于 Python 的 Playwright

    为 Python 创建一个新的 Playwright 项目
  3. 如果需要,请命名新项目并更改其位置。

  4. (可选)启用 创建Git 仓库 选项,将新项目置于版本控制之下。 如果您现在不想做,您可以随时稍后再做。

  5. 选择是否要创建一个新的或使用现有的 环境 并配置相应的设置。

    配置新的 Virtualenv 环境
    • 从列表中选择基础解释器,或者点击 选择基础解释器 并在您的文件系统中找到 Python 可执行文件。

    • 指定新虚拟环境的位置在 位置 字段中,或者点击 虚拟环境位置 并在您的文件系统中浏览位置。 新虚拟环境的目录应该是空的。

    • 如果您希望将机器上全局 Python 中安装的所有包添加到您将要创建的虚拟环境中,请选择 继承全局 site-packages 复选框。 此复选框对应 --system-site-packages 选项的 virtualenv 工具。

    • 如果您希望在 IntelliJ IDEA 中创建 Python interpreters 时重用此环境,请选择 向所有项目开放 复选框。

    有关更多信息,请参阅 PyCharm 文档

    配置一个新的 Conda 环境
    • 位置 字段中指定新 Conda 环境的位置,或点击 Conda 环境位置 并在文件系统中浏览位置。 新 conda 环境的目录应为空。

    • 从列表中选择 Python 版本。

    • 通常,IntelliJ IDEA 会检测到 conda 的安装。

      否则,指定 conda 可执行文件的位置,或点击 Conda 可执行文件位置 进行浏览。

    • 如果您希望在 IntelliJ IDEA 中创建 Python interpreters 时重用此环境,请选择 向所有项目开放 复选框。

    有关更多信息,请参阅 PyCharm 文档

    配置一个新的 Pipenv 环境
    • 从列表中选择基础解释器,或点击 选择基础解释器 并在您的文件系统中找到 Python 可执行文件。

    • 如果您已将基础二进制目录添加到您的 PATH 环境变量中,则无需设置任何其他选项:pipenv 可执行文件的路径将自动检测。

      如果未找到 pipenv 可执行文件,请按照 pipenv 安装程序 发现可执行文件路径,然后在对话框中指定它。

    有关更多信息,请参阅 PyCharm 文档

    配置一个新的 Poetry 环境
    • 从列表中选择基础解释器,或者点击 选择基础解释器 并在您的文件系统中找到 Python 可执行文件。

    • 如果 IntelliJ IDEA 未检测到 poetry 可执行文件,请在对话框中指定以下路径,将 jetbrains 替换为您的用户名:

      /Users/jetbrains/Library/Application Support/pypoetry/venv/bin/poetry
      C:\Users\jetbrains\AppData\Roaming\pypoetry\venv\Scripts\poetry.exe
      /home/jetbrains/.local/bin/poetry

    有关更多信息,请参阅 PyCharm 文档

    配置现有环境
    • 从列表中选择解释器。 如果没有可用的解释器,请点击 添加解释器 并根据您的需要配置一个。

  6. 点击 创建

根据您选择的选项,新项目已创建。

初始化 Playwright 项目

一旦项目创建完成,您需要初始化它。 在此过程中,您将选择所需的语言,安装 Playwright 浏览器,并指定其他设置。

项目初始化

开始项目初始化:

  1. 运行工具窗口 Alt+4 中,按键盘上的上/下箭头按钮选择您要在项目中使用的语言。

  2. 请输入您要放置端到端测试的文件夹名称。

  3. 请指定是否要添加 GitHub Actions 工作流

  4. 指定是否要安装 Playwright 浏览器。

当您指定所有参数时,初始化开始。 系统将通知您,一旦流程完成:

项目初始化成功

基于角色的定位器支持

在 Playwright 中,您可以通过其 角色定位元素。 这有助于准确定位页面上的特定元素,无论是按钮、复选框、标题、链接或其他元素。

IntelliJ IDEA 可以生成这些定位器并将其添加到您的代码中,以便您在测试中使用它们。

基于角色的定位器

向代码添加元素

  1. 打开您要添加元素的文件。

  2. 点击 Web Inspector 按钮 右侧边栏以打开 Web 检查器 工具栏窗口。

  3. 在地址栏中指定页面的 URL。

    地址栏控件
  4. 点击 页面中选择元素按钮 并在 Web Inspector 中选择您要添加的元素。

    在页面中选择元素
  5. 一旦选择了该元素,点击 将元素添加到代码 将该元素添加到代码中。

    将元素添加到代码按钮

    要添加特定类型的选择器(IDNameTag with classes等),请点击 通过以下方式将元素添加到代码: 并选择所需选项。

    通过向代码添加元素

    如果您想在 CSS 和 XPath 定位器之间切换,请点击 并选择所需的定位器类型。

    选择定位器类型

因此,一段代码被生成并添加到代码编辑器。

运行测试

  • 要运行您的测试,请点击测试类或测试方法旁边的 运行按钮 图标,然后从列表中选择 运行 选项。

    运行测试

    或者,将文本光标放在测试类上,以运行该类中的所有测试;或者将文本光标放在测试方法上,然后按下 Ctrl+Shift+F10

您可以使用 run/debug configurations 以更可定制的方式运行测试。 有关更多信息,请参见 运行测试

在可见模式下运行测试

在有界模式下运行测试使您能够直观地展示 Playwright 如何与网站进行交互。

要在有头模式下运行测试:

  1. 点击运行/调试配置切换器中的当前配置,然后点击 并选择 编辑(E) 选项。

    编辑运行/调试配置
  2. Playwright 选项 字段中,指定 --headed 命令:

    配置运行/调试配置以在有头模式下运行测试
  3. 应用更改并运行您的测试。

  1. 打开包含您想要在 headed 模式下运行的测试的文件。

  2. 请在您的代码中添加以下选项:

    launch(new BrowserType.LaunchOptions().setHeadless(false))
    将代码修改为在有界面模式下运行测试
  3. 运行您的测试。

  1. 点击运行/调试配置切换器中的当前配置,然后点击 并选择 编辑(E) 选项。

    编辑运行/调试配置
  2. 其他实参 字段中,指定 --headed 命令:

    配置运行/调试配置以在有头模式下运行测试
  3. 应用更改并运行您的测试。

结果,一个浏览器被打开以重现测试中的步骤。

查看测试结果

测试运行结束后,结果会显示在 测试运行程序 选项卡的 运行 工具窗口中。 在此选项卡上,您可以重新运行测试、导出和导入测试结果、查看每个测试的运行时间以及执行其他操作。

运行工具窗口的测试运行器选项卡显示的测试结果

有关更多信息,请参见 探索测试结果

调试测试

通常,调试过程包括以下步骤:

  1. 为必须暂停执行的代码行设置断点。

  2. 在调试模式下运行您的代码。

  3. 使用 调试 工具窗口分析代码并查找潜在问题。

  4. 修复这些问题。

要在 IDE 中重现这些步骤,请执行以下操作:

  1. 在行号栏中,将鼠标悬停在您想要暂停执行的那行代码上,然后点击

    设置断点
  2. 点击 中的标记并选择 调试。 这将启动调试器会话并运行您的代码。

    开始调试会话
  3. 一旦程序达到断点,执行将被挂起,您可以在 调试 工具窗口中查看调试会话的结果。

    调试工具窗口概述

有关调试的更多信息,请参阅 调试代码

生成 Playwright 报告

Playwright reporters 提供有关失败测试的详细信息,使您能够更彻底地分析测试执行期间发生的情况。

默认情况下,会生成一个 html 报告,但您可以使用运行/调试配置切换到其他格式。 为此:

  1. 点击运行/调试配置切换器中的当前配置,然后点击 并选择 编辑(E) 选项。

    编辑运行/调试配置
  2. Playwright 选项 字段中,指定所需的 报告者。 例如:

    --reporter=line
  3. 应用更改并运行您的测试。

因此,会生成一份详细报告。

生成的 Playwright 报告

修改运行/调试配置

如果您想修改测试的启动属性,请编辑运行/调试配置:

  1. 点击运行/调试配置切换器中的当前配置并选择 编辑配置(R)… 选项。

    选择运行/调试配置
  2. 运行/调试配置 对话框中,选择您要编辑的配置。

  3. 配置所需的启动属性。

    配置启动属性
    配置启动属性
    配置启动属性
  4. 应用更改并点击 OK

有关运行/调试配置的详细信息,请参阅 运行/调试配置

自定义定位器模板

如果您想自定义如何将所选元素添加到您的代码中,您可以修改模板:

  1. 点击状态栏上的框架名称。 UI 自动化框架 菜单已打开。

    自定义模板
  2. 请选择 自定义模板 选项。

  3. 文件和代码模板 对话框中,从列表中选择所需的框架。

    文件和代码模板对话框
  4. 请重新编写用于网页元素定位器的代码生成算法。

  5. 点击 OK 以保存更改。

因此,这些定位器将根据更新后的代码生成算法添加到代码中。

最后修改日期: 2025年 4月 24日