Skip to main content
Transform your testing process with: Company-wide Licences, Test Observability & App Percy

We recommend using our BrowserStack SDK for Percy integration.

Integrate Percy with your test suite to run visual tests. To do that, follow these steps:

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:

Copy icon Copy snippet
Copy icon Copy snippet
Copy icon Copy snippet

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:

Copy icon Copy snippet

Install the PercyIO.Selenium package by running the following command:

Copy icon Copy snippet

Update your test script
Import the Percy library to use the method and attributes required to take screenshots.

In the following code, the Percy.Snapshot method is used:

Copy icon Copy snippet

We are passing the required argument which is name, and are using an <https://example.com> web application. .NET example as the name of the snapshot within the Percy.Snapshot method.

The snapshot method arguments are:

Copy icon Copy snippet
  • driver (required) - A selenium-webdriver driver instance
  • name (required) - The snapshot name; must be unique to each snapshot
  • options - An object containing various snapshot options. See per-snapshot configuration options


To learn more, visit Percy snapshot.

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

If you are unable to use the percy:exec command or prefer to run your tests using IDE run options, you can use the percy exec:start and percy exec:stop commands. To learn more, visit Run Percy.

Copy icon Copy snippet

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

Copy icon Copy snippet

Congratulations!

You have successfully created your first build on Percy. To see the build with snapshots of your application, visit your project in Percy.

When you run another build with visual changes to your application, Percy takes new snapshots. You can then see the comparisons between the two runs on the new build.

Advanced topics

Percy Snapshot command

In the preceding steps, we used the Percy Snapshot command for capturing snapshots. Percy provides various configurations to use with Percy snapshot command. To learn more visit, Percy snapshot command.

Base build selection

By default, Percy uses the previous build for comparison however, you always have the option to configure the base build for comparison as needed. To learn more, visit base build selection logic.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback

Is this page helping you?

Yes
No

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked






Thank you for your valuable feedback!

Talk to an Expert
Download Copy