Skip to main content

Sauce Labs Integration - Overview

This document gives you a high-level overview of how the Eggplant Gateway for Sauce Labs devices connects to the Sauce Labs environment.

How the Eggplant Gateway for Sauce Labs devices connects to the Sauce Labs environment​

The Eggplant Gateway for Sauce Labs (or the Eggplant Gateway, in short) enables Eggplant Functional to connect directly to devices hosted in the Sauce Labs Real Device Cloud.

Typically, the Eggplant Gateway runs on the same machine as on which you have installed Eggplant Functional. The Eggplant Gateway and Eggplant Functional communicate using the VNC protocol (for image-based automation, usually at port 5900) and WebDriver (for Appium-driven automation, usually at port 5000).

The Eggplant Gateway will allocate a device on the Sauce Labs Real Device Cloud using the Sauce Labs API. The Eggplant Gateway connects to the Sauce Labs API using the HTTPS protocol (at port 443) and the Secure WebSockets protocol (at port 443). See the Sauce Labs documentation for more information about the Sauce Labs Data Center endpoints.

flowchart LR
    subgraph Local Machine
    EPF[Eggplant Functional]-->|VNC, WebDriver|EPG[Eggplant Gateway]
    end
    subgraph Sauce Labs Real Device Cloud
    EPG-->|HTTPS, WebSockets|Device[Sauce Labs API]
    end

The communcation flow is similar when running a DAI model on a Sauce Labs device. In this case, DAI connects to an instance of Eggplant Functional, which leverages the Eggplant Gateway to connect to the Sauce Labs Real Device Cloud.

Allowing applications on Sauce Labs devices to connect to corporate systems​

When using the Eggplant Gateway for Sauce Labs, the application under test is running on a Sauce Labs device. These devices are located in one of Sauce Labs' datacenters. In certain scenarios, these applications may need to connect to corporate systems, such as UAT environments, which are not usually exposed over the public Internet.

In these scenarios, you can consider using Sauce Connect (a VPN tunnel technology) to provide your application with access to the corporate systems. See the Sauce Connect documentation for more information.

Last updated on