Skip to main content

Integrate App Percy with Appium and JUnit5

Learn how to integrate Appium with JUnit5 automated tests and Percy to catch visual differences in your website.

Prerequisites

Before you start, ensure that you have the following:

To integrate your JUnit5 based test suite with App Percy using the BrowserStack SDK, follow these steps:

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.

Copy icon Copy snippet
Copy icon Copy snippet

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.

Copy icon Copy snippet
Copy icon Copy snippet

Update your BrowserStack config file

In the browserstack.yml file:

  1. Set percy: true.

  2. Set a projectName.
    After you run a test, an App Automate project and an App Percy project are created with the project name you set here.
    If a App 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 a 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.

Copy icon Copy snippet

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:

Java
Copy icon Copy snippet

Run your test script

Congratulations!

You have successfully integrated App Percy with BrowserStack SDK and created your first build. 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, App Percy takes new screenshots. You can then see the comparisons between the two runs on the new build. You can access the App Percy dashboard directly from the App Automate dashboard.

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