Changeset 56926 for trunk/tests/e2e/README.md

Timestamp:

10/13/2023 08:11:41 AM (12 months ago)

Author:

swissspidy

Message:

Build/Test Tools: Migrate Puppeteer tests to Playwright.

As per the migration plan shared last year, this migrates all browser-based tests in WordPress core to use Playwright.
This includes end-to-end, performance, and visual regression tests.

Props swissspidy, mamaduka, kevin940726, bartkalisz, desrosj, adamsilverstein.
Fixes #59517.

File:

• trunk/tests/e2e/README.md (modified) (3 diffs)

trunk/tests/e2e/README.md

@@ -6 +6 @@
 ## Running the tests
 
-The e2e tests require a production-like environment to run. By default, they will assume an environment is available at `http://localhost:8889`, with username=admin and password=password.
+The e2e tests require a production-like environment to run. By default, they will assume an environment is available at `http://localhost:8889`, with username `admin` and password `password`.
 
 If you don't already have an environment ready, you can set one up by following [these instructions](https://github.com/WordPress/wordpress-develop/blob/master/README.md).
@@ -21 +21 @@
 
 ```
-npm run test:e2e -- --wordpress-base-url=http://mycustomurl --wordpress-username=username --wordpress-password=password
+WP_BASE_URL=http://mycustomurl WP_USERNAME=username WP_PASSWORD=password npm run test:e2e
 ```
 **DO NOT run these tests in an actual production environment, as they will delete all your content.**
 
-For debugging purposes, you might want to follow the test visually. You can do so by running the tests in an interactive mode.
+For debugging purposes, you might want to follow the test visually. You can do so by running the tests in an interactive mode:
 
 ```
-npm run test:e2e -- --puppeteer-interactive
+npm run test:e2e -- --ui
 ```
+
+[UI Mode](https://playwright.dev/docs/test-ui-mode) let's you explore, run and debug tests with a time travel experience complete with watch mode.
+All test files are loaded into the testing sidebar where you can expand each file and describe block to individually run, view, watch and debug each test.
 
 You can also run a single test file separately:
@@ -42 +45 @@
 * Block Editor Handbook end to end testing overview: https://developer.wordpress.org/block-editor/contributors/code/testing-overview/#end-to-end-testing
 
-* Gutenberg e2e-test-utils package API docs: https://github.com/WordPress/gutenberg/tree/trunk/packages/e2e-test-utils
+* Gutenberg e2e-test-utils-playwright package API docs: https://github.com/WordPress/gutenberg/tree/trunk/packages/e2e-test-utils-playwright
 
-* Puppeteer API docs: https://github.com/puppeteer/puppeteer#readme (the version we are using is indicated in the @wordpress/scripts package: https://github.com/WordPress/gutenberg/blob/trunk/packages/scripts/package.json)
+* Playwright API docs: https://playwright.dev/docs (the version we are using is indicated in the `@wordpress/scripts` package: https://github.com/WordPress/gutenberg/blob/trunk/packages/scripts/package.json)