percy-appium-app 2.0.1

Python client for visual testing with Percy for mobile apps

percy-appium-python

Percy visual testing for Python Appium.

Installation

npm install @percy/cli:

$ npm install --save-dev @percy/cli

pip install Percy appium package:

$ pip install percy-appium-app

Note: This package is tested on Python versions 3.6, 3.8, 3.9 as part of unit tests. It should ideally work on all Python 3.6+ versions

[NOTE] Appium-Python-Client(>= v2.9.0) is having compatibility issues with urllib3 latest versions. To solve the issue it is recommended to add urllib3>=1.26.15,<2 in your requirements.txt file.

Usage

This is an example test using the percy_screenshot function.

from appium import webdriver
from percy import percy_screenshot

driver = webdriver.Remote("https://" + userName + ":" + accessKey + "@hub-cloud.browserstack.com/wd/hub", desired_caps)

# take a screenshot
percy_screenshot(driver, 'here is some name')

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

[percy] Percy is not running, disabling screenshots

When running with percy app:exec, and your project's PERCY_TOKEN, a new Percy build will be created and screenshots will be uploaded to your project.

$ export PERCY_TOKEN=[your-project-token]
$ percy app:exec -- [python test command]
[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Screenshot taken "Python example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!

Configuration

percy_screenshot(driver, name[, **kwargs])

• 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 [portrait | 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) - [Experimental] only supported on App Automate driver sessions [ needs @percy/cli 1.20.2+ ]; boolean
• screen_lengths (optional) - [Experimental] 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) - [Experimental] offset from top of scrollview [ needs @percy/cli 1.20.2+ ]; int
  • bottom_scrollview_offset (optional) - [Experimental] offset from bottom of scrollview [ needs @percy/cli 1.20.2+ ]; int
• scrollable_xpath (optional) - [Experimental] scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]; string
• scrollable_id (optional) - [Experimental] 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 user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of ignore_region object
  • IgnoreRegion:-

    • Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff.

    • Constructor:

      init(self, top, bottom, left, right)
      

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

Running with Hybrid Apps

For a hybrid app, we need to switch to native context before taking screenshot.

• Add a helper method similar to following for say flutter based hybrid app:

def percy_screenshot_flutter(driver, name: str, **kwargs):
  driver.switch_to.context('NATIVE_APP')
  percy_screenshot(driver, name, **kwargs)
  driver.switch_to.context('FLUTTER')

• Call PercyScreenshotFlutter helper function when you want to take screenshot.

percy_screenshot_flutter(driver, name, **kwargs)

Note:

For other hybrid apps the driver.switch_to.context('FLUTTER') would change to context that it uses like say WEBVIEW etc.

Running Percy on Automate

percy_screenshot(driver, name, options) [ needs @percy/cli 1.27.0-beta.0+ ];

• driver (required) - A appium driver instance
• name (required) - The screenshot name; must be unique to each screenshot
• options (optional) - There are various options supported by percy_screenshot to server further functionality.
  • freeze_animation - Boolean value by default it falls back to false, you can pass true and percy will freeze image based animations.
  • percy_css - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
  • ignore_region_xpaths - elements in the DOM can be ignored using xpath
  • ignore_region_selectors - elements in the DOM can be ignored using selectors.
  • ignore_region_appium_elements - elements can be ignored using appium_elements.
  • custom_ignore_regions - elements can be ignored using custom boundaries
    • IgnoreRegion:-

      • Description: This class represents a rectangular area on a screen that needs to be ignored for visual diff.

      • Constructor:

        init(self, top, bottom, left, right)
        

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

Creating Percy on automate build

Note: Automate Percy Token starts with auto keyword. The command can be triggered using exec keyword.

$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- [python test command]
[percy] Percy has started!
[percy] [Python example] : Starting automate screenshot ...
[percy] Screenshot taken "Python example"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!

Refer to docs here: Percy on Automate

Migrating Config

If you have a previous Percy configuration file, migrate it to the newest version with the config:migrate command:

$ percy config:migrate