Integrate your Appium and Ruby 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 Percy’s Appium SDK using gem as shown below:

Update test script

Make sure to import AppPercy in your code.

Below is an example test using the percy_screenshot function. Use this function wherever you have to take a screenshot.

We are passing the required arguments.percy_screenshot method.

The screenshot method arguments are:

• driver (required) - A appium driver instance
• name (required) - The screenshot name; must be unique to each screenshot
• device_name (optional) - The device name used for capturing screenshot
• orientation (optional) - Orientation of device while capturing screeenshot. Allowed values are portrait or landscape
• status_bar_height (optional) - Height of status bar; int
• nav_bar_height (optional) - Height of navigation bar; int
• full_screen (optional) - Indicate whether app is full screen; boolean
• fullpage (optional) - [alpha] only supported on App Automate driver sessions [ needs @percy/cli 1.20.2+ ]; boolean
• screen_lengths (optional) - [alpha] max screen lengths for fullPage [ needs @percy/cli 1.20.2+ ]; boolean
• In case scrollview is overlapping with other app elements. Offsets can be provided to reduce the area which needs to be considered for scrolling:
  • top_scrollview_offset(optional) - [alpha] offset from top of scrollview [ needs @percy/cli 1.20.2+ ]; int
  • bottom_scrollview_offset (optional) - [alpha] offset from bottom of scrollview [ needs @percy/cli 1.20.2+ ]; int
• scrollable_xpath (optional) - [alpha] scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]; string
• scrollable_id (optional) - [alpha] scrollable element accessibility id for fullpage [ needs @percy/cli 1.20.2+ ]; string
• ignore_regions_xpaths (optional) - elements xpaths that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of string
• ignore_region_accessibility_ids (optional) - elements accessibility_ids that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of string
• ignore_region_appium_elements (optional) - appium elements that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of appium element object
• custom_ignore_regions (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 ValueError: 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.

Running the test above normally will result in the following log:

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