Managing SUTs in Eggplant DAI

From Controller > SUTs, you can manage system under test (SUT) connections in Eggplant DAI to automate testing on remote systems. You can also view, add, edit, and delete SUTs and connection types here. The list of SUTs is updated dynamically as connections are added, deleted, or modified. You can have any number of SUTs connected at any given time.

note

A SUT appears locked if it is being used by another user or by a test run in progress. Locked SUTs cannot be used for any other purpose until they are unlocked.

The following columns are displayed to provide at-a-glance details about each SUT connection:

• Name: Display name of the SUT.
• Description: Description of the SUT.
• Criteria Tags: Any criteria tag defined for the selected SUT that you're viewing. A SUT can have one or more criteria tags.
• Connection Types: Connection types defined for a SUT. It could have one or more of the following connection types: VNC, RDP, WebDriver, Citrix, Sauce Labs Browser, Sauce Labs Device, Android Device, iOS Device, Single System.
• Status: Indicates the availability of the SUT. The options are: Locked, Unlocked (Available) and Disabled.

Click the Actions menu to Edit, Delete, or Unlock a SUT and its associated connection types.

Click the SUT name to view full SUT details.

You can filter the SUTs view by clicking Filter All to filter by All, Available, Locked, and Disabled.

note

You need to have Administrator permissions to be able to edit, delete, or unlock SUTs in Eggplant DAI.

Adding SUT Connections

note

If you're using DAI Eggplant Cloud (previously called Hosted DAI), you don't need to register or add SUTs manually as Cloud SUTs will automatically be allocated during test execution.

You can define a variety of ways to connect to a SUT in Eggplant DAI. Eggplant DAI supports Virtual Network Computing (VNC) and Remote Desktop Protocol (RDP) connections for testing desktop systems and mobile device connections, WebDriver for object-based testing of apps on web browsers, web applications, and mobile devices. It also supports connections to Citrix Storefront as well as Sauce Labs Browsers and Sauce Labs Devices. The connections defined against SUTs are established automatically when the SUT is used to run a test in the Controller > Runner.

Follow these steps to add a new SUT connection:

1. Go to Controller > SUTs.

2. From the top menu, click + New SUT.

3. Enter the display Name and Description for the SUT so that you can easily identify it in your existing list of SUTs.

4. Add Criteria tags by entering a name for the tag and pressing Enter. You can add any number of criteria tags, which can be used for selecting a SUT to use in a test.

5. Add the Execution Environment(s) to be used for this SUT by clicking and choosing them from a list. You can filter the list by entering specific characters of the Execution Environment name. You can add any number of Execution Environments. When this field is left blank, any available execution environment will be used to connect to the SUT when a test is run. This field becomes mandatory if your Connection Type is Android Device, iOS Device or Single System. Once the field becomes mandatory, one or many Execution Environments can be selected. However, for Connection Type of Single System, only one Execution Environment can be selected.

6. (Optional) Select the Disable SUT checkbox, if necessary. This will prevent the SUT from being used when running tests.

7. Click Add Connection + to define a Connection Type for your SUT.

8. Select a Connection Type from the following options:

   • RDP: Select for connections via RDP.
   • VNC: Select for connections via VNC.
   • WebDriver: Select for connections using Selenium WebDriver.
   • Citrix: Select for connections using Citrix.
   • Sauce Labs Browser: Select for connections using Sauce Labs Browser.
   • Sauce Labs Device: Select for connections using Sauce Labs Device.
   • Android Device: Select for connections using Android Device.
   • iOS Device: Select for connections using iOS Device.
   • Single System: Select for connections using Single System.

9. (Optional) If you choose RDP, VNC or WebDriver, you get the option to add a secondary connection.

   See the referenced sections below for adding each of the connection types in detail.

   note

   A primary connection is required to create a SUT. A secondary connection is optional. You can define the connections based on these rules:

   • If RDP is the primary connection, then only WebDriver can be the secondary connection.
   • If VNC is the primary connection, then only WebDriver can be the secondary connection.
   • If WebDriver is the primary connection, then only RDP or VNC can be the secondary connection. Once RDP or VNC is added into the connection list, it will become the primary connection and WebDriver becomes the secondary connection.
   • If Citrix, Sauce Labs Browser, Sauce Labs Device, Android Device, iOS Device or Single System is the primary connection, then there is no secondary connection available.

10. Click Save and close.

The newly added SUT connections appear in the SUTs tab.

Step by Step: Entering RDP Connection Details

1. From the Connection Type list, select RDP.
2. Enter the IP address or Hostname of the SUT you want to connect to. The RDP connections default to port 3389, but you can change this if necessary.
3. For RDP connections, the Password and Username fields refer to the Windows user account you are connecting to. This information is always required for RDP connections.
4. Specify the Width and Height at which the RDP session window must open.
5. Click Save connection to save the connection details to the Connection Types list.

