Worksoft Certify Integration with Applitools Eyes

With Worksoft Certify® integration with Applitools Eyes, you can compare screen captures against the base line of screen captures that are stored on the Applitools server.

If you are using the Certify Mac interface to connect with a Mac® machine, you can use the Certify Applitools interface to compare screen captures taken from the Mac machine.

System Requirements

Before you integrate with Applitools Eyes, verify that your machine meets the following system requirements:

API key of Applitools software
Worksoft Certify v12.0.2008.x or later versions

If your application is running on a Mac machine, verify that your machine meets the following requirements:

macOS® v10.13 (High Sierra) or later versions
Mac user with local administrative privileges
An HDMI emulator device to support screen capture if a headless Mac

Installation

The Applitools interface is part of the Worksoft Certify installation, and a single map file named AppiToolsEyes.map is included in the interface installation. In order to use this interface, you must import this map file into Certify application.

Using the Applitools Interface

Complete the following actions in Certify before creating a Certify process using the Applitools interface:

Manually create an Applitools application.
Create a Certify project that includes the application.
Import the map file AppiToolsEyes.map from the following directory:

C:\Program Files (x86)\Worksoft\Certify\Interface Client\Worksoft\wsTest\Applitools

Applitools Interface Eyes Actions

To compare an image on Windows system, you will use the Applitools Eyes class actions in the following order:

Action	Description	Parameters
Open	Establishes the connection with the Applitools server.	Applitools Eyes server URL Applitools Eyes API key
Start	Identifies the project and test name on the Applitools Eyes server.	Project - Specify the Applitools project name. Test name - Specify an Applitools test name. The test name must be unique within the scope of the application name.
Load Image	Loads image with step name.	Name - Enter a name that identifies the step in the Applitools Eyes Test Manager. Maximize AUT - Specify whether Certify should maximize the application before taking a screenshot.
Close	Compares screen capture with the corresponding screen capture on the Applitools server that is listed in the Load Image action.	Fail - Specify whether to fail the step on screen capture mismatch.

To see a process example of Worksoft Certify integration with Applitools Eyes, click here.

Applitools Interface Eye Web Browser Extension Actions

The Interface Eye Web Browser Extension actions use the Selenium® Web driver to start an instance in the Chrome™ browser to a URL. The actions use an Applitools browser extension that is programmatically added to this browser instance in order to communicate with the Applitools server.

Next, Applitools opens the URL on the server in the browsers and/or devices that you specified and produces screenshots. Changing the Application Name, Test Name, or Image Name causes Applitools to create a new baseline image against subsequent screenshots with these same names, and they are compared.

A Certify user can specify multiple browsers, devices, and iOS devices that are supported by Applitools. The image is taken on the Applitools server and not in the Chrome browser.

Action	Description	Parameters
1 - Load Browser	Loads the browser to the specified URL address.	Browser Type - Specify the local browser type. URL - Specify the URL that you want to load. Pageload Timeout Minutes - Specify page load timeout in minutes.
2 - Open Eyes	Establishes the Applitools Eyes connection.	Server URL - Specify the Applitools server URL. API Key - Specify an Applitools API key. Application Name - Specify the application name. Test Name - Enter the test name. Browsers - Enter a comma-delimited string of browsers to image and test for Applitools accessibility levels and contrast ratios. Browser Width - Specify the browser width to the image. Browser Height - Specify the browser height to the image. Devices - Enter a comma-delimited string of devices to image. Devices Screen Orientation - Specify the devices screen orientation–Portrait or Landscape. iOS Devices - Enter a comma-delimited string of iOS devices to image. iOS Devices Screen Orientation - Specify the iOS devices screen orientation–Portrait or Landscape. iOS Devices Version - Specify iOS devices version–latest or latest-1. Concurrency - Specify Applitools concurrency setting. Default value is 20. Command Timeout Minutes - Specify timeout for JavaScript commands in minutes. Default value is 5. Proxy URL - (Optional) Specify the proxy URL. Proxy Username - (Optional) Specify the proxy user name. Proxy Password - (Optional) Specify the proxy password.
2 - Open Eyes (Local Browser)	Establishes the Applitools Eyes connection on a local browser.	Server URL - Specify the Applitools server URL. API Key - Specify an Applitools API key. Application Name - Specify the application name. Test Name - Enter the test name. Command Timeout Minutes - Specify timeout for JavaScript commands in minutes. Default value is 5. Acceptability Validation Level - Specify accessibility validation level Acceptability Guidelines Version - Specify accessibility guidelines version (Applitools Contrast Advisor) Proxy URL - (Optional) Specify the proxy URL. Proxy Username - (Optional) Specify the proxy user name. Proxy Password - (Optional) Specify the proxy password.
3 - Checkpoint	Performs image checkpoint.	Image Name - Specify image name. Full Page Screenshot - Select to take a screenshot of the full page or only the viewport. Element Check - Specify the element's CSS Selector to image one individual element on a web page.
4 - Close Eyes	Closes the Eyes session and logs checkpoint results.	Fail on Mismatch - Show a failed status on mismatched status from Applitools.
5 - Close Browser	Closes the web driver and the Applitools extension browser.	No parameters

Using Applitools Interface on Mac Machine

In order to use the Applitools interface on a Mac machine, you must include the Mac application in the project. Also, you need to use the Certify Mac System class action Connect to connect with the Mac machine.

Use the Applitools interface and Mac interface actions in the following order:

Log File

The log file Applitools_Execution_Log.txt is created during execution. With each execution, the file is overwritten.

The log file is located in the following directory:

%appdata%\Worksoft\Applitools