Adding SUTs in Eggplant Manager

Before selecting a system under test (SUT) for a test run, you must add it to Eggplant Manager so that the appropriate connection is made at runtime. You add SUTs on the SUTs page by going to Admin > SUTs.

For general information about working with the SUTs administration page, see Working with Systems Under Test (SUTs).

You have several methods for adding new SUTs, as well as many types of SUTs that Eggplant Manager supports. The method you choose for adding a SUT might be determined by the type of SUT you're adding as well as other factors. Be sure to read the following sections carefully so that you can make the appropriate choice.

Using SUT Discovery to Add SUTs

Use the SUT Discovery feature on the SUTs administration page to find test environments and automatically add basic information about the environment. This method is a good choice for adding multiple SUTs as well as for adding mobile device SUTs because much of the information on the New SUT dialog box is filled in for you.

The SUT Discovery section of the SUT administration page in Eggplant Manager

Choose Discover LAN SUTs, which locates any environment reachable via your LAN, or Discover USB SUTs, which locates mobile devices (Android or iOS) that are currently connected via USB, or Import SUTs from Eggplant Functional. Follow the appropriate instructions shown below to add SUTs with the automatic discovery feature.

Step by Step: Adding LAN SUTs with SUT Discovery

The following steps guide you through adding SUTs from your LAN by using the SUT Discovery feature:

1. In Eggplant Manager, go to the SUTs page by choosing Admin > SUTs, then locate the SUT Discovery section.
2. Click Discover LAN SUTs. Eggplant Manager searches for all environments reachable via the LAN. You'll see a progress bar during the search. When the search is complete, the Find LAN SUTs dialog box shows the list of SUTs available to add.
   
3. Select the checkbox for the SUTs you want to add, then click Save Selected. The new SUTs are added to the SUTs list at the top of the page. The IP address is added automatically, and the connection type defaults to VNC.
4. Add or update information about the device in the Edit SUT dialog box, if necessary.

The SUT is now ready to be used for running tests through Eggplant Manager.

Step by Step: Adding Mobile Device SUTs with SUT Discovery

The following steps guide you through adding a USB SUT for a mobile device using SUT Discovery:

1. Connect the mobile device via USB to the computer where your Eggplant Manager server is running.
2. In Eggplant Manager, go to the SUTs page by choosing Admin > SUTs, then locate the SUT Discovery section.
3. Click Discover USB SUTs. Eggplant Manager searches for any devices connected to the Eggplant Manager machine via USB. Eggplant Manager creates a new SUT for each device it finds. The new SUT is added to the SUTs list at the top of the page.
   Note: If more than one device is detected, a new SUT is added for each one.
4. Add or update information about the device in the Edit SUT dialog box, if necessary.

The mobile device SUT is now ready to be used for running tests through Eggplant Manager.

Step by Step: Importing SUTs from Eggplant Functional

Follow these steps to import SUTs that you've defined or added in the Eggplant Functional Connection List:

1. Click Import SUTs from Eggplant Functional. The Import SUTs window opens.

   

2. Click Choose File to select your Eggplant Functional preferences file. Follow the instructions to export the preferences file if you haven't done so previously.
3. Select the SUT you want to import, then click Submit. Your new SUT is added to the SUTs list at the top of the page.

   

4. Add or update information about the SUT in the Edit SUT dialog box, if necessary.

The imported SUT is now ready to be used for running tests through Eggplant Manager.

Manually Adding SUTs

When you have individual SUTs to add, use the New SUT dialog box on the SUTs administration page. This method requires you to input all the details for the connection, and lets you customize all the information as you enter it. You must use the New SUT dialog box to create a rule-based SUT, as well as certain configurations for mobile device SUTs and VMs.

Step by Step: Adding SUTs with the New SUT Dialog Box

The following instructions guide you through adding a SUT.

1. In Eggplant Manager, go to Admin > SUTs.
2. In the SUTs section, click New SUT to open the New SUT dialog box.



The New SUT dialog box in Eggplant Manager.

