迁移指南

本文档概述了将 Jest + Puppeteer 测试迁移至 Playwright 的典型流程。请注意，迁移过程也是重构或重写部分测试的良好契机。开始迁移前，请先阅读最佳实践指南。

测试迁移步骤

在 packages/e2e-tests/specs 中选择要迁移的测试套件，将 .test.js 重命名为 .spec.js，并置于 test/e2e/specs 内的相同文件夹结构中。

从 @wordpress/e2e-test-utils-playwright 引入测试辅助工具：

const { test, expect } = require( '@wordpress/e2e-test-utils-playwright' );

将所有出现的 describe、beforeAll、beforeEach、afterEach 和 afterAll 加上 test. 前缀。例如，describe 变为 test.describe。
使用夹具 API 引入之前全局的变量，如 page 和 browser。
删除所有对 e2e-test-utils 的导入。改为使用夹具 API 直接获取 admin、editor、pageUtils 和 requestUtils。（注意：admin、editor 和 pageUtils 不能在 beforeAll 和 afterAll 中使用，需改用 requestUtils 重写。）
如果缺少某个工具函数，且步骤较少，可尝试直接在测试中内联实现操作。如果认为有必要作为测试工具函数实现，请参考以下指南。
根据推荐的最佳实践手动迁移测试中的其他细节。请注意，尽管 Playwright 和 Puppeteer 的 API 差异较小，但仍需进行一些手动调整。

测试工具函数迁移步骤

在迁移测试工具函数前，请仔细考虑是否必要。Playwright 提供了许多易读且强大的 API，使得许多工具函数不再需要。可先尝试在测试中直接内联实现相同功能。仅当此方法不适用时，再参考以下指南。适合在 e2e-test-utils-playwright 包中实现的工具函数示例包括复杂的浏览器 API（如 pageUtils.dragFiles 和 pageUtils.pressKeys）以及状态设置 API（如 requestUtils.*）。

e2e-test-utils-playwright 包并非旨在完全替代 Jest + Puppeteer 的 e2e-test-utils 包。部分工具函数仅为简化迁移过程而创建，并非必需。

Playwright 工具函数的组织方式与 e2e-test-utils 包略有不同。e2e-test-utils-playwright 包将工具函数分为以下文件夹：

admin - 与 WordPress 后台或 WordPress 后台用户界面相关的工具函数（例如 visitAdminPage）。
editor - 用于块编辑器的工具函数（例如 clickBlockToolbarButton）。
pageUtils - 用于与浏览器交互的通用工具函数（例如 pressKeys）。
requestUtils - 用于发起 REST API 请求的工具函数（例如 activatePlugin）。这些工具函数用于测试的初始化和清理。

复制 e2e-test-utils 中的现有文件，根据工具函数类型粘贴到 e2e-test-utils-playwright 的 admin、editor、page 或 request 文件夹中。
更新工具函数中需要重写的部分：
- page 和 browser 变量在 admin、editor 和 pageUtils 中可通过 this.page 和 this.browser 访问。
- 同一类中的所有其他工具函数可通过 this 访问，并绑定到同一实例。可移除所有 import 语句，改用 this 访问。
- 如果熟悉 TypeScript，可考虑将工具函数更新为 TypeScript 版本。
在 index.ts 中导入新迁移的工具函数，并将其作为实例字段放入 Admin/Editor/PageUtils/RequestUtils 类中。

3.7 KiB Raw Blame History Unescape Escape

迁移指南

测试迁移步骤

测试工具函数迁移步骤

3.7 KiB

Raw Blame History