Eggplant Studio

In the fast-paced world of software development, test automation plays a pivotal role in ensuring the efficiency, reliability, and quality of your applications. Keysight Eggplant Test ("Eggplant Test") provides an essential testing solution for test automation engineers.

This extension redefines and streamlines the test script creation and debugging experience for Eggplant Test. It combines the power of VS Code with Eggplant Test's unique automation features, enabling you to author, debug, and run Eggplant Test SenseTalk scripts directly in VS Code.

We welcome your feedback! Please contact our Customer Support with any feedback or questions.

Table of Contents

• Overview
• Getting Started
• Features
  • Opening a suite
  • Connect to a SUT
  • Open and edit a SenseTalk Script
  • Image Capture
  • Magnetic Snapping during image capture
  • Assisted Scripting
  • Editing your images
  • Run or debug a SenseTalk script
• Additional information
  • Eggplant Studio Documentation
  • Eggplant Studio Legal Notices
  • Security Baseline Guidelines
  • Contact Eggplant Support

Overview

The Eggplant Studio VS Code extension supports your test creation process all in one place with the following features:

• Walkthroughs demonstrating key features of the extension.

• An editor for authoring and editing test scripts, with line numbers, syntax highlighting, semantic tokens, tooltips, and auto-complete for the Eggplant Test “SenseTalk” language. It also lets you open suites containing test scripts and other test artefacts, such as images and resources.

• Ability to create, edit, and delete connections to your System Under Test (SUT), so you can interactively develop and run tests

• Having connected to your SUT, easily capture images and save them to your test suite

• Magnetic Snapping during image capture to auto-identify image boundaries.

• Our assisted scripting capability allows you to capture images from a SUT, assign actions to them, insert the appropriate SenseTalk code snippet in your script, and execute it, in one seamless process

• The ability to view images edited using Eggplant Studio's Image Editor, and to apply edits directly in Eggplant Studio using our bespoke image editing toolbar

• A debugger for running and debugging scripts, with options to run entire scripts or selected lines, set breakpoints, and inspect variables and call stacks

• Compatibility with existing Eggplant Functional suites

Getting Started

1. Download, install, and license Eggplant Functional 23.2.0 or later.

2. In VS Code, open the Extensions view, search for Eggplant Studio, and select the extension authored by Keysight Technologies.

3. Click Install.

4. Alternatively, if you cannot access VS Code's Marketplace, you can install VS Code from a downloaded VSIX file available from Eggplant Studio download page.

5. When the installation finishes, the Eggplant Studio icon appears in the Activity Bar.

6. After the extension has been installed, a notification will appear in the lower right corner prompting you to acknowledge Keysight's End User License Agreement (EULA) and Privacy Policy.

7. When you run the extension for the first time, if asked, please accept and install the security certificate. You are now ready to begin using the extension.

Features

Opening a suite

After acknowledging the legal agreements, you will see some buttons which provide a quick way to open a Demo suite or an existing Eggplant Test suite if you have one. If you open the Demo suite, you can tour the extension via a simple walkthrough or explore sample scripts to see the capabilities of the extension.

When you are ready to edit your existing Eggplant Test scripts:

1. Open a new VS Code window (by choosing File > New Window in the VS Code menu bar).
2. Click the Eggplant Studio extension icon in the Activity Bar.
3. Click the Open a Suite button.
4. Navigate to the root folder of your suite and click Open.

Connect to a SUT

Eggplant Studio supports connecting to SUTs for interactive test development and execution. If you have saved connections in your local Eggplant Functional instance, Eggplant Studio will automatically import them from your Preferences (.plist file) and make them available in its Connections view. The currently supported connection types are:

• Android Devices
• Citrix (Windows)
• iOS Devices
• Sauce Labs Devices (iOS/Android)
• Sauce Labs Browsers
• Tutorial SUT
• Remote Desktop (RDP)
• Single System
• VNC (automatic)

You can perform the following connection-related tasks in Eggplant Studio:

• Create, edit and delete a connection
• View the status of a connection
• Connect and disconnect to a System Under Test (SUT)
• Drag a connection, the SUT Connection Viewer panel, to a separate VS Code window (requires VS Code version 1.88 or higher)
• Copy any error message by hovering over the connection status and clicking the copy icon when it appears
• Capture images from your SUT Connection Viewer
  • Adjust the location of the Hot Spot during Image Capture
  • Modify most Image Capture shortcuts

Open and edit a SenseTalk Script

Eggplant Studio contains a wealth of features to help you extend and maintain your SenseTalk scripts. Here are a few examples of how using Eggplant Studio can enhance your SenseTalk script editing experience.

• Extends VS Code's Intellisense to provide code completion suggestions for SenseTalk, syntax highlighting, auto-completion of image and script paths and previewing script documentation and definitions
• Add an image path to your SenseTalk script by clicking the image and then holding the shift key before you drag it into your script
• Extract a custom selection into a new script and automatically include references to relevant script parameters
• Automatically rescope global variables after extracting them to a new script or handler
• Display an image preview when hovering over an image path in your SenseTalk script.

Image Capture

Image capture enables you to capture images from your SUT, crop them, and save them to your suite in three easy steps.

1. Click the Capture Mode button on the SUT screen
2. Select the part of the image you'd like to capture. If a Capture Area is already drawn, you can press Backspace or Delete to remove it and draw a new one.
3. Click the Save As... button and choose where to store it