note

For RDP connection to work, your SUT must be configured to accept the connection.

RDP Settings

RDP Setting	Description
Server (IP Address, Hostname)	Enter the SUT's IP Address or Hostname.
Port	The port number used to connect to the SUT.
Username	The username of RDP connection for SUT to connect.
Password	The password of RDP connection for SUT to connect.
Color Depth	(Optional) The depth of color with which the VNC sessions open. To increase the speed of your connection, you can decrease the color depth by selecting a lower depth from the options available in the drop-down list. - Default: Select this to draw the SUT with the same color depth you see on its native display. - Millions (32-bit): Select this to increase the color depth of the SUT by millions of colors that are otherwise not visible to the human eye. - Thousands (16-bit): Select this to decrease the color depth of the SUT to 65,536 colors. - 256 (8-bit): Select this to decrease the color depth of the SUT to 256 colors. - Width and Height: (Optional) is the width and height at which the RDP session window must open.

Step by Step: Entering VNC Connection Details

1. From the Connection Type list, select VNC.
2. Enter the IP address or Hostname of the SUT you want to connect to. The VNC connections default to port 5900, but you can change this if necessary.
3. For VNC connections, the Username and Password fields refer to the VNC server on the SUT. If this information is required to connect to the VNC server, enter it here. On Windows, enter your SSH key in the Password field.
4. (Optional) Add the required SSH Settings for this connection.
5. Click Save connection to save the connection details to the Connection Types list.

VNC Settings

VNC Setting	Description
Server (IP Address, Hostname)	Enter the SUT's IP Address or Hostname.
Port	The port number used to connect to the SUT.
Username	(Optional) The username of VNC connection for SUT to connect.
Password	(Optional) The password of VNC connection for SUT to connect.
Color Depth	(Optional) The depth of color with which the VNC sessions open. To increase the speed of your connection, you can decrease the color depth by selecting a lower depth from the options available in the drop-down list: - Default: Select this to draw the SUT with the same color depth you see on its native display. - Millions (32-bit): Select this to increase the color depth of the SUT by millions of colors that are otherwise not visible to the human eye. - Thousands (16-bit): Select this to decrease the color depth of the SUT to 65,536 colors. - 256 (8-bit): Select this to decrease the color depth of the SUT to 256 colors. - Scale Ratio: Select the option to scale VNC servers by 50 percent in each dimension. This option provides better performance when you are using mobile devices with large screens or high resolution. - SSH Settings: (Optional) Secure Shell (SSH) is a network protocol that uses data encryption to transfer information securely. - Host: The host name or IP address of the computer that hosts an SSH tunnel for the SUT’s secure connections. - Username: The account name with which the SUT user logs into an SSH host. - Password: The password with which the SUT user logs into an SSH Host.

note

When you add RDP or VNC as the primary connection and WebDriver as the secondary connection, you will see that the Server field for WebDriver is disabled by default. To change this, you have to change the Server field from the RDP or VNC field instead.

Step by Step: Entering WebDriver Connection Details

1. From the Connection Type list, select WebDriver.

2. Enter the IP address or Hostname of the SUT you want to connect to. WebDriver connections default to port 4444, but you can change this if necessary.

3. Select a Browser from the following options:

   • Chrome
   • Firefox
   • Safari
   • Microsoft Edge
   • Internet Explorer
   • None

4. Add any desired WebDriver Capabilities as key value pairs, using JSON format.

   note

   If your test uses a browser that is not listed in the Browser drop-down list above, then select None and enter browserName: <your browser> as one of the key value pairs in the Capabilities field.

5. Click Save connection to save the connection details to the Connection Types list.

   note

   Any WebDriver devices configured to use this SUT will automatically connect when running tests. You can use WebDriver() functions in your SenseTalk snippets to get access to this connection and perform actions against it.

WebDriver Settings

WebDriver Setting	Description
Server (IP Address, Hostname)	Enter the SUT's IP address or hostname.
Port	The port number used to connect to the SUT.
Browser	(Optional) The type of browser you want to launch on the SUT for testing.
Capabilities	(Optional) A valid JSON file that is used to communicate the features supported by a session.

Step by Step: Entering Citrix Connection Details

1. From the Connection Type list, select Citrix.
2. Enter Username and Password of the Citrix account.
3. Enter Storefront URL. For example: http://{server}/Citrix/{company name}.
4. Enter Application name.
5. (Optional) Enter Screenshot Interval. The default value is 400 milliseconds.
6. (Optional) Enter resolution Width and Height. The default value is 1600x900.
7. Click Save Connection to save the connection details to the Connection Types list.

