Skip to main content

Integrate App Percy with Appium and Cucumber-TestNG

Learn how to integrate Appium with Cucumber-TestNG automated tests and App Percy to catch visual differences in mobile apps.

Prerequisites

Before you start, ensure that you have the following:

To integrate your Cucumber-TestNG 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 or Upgrade BrowserStack SDK

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 will continue to run, but an error message will appear in your logs. Your functional tests still run as expected.

  3. Set percyCaptureMode: auto.
    There are other supported automated capture modes in the percyCaptureMode parameter. The table below lists and describes all the acceptable modes.

App Percy screenshot capture mode Description
auto Automatically capture screenshots on common events such as screenshot, click, and sendKeys.
testcase Automatically capture screenshots at the end of each test case.
click Automatically capture screenshots on every click.
screenshot Automatically capture screenshots on every driver.screenshot call.
manual This gives you more control over the screenshots you want captured. When used, you have to add the AppPercySDK.screenshot(driver, name) method at required points in your test script.

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

Copy icon Copy snippet

Additonal configuration settings (Optional)

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

  1. Import the BrowserStack Percy SDK in your test script.
  2. Add the AppPercySDK.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

You can continue running your tests as you have been previously.

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