Selenium - Ruby


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.

eyes.api_key = 'MY_API_KEY'

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., app_name, test_name, viewport_size)

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

viewportSize – a predefined viewport size that will be used for the browser window during this test (this parameter is very important for visual tests to ensure that the test will run of a defined viewport size and the results will be consistent)

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 milliseconds) that Eyes will wait for an image to stabilize to a point that it is similar to the baseline image (the default value is 2000 milliseconds).

eyes.match_timeout = 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.check_window(window_name, matchTimeout)

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

matchTimeout - (optional) matchTimeout in milliseconds, 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.check_region(how, what, matchTimeout, "window_name")

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 the following: 
: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 milliseconds, given for the step to pass.

Visual validation checkpoint of iframes in page

The functionality is not yet available in this language and will be added in future versions of the SDK.

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) Ending tests without throwing exception on failure

The default behaviour on failure is to throw exception or raise error on test ending. To override this behaviour use the following override which takes a boolean.

    testResults = eyes.close(false)

testResults - Test results details, contains attributes about the test and the failure, such as:

URL - String containing the URL to the report of the test in Applitools dashboard.

Steps - An integer representing the total steps count.

Matches - An integer representing the total matches count.

Mismatches - An integer representing the total mismatches count.

Missing - An integer representing How many missing steps found.

isNew - Boolean value indicates whether the test classified as a new test.

(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).

eyes.batch =

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

Set logs to console

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

eyes.log_handler =

Set logs to file

eyes.log_handler =‘logfile.log’)

(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.

eyes.branch_name = branch_name

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.

eyes.parent_branch_name = parent_branch_name

parentBranchName – the name of the parent branch to inherit from

Merging Branches 

Click here to learn how to automatically create a separate baseline per branch.

(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.

eyes.match_level = Applitools::MATCH_LEVEL[:<Level>]

Level - The match level of the test 

  • Exact - Pixel to pixel comparison, for demonstration purposes and debugging, will fail a test if a pixel is not in place (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) 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.

eyes.save_new_tests = true/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.

eyes.save_failed_tests = true/false

(Optional) Force full page screenshot

By default when calling the ‘checkWindow’ command, only the visible area (viewport) will be taken in a screenshot. It is possible to set Eyes to ‘stitch’ together all the scrollable areas into a single screenshot to show the entire page. To set full page stitching, pass true to ‘force_fullpage_screenshot’:

eyes.force_full_page_screenshot = true

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.

eyes.use_css_transition = true

(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.host_app = hostApp
eyes.host_os = hostOs

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 wait before screenshots 

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

with one of the methods, checkWindow/checkRegion/checkFrame
eyes.wait_before_screenshots = waitMsec # in milliseconds

Set Baseline Name

This command overrides the internal heuristic for setting the Host operating system, application and viewport Size, by setting a uniform baseline string for all three parameters. Commonly used for cross brower/OS/Device testing using the same baseline.

eyes.baseline_name = "baseLineName"

Hide scroll bars

This command hides the scrollbars while taking the screenshots.

eyes.hide_scrollbars = true

CSS Stitching 

eyes.setViewportSize(driver, new RectangleSize(width, height));

eyes.stitch_mode = :CSS

Prior to version 3.2.2:

eyes.use_css_transition = true

Set scale ratio 

Set Scale Ratio - Sets the scale ratio of screenshots before they sent to Applitools, used to override the default logic when device pixel ratio is not 1 (ie. retina displays and high-res mobile devices).

eyes.scale_ratio = 0.5

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() 

eyes.set_proxy("https://proxy", "user", "password")

Note that the user and password parameters are optional.