For more information about the setup, see Install Eggplant Functional and Citrix.

note

Support for Citrix connections is only available with the Windows version of Eggplant Functional.

Citrix Settings

Citrix Setting	Description
Username	The username to connect to the Citrix SUT.
Password	The password for the username to connect to the Citrix SUT.
Storefront URL	The Citrix Storefront URL.
Application	The name of the application or desktop to launch in Citrix.
Screenshot Interval	(Optional) This is the time to wait between two subsequent captures of the Citrix frame buffer.
Width and Height	(Optional) The width and height at which the Citrix window must open.

Step by Step: Entering Sauce Labs Browser Connection Details

1. From the Connection Type list, select Sauce Labs Browser.
2. Enter the Username and API Key of the Sauce Labs account you want to use.
3. Select a Data Center from the available options.
4. Click Check Connection to validate the Sauce Labs credentials and connection. When the account is successfully validated, more Sauce Labs settings will be visible for configuration.
5. Select a Platform Name from the available options to specify the type of operating system you want to test on the Sauce Labs SUT.
6. Select a Browser Name from the available options to specify the type of browser you want to launch and test on the SUT.
7. (Optional) Select a Version from the available options to specify the version of the browser you selected for testing on the SUT. By default the latest available version from Sauce Labs will be used, if the version is not specified.
8. (Optional) Specify the Width and Height (resolution) for the size of the SUT window you want to open for testing. The default value is 1024x768.
9. (Optional) Enter the URL you want to navigate to when the browser launches.
10. (Required for tunnel proxy users) Enter the Tunnel Owner name if you are using tunnel proxies with your Sauce Labs connections. Note that your Sauce Labs tunnel proxy should be running. You do not see the Tunnel Name field until you provide the Tunnel Owner.
11. (Required for tunnel proxy users) Enter the Tunnel Name name if you are using tunnel proxies with your Sauce Labs connections. Note that your Sauce Labs tunnel proxy should be running. You do not see this field until you provide the Tunnel Owner.
12. Click Save Connection to save the connection details to the Connection Types list.

note

Your Sauce Labs connection will end after 3 hours.

For more information about supported Platform name, Browser name and Version, see Supported Browsers & Devices. For more information about Tunnel Owner and using tunnels with Sauce Labs tunnel proxies, see Sauce Connect Proxies in the Sauce Labs documentation.

Sauce Labs Browser Settings

Sauce Labs Browser Setting	Description
Username	The Sauce Labs account username.
API Key	The Sauce Labs account API Key. For more information, see Sauce Labs User Settings.
Data Center	The location of the Sauce Labs server where your tests are run and related artifacts are stored.
Check Connection	Validates the Sauce Labs account and connection, and enables more Sauce Labs configuration options.
Platform Name	The operating system to use for the Sauce Labs SUT.
Browser Name	The browser (for example, Chrome or Firefox) to launch and run the test.
Version	(Optional) The version of the browser you want to use in your test.
Width and Height	(Optional) The resolution of the window to open for the Sauce Labs browser. For more information about supported resolution, see Sauce Labs platform configuration.
URL (Optional)	The website address to navigate to when the browser launches.
Tunnel Owner (Required for tunnel proxy users)	Your tunnel owner name if you use tunnel proxies with your Sauce Labs connections. You do not see the Tunnel Name field until you provide a Tunnel Owner.
Tunnel Name (Required for tunnel proxy users)	Your tunnel name if you use tunnel proxies with your Sauce Labs connections. You do not see this field until you provide the a Tunnel Owner.

Step by Step: Entering Sauce Labs Device Connection Details

1. From the Connection Type list, select Sauce Labs Device.
2. Enter the Username and API Key of the Sauce Labs account you want to use.
3. Select a Data Center from the available options.
4. Click Check Connection to validate the Sauce Labs account and connection. When the Sauce Labs account is successfully validated, more Sauce Labs settings will be visible for configuration.
5. Select a Platform Name from the available options to specify the type of operating system you want to test on the Sauce Labs SUT.
6. Select a Device Name from the available options to specify the type of mobile device you want to test.
7. (Optional) Enter the path to the App you want to launch on the Sauce Labs device. If you do not specify an one, the device starts-up without launching an app. For more information, see Mobile App Storage.
8. (Required for tunnel proxy users) Enter the Tunnel Owner name if you are using tunnel proxies with your Sauce Labs connections. You do not see the Tunnel Name field until you provide the Tunnel Owner. Your tunnel proxy must be running to use it with your DAI connection.
9. (Required for tunnel proxy users) Enter the Tunnel Name name if you are using tunnel proxies with your Sauce Labs connections. You do not see this field until you provide the Tunnel Owner.
10. Click Save Connection to save the connection details to the Connection Types list.

note

