woocommerce/plugins/woocommerce-blocks/tests/e2e

WooCommerce Blocks Playwright End to End Tests

This is the documentation for the new E2E testing setup based on Playwright and wp-env. Over time, these playwright E2E tests should replace the current Puppeteer E2E tests.

Table of contents

• Pre-requisites
• Introduction
  • Running tests for the first time
  • To run the test again, re-create the environment to start with a fresh state
  • Other ways of running tests

Pre-requisites

• Node.js (Installation instructions)
• NVM (Installation instructions)
• Docker and Docker Compose (Installation instructions)

Note, that if you are on Mac and you install docker through other methods such as homebrew, for example, your steps to set it up might be different. The commands listed in steps below may also vary.

If you are using Windows, we recommend using Windows Subsystem for Linux (WSL) for running E2E tests. Follow the WSL Setup Instructions first before proceeding with the steps below.

Introduction

End-to-end tests are powered by Playwright. The test site is spun up using wp-env (recommended), but we will continue to support e2e-environment in the meantime.

Running tests for the first time

nvm use

npm install

npm run env:start

npm run test:e2e

To run the test again, re-create the environment to start with a fresh state

npm run env:restart

npm run test:e2e

Tests with side effects

We call tests that affect other tests (ones that modify the site settings, using custom plugins) are tests with side effects and we split those tests to a separate test suite:

npm run test:e2e:side-effects

Note: All commands parameters of test:e2e can be used for test:e2e:side-effects.

Other ways of running tests

Headless mode:

npm run test:e2e

Interactive UI mode:

npm run test:e2e -- --ui

Headed mode:

npm run test:e2e -- --headed

Debug mode:

npm run test:e2e -- --debug

Running a single test:

npm run test:e2e ./tests/e2e/tests/example.spec.ts

To see all options, run the following command:

npx playwright test --help