Skip to main content

Getting Started with Eggplant Functional

Eggplant Functional (EPF) is a test automation tool that you can use for the entire testing process, from authoring scripts to evaluating results. It’s quick to get up and running with Eggplant Functional and this page will show you how, by walking you through a basic EPF test environment setup on Microsoft Windows.

To demonstrate how easy it is to set up and run tests with EPF, we will configure one system to be both your EPF host machine and system under test or "SUT." When you complete the setup detailed below, your Windows machine will be configured to run EPF and connect to itself as a SUT, and you’ll be ready to use Eggplant Functional.


While this walkthrough demonstrates the simpler set up of one machine as both the EPF host machine and SUT (called a "Single System model"), EPF was designed to run as a two-system model, where EPF is on a separate machine from the SUT. See Creating Your First SUT Connection for information about setting up EPF and a SUT in a two-system model.

Step by Step: Setting Up Eggplant Functional

For many users, the Eggplant machine will be your everyday workstation. It can be a Windows, Mac, or Linux machine. But for the sake of this demonstration, we are using a Windows machine as our Eggplant machine.

Follow the steps below to install and license EPF, and then set up the same machine as a SUT. Contact our Customer Support with any questions about this process.

Step 1. Download and Install EPF

  • You can download Eggplant Functional from the Eggplant Functional Downloads page.

  • Install EPF by running the Setup program you downloaded.

  • As stated above the steps in this walkthrough are for installing EPF on a Windows machine. For information about all supported operating systems and recommended hardware configurations for the Eggplant machine, see Prerequisites. For information about installing EPF on all supported platforms, see Installing Eggplant Functional.

Step 2. License EPF

  • You can get a free trial key from Eggplant's trial key request page.

  • To license Eggplant Functional with a trial key, launch the application and wait for the licensing splash screen shown below to open. Then copy your trial key, paste it into the License Key field, and click Add. The EPF application opens displaying the Welcome panel.

The licensing splash screen in Eggplant Functional

Step 3. Configure the Eggplant Machine to also be your SUT

  • Launch EPF, if it is not already running on the Eggplant machine, and open the Connection List. (Choose Connection > Connection List from the main EPF menu.) When the Connection List opens, and no connections have been created, it looks like the following sample screen.

The Eggplant Functional Connection List when no connections have been added

  • Click either of the Add buttons to create your SUT. The New Connection panel opens.

  • Select Single System from the Connection Type drop-down list. (Note that the default connection type, VNC Automatic, is not shown). You will see that the fields on the panel change when you make the selection as shown in the following sample screen.

Add Single System SUT Connection Type

  • Provide a name for your SUT in the Display Name field, and then specify your user and password. These will be the credentials you use to log into your Eggplant machine.

  • Click Save to save your connection. You will see your new connection in the Connection List as shown in the sample screen below:

The Eggplant Functional Connection with first connection

Step 4. Connect to your SUT

  • Select your SUT in the Connection List and click the Connect button. After a few moments, the EPF Viewer window will open displaying your SUT desktop. Because this is a single-system configuration, your SUT is actually a second session into your Eggplant machine.

The EPF Viewer Window Connected to a Windows SUT


There are a few limitations to the Single System connection type in EPF. For example, you cannot run your browser on both the desktop session where you are running EPF and the SUT session. Your browser can only run in one of these sessions at a time. For more information about testing with Single System connections, see Connecting to the Same Machine (Single Machine Testing).

You are now ready to start writing scripts and running tests with Egglant Functional!

Next Steps

Now that your initial environment is set up, you should be ready to dive in and begin your automated testing experience. The following links will help you get a deeper understanding of how to use Eggplant Functional to satisfy your testing needs.