Skip to main content

Run and Create Applitools Eyes Tests

With the Ranorex Applitools Eyes integration, you can create and run visual validation tests directly in Ranorex Studio. This article explains how to prepare your test suite, add visual checks, and run tests with Applitools Eyes.

Run your test

You can run tests with Applitools Eyes visual checks the same way as any other Ranorex test. To run your test, click Run in the test suite view. During test execution, Ranorex uploads the required image data for each visual check to Applitools Eyes. Applitools Eyes then analyzes the visual check and returns the result to Ranorex.

Note: Tests with visual checks may take longer to run, depending on the number of visual checkpoints in the test. Each visual check requires image data to be sent to Applitools Eyes.

Run your test from the command line

You can also run your test from the command line. All global parameters defined for the Applitools Eyes integration can be passed as command-line parameters, e.g.:

ApplitoolsIntegration.exe -param:viewPortHeight=1080 -param:viewPortWidth=1920

Important: To run tests with visual checks, the Ranorex option Use UiaLauncher to elevate privileges for processes started by tools must be disabled. To disable it:
1. Close your solution.
2. Go to Settings > Advanced.
3. Clear the Use UiaLauncher to elevate privileges for processes started by tools checkbox.
4. Click OK.

Prepare the test suite

Before you add visual checks, prepare your test suite for Applitools Eyes.

  1. In the Test Suite view, right-click the test suite and click Add setup.
  2. Right-click the test suite again and click Add teardown.
  3. In the Module Browser, drag InitializeEyes to the setup region.
  4. Drag FinalizeEyes to the teardown region.
  5. Right-click the test suite and click Global parameters…
  6. In the dialog that appears, click Auto-create and Auto-bind.
  7. Next to EyesApiKey, enter your Applitools Eyes API key. 
  8. If you use an on-premises Applitools installation, enter the server URL in ServerURL.

  9. Optionally configure any additional parameters you want to use.

    ParameterDescription
    AppNameEnter the name you want the test to be saved under in the Apps & tests category in Eyes.
    EyesBatchIdEnter the ID of a test batch to always pass results to this batch.
    ViewPortWidthDefine a custom width in pixels for the Applitools Eyes viewport.
    ViewPortHeightDefine a custom height in pixels for the Applitools Eyes viewport.
    MatchLevelDefine the match level that will be used. Possible values: Exact, Strict, Layout, Content. The default is Strict.

Add visual checks to your test

After the test suite is prepared, you can build your test as usual and add visual checks in recording modules by using Applitools Eyes user code methods.

To add a visual check:

  1. Open the recording you want to add a visual check to.
  2. Drag and drop the repository item you want to check from the repository to the desired position in the action table.
  3. In the context menu that appears, click User code > Select from library.
  4. Double-click the VisualCheckpoint method.

Note: You can perform visual checks on any repository item, from an entire web page to a single UI element such as a button.
You can add as many visual checks as needed, but each checkpoint adds execution time because the image data must be sent to Applitools Eyes.

Other Applitools user code methods

In addition to VisualCheckpoint, the Applitools Eyes integration provides other user code methods that let you set Applitools parameters at runtime. These runtime values override the global parameters configured in the test suite.

To add another Applitools user code method:

  1. Open the recording where you want to add the method.

  2. In the action table, click Add new action > User code > Select from library.

  3. Double-click the user code method you want to use.

  4. In the action table, enter the required argument value.

PDF and image file checks

The Applitools Eyes integration can also be used to perform visual regression checks on PDF files and image files.

For this scenario, use the dedicated user code method:

VisualCheckpoint(String fileORFolderPath)

To add a PDF or image file check:

  1. Open the recording where you want to add the file check.
  2. In the action table, click Add new action > User code > Select from library.
  3. Double-click VisualCheckpoint(String fileORFolderPath).
  4. In the action table, enter the path to the file or folder you want to check.

The following path formats are supported:

  • Absolute path
    Example for a file: C:\Users\User\Documents\MyPDF.pdf
    Example for a folder: C:\Users\User\Documents
  • Relative path
    Example for a file: MyPDF.pdf
    Example for a folder: Documents

Relative paths only work for files and folders located in the same directory as the test executable.

Was this article helpful?
Powered by Zendesk