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.

export BROWSERSTACK_USERNAME="YOUR_USERNAME"
export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

$env:BROWSERSTACK_USERNAME="YOUR_USERNAME"
$env:BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

setx BROWSERSTACK_USERNAME "YOUR_USERNAME" 
setx BROWSERSTACK_ACCESS_KEY "YOUR_ACCESS_KEY" 
set BROWSERSTACK_USERNAME=YOUR_USERNAME
set BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY

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.

mvn archetype:generate -B -DarchetypeGroupId=com.browserstack \
-DarchetypeArtifactId=browserstack-sdk-archetype-integrate -DarchetypeVersion=1.0 \
-DgroupId=com.browserstack -DartifactId=browserstack-sdk-archetype-integrate -Dversion=1.0 \
-DBROWSERSTACK_USERNAME= "YOUR_USERNAME" 
-DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"
-DBROWSERSTACK_FRAMEWORK=java

mvn archetype:generate -B -DarchetypeGroupId="com.browserstack" -DarchetypeArtifactId="browserstack-sdk-archetype-integrate" -DarchetypeVersion="1.0" -DgroupId="com.browserstack" -DartifactId="browserstack-sdk-archetype-integrate" -Dversion="1.0" -DBROWSERSTACK_USERNAME="YOUR_USERNAME"  -DBROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY" -DBROWSERSTACK_FRAMEWORK="java"

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 will continue to run, but an error message will appear in your logs. 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.

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
platforms:
  - os: Windows
    osVersion: 11
    browserName: Chrome
    browserVersion: 103.0
  - os: Windows
    osVersion: 10
    browserName: Firefox
    browserVersion: 102.0
  - os: OS X
    osVersion: Big Sur
    browserName: Safari
    browserVersion: 14.1
parallelsPerPlatform: 1
browserstackLocal: true
buildName: browserstack-build-1
projectName: BrowserStack Sample
debug: false
percy: true
percyCaptureMode: manual

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:

// ...imports
import com.browserstack.PercySDK;
public class TestNG extends SeleniumTest {
    @Test
    public void test() throws Exception {
         // ...
         PercySDK.screenshot(driver, "My Screenshot");
         // ...
    }
}

Run your test script

Create Project

Create a Percy Web project using the Percy dashboard. For more information, see Create a project.

Update your BrowserStack config file

1. In the browserstack.yml file, set percy: true.

2. Set a projectName.
   Use the same projectName specified when creating the Percy Web Project.

3. Set browserstackAutomation: true if it is currently set to false.

4. Set percyCaptureMode: manual.

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

userName: YOUR_USERNAME
accessKey: YOUR_ACCESS_KEY
platforms:
  - os: Windows
    osVersion: 11
    browserName: Chrome
    browserVersion: 103.0
  - os: Windows
    osVersion: 10
    browserName: Firefox
    browserVersion: 102.0
  - os: OS X
    osVersion: Big Sur
    browserName: Safari
    browserVersion: 14.1
parallelsPerPlatform: 1
browserstackLocal: true
buildName: browserstack-build-1
projectName: Percy Web Prj
debug: false
percy: true
percyCaptureMode: manual
browserstackAutomation: true

Update your test script

Update your test script to capture snapshots using the BrowserStack SDK in Manual mode.

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

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

Here’s an example:

// ...imports
import com.browserstack.PercySDK;
public class TestNG extends SeleniumTest {
    @Test
    public void test() throws Exception {
         // ...
         PercySDK.snapshot(driver, "My Snapshot");
         // ...
    }
}

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:

export PERCY_TOKEN="<your token here>"

$Env:PERCY_TOKEN="<your token here>"

set PERCY_TOKEN="<your token here>"

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:

npm install --save-dev @percy/cli

If you’re using Maven, add percy-java-selenium to your project dependencies:

<dependency>
  <groupId>io.percy</groupId>
  <artifactId>percy-java-selenium</artifactId>
  <version>1.3.0</version>
</dependency>

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:

// import ...
import io.percy.selenium.Percy;
public class Example {
  private static WebDriver driver;
  private static Percy percy;
  public static void main(String[] args) {
    ChromeOptions options = new ChromeOptions();
    options.setHeadless(true);
    driver = new ChromeOptions(options);
    driver.get("https://example.com");
    percy = new Percy(driver);
    percy.snapshot("Java example");
  }
}

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:

percy.snapshot(name, options)

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

$ npx percy exec -- mvn test

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

[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Snapshot taken "Java example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!