3. Specify a unique name for the SUT in the Name field.
4. Select the type of SUT you are adding from the Type drop-down list. The next section changes depending on the SUT type you choose. Your choices are:
   VNC/RDP: These SUT types let you specify connection information to specific environments. Read more . . .

   These two SUT types are closely related. Typically, you use these SUT types for environments, which can be physical machines or virtual machines (VMs), that you connect to via a specific IP address or hostname and on a specific port.

   Complete the following fields to add either a VNC SUT or an RDP SUT:

   • IP Address: Enter the IP address or hostname of the SUT.
   • Port: Specify the port for your connection. By default, 5900 is entered for VNC connections, and 3389 is entered for RDP connections.
   • Username: (RDP only) Enter the Windows username needed for connections to this SUT, if one is required. (Optional)
   • Password: Enter the password for this SUT, if one is required. (Optional)
   • Screen Size: (RDP only) Enter the Width and Height for the RDP connection window. (Optional)

   Rule: This SUT type matches available SUTs to your specified criteria at test runtime. Read more . . .

   With rule-based SUTs, you set matching criteria, or rules, then Eggplant Manager selects a specific SUT from your list that meets the requirements and is available at test runtime. Complete the following fields to create a rule-based SUT:

   • Match: Select the attribute you want to match from the drop-down list. Most of the attributes that appear on the New SUT dialog box are available for matching, and if you have created custom SUT Tags, they appear in the list as well.
   • Value: Enter the specific value for the attribute that you want to match. Matches are case-sensitive and must be exact.

   
   The New SUT dialog box showing a rule-based SUT for Windows 10 environments

   To add additional rules, click the green plus (+) button to add a new Match and Value pair. Every rule you create must be true for the overall match to be valid.

   To remove a rule, click the red X button.

   Beneath the Match and Value fields, Eggplant Manager automatically shows the valid matches based on the current rule set. These are the SUTs that Eggplant Manager chooses from when you start a test with this rule-based SUT. You won't know the specific "fixed" SUT until the test begins.

   Note: If you need a test to run in a specific SUT, it's always best to specify that SUT rather than to use a rule-based SUT.

   Note: When you select the Rule option, the New SUT dialog box changes so you no longer have options on the right side of the window, such as OS and Version. Instead, you would make rules to match those fields in other SUTs.
   TCP: This SUT type lets you use different functional test automation tools, such as Selenium, Appium, and other tools integrating with Eggplant Functional that require a TCP connection, with your Eggplant Automation Cloud-based testing environment. Read more...

   Select this SUT type if you currently use a variety of functional test automation tools and know that a tool requires a TCP connection. TCP SUTs let Eggplant Automation Cloud manage access for 3rd party testing solutions that use TCP connections. After a reservation to a 3rd-party tool is active (connected using TCP), you can run scripts from that 3rd party tool using the reservation IP address and port.

   Make entries in the following fields to add a TCP SUT:

   • IP Address: Enter the IP address or hostname of the SUT.
   • Port: Specify the port for your connection. By default, 5900 is entered for TCP connections.

   
   

   The TCP setting dialog box for connecting Eggplant Functional to test automation tools.

   Mobile SUT: Use this SUT type to add Android and iOS device SUTs. Read more . . .

   Use the Mobile SUT option to add Android and iOS device SUTs. For Eggplant Manager to connect to these devices, you also need to install the appropriate support application (Android Gateway or iOS Gateway). With a properly configured mobile device SUT, Eggplant Manager launches the support application, makes the connection to the device, and then runs the test.

   Note: The Mobile SUT option appears only if either Android Gateway or iOS Gateway (or both) is installed on the machine where Eggplant Manager is running.

   Complete the following fields to add a mobile device SUT:

   • Gateway: Choose iOS Gateway to connect to iOS mobile devices or Android Gateway to connect to Android mobile devices.
     Note: The appropriate application must be installed on the machine where Eggplant Manager is running for it to appear in the list.
   • SUT Identifier: Enter the Unique Device ID (UDID) for iOS devices or the serial number for Android devices. You should be able to find this information through iOS Gateway, Android Gateway, or through the device's settings. If you use SUT Discovery to add a mobile device SUT, this information is filled in automatically.

   
   Adding a new Mobile SUT for an iOS device in Eggplant Manager.

   For more information about using mobile device SUTs for tests, see Mobile Device SUTs.

   VirtualBox Virtual Machines: This SUT type allows Eggplant Manager to start and stop VMs for use at test runtime. Read more . . .

   This SUT type requires that you use Oracle VM VirtualBox for the VMs you wish to manage with this method.

   VirtualBox VMs can run Windows, Mac OS, or Linux operating systems, and you can set the connection type as either VNC or RDP. If you install the VirtualBox Extension Pack, you also have the Auto RDP connection option, which lets VirtualBox make the connection to the virtual environment.

   Note: The VirtualBox Virtual Machine SUT type appears only if VirtualBox is installed on the machine where Eggplant Manager is running.

   Complete the following fields to add a VirtualBox Virtual Machine SUT:

   • VM Template: The drop-down list shows all available appliances (VMs) that are currently in VirtualBox.
   • Connection: Select the connection method, either Auto RDP, VNC, or RDP, from the drop-down list. Note, however, that you won't have the Auto RDP option unless you have installed the VirtualBox Extension Pack. With Auto RDP, VirtualBox makes the connection to the SUT, so no further information is required. The following fields are enabled only if you select VNC or RDP.
   • IP Address: Enter the IP address or hostname to connect to this VM.
   • Port: Enter the port over which you connect to this VM. By default, 5900 is entered for a VNC connection, and 3389 is entered for an RDP connection.
   • Password: Enter the password for this SUT, if one is required.

   
   The Virtual Machine section of the New SUT dialog box in Eggplant Manager.

   When you add a Virtual Machine SUT, a clone of the appliance is created in VirtualBox after you click Create (step 9 below). The new SUT is added to the SUTs list and is marked Inactive until the cloning is complete, when it switches to Active.

   Note: You can create multiple SUTs from the same VM Template (appliance). However, each SUT you add creates a clone of the original appliance, so you will want to watch the amount of disk space you are using.

   For more information about using the embedded Virtual Machines feature, see Setting up VirtualBox SUTs.

   VMware Virtual Machines: This SUT type allows Eggplant Manager to start and stop VMs for use at test runtime. Read more . . .

   This SUT type requires that you use VMware Fusion or Fusion Pro (Mac) or Workstation Pro (Windows or Linux) for the VMs you wish to manage with this method. These VMs can run Windows or Mac operating systems, and you can set the connection type as either VNC or RDP.

   Complete the following fields to add a VMware virtual machine SUT:

   • Connection: Select the connection method, either VNC, or RDP, from the drop-down list. Note that VMware virtual machines feature a built-in VNC server.
   • File Browser: Selecting this box adds the Virtual Machine Directory Path field to the New SUT window. Click the folder to navigate to the location of your VMware virtual machine. Note that you can also enter this path in Admin > System Preferences.
   • IP Address: Enter the IP address or hostname to connect to this VM.
   • Port: Enter the port over which you connect to this VM.
   • Password: Enter the password for this SUT, if one is required.

   

   Note: Your list might also include Mobile Emulator. This SUT type for Android and iOS mobile emulators is available only if you have enabled experimental features on the System Preferences page. Each emulator platform has additional requirements as well.
