Integrate your Appium with C# test suite with App Percy

Create new app project on percy dashboard

Sign in to Percy and create a new app type project. After you’ve created the project, you’ll be shown a PERCY_TOKEN environment variable. Percy will use the PERCY_TOKEN to know which organisation and project to upload the screenshots to. You will need this PERCY_TOKEN in next steps.

Set the project token as an environment variable

Run the given command to set PERCY_TOKEN as an environment variable:

Install Percy packages

Install Percy CLI by running the following command:

Install dependencies

Install the PercyIO.Appium package (for example, with .NET CLI):

Update test script

Make sure to import PercyIO.Appium in your code.

Below is an example test using the percy’s Screenshot method. Use this function wherever you have to take a screenshot.

We are passing the required arguments.percy.screenshot method.

The screenshot method arguments are:

• name (required) - The screenshot name; must be unique to each screenshot
• Additional screenshot options (overrides any project options):
• fullScreen - It indicates if the app is a full screen
• options - Optional screenshot params: Use ScreenshotOptions to set following params to override
• DeviceName - Device name on which screenshot is taken
• StatusBarHeight - Height of status bar for the device
• NavBarHeight - Height of navigation bar for the device
• Orientation - Orientation of the application
• FullPage: true/false [alpha] only supported on App Automate driver sessions [needs @percy/cli 1.20.2+ ]
• In case scrollview is overlapping with other app elements. Offsets can be provided to reduce the area which needs to be considered for scrolling:
  • TopScrollviewOffset: (optional) - [alpha] offset from top of scrollview [ needs @percy/cli 1.20.2+ ]; int
  • BottomScrollviewOffset (optional) - [alpha] offset from bottom of scrollview [ needs @percy/cli 1.20.2+ ]; int
• ScreenLengths: int [alpha] max screen lengths for fullPage [ needs @percy/cli 1.20.2+ ]
• ScrollableXpath (optional) - [alpha] scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]; string
• ScrollableId (optional) - [alpha] scrollable element accessibility id for fullpage [ needs @percy/cli 1.20.2+ ]; string
• IgnoreRegionXpaths (optional) - elements xpaths that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of string
• IgnoreRegionAccessibilityIds (optional) - elements accessibility_ids that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of string
• IgnoreRegionAppiumElements (optional) - appium elements that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of appium element object
• CustomIgnoreRegions (optional) - Custom locations that users want to ignore in visual diffs, with (0, 0) starting at the top left (requires @percy/cli 1.23.0+); list of ignore_region objects.
• IgnoreRegion
  • Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff.
  • Constructor:-

• Parameters:-
  • Top (int): Top coordinate of the ignore region. Bottom (int): Bottom coordinate of the ignore region.
  • Left (int): Left coordinate of the ignore region. Right (int): Right coordinate of the ignore region.
  • Raises: ArgumentException If top, bottom, left, or right is less than 0 or top is greater than or equal to bottom or left is greater than or equal to right.
  • valid: Ignore region should be within the boundaries of the screen.

Run your test script

Run your tests using percy app:exec.

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