percy-espresso-java

Percy visual testing for Espresso

Installation

Add library to your gradle file:

  androidTestImplementation "io.percy:espresso-java:1.0.4"

• Update app manifest to add internet permission

    <uses-permission android:name="android.permission.INTERNET" />
  

• Add networkSecurityConfig

  • Create a network_security_config.xml and add following:

    <domain-config cleartextTrafficPermitted="true">
        <domain includeSubdomains="true">percy.cli</domain>
    </domain-config>
  

  • Update app manifest to add networkSecurityConfig permission

    <application android:networkSecurityConfig="@xml/network_security_config">
  

Usage

This is an example test using the percyScreenshot function.

Java

import io.percy.espresso.AppPercy;
AppPercy percy = new AppPercy();
percy.screenshot("Screenshot");

Kotlin

import io.percy.espresso.AppPercy
val percy = AppPercy()
percy.screenshot("Screenshot")

Configuration

Java

ScreenshotOptions options = new ScreenshotOptions();
percy.screenshot("Screenshot", options);

Kotlin

val options = ScreenshotOptions()
percy.screenshot("Screenshot", options)

• name (required) - The screenshot name; must be unique to each screenshot.
• options object (optional)

Setter Method	Description
setDeviceName(String deviceNameParam)	Device name on which screenshot is taken
setStatusBarHeight(Integer statusBarHeightParam)	Height of status bar for the device
setNavBarHeight(Integer navBarHeightParam)	Height of navigation bar for the device
setOrientation(String orientationParam)	["portrait"/"landscape"] Orientation of the application [ Note: This is only for tagging purpose, does not change the orientation of the device ]
setFullScreen(Boolean fullScreenParam)	Indicate whether app is full screen; boolean
setTestCase (String testaCaseParam)	groups snapshot under a particular test case
setLabels (String labelsParam)	adds label to the particular snapshot