5. Select the Active checkbox if you want this SUT to be available to run tests. If the checkbox is not selected, the SUT definition remains but the SUT is unavailable for tests. Default: selected.
6. Set group membership in the Groups box. When you add new SUTs, the Default Group is automatically selected. Be sure to remove SUTs from this group and add them to your own groups if you intend to use groups to control user access to specific SUTs. For information about using groups to manage access, see Working with Eggplant Automation Cloud Groups.
7. Enter descriptive text in the Description field, if desired. This field is optional. However, you can use it to provide additional information about the SUT.
8. On the right side of the New SUT dialog box, fill in the additional information about the SUT. These fields include:
   • Manufacturer
   • Model
   • OS
   • Version
   Note: Although these fields are optional, you should fill them all in if you plan to use Test Advisor to determine coverage.

   Note: If your SUT is a mobile device connected using VNC, click Poll Data to have Eggplant Manager automatically populate these fields.

   

   If you have custom SUT Tags in your environment, they also appear here. Although these fields are optional, any information you enter can be used to create rule-based SUTs as well as for filtering the SUTs list, so it's a good idea to include as much information as you can.

9. When you finish filling in the information for your new SUT, click Create. Your new SUT appears in the SUTs list.

Editing and Removing SUTs

To edit a SUT, select the SUT in the SUTs list, then click Edit SUT. You can also double-click the SUT in the list. The Edit SUT dialog box contains the same fields as the New SUT dialog box.

To remove an existing SUT, select it in the list and click Remove SUT. You can also click the Remove button on the Edit SUT dialog box.

Creating SUT Tags

If you want to record additional information or attributes for your SUTs, create SUT tags. SUT tags are custom fields that, when created, display on the Create and Edit SUT panels. For example, you might add a field named Device to indicate the type of device as shown in the sample screen below. You can also create SUT tags to add criteria you can use for matching your rule-based SUTs.

Click New Tag to open the New Tag dialog box:

The name you enter for the tag appears in the drop-down list of filters. You can also include a description to explain what the tag is used for and any specific information about how information should be entered. For example, you might include a tag such as Accessibility where you want the information stored as a Boolean, true or false, to indicate whether the SUT has accessibility features turned on.

When you have SUT Tags defined, they appear as fields when you add or edit SUTs:

The value you enter in the tag field becomes something you can use as a filter. For example, if you defined a Location filter, the value you entered in the field might correspond to the physical location of the SUT. So if you selected Location from the Filter drop-down list, you could enter server room in the Value field to find only SUTs entered with that location.

 

This topic was last updated on August 19, 2021, at 03:30:51 PM.

Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2022 Eggplant