PDF Documentation

Published on Documentation (http://127.0.0.1)
Home > Getting Started
Getting Started
Getting Started with eggPlant Functional
This manual provides the background and set-up instructions you need to get started with eggPlant
Functional, TestPlant's test automation tool.
Following these few steps, you can be ready to start writing test scripts within one hour:
1.
2.
3.
4.
Set up the eggPlant Functional application.
Install a VNC server on your system under test (SUT).
Open a VNC connection.
Take a brief tour of eggPlant Functional.
PDF Version
If you want to access the documentation offline, you can download a PDF version of this manual from the
following link:
Click Here for PDF Documentation [1]
Table of Contents
About eggPlant Functional [2]
Creating the eggPlant Functional Environment [3]
Installing eggPlant Functional [4]
Installing a VNC Server [5]
VNC Security [6]
Connecting Under Special Circumstances [7]
Direct Connections [8]
Reverse VNC Connections [9]
Connecting with a KVM Switch [10]
Troubleshooting Connection Issues [11]
Licensing [12]
Generating eggPlant Functional Licenses [13]
Generating Node-Locked Licenses [14]
Generating Team Licenses [15]
About Team Licenses [16]
Port Configuration [17]
Installing and Licensing the TLS [18]
Running the TLS as a Service [19]
Help and Additional Information
Manuals
You can access all of the following manuals online through the TestPlant Documentation website [20]. You
can also access documentation within individual products by going to Help > Documentation.
Getting Started [21] provides instructions for a basic eggPlant Functional set up to get you started using
this testing tool and familiarize you with its functionality.
Using eggPlant Functional [22] is a collection of articles that delve into the eggPlant Functional
workflow and explain a variety of important tasks and concepts such as how to organize your testing
process and how to use eggDrive to integrate scripts from other testing tools.
eggPlant Functional Reference [23] describes the eggPlant Functional interface and scripting processes,
1
and the SenseTalk commands, functions, and global properties that are unique to eggPlant
Functional.
SenseTalk Reference [24] is a comprehensive guide to the SenseTalk scripting language used with
eggPlant Functional. This manual discusses all aspects of the SenseTalk language that are used for
general scripting purposes. Commands and functions that are unique to eggPlant Functional are also
described here.
The eggPlant Performance [25] manual describes how to set up, run tests, and view results with
eggPlant Performance, a load and performance testing tool.
The eggPlant Manager [26] manual provides instructions for a basic set up of eggPlant Manager, a test
management system. Learn how to schedule and execute tests and view results.
The eggCloud [27] manual describes how to deploy and administer eggCloud, a test-reservation
system. You'll also learn how to make reservations and how to connect through eggCloud.
The eggMan [28] reference helps you set up and get started using this free tool for manual testing.
The eggBox [29] manual describes this appliance, which comes with a range of pre-installed TestPlant
tools and related applications, and shows how you can use it to easily set up and run a test lab.
The eggPlant Network [30] reference describes the eggPlant Network appliance and how to use it to
emulate network conditions when testing with eggPlant Functional and eggPlant Performance.
Connecting to SUTs [31] is a reference for everything you need to know about how to connect to and
test against mobile devices with eggPlant Functional using either eggOn or iOS Gateway.
The Knowledge Base [32] is a collection of articles from different contributors that describe a variety of
techniques and approaches to using eggPlant Functional, as well as best practices and use-case
scenarios.
Further Resources
The Examples section [33] of the TestPlant documentation provides a variety of example scripts using
SenseTalk to run eggPlant Functional tests, which you can adapt to fit your testing needs.
The FAQ section [34] gathers common problems and solutions for TestPlant products.
Online eggPlant Functional Tutorials: [35] This series of four interactive tutorials introduces the scripting
environment and some frequently used commands and functions.
eggPlant Functional User Forum: [36] Use this forum to ask questions of other eggPlant Functional
users, help your peers, and share ideas and approaches for using the product.
eggPlant Functional Examples Forum: [37] This forum is a collection of eggPlant Functional scripts
written in SenseTalk that address a variety of scripting problems.
About eggPlant Functional
About eggPlant Functional
What is eggPlant Functional?
eggPlant Functional is a test automation tool. It's used for the entire testing process, from authoring scripts
to evaluating results.
2
How Is eggPlant Functional Different from Other Testing Tools?
eggPlant Functional Uses a Two-System Model
eggPlant Functional works using a two-system model. This means that eggPlant Functional runs on one
computer, but can test any number of other computers.
The first system is the machine running the eggPlant Functional application. This system can be a Mac,
Windows, or Linux machine. This machine has everything needed to run the test, such as the scripts and
associated images. The second system is the system under test, or SUT. The SUT is where the application
to be tested is running. The SUT can be any system, including desktop machines, virtual machines, or
mobile devices.
eggPlant Functional uses Virtual Network Computing (VNC) or Remote Desktop Computing (RDP) to “look
at” the SUT and send mouse and keyboard commands to it.
eggPlant Functional Finds Objects Visually
To write an eggPlant Functional script, you open a connection with a SUT and capture images of the GUI
objects that you need to test. Your script commands refer to these objects by image name. For example,
the command DoubleClick “Trash_icon” tells eggPlant Functional to search the SUT for something that
looks like the “Trash_icon” image, and double-click it.
Like a person, eggPlant Functional can interact with any object that it can “see”—regardless of operating
system or programming language. For example, a single script can validate a web application in five
different browsers, then switch to a different operating system and repeat the same process.
Overview of Testing with eggPlant Functional
1. Select a system under test (SUT) and open a connection.
2. As you control the SUT through eggPlant Functional, you can capture images that indicate the
elements of the SUT interface that you want eggPlant Functional to interact with.
3. Generate a script that tells eggPlant Functional which actions to perform at the image locations you
capture.
4. Run the script as many times as you need to perform a task or validate a process on the SUT.
5. Use the statistics and detailed run information for that script, found in the Results list of the Suite
window, to analyze your results.
Creating the eggPlant Functional Environment
Creating the eggPlant Functional Environment
This section describes the initial setup of eggPlant Functional and systems under test (SUTs).
3
For information about installing eggPlant Functional itself, see Installing eggPlant Functional [4]. For
information about installing a VNC server on your SUT, or information about VNC security, see Installing a
VNC Server [5].
If you have already installed eggPlant Functional and enabled VNC connections with your SUTs, please see
the next section.
Installing eggPlant Functional
Installing eggPlant Functional
This section covers installation of eggPlant Functional on Windows, Mac, and Linux, including the system
requirements for each.
Installing eggPlant Functional on Windows
Windows System requirements
Processor: 1.5 GHz or faster
RAM: 1 GB or more
Operating System: Windows 7, Windows 8, or Windows Server 2008/2012
For inquiries about other Windows operating systems, please e-mail TestPlant support [38].
Installation
1. Download the eggPlant Functional installer from the TestPlant Downloads [39] page.
2. Double-click the eggPlant Functional installer.
Licensing
The next step is to license eggPlant Functional. To read about this process see Generating eggPlant
Functional Licenses [13] and Licensing [12]. For specific instructions on using team licenses, please see About
Team Licenses [16].
Installing eggPlant Functional on Mac
Mac OS X System requirements
Mac OS 10.7/10.8/10.9 (Intel only)
Installation
1. Download eggPlant Functional from the TestPlant Downloads [39] page.
2. Drag the eggPlant Functional ‘dmg’ file into your Applications folder.
Tip: For quick access to eggPlant Functional, drag the eggPlant Functional icon from the Applications
folder into your Dock.
Licensing
The next step is to license eggPlant Functional. To read about this process see Generating eggPlant
Functional Licenses [13] and Licensing [12]. For specific instructions on using team licenses, please see About
Team Licenses [16].
Installing eggPlant Functional on Linux
Linux System requirements
Processor: Intel x86 32-bit or 64-bit with 32-bit system libraries
RAM: 1 GB or more
One of the following Linux distributions:
RedHat Enterprise Server 6+
4
Fedora 13+
Debian 5+
Ubuntu 10.10, 11.10, and 12.04
For inquiries about other distributions of Linux, please e-mail TestPlant support [38].
Installation
1. Download eggPlant Functional for your Linux distribution from the TestPlant Downloads [39] page.
2. Unpack the eggPlant Functional archive.
3. Install the eggPlant Functional package with a package manager.
Licensing
The next step is to license eggPlant Functional. To read about this process see Generating eggPlant
Functional Licenses [13] and Licensing [12]. For specific instructions on using team licenses, please see About
Team Licenses [16].
Installing a VNC Server
Installing a VNC Server
VNC stands for Virtual Network Computing. The VNC Server is installed on the System-Under-Test (SUT)
and works with eggPlant Functional to allow control of this second machine.
VNC Checklist
VNC server installation varies from system to system, but this section contains a checklist for general VNC
configuration, and notes about specific VNC servers.
Install a standard VNC server (up to RFB protocol 3.8.)
Verify that your network security will allow the SUT to receive connections from eggPlant Functional on
one of the VNC ports: 5900-5909.
If the VNC server requires that clients have a user account on the SUT, create an account that the
eggPlant Functional users can log in to.
Make a note of the following information to enter in eggPlant Functional’s Connection List:
The
The
The
The
SUT’s IP address or host name
SUT’s VNC port number
name and password of a user account on the SUT, if the VNC server requires it
VNC server password (if there is no user-account password)
Common VNC Servers
Platform
Server
Notes
Linux
Built-in VNC servers
Mac OS X
Vine Server from
TestPlant
If Apple Remote Desktop is running on your SUT, port 5900 is not
available for VNC connections. If you do not need to run Apple Remote
Desktop, we recommend that you turn it off; otherwise, remember to
use a VNC port other than 5900.
Windows 7,
Windows
Vista
RealVNC Personal
Edition, RealVNC
Enterprise Edition,
and UltraVNC
RealVNC Personal Edition must be run in User mode.
5
Platform
Server
RealVNC Free
Edition,
RealVNC Personal
Windows XP
Edition, RealVNC
Enterprise Edition,
and UltraVNC
Notes
RealVNC Personal Edition runs in both User mode and Service mode on
Windows XP.
Step-By-Step Instructions for VNC Server Installation
Installing RealVNC Server 5.0.2 on Windows
(The example below is on Windows 7)
1. Go to realvnc.com and download RealVNC 5.0.2 for Windows. You can use the Free version, or one of
the commercial versions. The commercial versions offer more features but these are not strictly
necessary for VNC connection with eggPlant Functional.
2. Get a license from the website by clicking on the button shown below (you can also obtain a license
later in the process after installation).
3. Open the downloaded package from the downloads folder on your machine.
4. Follow the installation instructions.
5. To configure a password, open the RealVNC Server and click More, then select Options. This will
bring up a panel that allows you to set a password for the connection.
6
6. To license, click More, then select Licensing, and follow the instructions, using the license key you
have obtained from the RealVNC website.
Installing Vine 4.0 on Mac
(The example below is on Mac OS 10.7 Lion)
1. Download the latest version of Vine VNC from the TestPlant Downloads page.
7
2. Open the .dmg package.
3. In Finder, drag the Vine Server icon that appears into your Applications folder, and/or your Dock.
4. Launch Vine. Make sure that it is set up to communicate on the correct port (usually 5900).
Using Built-In VNC on Ubuntu
(The example below is on Ubuntu 12.04)
1. Open Desktop Sharing, which can be found under Applications.
2. Select Allow other users to view your desktop .
Optional - de-select You must confirm each access to this machine , so that you do not have to
approve the connection from the Ubuntu machine every time.
8
3. If you are not seeing updates in the Remote Screen Window from the eggPlant side, log out of the
Ubuntu user account, and click the gear next to the log in field.
Then select Ubuntu 2D. This will disable some desktop effects, and allow the VNC to send updates of
the screen to eggPlant Functional.
VNC Security
VNC Security
This article answers many frequently asked questions for customers who are concerned about security
when using VNC. It discusses some different steps that can be taken to make the VNC server secure.
We have customers using VNC in secure environments including DoD labs around the country, and in those
cases the issues of security have been addressed to everyone’s satisfaction.
It is easy to deploy the VNC server securely, but how that is done is up to individual network infrastructure.
The most important thing to understand is that the security of the VNC server is controlled by the network
and not the other way around. If the machine that VNC is running on is behind a network firewall and the
ports used by the VNC server are closed by that firewall, then the VNC server on that machine is as secure
as anything else on the LAN.
VNC Server Security
The VNC server itself can be secured in a couple of ways; First by using a password, and second through
9
SSH encryption.
Password
The first and most obvious is that it can be protected with a password, so that only those with the
password can initiate a connection. The second is that the server can be set up to accept connections only
from a specific IP address (or addresses) or addresses within a designated subnet.
SSH Encryption
Taking things a step further, the server can be configured to only accept connections via SSH (the secure
shell). This requires the installation of some additional (freely available) software on Windows, but in this
way the connection between eggPlant Functional and the VNC server is fully encrypted. If the server is then
configured to accept connections only from localhost (127.0.0.1), which is unspoofable because it is not
routable, the only connection the server will accept is one made via the SSH tunnel, thus creating a
completely secure connection.
Using SSH to Ensure VNC Security
Note: To read about making an SSH connection through the Connection List in eggPlant Functional, see
Opening Secure Connections [40].
10
Network Security
The Network configuration can also be set up in a secure manner, outside of the VNC server:
Virtual Machines
Another approach, which is in some ways simpler to implement, is to run a virtual machine (VM) on the
eggPlant Functional machine. A NATted network can be set up between the eggPlant Functional machine
and the VM(s) and then the VNC server can be run on the VM to serve as the SUT. The NATted network is
behind the firewall on the eggPlant Functional machine and the VNC server is running inside a program
pretending to be a computer on a separate network. All the other security measures could be still be
applied to configuring the VNC server for an even more secure approach.
Using a NATted Network to Ensure VNC Security
Isolation
A final approach is to have the test environment on its own network with no external connections.
Obviously this is only viable for scenarios that don’t require access to other network resources such as web
servers, but when practicable it does produce a secure test environment. In its most basic form, an
eggPlant Functional test environment is just two machines networked to each other.
Connecting Under Special Circumstances
11
Connecting under Special Circumstances
Direct Connections
If you are testing a SUT that cannot be part of a larger network (usually for security or logistical purposes),
Direct Connections [8] explains how to create a closed, local connection with eggPlant Functional.
Reverse VNC Connections
If you are unable to configure the firewall of a SUT to accept VNC connections, you can often open a
reverse VNC connection [9], in which the SUT initiates the VNC connection and the eggPlant Functional
computer accepts it.
Connecting with a KVM Switch
If you are unable to install a VNC Server on the SUT due to security concerns or lack of VNC Server
availability, Connecting with a KVM Switch [10] is a good alternate method.
Direct Connections
Direct Connections
If you are testing a SUT that cannot be part of a larger network (usually for security or logistical purposes),
this section explains how to create a closed, local connection with eggPlant Functional.
Step-by-Step: Setting up a Direct Connection Between
eggPlant Functional and the SUT
This process is nearly identical for the eggPlant Functional computer and the SUT. (The only difference is
the IP address in step three.)
The required settings are found in the computers' network preferences (not in the eggPlant Functional
application or the VNC server.)
1. In network preferences, select (or create a new) connection. Select a "wired" or "ethernet"
connection.
2. Indicate that you are using a static IP address. This option may take several forms:
Disable DHCP or Roaming Mode.
Select Static or Manual IP address.
Select Use the following IP address:
3. Enter a private IP address. Use 10.0.0.1 for eggPlant Functional, and 10.0.0.2 for the SUT. (These
IP addresses are "non-routable", or reserved for private networks.)
4. Make the eggPlant Functional computer a router for the SUT.
1. In the Gateway or Router field, enter the IP address of the eggPlant Functional computer:
10.0.0.1 .
2. Enter the subnet mask 255.255.255.0 . (On this network, only IP addresses that begin with 10.0.0
are considered local.)
5. Connect the computers with an ethernet cable.
Step-by-Step: Setting up a Direct Connection in eggPlant
Functional
1. Create a new network location on the eggPlant Functional computer. (For Mac OS X 10.4, see
note below.)
12
1. Open Mac OS X System Preferences > Network.
2. In the Location pop-up menu, choose Edit Locations.
3. In the location list, click the plus sign to add a new location.
4. Give the new location a descriptive name, such as "Direct Connection".
5. In the list of network interfaces, select Ethernet.
2. Give the computer a private IP address.
1. In the Configure pop-up menu, choose Manually.
2. In the IP Address field, enter 10.0.0.1 . (This IP address is "non-routable", or reserved for private
networks.)
3. Make the eggPlant Functional computer a router for the SUT.
1. In the Router field, repeat the IP address you just entered: 10.0.0.1 . (You will also use this IP
address as the SUT's router, so the eggPlant Functional computer will control traffic to the SUT.)
2. In the Subnet Mask field, enter 255.255.255.0 . On this network, only IP addresses that begin
with 10.0.0 are considered local.
Step-by-Step: Setting up a Direct Connection on the SUT
1. In network preferences, select (or create a new) connection. Select a "wired" or "ethernet"
connection.
2. Indicate that you are using a static IP address. This setting may take several forms:
Disable DHCP or Roaming Mode.
Select Static or Manual IP address.
Select Use the following IP address.
3. Enter 10.0.0.2 as the SUT's IP address.
4. Enter eggPlant Functional's IP address ( 10.0.0.1) as the gateway or router IP address for
the SUT.
5. Enter the subnet mask 255.255.255.0. (This is the same subnet mask you entered on the
eggPlant Functional computer.)
6. Connect the computers with an ethernet cable.
Reverse VNC Connections
Reverse VNC Connections
If you are unable to configure the firewall of a SUT to accept VNC connections, you can often open a
reverse connection, in which the SUT initiates the VNC connection and the eggPlant Functional computer
accepts it.
The eggPlant Functional side of reverse connections is described below; for the SUT, please refer to its VNC
server documentation.
Step-by-Step: Preparing eggPlant Functional for Reverse
Connections
1. In eggPlant Functional's VNC preferences, select the Listen for Reverse Connections
checkbox.
2. In the Port field, specify the port number for reverse connections. (The standard port for
reverse VNC connections is 5500.)
3. Configure your router (and any additional firewall on your system) to allow connections on
port 5500. (Modifying the Mac OS X internal firewall is described below; for external firewalls, refer to
their specific documentation.)
Modifying the Mac OS X Firewall
1.
2.
3.
4.
5.
In
In
In
In
In
System Preferences, select Sharing.
the Firewall tab, click the New button to permit an additional service through the firewall.
the Port Name pop-up menu, choose Other.
the TCP Port Number field, type 5500 (or the port number that you specify in VNC preferences).
the Description field, type Reverse Connections.
13
Connecting with a KVM Switch
Connecting with a KVM Switch
Note: This method of connecting to a System Under Test from eggPlant Functional is intended as an
alternative to the VNC method described here [41].
Requirements
This testing method requires a KVM-over-IP device.
The AdderLink IPEPS [42] is the recommended KVM-over-IP device for use with eggPlant Functional.
Why use a KVM?
In some testing environments you might be unable to install a VNC Server on your System Under Test
(SUT), either due to security concerns or a lack of an available VNC Server for the platform. In such
situations, a KVM-over-IP device allows you to automate your SUT using eggPlant Functional by providing a
hardware-based VNC Server solution.
How it Works
A KVM-over-IP device has a VNC Server running on it and an Ethernet port so that remote machines can
connect to this VNC Server. The device is also physically connected to the keyboard, video, and mouse
ports of the SUT using standard keyboard, video, and mouse cables. The KVM-over-IP device essentially
converts the VNC protocol into standard keyboard and mouse signals going into the SUT, and converts
video signals coming out of the SUT into the VNC protocol. To a connecting VNC Client, such as eggPlant
Functional, this KVM over IP setup is indistinguishable from a VNC Server running directly on the SUT.
KVM-over-IP devices are available in single or dual channel models. Single channel models allow only
remote control of the system (i.e. via the VNC Server), while dual channel models allow you to also have a
keyboard, video (monitor), and mouse connected directly to the KVM to manually use the SUT. Dual
channel models typically allow you to use the physical console and the VNC server at the same time.
Step-by-Step: Setting up a KVM-over-IP Device
The AdderLink IPEPS [42] is the recommended KVM-over-IP device for use with eggPlant Functional. This
section is based on setting up an AdderLink IPEPS, but setup using other KVM-over-IP devices should be
similar.
1. Physically plug your KVM-over-IP into your SUT. The keyboard and mouse cables plug either into PS2
ports or USB ports on the SUT. The video cable will plug into the VGA or DVI video output on the SUT.
The KVM over IP device can be powered over USB or through a normal power cable depending on the
specific device.
2. Connect your KVM-over-IP to your network.
a. The diagram below represents a typical network setup with a single channel KVM-over-IP device
component.
14
b. Determine whether the default IP address used by the device will be reachable by the machine
running eggPlant Functional over your network. If it will not, follow the instructions for your KVMover-IP device in order to change the IP to a valid IP via a USB connection. For the instructions for
the AdderLink IPEPS see page 17 here [43].
3. Configure your KVM-over-IP.
a. Calibrate the mouse cursor and video.
b. Configure the mouse to use the Absolute setting under Controls > Mouse Control > USB Mouse
(when applicable) and click Reconnect.
4. Configure the SUT in eggPlant Functional. Within eggPlant Functional, you will manage this KVM VNC
connection in the same way as traditional VNC connections.
15
Tips and Tricks
Tips and tricks for testing against a KVM-over-IP device.
1. Ensure that the mouse cursor on your KVM-over-IP device is calibrated and configured correctly to
accurately mirror the location of the cursor on the eggPlant Functional Remote Connection Viewer
window. Failure to configure the cursor correctly will result in the VNC cursor interacting with the
wrong UI elements on the screen of the System Under Test.
Improperly Configured Cursor on the KVM-over-IP VNC Server
2. Even when calibrated and configured correctly, the VNC cursor will lag behind the eggPlant Functional
Viewer cursor, and the degree of lag will depend on factors such as network speed and the physical
capabilities of the KVM-over-IP device. The KVM-over-IP setup can also introduce additional delays in
the communication between your eggPlant Functional controller and the SUT. Leverage eggPlant
Functional’s Global Properties in order to ensure that your eggPlant Functional scripts and the SUT
remain in sync. Below are some Global Properties that you can consider adjusting to ensure the
success of your scripts. Which of these Global Properties will be needed in your scripts, and what
values they are set to, will depend on the specific needs of your testing environment (for a complete
list of these runtime Global Properties, please go to the Run Options [44] global properties.
the MouseMoveSpeed [45]: By default the eggPlant Functional cursor jumps between locations
rather than moving smoothly between them. Adjusting the MouseMoveSpeed to be slower may
improve the VNC cursor’s ability to mirror the eggPlant Functional Viewer cursor.
the MouseClickDelay [46]: This global property determines the delay between mouse up and
mouse down events in a single Click command, and adjusting this value may be important to the
success of Click commands against the SUT.
the RemoteWorkInterval [47]: This global property puts a pause between actions to allow
additional processing time on the SUT before the next action is sent.
3. If eggPlant Functional is unable to establish a connection to the KVM-over-IP device
Verify that the IP address used by the KVM-over-IP device is accessible by the eggPlant
Functional controller over the network.
Verify that the eggPlant Functional connection is using the proper IP address and port number
specified by the KVM-over-IP device.
Troubleshooting Connection Issues
Troubleshooting Connection Issues
Connection
error
FAILED: No such
host
Possible Cause
Solution
In the Mac OS X Finder, choose Go
eggPlant Functional does not
menu > Connect to server to see if your computer
recognize the network name you are can find that name.
using.
Try using the SUT’s IP address instead.
16
Connection
error
Possible Cause
Solution
FAILED:
Temporarily
unable to
connect:
Operation timed
out
eggPlant Functional cannot see the
IP address.
FAILED:
Temporarily
unable to
connect:
Connection
refused
The IP connection to the SUT has
been established, but eggPlant
Functional cannot connect to the
VNC server on the SUT.
FAILED: Remote
Login Failed Password
Rejected
Re-enter the password in the Connection List.
The password in the Connection List
is incorrect, or the password in the
Try retyping the password in the VNC server on
VNC server was typed incorrectly.
the SUT.
Viewer window
updates are very
This is probably a network issue.
slow in Live
Mode.
Open the Network Utility and try to ping the IP
address. If you can’t ping the IP address, then you
could be using the wrong IP address.
Make sure that the SUT’s firewall is allowing VNC
connections.
The IP connection to the SUT has been
established, but eggPlant Functional cannot
connect to the VNC server on the SUT.
Discuss the issue with your system administrator.
(As a test, create a direct connection between
eggPlant Functional and the SUT to see if this
improves performance.)
Licensing
Licensing eggPlant Functional
To run eggPlant Functional on your machine, you must license it. If you need to purchase licenses, please
contact your account manager or sales@testplant.com [48]. You can also request a free trial license by
visiting the TestPlant website [49].
Licensing Options
TestPlant offers two licensing options: a node-locked license and a team license.
A node-locked license is one that is tied to a specific workstation. In other words, it's essentially a singleuser license, although it's tied to the machine, not the user. This licensing model is appropriate when you'll
install and use the software always on the same machine or machines.
A team license, also known as a floating license , allows you a certain number of users to run the software
concurrently on any machine. The number of instances of eggPlant Functional that you can run at any one
time is dictated by your license terms. This model is useful for large testing teams and for when users
might need to use eggPlant Functional from different machines periodically.
With team licenses, you install and run the Team License Server (TLS), which is itself node locked, and the
TLS tracks how many licenses you have available and whether a user is granted a license when they
launch eggPlant Functional. For more information about team licenses, see About Team Licenses [16].
greenHouse
greenHouse is TestPlant's web-based license management system. All customers are given a login to the
greenHouse portal, where you can review and create available licenses and perform other license
management tasks for your account. You can also use this portal to submit questions to support and view
information about any support cases.
You should receive your initial greenHouse login information from your account manager. If you've lost or
forgotten your password for the greenHouse site, you can use the link on the login page to have a
17
password resent to you. If you don't have a password, you'll need to contact your account manager or
sales@testplant.com [48].
Before you launch eggPlant Functional for the first time, you can log in to your greenHouse account and
generate an eggPlant Functional license [13]. Note that you need your Host ID to create a license in
greenHouse. However, it's not necessary to generate a license beforehand as you'll have the option to do
so when you launch the application as well.
There are two ways to generate eggPlant Functional licenses:
1. Generate the licenses through eggPlant Functional, as described in the next section.
2. Generate the licenses directly in greenHouse and license manually. See Generating Node-Locked
Licenses [14] or Generating Team (Floating) Licenses [15] for more information on this method.
Step-by-Step: Licensing eggPlant Functional
The first time you launch eggPlant Functional, you must enter a license key. You'll be presented with a
licensing splash screen with several options to either enter or generate your license key:
You must enter a license key to run eggPlant Functional
If you have already generated your license key and username in greenHouse, follow these steps:
1. Enter the Key and User Name from greenHouse in the appropriate fields of the licensing screen.
2. Click Add.
If you haven't generated a license key, you can use your greenHouse login credentials to let eggPlant
Functional retrieve a license for you by following these steps:
1. Click the GreenHouse button on the licensing screen.
2. Enter the Customer Email and Password for your greenHouse account in the appropriate fields.
3. Click Fetch License Info. You should see a message that tells you license information is being
retrieved from the TestPlant server. This process can take a few minutes.
4. If multiple licenses are available for your account, you'll be presented with a dialog box that lets you
choose which to install on this machine. When you've selected the appropriate license from the list,
click Install.
From the licensing splash screen, you can click License Panel to go to the full eggPlant License
Registry panel, described below.
To read the licensing agreement, from the eggPlant Functional menu, select eggPlant > Licenses. By
running eggPlant Functional, you are agreeing to the terms of the licensing agreement.
The eggPlant License Registry Panel
When you launch eggPlant Functional, the license registry checks to make sure there is a license available.
The eggPlant License Registry panel displays information about the eggPlant Functional licenses
available and in use on your network. This panel also provides you several license management options:
18
License management options are available in the eggPlant License Registry panel
1. Licenses Currently In Use: This section displays information about any licenses currently in use on
your network.
2. Licenses Found: This section displays information about the licenses found on the current machine.
3. Free Trial: Use this button to visit the TestPlant website to request a trial license for eggPlant
Functional.
4. GreenHouse: This button takes you to the greenHouse login page on the web.
5. Remove: Use this button to remove licenses. Select the license in the Licenses Found list, then click
Remove. Note: You can not remove a license that is currently in use.
6. Add License: Use this section to add a license that has already been generated through greenHouse.
Enter the Key and User Name, then click Add. Note that you can also view your machine's Host ID
here; if you plan to visit the greenHouse site to generate keys, you can right-click to copy the Host ID,
which you'll need to have to generate keys.
7. Retrieve License from greenHouse: Use this button to retrieve licenses from greenHouse
automatically. You'll need your credentials (email address and password) for your greenHouse
account.
8. Licenser Host: Use this field to enter the IP address or hostname of the TLS, if necessary. Note that
you need to enter this information only if your local machine is on a different subnet from your TLS.
See Port Configuration [17] for more information about environments of this type.
Sharing a License Between User Accounts
Mac OS X and Linux
By default, your eggPlant Functional license is stored in the /Library/Eggplant directory, which is
accessible to all user accounts. However, if the user who installs eggPlant Functional does not have
permission to write to that directory, the license is stored in the user’s own Library directory. To make the
license accessible to all users, someone with the appropriate permissions must move the license to
/Library/Eggplant.
Windows
By default, your eggPlant Functional license is stored in the C:\Library\Eggplant directory, which is
accessible to all user accounts. However, if the user who installs eggPlant Functional does not have
permission to write to that directory, the license is stored in the user’s own Library directory. To make the
license accessible to all users, someone with the appropriate permissions must move the license to
19
C:\Library\Eggplant.
Note: The eggPlant Functional Preferences are stored by individual user account on the eggPlant
Functional computer.
Generating Node-Locked Licenses
Generating Node-Locked Licenses for
eggPlant Functional
To generate licenses for eggPlant Functional, you will need to access your account on the greenHouse
license management portal. You can access greenHouse either directly through your web browser or
through the eggPlant License Registry panel [51] within eggPlant Functional.
[50]
Step by Step: Generating Node-Locked Licenses
Follow these steps to create a node-locked license:
1. You will need:
Your log in credentials for greenHouse. If you don't have this information, contact your account
manager or sales@testplant.com [48].
Your Host ID for the machine on which you intend to run eggPlant Functional. Remember that a
node-locked license will be tied to a single machine or workstation. To find your Host ID, launch
an unlicensed copy of eggPlant Functional on that machine. The Host ID appears on the licensing
splash screen, as shown below:
The licensing splash screen displays your Host ID
Copy the Host ID to your clipboard before going to the next step. Note that you can also find the
Host ID on the eggPlant License Registry panel, as shown in Licensing [51].
2. Log in to your greenHouse account. The "Licenses" page in greenHouse shows both the Unused
Licenses and Active Licenses for your account. New or unused licenses will show "-not created-" in the
Key column instead of an actual license key. The Product column indicates both the platform the
license is for and whether it's "Node-Locked" or "Floating" (team).
3. Choose the appropriate license in the list, then select Generate from the drop-down list in the
Actions column.
[52]
Generate your license key from greenHouse (Click image to view larger)
20
4. On the “Generate License Key” page, enter the Host ID of the machine where the eggPlant Functional
license will be installed. Note that if you copied the Host ID to your clipboard previously, you can Paste
(Ctrl+V for Windows, Cmd+V for Mac) that value into the Host ID field.
Enter your Host ID, then click Generate License Key
5. Click Generate License Key
The license key will be displayed on the form after it is generated, and it will be emailed to you. You will
also be able to see it on the "Licenses" page in greenHouse, along with its associated User Name. You will
need to enter the User Name and the Key value into eggPlant Functional to complete your licensing, as
described in Licensing eggPlant Functional [12].
Generating Team Licenses
Generating Team (Floating) Licenses for
eggPlant Functional
To generate licenses for eggPlant Functional, you will need to access your account on the greenHouse
license management portal. You can access greenHouse either directly through your web browser or
through the eggPlant License Registry panel [51] within eggPlant Functional.
[50]
For team licenses, you must run the eggPlant Functional Team License Server (TLS), which is licensed to a
specific machine via a node-locked license. When the TLS is running in your environment, you can install
and run the eggPlant Functional application on other machines; each machine on which you will run
eggPlant Functional must have a license entered on it, which is a team or floating license. A more detailed
description of this configuration can be found in About Team Licenses [16].
Setting up your environment to run with team licenses is a two-stage process:
1. Install and license the Team License Server (TLS).
2. Generate the eggPlant Functional team license and install it on other machines or workstations as
needed.
Step by Step: Licensing the TLS
Detailed information about installing the TLS can be found in Installing and Licensing the TLS [18]. Note that
for Windows and Linux, the TLS is installed automatically when you install eggPlant Functional; on the Mac,
the TLS is in the Utilities folder of the eggPlant Functional installation disk image and must be added to the
Applications folder manually.
Make sure the TLS is installed on the machine on which you want it to run, then follow these steps to
license it:
1. You will need:
Your log in credentials for greenHouse. If you don't have this information, contact your account
manager or sales@testplant.com [48].
Your Host ID for the machine on which you intend to run the TLS. Remember that the TLS
requires a node-locked license, which must be tied to a single machine or workstation. To find
21
your Host ID, launch the unlicensed version of the TLS. The Host ID appears on the licensing
splash screen, as shown below:
The licensing splash screen displays your Host ID
Copy the Host ID to your clipboard before going to the next step.
2. Log in to your greenHouse account. The "Licenses" page in greenHouse shows both the Unused
Licenses and Active Licenses for your account. New or unused licenses will show "-not created-" in the
Key column instead of an actual license key. The Product column indicates both the platform the
license is for and whether it's "Node-Locked" or "Floating" (team).
3. Choose the Team License Server license in the list, then select Generate from the drop-down list in
the Actions column.
[53]
Generate the license for your TLS (Click image to view larger)
4. On the "Generate License Key" page, enter the Host ID of the machine where the TLS license will be
installed. Note that if you copied the Host ID to your clipboard previously, you can Paste (Ctrl+V for
Windows, Cmd+V for Mac) that value into the Host ID field.
Enter your Host ID, then click Generate License Key
5. Click Generate License Key. The license key will be displayed on the form after it is generated, and
it will be emailed to you. You will also be able to see it on the "Licenses" page in greenHouse.
6. Enter the Key and User Name values into the licensing splash screen of the TLS to complete your
licensing. Be sure to enter both values exactly as they are displayed in greenHouse with no spaces
either before or after either value.
7. Click Add on the licensing splash screen to complete the licensing of the Team License Server.
22
Step by Step: Generating the Team License for eggPlant Functional
After the TLS is installed and licensed, you can create the eggPlant Functional floating application license
(team license) and tie it to the server. For this stage, you do not need a host ID or any information from the
computer or computers that will run eggPlant Functional.
Follow these steps to generate a team license:
1. In the greenHouse portal, locate the appropriate "Floating" license in the list, then select Generate
from the drop-down list in the Actions column.
[54]
Generate your license key from greenHouse (Click image to view larger)
2. On the "Generate License Key" page, select the appropriate Team License Server from the drop-down
list for License Server. If you have only one TLS in your environment, this field will contain only one
value. If you have installed more than one TLS, you might want to tie your team license to a server
other than the default.
Select the appropriate TLS, then click Generate License Key
3. Click Generate License Key to generate the new key.
The license key will be displayed on the form after it is generated, and it will be emailed to you. You will
also be able to see it on the "Licenses" page in greenHouse.
You can use this Key and User Name pair to license eggPlant Functional on any machine where you want to
run the application, as described in Licensing eggPlant Functional [12]. The TLS governs how many instances
of eggPlant Functional you can launch concurrently with your team license, based on your licensing terms.
For more information on licensing eggPlant Functional with your team licenses, visit Installing and
Licensing the TLS [18] in About Team Licenses [16].
About Team Licenses
About Team Licenses
This post describes a basic team license configuration for eggPlant Functional and the Team License
Server set up process. To learn about license generation, please see Generating eggPlant Functional
Licenses. [55]
What Are Team Licenses?
Team licenses allow you to run multiple instances of eggPlant Functional concurrently in a flexible "team"
23
environment. The number of instances you can run at any given time is dictated by your licensing terms. If
you have a 3-user team license, for instance, you can run three copies of eggPlant Functional at the same
time, but the machines that run the eggPlant Functional application can vary. With this model, you can
share eggPlant Functional licenses within your team; hence the term team license.
How Team Licenses Work
There are two license keys involved in the eggPlant Functional team license setup:
The Team License Server (TLS) key: The TLS is installed on a single machine and requires a nodelocked license (i.e., it must always run on the same machine where it is licensed).
The eggPlant Functional team license key: This key is a floating or non-node-locked license that
can be installed on as many machines as desired. You need to install it on every machine where your
team runs eggPlant Functional.
Each team license has a designated number of users. For instance, if you purchase an eggPlant Functional
team license set up with three users, only three computers would be allowed to use eggPlant Functional at
the same time, even if there were a hundred computers that had that eggPlant Functional team license
installed.
You manage and generate license keys in greenHouse [50], TestPlant's web-based license management
system. All customers are given a login to greenHouse to access their account, review and create licenses,
and submit questions to support (questions can also be sent via email or through the eggPlant Functional
application itself). If you don't have login credentials, you'll need to contact your account manager or
sales@testplant.com [48].
On the "Licenses" page in greenHouse, you'll see a list of both Unused Licenses and Active Licenses. New
licenses appear in the top section, Unused Licenses. For information on how to generate a license key and
license the TLS and eggPlant Functional, see Generating Team Licenses [15]. After you've generated the
license key, it appears in the Active Licenses section:
[56]
Team Licenses in greenHouse (click image for larger view)
In the image above, the TLS license is boxed in purple. The license key for the server (also boxed in purple)
is shown in the Key column. You enter the TLS key on only one machine.
The eggPlant Functional team license is boxed in red in the image. greenHouse refers to the license as
"eggPlant for Windows+Mobile - Floating" in the example; the license always indicates the platform it's
designated for. "Floating" specifies this as a team license; therefore, this key can be entered on any
number of machines that might want to run the eggPlant Functional application.
The number of instances available for concurrent or simultaneous use in this example is 2, which is boxed
in yellow. Note, however, that you can license more than two machines with this key. In fact, you can
install eggPlant Functional with the same team license on as many machines as necessary. The TLS
governs how many instances can run at any given time, which in this example would be no more than 2.
An Example Team License Setup
The image below provides a visual for what an actual team license environment might look like:
24
An example team license setup with a single-user team license
The diagram shows a team license setup where the team license allows only one connection. Therefore, if
one computer is using the eggPlant Functional application, any other computers that try to access it will be
denied.
The configuration of a multiple-user license setup will naturally be more complex, but it would use the
same principle setup. As can be seen, each computer that has the eggPlant Functional team license
installed on it can ask the TLS for use of the application; if there is an unused license available, the server
allows that computer to run eggPlant Functional.
Port Configuration
Port Configuration
All communication between the Team License Server and eggPlant Functional Floating Licenses takes
place on UDP port 5538. Make sure that both machines are accepting two-way communication on that
port, and that the port is not being used by any other processes.
If any of the eggPlant Functional Machines are on a different subnet than the Team License Server (this can
be determined by looking at the IP addresses of the different machines) then some extra configuration is
required. You must specify the external IP address of the Team License Server Machine in the Licenser Host
field of the "eggPlant License Registry" panel. This must be done on every eggPlant Functional machine
that is on a different subnet.
25
The Licenser Host Field
Depending on the network configuration, it may also be necessary to configure port forwarding of UDP port
5538, which is something that normally has to be undertaken by a network administrator. We cannot
provide specific details on how to perform this configuration, because it is dependent on network topology
and the specific network hardware in use.
Installing and Licensing the TLS
Installing and Licensing the TLS
Before Installation
Generate a License
Before installing the Team License Server, you will need to generate the license for it. Visit Generating
Team Licenses [15] for more information.
If You Are Updating
If you have previously installed the TLS and you are updating it, please make sure that it is not running
before attempting to download and install a new version.
Step-by-Step: Installing and Licensing the TLS
Please find instructions below for installing and licensing the TLS on all platforms:
Mac
Windows
Linux
On Mac
The first step of the Team License Server installation process is to download eggPlant Functional from the
downloads page of our website here [57].
26
When you first download eggPlant Functional, open the .dmg package. You will see this in the Finder:
The eggPlant Functional Installation Package on Mac
To install the TLS, open the Utilities folder and drag the TeamLicenseServer.apk (shown below) to the
Applications folder and launch it.
The Team License Server Application File on Mac
You will be presented with the Team License Server license panel. You are given three options on this
panel: to enter the license key and username (boxed in blue below), to enter the login credentials to your
team's GreenHouse account (boxed in orange), or to show the license panel and license later (boxed in
purple).
27
The Team License Server License Panel on Mac
Once you have licensed the Team License Server, the below panel will pop up, displaying the Server
information.
The Team License Server on Mac
The below area labeled "eggPlant Team Licenses in Use" is a live update of all instances of eggPlant
Functional associated with the Team License Server that are actively being used.
On Windows
The first step of the Team License Server installation process is to download eggPlant Functional from the
downloads page of our website here [57].
When you first download eggPlant Functional, open the .exe package and follow the installation
28
instructions provided.
The Team License Server will already be available through your file system in:
C:Program Files (x86)Eggplant
To license it, launch the Team License Server from this location. You will be presented with the Team
License Server license panel. You are given three options on this panel: to enter the license key and
username (boxed in blue below), to enter the login credentials to your team's GreenHouse account (boxed
in orange), or to show the license panel and license later (boxed in purple).
The Team License Server License Panel on Windows
Once you have licensed the Team License Server, the below panel will pop up, displaying the Server
information.
29
The Team License Server on Windows
On Linux
This process will vary some between variations of Linux.
The first step of the Team License Server installation process is to download eggPlant Functional from the
downloads page of our website here [57].
Installation notes are included in the eggPlant Functional download for Linux, which can be referenced.
This file is called "InstallNotes".
There are two routes that can be taken to install eggPlant Functional on Linux. The first is to install
eggPlant Functional through your distribution package manager. The second is to install via the command
line, by calling the package manager.
To launch the Team License Server on Linux, use the following command line call:
efls
You will be presented with the Team License Server license panel. You are given three options on this
panel: to enter the license key and username (boxed in blue below), to enter the login credentials to your
team's GreenHouse account (boxed in orange), or to show the license panel and license later (boxed in
purple).
The Team License Server License Panel on Linux
Once you have licensed the Team License Server, the below panel will pop up, displaying the Server
information.
30
The Team License Server on Linux
Running the TLS as a Service
Running the TLS as a Service
The Team License Server (TLS) can be run as a service on Windows.
Before Running the TLS as a Service
If you have just installed the TLS on your machine, or if you have used it previously and are now setting it
up to run as a service, please make sure to quit the process. The TLS cannot be run as a service if it is
already running.
Step-by-Step: Running the TLS as a Service
To run the Team License Server as a service on Windows, please follow the instructions below.
1. Run the "InstallTeamLicenseService" batch file found in one of the following locations:
C:\Program Files (x86)\Eggplant\InstallTeamLicenseService.bat
31
C:\Program Files\Eggplant\InstallTeamLicenseService.bat
2. A command prompt window will appear as the batch file runs. You do not need to interact with it; Just
let it run and press any key to continue when prompted at the end.
32
3. You can now go into the Services list and see that the Team License Server is listed. You can either
manually start the process or re-start your system to get the Team License Server process running as
a Windows service.
Powered by Drupal
Source URL: http://127.0.0.1/?q=content/getting-started-1
Links
[1] http://docs.testplant.com/PDFs/Getting%20Started.pdf
[2] http://docs.testplant.com/?q=content/about-eggplant-0
[3] http://docs.testplant.com/?q=content/creating-eggplant-environment-0
[4] http://docs.testplant.com/?q=content/installing-eggplant
[5] http://docs.testplant.com/?q=content/installing-vnc-server
[6] http://docs.testplant.com/?q=content/vnc-security
[7] http://docs.testplant.com/?q=content/connecting-under-special-circumstances
[8] http://docs.testplant.com/?q=direct-connections
[9] http://docs.testplant.com/?q=reverse-vnc-connections
[10] http://docs.testplant.com/?q=connecting-with-a-kvm-switch
[11] http://docs.testplant.com/?q=content/troubleshooting-connection-issues-0
[12] http://docs.testplant.com/?q=content/licensing
[13] http://docs.testplant.com/?q=content/generating-eggplant-licenses
[14] http://docs.testplant.com/?q=content/generating-node-locked-licenses
[15] http://docs.testplant.com/?q=content/generating-team-licenses
[16] http://docs.testplant.com/?q=content/about-team-licenses
[17] http://docs.testplant.com/?q=content/port-configuration
[18] http://docs.testplant.com/?q=content/installing-and-licensing-tls
[19] http://docs.testplant.com/?q=content/running-tls-service
[20] http://docs.testplant.com/?q=Documentation-Home
[21] http://docs.testplant.com/?q=content/getting-started-1
[22] http://docs.testplant.com/?q=content/using-eggplant
[23] http://docs.testplant.com/?q=content/eggplant-reference
[24] http://docs.testplant.com/?q=content/sensetalk-reference
33
[25]
[26]
[27]
[28]
[29]
[30]
[31]
[32]
[33]
[34]
[35]
[36]
[37]
[38]
[39]
[40]
[41]
[42]
[43]
[44]
[45]
[46]
[47]
[48]
[49]
[50]
[51]
[52]
[53]
[54]
[55]
[56]
[57]
http://docs.testplant.com/?q=eggPlant-Performance
http://docs.testplant.com/?q=content/eggplant-manager
http://docs.testplant.com/?q=eggCloud
http://docs.testplant.com/?q=eggMan
http://docs.testplant.com/?q=content/eggbox
http://docs.testplant.com/?q=content/eggplant-network
http://docs.testplant.com/?q=content/eggon
http://docs.testplant.com/?q=content/knowledge-base
http://docs.testplant.com/?q=content/Examples
http://docs.testplant.com/?q=content/faq
http://www.testplant.com/support/tutorials/
http://forums.testplant.com/phpBB2/viewforum.php?f=2&sid=ef4b0b399b15ceb7ebd0957abe126be3
http://www.testplant.com/phpBB2/viewforum.php?f=5&sid=3b0d1b7ca58256b3d760560ff1b95519
mailto:support%40testplant.com?subject=
http://www.testplant.com/downloads
http://docs.testplant.com/?q=content/connection-list#opening-secure-connections
http://docs.testplant.com/?q=content/open-vnc-connection
http://www.adderlink.com/uk/products/IPEPS.aspx
http://us.adder.com/sites/default/files/pdf/manuals/AdderLinkiPEPSv1-0f.pdf
http://docs.testplant.com/?q=content/run-options
http://docs.testplant.com/?q=content/run-options#the-mousemovespeed
http://docs.testplant.com/?q=content/run-options#the-mouseclickdelay
http://docs.testplant.com/?q=content/run-options#the-remoteworkinterval
mailto:sales@testplant.com
http://www.testplant.com/eggplant/free-trial/
http://docs.testplant.com/?q=content/licensing#greenHouse
http://docs.testplant.com/?q=content/licensing#License_Registry
http://docs.testplant.com/sites/default/files/images/GettingStarted/Licensing/Assets.png
http://docs.testplant.com/sites/default/files/images/GettingStarted/Licensing/GenerateNewTLS.png
http://docs.testplant.com/sites/default/files/images/GettingStarted/Licensing/GenerateTeam.png
http://www.testplant.com/2011/08/05/license-generation/
http://docs.testplant.com/sites/default/files/images/GettingStarted/Licensing/TLSInstallation/greenHouseFL.png
http://www.testplant.com/dlds/eggplant-functional/
34