Note: You will need to click inside the SUT window to use the keyboard shortcuts described in our documentation.

Magnetic Snapping during image capture

When capturing an image, Eggplant Studio auto-identifies the boundaries of the selected element and snaps the Capture Area to it. To override this behavior, hold the Alt key on Windows/Linux or Option on Mac while making the selection. After the initial snapping, any adjustments to Capture Area boundaries will be maintained when you save the image.

Assisted Scripting

When capturing an image, a lightbulb icon appears next to the Capture Area. Clicking the lightbulb icon opens a context menu. Selecting an action from this menu triggers a code snippet to be appended to a SenseTalk script and executed.

If you wish to disable the functionality for executing the snippet once it has been appended, ⚙️click here or click on the gear icon in the top right of the Connection Viewer tab while having it in focus and toggle the Execution Enabled setting off.

Note: You can

Editing your images

After you capture your images they may need editing to increase the performance of your tests. To help you do this Eggplant Studio contains an Image Editor. The Image Editor provides a variety of tools that can help you optimize your image searches with options such as specifying colors the test should ignore, cropping the image, erasing pixels or maybe completely removing the background using our AI auto-mask tool.

Run or debug a SenseTalk script

You can run or debug your SenseTalk scripts using Eggplant Studio. If you're running a script you can choose to execute the script one line at a time or run the whole script.

Additional information

Eggplant Studio Documentation

Eggplant Studio is a powerful tool which is capable of running complex test suites. For a more in-depth overview of its capabilities, including a list of keyboard shortcuts, please visit our Eggplant Studio documentation.

Eggplant Studio Legal Notices

© Keysight Technologies 2025. No part of this documentation may be reproduced in any form or by any means (including electronic storage and retrieval, or translation into a foreign language) without prior agreement and written consent from Keysight Technologies, Inc. as governed by United States and international copyright laws.

For more information please review Eggplant Studio's legal notices

Proxy Configuration

Eggplant Studio requires direct communication with the Eggplant Functional (EPF) and Eggplant Gateway (EPGW) processes it launches. To achieve this, it uses the machine’s local network interface (i.e., the loopback address 127.0.0.1/localhost), which is specifically designed to keep network traffic on the same device.

Proxying requests meant for localhost is generally undesirable unless specifically required. Chromium-based browsers (like VS Code, Chrome, Edge) bypass system proxy settings for localhost by default. However, that behavior can be overridden, potentially leading to errors.

The recommended solution is to explicitly bypass proxying for localhost traffic either for the specific application (VS Code) or on a system-wide level. Below is the recommended approach to resolve common proxy configuration issues in VS Code. For more information please visit our Eggplant Studio documentation

Exclude Localhost Traffic from getting proxied in VS Code

VS Code added a global setting for configuring all launched VS Code instances in version 1.96. Prior versions support command line arguments

1. VS Code Version 1.96 and Higher:

⚙️Click here or open User Settings via the >Preferences: Open Settings (UI) command and search for the http.noProxy setting. Add both localhost and 127.0.0.1 to this setting. The change takes effect immediately without requiring a restart.

2. All VS Code Versions:

Launch VS Code with the following command-line arguments to disable proxy usage or bypass the proxy for specific addresses:

# Disable proxy entirely:
--no-proxy-server
# Bypass proxy for localhost:
--proxy-bypass-list="localhost;127.0.0.1"

For more details, refer to the VS Code proxy server support documentation and Chromium's Network Settings.

Troubleshooting Encrypted Localhost Traffic

On Windows and Linux, Eggplant Studio shows a notification the first time it gets opened in the sidebar. The notification prompts you whether you want to enable encryption for the localhost traffic using self-signed HTTPS certificates. If you accepted and that has resulted in proxy or certificate errors using the extension, you can follow the steps below to troubleshoot them.

You can either:

1. Disable encryption:

To troubleshoot, run the >Eggplant Studio: Disable Self Signed Certificates command to determine if encrypted traffic is causing issues. If this resolves the problem, it indicates that either VS Code or a proxy does not trust the certificate used by Eggplant Studio.

If there is no strict security requirement, you can continue using Eggplant Studio with certificates disabled.

Note: You can re-enable encryption by running the >Eggplant Studio: Enable Self Signed Certificates command.

2. Bring Your Own Trusted Localhost Certificates:

This feature allows users to use their own certificates to encrypt the traffic in localhost on all Operating Systems.

Provide Eggplant Studio with a pair of localhost certificates (valid for 127.0.0.1, not public domains) that your system trusts by setting the following environment variables prior to lanching Visual Studio Code:

# Path to the PKCS8 PEM encoded certificate pair
EPGW_HTTPS_CERT_PATH=/path/to/public.crt
EPGW_HTTPS_KEY_PATH=/path/to/private.key
# Password for the private key if encrypted
EPGW_HTTPS_KEY_PASSWORD=some_password

Note: To disable encryption, remove the environment variables and restart VS Code.

Security Baseline Guidelines

For more information please review Eggplant Studio's Security Baseline Guidelines

If you require a checksum to verify Eggplant Studio's VSIX file, please visit our Eggplant Studio download page

Contact Eggplant Support

Eggplant Studio is Keysight Technologies Software. See the Eggplant Test page on the Keysight website for more information.

Please use the Product Support for Keysight Eggplant Software portal to contact Eggplant Support for warranty, service, or technical support information.

For more information please review Eggplant Studio's contact page available in our online documentation.