Your Sauce Labs connection will end after 3 hours.

Sauce Labs Device Settings

Sauce Labs Device Setting	Description
Username	The Sauce Labs account username.
API Key	The Sauce Labs account API Key. For more information, see Sauce Labs User Settings.
Data Center: The location of the Sauce Lab server where your tests are run and related artifacts are stored.
Check Connection	Validates the Sauce Labs account and enables more Sauce Labs configuration fields.
Platform name	The Sauce Labs device operating system.
Device name	The type of mobile device and version.
App	(Optional) Allows you to set a path to an .ipa, .apk, .aab or .zip file containing the mobile app you want to test.
Tunnel Owner (Required for tunnel proxy users)	Your tunnel owner name if you use tunnel proxies with your Sauce Labs connections. You do not see the Tunnel Name field until you provide a Tunnel Owner. Your tunnel proxy must be running to use it with your DAI connections.
Tunnel Name (Required for tunnel proxy users)	Your tunnel name if you use tunnel proxies with your Sauce Labs connections. You do not see this field until you provide the a Tunnel Owner.

For more information about supported Platform name and Device name, see Supported Browsers & Devices. For more information about Tunnel Owner, Tunnel Name, and using tunnels with Sauce Labs tunnel proxies, see Sauce Connect Proxies in the Sauce Labs documentation.

Step by Step: Entering Android Device Connection Details

1. From the Connection Type list, select Android Device.
2. Enter the Device ID of an Android device listed in the Android Gateway UI.
3. Click Save Connection to save the connection details to the Connection Types list.

For more information about connecting to Android devices with Android Gateway, see Connecting to Devices.

Android Device Settings

Android DeviceSetting	Description
Device ID	serial number, emulator name.

Step by Step: Entering iOS Device Connection Details

1. From the Connection Type list, select iOS Device.
2. Enter the UDID of the iOS device listed as described in Getting iOS Mobile Unique Device IDs (UDIDs).
3. (Optional) Enter the Developer certificate name or thumbprint.
4. Enter the Provisioning profile name or identifier.
5. Click Save Connection to save the connection details to the Connection Types list.

note

The values you enter for Developer certificate name or thumbprint and Provisioning profile name or identifier are ignored if a connection to the selected iOS device has already been set up previously and the existing Developer certificate is still valid.

For more information about connecting to iOS devices , see Configuring Your iOS Mobile Device for Automation.

iOS Device Connection Settings

iOS Device Setting	Description
UDID	The unique identifier of the iOS device.
Developer certificate name or thumbprint	(Optional) The path to the developer certificate.
Provisioning profile name or identifier	The path to the provisioning profile.

Step by Step: Entering Single System Connection Details

1. From the Connection Type list, select Single System.
2. (Optional) Enter the Username and Password of the Windows Account.
3. (Optional) Enter the Width and Height of the Windows resolution.
4. Click Save Connection to save the connection details to the Connection Types list.

note

Single System SUTs run as a child process of the machine where the Eggplant Functional that makes the Single System connection runs. This Eggplant Functional is part of your DAI Execution Environment. So, this is the Windows account you would use to log into that machine. If you do not specify credentials in Username and Password when you add the connection, you may see the login screen in the Viewer window when EPF connects to the Single System SUT. (Single System connection types are only available on Windows.) Moreover, if you do not specify the credentials for Width and Height, then a default resolution of 1920 x 1080 is used.

Important

A Single System Connection cannot be used with the DAI Run Agent running as a Windows Service. The machine hosting the Run Agent would need to spawn a Windows child session to start a Single System SUT but that is not possible due to the nature of Windows Services being a non-interactive session (running in the background).

Examples of use cases for supported and non-supported environments:

Use case 1 (not supported): DAI Run Agent is launched in Windows Service mode (non-interactive session), and the connection fails with an error.

Use case 2 (supported): DAI Run Agent is launched using a terminal (interactive session), and the connection is established.

Important

Single System Connection is not supported in a Cloud Execution Environment.

Editing SUT Connections

To edit an existing SUT connection:

1. Go to Controller > SUTs.
2. Find the SUT connection that you're interested in updating, then from the Actions menu, select Edit.
3. From here you can update the SUT information or connection details.

Viewing SUT Connections

To view the details for an existing SUT:

1. Go to Controller > SUTs.
2. Find the SUT connection that you want to view, then click on the connection name.

note

If the SUT is locked, click on the padlock icon in the Status column to unlock it.

About Passwords and API Keys

Passwords and API Keys are write-only. Once you have saved the connection details you will not be able to access the password or API Key again later, so you must make sure you store the password or API Key in a separate, secure location if you will need to access it in future.

When adding or editing a password or API Key you can click the toggle icon to reveal your newly entered password or API Key value before saving.