Integrate Percy with Selenium and Java

Set BrowserStack credentials

Save your BrowserStack credentials as environment variables. It simplifies running your test suite from your local or CI environment. You can export the environment variables for the Username and Access Key of your BrowserStack account or you can set it in the config file.

Install BrowserStack SDK using Maven Archetype

Maven Archetype provides a template to quickly configure your project. Copy & run the following command on your terminal/command prompt to add browserstack-java-sdk dependency in your pom.xml and browserstack.yml file in your project.

Update your BrowserStack config file

In the browserstack.yml file:

1. Set percy: true.

2. Set a projectName.
   After you run a test, an Automate project and a Percy project are created with the project name you set here.
   If a Percy project by the name you set in the browserstack.yml file already exists, your screenshots are added to the same project. However, if the name matches an App Percy project, your visual tests do not run, and you see an error message in your terminal. Your functional tests still run as expected.

3. Set percyCaptureMode: manual.
   

Below sample browserstack.yml file shows how to set the percy, the projectName, and the percyCaptureMode parameters.

Manually add Percy screenshot method to update test script

To manually capture screenshots, implement the following steps in your test script:

1. Import the BrowserStack Percy SDK in your test script.
2. Add the PercySDK.screenshot(driver, name) method at required points in your test script to get the screenshots you want.

Here’s an example:

Run your test script

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-java-selenium to your project dependencies:

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:

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

The snapshot method arguments are:

• 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:

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