@wordpress/e2e-test-utils-playwright
v1.11.0
Published
End-To-End (E2E) test utils for WordPress.
Downloads
170,941
Readme
E2E Test Utils
End-To-End (E2E) Playwright test utils for WordPress.
It works properly with the minimum version of Gutenberg 9.2.0
or the minimum version of WordPress 5.6.0
.
Installation
Install the module
npm install @wordpress/e2e-test-utils-playwright --save-dev
Note: This package requires Node.js version with long-term support status (check Active LTS or Maintenance LTS releases). It is not compatible with older versions.
API
test
The extended Playwright's test module with the admin
, editor
, pageUtils
and the requestUtils
fixtures.
expect
The Playwright/Jest's expect function.
Admin
End to end test utilities for WordPress admin's user interface.
const admin = new Admin( { page, pageUtils } );
await admin.visitAdminPage( 'options-general.php' );
Editor
End to end test utilities for the WordPress Block Editor.
To use these utilities, instantiate them within each test file:
test.use( {
editor: async ( { page }, use ) => {
await use( new Editor( { page } ) );
},
} );
Within a test or test utility, use the canvas
property to select elements within the iframe canvas:
await editor.canvas.locator( 'role=document[name="Paragraph block"i]' );
PageUtils
Generic Playwright utilities for interacting with web pages.
const pageUtils = new PageUtils( { page } );
await pageUtils.pressKeys( 'primary+a' );
RequestUtils
Playwright utilities for interacting with the WordPress REST API.
Create a request utils instance.
const requestUtils = await RequestUtils.setup( {
user: {
username: 'admin',
password: 'password',
},
} );
Contributing to this package
This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.
To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.