Integrate Percy with Playwright and Cucumber

Create a Percy project
Sign in to Percy. In Percy, create a project of the type, Web, and then name the project. After the project is created, Percy generates a token. Make a note of it. You have to use it set your environment variable in the next step.

For details on creating a project, see Create a Percy project.

Set the project token as an environment variable
Run the given command to set PERCY_TOKEN as an environment variable:

To learn about environment variables in Percy, see Percy environment variables.

Install Percy dependencies
Install the following components to establish the integration environment for your test suite.

Install Percy CLI by running the following command:

If you’re using Maven, add percy-playwright-java and cucumber-java to your project dependencies. The Percy SDK declares Cucumber as a provided dependency, so you supply your own Cucumber version (7.x is recommended):

Set up Cucumber hooks
Pass your Playwright Page instance to PercySteps from a Cucumber @Before hook, and reset it in an @After hook. The setPage method also registers the Cucumber wrapper in your Percy build information.

Add the io.percy.playwright.cucumber package to your Cucumber glue path so that the step definitions are discovered:

Write a feature file
Use the Percy steps in your Gherkin scenarios. The following feature file takes a basic snapshot, a responsive snapshot, and a snapshot that ignores a region:

To pass several options at once, use the with options: step with a Cucumber data table:

For the full list of available steps, see Available step definitions.

Run Percy
Run your tests using the percy exec command as shown below:

This command starts Percy, creates a new Percy build, takes snapshots and uploads them to your project, and stops Percy: