Package: percy-appium-app
percy-appium-pythonPercyvisual testing for Python Appium.Installationnpm install@percy/cli:$ npm install --save-dev @percy/clipip install Percy appium package:$ pip install percy-appium-appNote: 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 addurllib3>=1.26.15,<2in your requirements.txt file.UsageThis is an example test using thepercy_screenshotfunction.fromappiumimportwebdriverfrompercyimportpercy_screenshotdriver=webdriver.Remote("https://"+userName+":"+accessKey+"@hub-cloud.browserstack.com/wd/hub",desired_caps)# take a screenshotpercy_screenshot(driver,'here is some name')Running the test above normally will result in the following log:[percy] Percy is not running, disabling screenshotsWhen running withpercy app:exec, and your project'sPERCY_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!Configurationpercy_screenshot(driver, name[, **kwargs])driver(required) - A appium driver instancename(required) - The screenshot name; must be unique to each screenshotdevice_name(optional) - The device name used for capturing screenshotorientation(optional) - Orientation of device while capturing screeenshot; Allowed values [portrait|landscape]status_bar_height(optional) - Height of status bar; intnav_bar_height(optional) - Height of navigation bar; intsync- Boolean value by default it falls back tofalse, Gives the processed result around screenshot [From CLI v1.28.0-beta.0+]fullpage(optional) - [Alpha] Only supported on App Automate driver sessions [ needs @percy/cli 1.20.2+ ]; booleanscreen_lengths(optional) - [Alpha] Max screen lengths for fullPage; intIn 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; intbottom_scrollview_offset(optional) - [Alpha] Offset from bottom of scrollview; intfull_screen(optional) - Indicate whether app is full screen; boolean [ needs @percy/cli 1.20.2+ ];scrollable_xpath(optional) - [Alpha] Scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]; stringscrollable_id(optional) - [Alpha] Scrollable element accessibility id for fullpage [ needs @percy/cli 1.20.2+ ]; stringignore_regions_xpaths(optional) - Elements xpaths that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of stringignore_region_accessibility_ids(optional) - Elements accessibility_ids that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of stringignore_region_appium_elements(optional) - Appium elements that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of appium element objectcustom_ignore_regions(optional) - Custom locations that user want to ignore in visual diff [ needs @percy/cli 1.23.0+ ]; list of ignore_region objectIgnoreRegion:-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.Running with Hybrid AppsFor 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:defpercy_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 thedriver.switch_to.context('FLUTTER')would change to context that it uses like say WEBVIEW etc.Running Percy on Automatepercy_screenshot(driver, name, options)[ needs @percy/cli 1.27.0-beta.0+ ];driver(required) - A appium driver instancename(required) - The screenshot name; must be unique to each screenshotoptions(optional) - There are various options supported by percy_screenshot to server further functionality.freeze_animated_image- Boolean value by default it falls back tofalse, you can passtrueand percy will freeze image based animations.freeze_image_by_selectors-List of selectors. Images will be freezed which are passed using selectors. For this to workfreeze_animated_imagemust be set to true.freeze_image_by_xpaths- List of xpaths. Images will be freezed which are passed using xpaths. For this to workfreeze_animated_imagemust be set to true.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- List of xpaths. elements in the DOM can be ignored using xpathignore_region_selectors- List of selectors. elements in the DOM can be ignored using selectors.ignore_region_appium_elements- List of appium web-element. elements can be ignored using appium_elements.custom_ignore_regions-  List of custom objects. elements can be ignored using custom boundaries. Just passing a simple object for it like below.example:{"top": 10, "right": 10, "bottom": 120, "left": 10}In above example it will draw rectangle of ignore region as per given coordinates.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.consider_region_xpaths- List of xpaths. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using xpaths.consider_region_selectors- List of selectors. elements in the DOM can be considered for diffing and will be ignored by Intelli Ignore using selectors.consider_region_appium_elements- List of appium web-element. elements can be considered for diffing and will be ignored by Intelli Ignore using appium_elements.custom_consider_regions- List of custom objects. elements can be considered for diffing and will be ignored by Intelli Ignore using custom boundariesexample:{"top": 10, "right": 10, "bottom": 120, "left": 10}In above example it will draw rectangle of consider region will be drawn.Parameters:top(int): Top coordinate of the consider region.bottom(int): Bottom coordinate of the consider region.left(int): Left coordinate of the consider region.right(int): Right coordinate of the consider region.Creating Percy on automate buildNote: Automate Percy Token starts withautokeyword. The command can be triggered usingexeckeyword.$ 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 AutomateMigrating ConfigIf you have a previous Percy configuration file, migrate it to the newest version with theconfig:migratecommand:$ percy config:migrate