PercyIO.Appium 3.0.0

percy-appium-dotnet

Percy visual testing for .NET Selenium.

NuGet

NuGet Package:

Dependencies:

• Newtonsoft.Json Version >= 13.0.1
• Castle.Core Version >= 4.3.1
• Microsoft.CSharp Version >= 4.7.0

Note: This package is tested against .netstandard 2.0 should be compatible with and standard that is superset of this.

Installation

npm install @percy/cli (requires Node 14+):

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

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

$ dotnet add package PercyIO.Appium

Usage

This is an example test using the Percy.Snapshot method.

// ... other test code
// import
using PercyIO.Appium;
class Program
{
  private static AppPercy percy;
  static void Main(string[] args)
  {
    AppiumOptions capabilities = new AppiumOptions();
    // Add caps here
    AndroidDriver<AndroidElement> driver = new AndroidDriver<AndroidElement>(
          new Uri("http://hub-cloud.browserstack.com/wd/hub"), capabilities);
​
    // take a snapshot
    appPercy = new AppPercy(driver);
    appPercy.Screenshot("dotnet snaphot-1", null);

    // quit driver
    driver.quit();
  }
}

Running the above normally will result in the following log:

[percy] Percy is not running, disabling snapshots

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

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

Configuration

The screenshot method arguments:

percy.screenshot(name, fullScreen)

• 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. [Experimental] only supported on App Automate driver sessions [ needs @percy/cli 1.20.2+ ]
    • ScreenLengths: int [Experimental] max screen lengths for fullPage [ needs @percy/cli 1.20.2+ ]
    • ScrollableXpath (optional) - [Experimental] scrollable element xpath for fullpage [ needs @percy/cli 1.20.2+ ]; string
    • ScrollableId (optional) - [Experimental] 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 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:-

        var ignoreRegion = new IgnoreRegion();
        ignoreRegion.Top = top;
        ignoreRegion.Bottom = bottom;
        ignoreRegion.Left = left;
        ignoreRegion.Right = 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: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.

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:

public void PercyScreenshotFlutter(AppPercy appPercy, AndroidDriver<AndroidElement> driver, String name, ScreenshotOptions options) {
    // switch to native context
    driver.Context = "NATIVE_APP";
    appPercy.Screenshot(name, options);
    // switch back to flutter context
    driver.Context = "FLUTTER";
}

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

PercyScreenshotFlutter(appPercy, driver, name, options);

Note:

For other hybrid apps the driver.Context = "FLUTTER"; would change to context that it uses like say WEBVIEW etc.

Migrating Config

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

$ percy config:migrate

Running Percy on Automate

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

This is an example test using the Percy.Screenshot method.

// ... other test code
// import
using PercyIO.Appium;
class Program
{
  static void Main(string[] args)
  {

    // Add caps here
    RemoteWebDriver driver = new RemoteWebDriver(
      new Uri("https://hub-cloud.browserstack.com/wd/hub"),capabilities);
​
    // take a snapshot
    PercyOnAutomate Percy = new PercyOnAutomate(driver);

    // navigate to webpage
    driver.Navigate().GoToUrl("https://www.percy.io");

    Percy.Screenshot("dotnet screenshot-1");

    // quit driver
    driver.quit();
  }
}

• 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.
  • freezeAnimation - Boolean value by default it falls back to false, you can pass true and percy will freeze image based animations.
  • percyCSS - Custom CSS to be added to DOM before the screenshot being taken. Note: This gets removed once the screenshot is taken.
  • ignoreRegionXpaths - elements in the DOM can be ignored using xpath
  • ignoreRegionSelectors - elements in the DOM can be ignored using selectors.
  • ignoreRegionAppiumElements - elements can be ignored using appium_elements.
  • customIgnoreRegions - 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