Appium - Java

      This page covers the following topics:

Installing Applitools Eyes SDK for  Appium Java

Applitools Eyes SDK for Selenium Java can be downloaded from Maven (the name of the package is eyes-selenium-java).

To install the SDK, add the following to your pom.xml file (make sure to change the version number below to the latest version that is available on Maven):


Eyes Object

Eyes object is the main object in Applitools Eyes SDK.


Eyes eyes = new Eyes();


Before anything else, you should set the API key which allows you work with the Eyes server. Note that you use a static function for that, so it will be available to all of your objects. In order to obtain your API Key, login to Applitools Eyes web application and open your account details page.


Replace MY_API_KEY with the API key of your account (you can find it in your signup Email).


The open method returns a custom web driver object that monitors all the driver actions. From this point, the new custom driver object should be used for all the actions in the test.

For Ruby users, the initialization and the section for ending a test can be replaced with a call to eyes.test with the same parameters as which handles initialization and ending the test.

driver =, appName, testName);

driver – the relevant Selenium Webdriver object.

appName – string that represents the logical name of the AUT (this name will be presented in the test result)

testName – string that represents the name of the test (this name will be presented in the test result

appWindow (only relevant for CodedUI) – the WinWindow or BrowserWindow object (when using BrowserWindow, a casting to WinWindow is required) of the application under test.

Match Timeout

matchTimeout defines the default amount of time (in seconds) that Eyes will wait for an image to stabilize to a point that it is similar to the baseline image (the default value is 2 seconds).

driver = eyes.setMatchTimeout(TimeOut);

Visual validation checkpoint

The check window command will take a snapshot of the current window in the AUT and will perform smart visual comparison of that window with the baseline. In case this is a new window that does not exist in the baseline, this window will be added to the baseline.

eyes.checkWindow(matchTimeout, windowName);

windowName – string that represents the logical name of this window/validation point that will appear in the test result report.

matchTimeout - (optional) MatchTimeout in seconds, given for the step to pass.

Visual validation checkpoint of a specific region

Check region method works in a similar way to check window, except for the fact that it takes a screenshot of the HTML element specified as its input (by means of a WebDriver "By" selector) instead of a screenshot of the entire web page. The check region command will take a snapshot of the specific object, regardless of where it appears in the page, and will perform smart visual comparison of that region with the baseline. In case this is a new region that does not exist in the baseline, this region will be added as a new region to the baseline.

eyes.checkRegion(selector, matchTimeout, "windowName");

selector – the “By” selector (for Selenium Webdriver) that identifies the object region. 

how - The type of the selector that will be passed in ‘what’ field. 
Could be one of: 
:class, :class_name, :css, :id, :link, :link_text, :name, :partial_link_text, :tag_name, :xpath 
what - The selection string suitable to how.

windowName – string that represents the logical name of this window/validation point that will appear in the test result report.

matchTimeout - (optional) MatchTimeout in seconds, given for the step to pass.

Visual validation checkpoint of iframes in page

Iframes are usually scrollable and not displayed fully on the page, it is possible to focus validation only on a specified iframe so the SDK will scroll and stitch all the parts of the frame into a single picture and thus only one validation step.

eyes.checkFrame(frame, matchTimeout, "tag");

frame - Either a webElement or a String identifier of the iframe. matchTimeout - (optional) MatchTimeout in seconds, given for the step to pass.

tag - (optional) String for step description.

Ending a test

At the end of each test, make sure to call the eyes.close method to notify the service that the test completed successfully. It is recommended to also call the method eyes.abortIfNotClosed at the end of the test as part of the ‘finally’ block to distinguish between completed tests and tests which were aborted abnormally (e.g. an exception was thrown).


In the “finally” block of Selenium tests, you would usually also want to include “driver.quit()”, since the test has either finished or failed.

(Optional) Creating a batch of tests

The object BatchInfo represent a batch/collection of tests that will be unified as one group in the Test Manager screen and the result of all tests in a batch will determine the batch result. In order to start a batch, you should create a BatchInfo object, and associate it to the Eyes object (before calling the “”). In order to add additional tests to the same batch, make sure to call eyes.setBatch for each of the tests/Eyes objects (so every test in the batch should start with creating an Eyes object, calling eyes.setBatch, and ending the test with eyes.close).

BatchInfo batch = new BatchInfo(batchName);


batchName – string that represents the logical name that will be assigned to this batch.

Use the command eyes.setBatch to associate a test to the batch using the eyes instance

(Optional) Enabling Logs

Enabling Logs to Console:

The logHandler method of the Eyes object enables logging for troubleshooting purposes.

Eyes.setLogHandler(new StdoutLogHandler(true));

Enabling Logs to File:

eyes.setLogHandler(new FileLogger("path/to/file.log", true, true));

(Optional) Working with Branches

Applitools Eyes include built-in support for branching, and allows creating separate baselines per branch, so whenever a developer makes changes in the app, he can run his visual tests locally without affecting other branches, and only commit the baseline changes after making sure that the tests are passing properly.

In order to create a branch, simply call the method eyes.setBranch after creating the Eyes object and before starting the test with the name of the branch as the parameter for this method. As a result, the subsequent tests will run as part of that branch and any baseline changes that you will perform on these tests from the web application will be private to this branch.


branchName – the name of the branch to create.

The initial baseline used in a branch is taken from its parent branch. You can specify the parent branch by calling the setParentBranchName method with the parent branch name as a parameter. If you don't specify a parent branch, the default branch will be used. Note that just like branching code; the baseline is copied from the parent branch only the first time it is accessed. Once the baseline is accessed in a branch, it is no longer affected by changes made in the parent branch.


parentBranchName – the name of the parent branch to inherit from

When the developer is ready to commit the code changes that he made to the app, he will need to also commit the baseline changes to the main branch to ensure the tests will keep passing. In order to push/commit the baseline changes of a private branch, Applitools Eyes exposes a web API that allows coping all the modified baselines from one Branch to another, and detect conflicts just like the source code operation would.


In the request body you provide the object { "source" : "≶name≷", "target" : "≶name≷" } which indicates the source and target branch names and causes the server to copy all baselines and models from the source branch to the target branch.

It is recommended to add hook to the source control client such that after every successful merge from the private branch to the main branch (or alternatively a "push" from the local repository to the main one), a web call will be made to the above API. This is a source control framework specific configuration and each framework has different APIs for accomplishing this.

It is also recommended to configure your test framework, so the current branch name that the developer is working on and the parent branch name will be obtained automatically from the source control client when the test starts.

(Optional) Overriding test comparison level

Comparison sensitivity, aka ‘match level’ is set by default to Strict to get optimal coverage. Sometimes for specific tests it is required to change the default comparison level


Level - The match level of the test (For Ruby and Python use u
  • Exact - Pixel to pixel comparison, for demonstration purposes and debugging, will fail a test if a pixel is not in place. (not lace. (not recommended)
  • Strict - strict is the default match level, it mimics human eyes so only significant visual changes will be spotted, while small changes that are not visible to a human eye will be ignored.
  • Content - ignores style and anti-aliasing differences, while spotting content changes. (the content level can be useful if your website includes different styles which are not relevant for your tests).
  • Layout - ignores content changes, and detects only layout changes. (useful for pages with dynamic content and localized pages)

Note: Overriding the match level is only effective if set before initialization.

(Optional) Ending tests without throwing exception on failure

The default behavior on failure is to throw exception or raise error on test ending. To override this behavior use one of the overrides which takes boolean.

    TestResults testResults = eyes.close(false);
}finally {
testResults - Test results details, Contains attributes about the test and the failure
such as:
    Steps - Total steps count
    Matches - Total matches count
    Mismatches - Total mismatches count
    Missing - How many missing steps found
    ExactMatches - Amount of matches compared in exact match level
    StrictMatches - Amount of matches compared in strict match level
    ContentMatches - Amount of matches compared in content match level
    LayoutMatches - Amount of matches compared in layour match level
    isNew - Boolean value indicates whether the test classified as a new test.

(Optional) Automatic baseline creation (Default: True)

New tests presented to the server are automatically saved as baseline. To override this functionality so baseline creation will be applied manually by reviewing and approving the steps in applitools eyes Test Manager, set ‘SaveNewTests’ to false before test stat.


*true/false - Either true or false.

(Optional) Auto-save on failure (Default: False)

For maintenance and debugging purposes it is possible to make eyes to save automatically failed results as baseline by setting ‘SaveFailedTests’ property to true before test started.

* It is highly unrecommended to set this property in production since all failures will be saved automatically without distinguishment between bugs and features.


*true/false - Either true or false.

(Optional) Force full page screenshot

By default when calling ‘CheckWindow’ on Chrome and Safari, only the visible area (viewport) will be taken as screenshot (this is the default behavior of ChromeDrive and SafariDriver) while with Firefox and IE a full image of the entire page will be captured.

It is possible to set eyes to ‘stitch’ all the scrollable areas into a single screenshot in order to ensure that the result will be similar to IE and Firefox. To set full page stitching pass true to ‘ForceFullPageScreenshot’:


Another way of taking fullpage screenshot is using Css transition. Css scrolling and stitching is an alternative way of page scrolling usually comes to help with floating elements to stay in place when scrolling.

(Optional) Setting app environment attributes

Normally applitools eyes SDKs automatically identifies the environment that is used to run the tests and creates a separate baseline for each environment. In order to override app environment parameters and ‘force’ Eyes to compare results of different environments, you can explicitly call ‘setAppEnvironment’:

eyes.setAppEnvironment(hostOs, hostApp);

hostOs - The OS name and its version or any other os-alike identifier. hostApp - The application name, if there is, such as browser name or any other app-alike identifier.

This functionality can be used to ‘force’ eyes to preset the hostOS and hostApplication so identical tests on different environments will be unified under the same baseline. Note that using this in such way will most likely cause the tests to fail, since in most cases there are some differences between how the AUT is presented in the different environments.

Set Baseline name:


Set wait before screenshots


Sets the amount of time to wait (MSec) between scrolling and stitching when using full page/stitch content


with one of the methods, checkWindow/checkRegion/checkFrame

eyes.setWaitBeforeScreenshots(TimeMS);      //Time in milliseconds

Hide scroll bars

This command hides the scrollbars while taking the screenshots.


CSS stitching 

An alternative way to perform full page screenshot (scrolling and stitching) to anchor floating UI elements (ie. top menus, help widgets) in place so they won't appear
on every section that been taken.


(Optional) Set Image Cut

Border cropping is a useful way of cutting out unwanted border sections from captured screenshots by cutting a given amount of pixels to be cropped.
For example, when running a test on mobile devices, the header and footer, which are a part of the operating system, are captured as part of the screen. As for visual validations the validated area should only be the viewport of the application, these areas should be removed.

Note: the amount of pixels to be removed might vary between different devices. That  will require adjustment for each device that is being tested.

eyes.setImageCut(new FixedCutProvider(fromHeader, fromFooter, fromLeft, fromFight));

fromHeader - Amount of pixels to exclude from the header.

fromFooter - Amount of pixels to exclude from the footer.

fromLeft - Amount of pixels to exclude from the left.

fromFight - Amount of pixels to exclude from the right.

Configuring a proxy server

This section explains how to configure a proxy server in the Applitools Eyes SDK to address issues such as connection refused or connection timeout when using Applitools Eyes behind a proxy server.

Please make sure to add the commands before calling new Eyes() and also import the below package :
import com.applitools.eyes.ProxySettings;

eyes.setProxy(new ProxySettings("http://YOUR-PROXY-URI"));


eyes.setProxy(new ProxySettings("http://YOUR-PROXY-URI", YOUR_USER, YOUR_PASSWORD));