SDK user guide

This topic is your starting point for everything related to using the Eyes SDK to create and run visual tests.

Eyes provides a variety of SDKs for various programming languages and webdriver technologies. You can see the full list of documentation by following the List of Eyes SDK link below. When you click on one of the SDKs from this list, you will be taken to the main page for that SDK.

When you visit any SDK page it become your "Last viewed SDK" and all references to that SDK throughout the documentation will use and refer to the classes and methods of that SDK. The second link above will take you directly to the last SDK you viewed.

Introduction articles

If you are completely new to Eyes then we recommend you read that articles in the Overview, in particular: the following pages are a good step by step introduction to the basics of writing an Eyes visual test:

Advanced topics

  • Configuring Eyes using the SDK

    This article describes the three basic patters for configuring Eyes, namely configurations used across many tests, test specific configuration and checkpoint specific configuration.

  • Test suite configuration

    This article presents some key configuration values, that are normally set once per test suite to customize Eyes to the test environment.

  • How to group tests into batches using the SDK

    This article describes how to use the eyes$setbatch$mOrP in the Eyes SDK to define that the results of multiple tests should be grouped together in the Test Manager.

  • Setting up Batch completion notification

    This article explains how to setup the SDK so that you get notifcations when a Batch completes.

  • Ultrafast Grid configuration

    This article describes how to configure the Ultrafast Grid, including: defining which browser configurations should be rendered, and setting the baseline environment.

  • Migrating code to use the Ultrafast Grid

    This article describes how to change code written before the Ultrafast Grid was available, to use the Ultrafast Grid compatible components.

  • The Eyes SDK check Fluent API

    This overview presents a high level overview of the Fluent API used with the eyes$check methods. In this overview you will be introduced to all the available methods implemented by this API and how they can be used together to create and configure your checkpoints.

  • Visual locators

    This article describes how you can use Eyes to find the position of visual entities on your page. You can use this to trigger instead of using DOM based locators.