Execution Cloud setup and installation

Prerequisites

To work with Applitools Execution Cloud, you need the following:

  • Permission to use Applitools Execution Cloud. To get access, contact the Applitools Support team.

  • Valid Applitools account with a valid API key. For details see How to retrieve your API key.

  • Applitools SDK in one of the following languages:

    • Selenium Java
    • Selenium JavaScript
    • Selenium Python
    • Selenium C#
    • Selenium Ruby
    • WebDriverIO

Setting up Execution Cloud

Setting up Execution Cloud involves the following easy steps:

  • Set the following environment variables:

    • APPLITOOLS_API_KEY – Your API key. See How to obtain your API key.

    • APPLITOOLS_SERVER_URL – The URL of the Eyes server. If you use the public Eyes server, the URL is https://eyes.applitools.com

    You can also set these variables using Chrome capabilities:

    Copy 
    'applitools:eyesServerUrl': 'https://eyesapi.applitools.com',
    'applitools:apiKey': 'api-key',

    or in the following format:

    Copy 
    applitools:options' {
      eyesServerUrl: 'https://eyesapi.applitools.com',
      apiKey: 'api-key',
      }

  • Use the following code to replace your local driver setup: 

    
                                    
    • 
                                

                                
Testing local websites without a public URL

                                
You can easily test your local websites with Applitools Execution Cloud using a secured tunnel between the remote browser and the local network. The remote Execution Cloud browser will then be able to control all network requests through the local network.

                                
Set the following environment variable:

                                
    
                                    
  • 
                                        
    APPLITOOLS_TUNNEL=true
                                        
    
                                    
    • 
                                

                                
Or using the Chrome capabilities, set 'applitools:tunnel' to true.

                                
Setting the Execution Cloud region

                                
By default, Execution Cloud resides on a cloud which is located in the United States. You can set the following Chrome capabilities to work with a cloud located in Australia:

                                
Copy
                                    
"applitools:region": "australia"