Eggplant Performance 9 Release Notes

The notes below provide descriptions of the new features and changes introduced with each release of Eggplant Performance. You are strongly encouraged to read about the relevant changes whenever you upgrade from an earlier version.

Get the latest version of Eggplant Performance from the Eggplant downloads page.

Compatibility

Windows:

• Windows 8.1, Windows 10 and Windows 11
• Windows Server 2012 R2, Windows Server 2016, Windows Server 2019, Windows Server 2022

Linux injectors:

• Red Hat Enterprise Linux 7, Red Hat Enterprise Linux 8
• Ubuntu 16.04.7 LTS , Ubuntu 18.04.5 LTS

Features and Improvements 9.5.7 (Jul 2024)

• Studio REST API improvements
  • The Create a test method takes extra parameters to specify test-level options: maxInjectorFailures, enableDefaultDataWarnings, stopEggplantFunctionalInstances and startSharedDataServer.
  • A new Get test method returns test information in the same format specified in the Create a test method.
  • The Generate an Eggplant Functional script method takes an extra virtualUserType parameter to specify a custom VU type.
  • A new Get script method returns test information in the same format specified in the Create a script method.
• Third-party software updates:
  • Upgraded the version of PostgreSQL included with Eggplant Performance Analyzer to 13.16.
  • Upgraded the JRE or JDK included with Eggplant Performance and Analyzer to 11.0.24+8.
• Fixed a potential vulnerability in the Eggplant Performance OCR installer, caused by folder permissions within the third-party ABBYY library.

Features and Improvements 9.5.6 (May 2024)

• Added several methods to the Test Controller REST API to manipulate shared variables in the Shared Data Server. This makes it easier to implement automatic control of rendezvous points (synchronization) from an external source, such as a CI/CD pipeline:

  • Get
  • Set
  • Increment
  • Decrement
  • Clear
  • Clear All
  • Virtual User Group Counts

Features and Improvements 9.5.5 (Feb 2024)

• Third-party software updates:
  • Upgraded the version of PostgreSQL included with Eggplant Performance Analyzer to 13.13. This remediates:
    • CVE-2023-5868, CVE-2023-5869
  • Upgraded the JRE or JDK included with Eggplant Performance and Analyzer to 11.0.21+9. This remediates:
    • CVE-2023-22049, CVE-2023-22045, CVE-2023-22041, CVE-2023-22036, CVE-2023-22006
  • Upgraded the version of Bouncy Castle included with Eggplant Performance to 2.2.1. This remediates:
    • CVE-2020-15522
  • Upgraded the version of Apache CXF included with Eggplant Performance to 3.6.2. This remediates:
    • Vulnerabilities within third-party dependencies of Apache CXF itself.
  • Upgraded the version of Brotli included with Eggplant Performance to 1.1.0. This remediates:
    • CVE-2020-8927
  • Upgraded the version of JSch included with Eggplant Performance to 0.1.55. This remediates:
    • CVE-2016-5725
  • For TCP/IP network recording, Eggplant Performance now uses Wireshark 3.6 instead of Ethereal. This remediates:
    • CVE-2003-0356, CVE-2003-0431, CVE-2003-0432, CVE-2005-3184, CVE-2006-3632 among others.

Features and Improvements 9.5.4 (Oct 2023)

• Fixed a bug where Eggplant Performance Studio failed to install due to a codepage problem preventing the installation of the included Java Runtime.

• Fixed a bug where the Check for Updates feature in Eggplant Performance Studio and Eggplant Performance Analyzer shows a getaddrinfo error (error code 11001) because the updates URL has changed.

  warning

  If you are using versions of Eggplant Performance Studio and Eggplant Performance Analyzer prior to 9.5.4, you will still receive this error when using the Check for Updates feature. Either upgrade to 9.5.4 or manually check the official downloads page for Eggplant Performance.

• Third-party software updates:

  • Upgraded the version of PostgreSQL included with Eggplant Performance Analyzer to 13.12. This remediates:
    • CVE-2023-39417
  • Upgraded the JRE or JDK included with Eggplant Performance and Analyzer to 11.0.20.1+1. This remediates:
    • CVE-2023-22049, CVE-2023-22045, CVE-2023-22041, CVE-2023-22036, CVE-2023-22006
  • Upgraded the version of PCRE (Perl Compatible Regular Expressions) included with Eggplant Performance to 10.42. This remediates:
    • CVE-2022-41409
  • Upgraded the version of the Zlib compression library included with Eggplant Performance to 1.3. This remediates:
    • CVE-2016-9842
  • Upgraded the version of Liquibase included with Eggplant Analyzer to 4.23.2. This remediates:
    • CVE-2022-0839

Features and Improvements 9.5.3 (Jul 2023)

• If Citrix Workspace is running in the background, it can cause issues with Citrix recordings in Eggplant Performance Studio. There is now an extra step in the Recording wizard which asks for confirmation and then stops existing Citrix processes. This is so that the Eggplant Performance Citrix Recorder can have better control, leading to more successful recordings.
• Older versions of the Microsoft Visual C++ Redistributable are no longer installed by Eggplant Performance Analyzer (although they are still needed by Eggplant Performance Studio).
• Links to Keysight Software Manager (KSM) have been updated to a new URL: Keysight Software Manager.
• Fixed a bug where the Recording Wizard would produce a runtime error if the path to the user's Documents/ folder is a UNC path.
• Third-party software updates:
  • Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 13.11.
  • Updated the JRE or JDK included with Eggplant Performance and Analyzer to 11.0.19+7.
  • Updated the version of Apache CXF included with Eggplant Performance to 3.6.0.

Features and Improvements 9.5.2 (Apr 2023)

• Fixed an issue where POST web requests requiring an SSL/TLS client certificate would sometimes not be sent correctly.
• Added an extra method/property to the WebBrowser class, enabling the use of optional client certificates.
• When default values are returned from Get*() methods in the Eggplant Performance Data API, a message is written to the Virtual User event log to aid troubleshooting of data binding issues. These messages can be toggled via an option on the Data tab of the Test view in Studio.
• Modified the script generation for SOAP/OpenAPI services such that generated methods are sorted alphabetically, making script regeneration more consistent and predictable.
• Added a quick-start guide to setting up a Java Selenium Virtual User
• Fixed broken links from the user guide documentation to the C# API reference.
• Third-party software updates:
  • Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 13.10.
  • Updated the JRE or JDK included with Eggplant Performance and Analyzer to 11.0.18.

Features and Improvements 9.5.1 (Feb 2023)

• Authorization headers are included in generated web script code, to make it easier to apply script generation rules and correlate authorization tokens.
• The vuLicenses.lic file now specifies port 5052, to make sure RLM listens on that port and not one chosen at random.
• The Keysight Privacy Notice has been added to the installers and About dialogs.
• Usage beacons are sent to Keysight to enable the development team to better understand how to improve Eggplant Performance.
  • You can opt out of these by checking the appropriate box in the Eggplant Performance Studio installer or the Eggplant Performance Studio Preferences dialog.
• The Transaction Log app has been given a refresh.
• Fixed a bug where generation rules would become duplicated in rare circumstances.
• Support for Eggplant Cloud injector families (which required an additional license) has been removed.
• Third-party software updates:
  • Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 13.9.
  • Updated the version of GSON to 2.10.

Features and Improvements 9.5.0 (Oct 2022)

• Documentation updates:
  • The sections in the user guide documentation on Licensing have been updated. All references to Greenhouse have been removed and all instructions on Licensing now refer and link to Keysight Software Manager.
  • All existing links to the Keysight Software Manager site have been updated with a new URL: Keysight Software Manager.
  • Fixed an issue where there were missing references (highlighted in red) for various classes and methods in the Web C# Virtual User API documentation.
• Data Sources and Bindings:
  • Fixed an issue on the Select virtual user groups page of the Data binding wizard where it was possible to have no options selected. The relevant sections of information text have also been positioned below the options to which they relate.
  • Fixed an issue for Group-level Data Bindings on the Allocate rows page of the Data binding wizard where the Each row in the table can be used by more than one virtual user checkbox (which should only affect the allocation of rows when using the Fixed number of rows per virtual user option) was incorrectly showing the "Not enough rows..." error when in an unchecked state and the unrelated Allow each virtual user to access all rows option was chosen.
  • Fixed an issue for Group-level Data Bindings on the Allocate rows page of the Data binding wizard where the Start at row value is greater than 1 and the Fixed number of rows per virtual user option has been selected. The dialog would correctly show the allocation of rows to virtual users, with the Start at row value being used as the lowerbound of the number of rows available. However, when running the Test, virtual users that should have been allocated rows starting from the lowerbound (after coming to the end of the table) were instead starting from row 1. This behaviour is only intended for Test-level data bindings. The behaviour for Group-level data bindings has been fixed to match what is illustrated by the dialog.
  • Fixed an issue where a runtime error would occur when selecting a Data Source in Studio and the file does not exist. The Data Source panel now shows an error message if the file cannot be found.
• Third-party software updates:
  • Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 13.8.
• Additional improvements and bug fixes:
  • Fixed an issue in the Generation Rules Wizard for Replace Date/Time where selecting a replacement date/time value using the day offset spinbox for the Offset the date/time by a fixed amount option would cause an error.
  • Fixed an issue when cloning a Test where it was possible to choose the same name and cause an unhandled error to occur. The Clone Test dialog now suggests a new name. If the same name is entered anyway, a standard Studio error dialog informs the user that the Test name entered already exists.
  • Fixed a display issue with the Generation Rules wizard when creating or editing any rule that uses the Request Filter dialog when filtering by Response Code. This also directly affected the Verify HTTP Response Code rule which uses the same dropdown list. The issue occurred when the screen DPI (scaling) was set to any value above 100%. This resulted in the dropdown list of response codes and descriptions shifting to the left when the mouse hovered over the list, obscuring the response codes and making the list unreadable.

Features and Improvements 9.4.2 (Jul 2022)

• Documentation updates:
  • The user guide documentation (which you are reading right now!) has been migrated into a new documentation framework, for better user experience and consistency with the other Eggplant product user guides.
  • The API Reference Manuals are also available in the offline documentation packaged with Eggplant Performance Analyzer.
• Public cloud injector improvements:
  • Added better handling and retries of public cloud injector requests, if they exceed the AWS request rate limit.
  • Updated the list of available AWS instance types selectable when creating an AWS public cloud injector family. It is possible to extend this list if new instance types become available.
  • Improved the clarity and presentation of messages, warnings and errors reported by external cloud providers when performing operations with public cloud injectors (starting, stopping, querying etc).
• Third-party software updates:
  • Added support for Windows 11 and Windows Server 2022.
  • Updated the version of Apache CXF included with Eggplant Performance to 3.5.0.
  • Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 13.7.
• UI improvements:
  • The Create a source file dialog provides a better default namespace/package, depending on the virtual user type.
  • The About dialog of each main component has been redesigned for better presentation and consistency.
  • The Licenses dialog in Test Controller links to Keysight Software Manager for managing licenses.
• Additional improvements and bug fixes:
  • Error message: “DB Error: column "max_value" does not exist” no longer occurs when trying to create an Analysis View.
  • Error message: “'WebTrace' object has no attribute 'getIcaFilePath'” no longer occurs when trying to start a Citrix StoreFront recording.
  • Error message: “serverController - Server exited with exit code -1073741819” no longer occurs when trying to start Test Controller on certain processor architectures.
  • Fixed an issue where recorded URLs containing the text %2F were not encoded correctly when requests were made by virtual users during a test run.
  • Fixed an issue preventing the Web Log Viewer from opening a replay which had no WebSocket traffic.
  • Fixed an issue where the Event Log Viewer window would remain empty and not display virtual user events while running a virtual user script from within an IDE using the Debug VU Group feature.
  • Fixed an issue where the create_comparison_chart endpoint in the Analyzer REST API would return 500 Server Error if a duplicate chart would be created. Now it correctly returns 409 Conflict.

Features and Improvements 9.4.1 (Apr 2022)

• Updated the version of Log4j included with Eggplant Performance Injector to 2.17.1.
• Updated the version of Apache Ant included with Eggplant Performance to 1.10.12.

Features and Improvements 9.4.0 (Dec 2021)

• Updated technical terminology to reflect Keysight’s values of inclusion and diversity.

note

You may need to rebuild your project or workspace before running any tests. Workspaces with Web Java or Web C# Virtual User scripts that use the HostFilteringMode enum are upgraded automatically when opened with Eggplant Performance 9.4.0 or later.

• Updated the JRE or JDK in the installer from Java 11.0.11 to 11.0.13.
• Additional improvements and bug fixes:
  • Eggplant Functional suites that contain multiple scripts with identical names within subfolders can now be imported correctly. The subfolder name is prepended to the generated Eggplant Performance script name.
  • Error message: “[Errno 22] Invalid argument in slot_testAndSeriesRequestFinished” no longer occurs when trying to run a test in an imported workspace that was previously exported with test runs excluded.
  • Error message: “'CSCLRScript' object has no attribute 'estimatedTransactionRatePerVU'“ no longer occurs when configuring a test that has multiple Virtual User groups with different scripts or workflows assigned to them.
  • Fixed an issue where Web C# Virtual Users paused indefinitely when trying to close a WebSocket connection.

Features and Improvements 9.3.0 (Oct 2021)

• Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 13.4.

note

If you have an existing analysis database, you must use the installer in UI mode to install Eggplant Performance Analyzer 9.3.0. Technical limitations mean that you cannot use the unattended (command-line) installation mode to upgrade a database created with a previous version of PostgreSQL.

• Additional improvements and bug fixes:
  • Added an extra default generation rule to Web Virtual User types, which promotes WebSocket connection upgrade requests.
  • Error message: “This Windows version does not support the required Bluetooth API” no longer occurs when running Test Controller on older versions of Windows.
  • Error message: “pyqtSignal must be bound to a QObject, not 'WebScriptGeneratorTaskWorker'“ no longer occurs when trying to create a Data Correlation rule.
  • Fixed an issue where invalid Set-Cookie headers in a recording caused the Filter Hosts dialog to display an empty list of hosts.

Features and Improvements 9.2.1 (Sep 2021)

• Updated the version of PostgreSQL included with Eggplant Performance Analyzer to 9.6.23.
• Fixed an issue that prevented the selection of Google Chrome for a web recording.
• Added support for Red Hat Enterprise Linux 8 and Ubuntu 18.04.5 LTS.
• Ended support for Windows 7 and Windows 8.
• Ended support for Windows Server 2008 and Windows Server 2012.

Features and Improvements 9.2.0 (Aug 2021)

• Updated the JRE/JDK included in the installer(s) from Java 8 to Java 11 and upgraded all Eggplant Performance Java components to be compatible with Java 11.

note

If you have been using your own Java 8 JRE/JDK, you will need to change it to a Java 11 JRE/JDK in the Studio → Tools → Preferences → Compilers and IDEs window. Otherwise, you may encounter errors similar to the following:

Exception in thread "main" java.lang.UnsupportedClassVersionError: <class> has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0

If you are running the Eggplant Performance Injector software on a Linux operating system (either to run Virtual Users or for SUT monitoring) then you will need to install a Java 11 JRE/JDK and make sure it replaces the previous Java version in the ${PATH} variable.

• Updated references to "Citrix receiver" to "Citrix Workspace", the new name for the Citrix client application. Eggplant Performance has been tested with Citrix Workspace versions 2012.1 (20.12.1.42) and higher.

Features and Improvements 9.1.0 (Apr 2021)

• Added the Keysight EULA to the installers for Eggplant Performance and Analyzer. For unattended installation on the command line, you must read and accept the EULA, and then pass the below parameters:
  • To the Eggplant Performance installer: accept_eula=yes
  • To the Analyzer installer: --accept_eula yes
• Eggplant Performance installers are now digitally signed using the Microsoft SignTool.
• Additional improvements and bug fixes:
  • Fixed an issue where Eggplant Functional Virtual Users in groups spread across multiple injectors were using the wrong port to send messages to Eggplant Functional, resulting in the error org.apache.xmlrpc.XmlRpcException: Execute called while still processing prior Execute.
  • Fixed an issue where the Citrix StoreFront recorder was not available for selection when trying to create a new recording from the Record user journeys task page.

Features and Improvements 9.0.6 (Feb 2021)

• Added support for the latest version of Citrix Receiver.
• Removed the requirement to specify Host ID for a remote license server.
• Injectors now always write to a log file, regardless of how they are started.
• Improved clarity of log messages about injector operations when starting and stopping a test.
• Extraction of test result zip files retrieved from injectors is now retried multiple times, to mitigate cases of anti-virus software preventing access to the files before they can be extracted.
• Loading and saving of Custom VU files now has better protection against accidental file corruption.
• Resolved an issue with exporting and importing scripts that were based on a Custom VU.

Features and Improvements 9.0.5 (Aug 2020)

• Added support for .NET 4.8.
• Added an option to enable CORS (on by default) for the REST API servers, making it easier to create AJAX-based web dashboards.
• Improved encryption of the analysis database password.
• Additional improvements and bug fixes:
  • Resolved an issue that was preventing use of the Citrix StoreFront recorder.
  • Additional log messages when transferring files to and from injectors.
  • Additional log messages when workspace and project files are recovered from backups.

Features and Improvements 9.0.4 (Mar 2020)

• Increased the connection waiting period to allow more time for Eggplant Cloud SUTs to become available.

note

This is only relevant when a test is using the Eggplant Cloud hosted SUTs to perform tests.

• Eggplant Performance Studio will automatically recover using backup files if workspace/project information becomes corrupted or missing.
• Fixed an issue where scripts within helper suites could not be executed by Eggplant Functional VUs.
• Resolved an issue with POST data in a recording where space characters got converted to "+" characters when generating Eggplant Performance scripts.

Features and Improvements 9.0.3 (Sep 2019)

• Microsoft Visual Studio 2019 support.
• Eggplant Performance Test Controller now supports exporting and importing of window layouts (views).
• A warning message is now displayed if a workspace is found within another workspace.
• Event Log views in Test Controller now open in a new window by default.
• Additional improvements and bug fixes
  • Fixed a runtime error that was displayed when launching an IDE that has both Eclipse and Visual Studio configured.
  • Cloned tests now include global variables for Shared Data Server (SDS) launch settings.
  • Improved icons for high-DPI displays.
  • Eggplant Performance Analyzer now shows the correct test start time for tests where virtual users were dynamically added part way through the Test at runtime.
  • The Eggplant Performance web engine now removes URL fragments from redirected requests.
  • Fixed a memory leak in API ConcurrentRequestSender.
  • Injector cache folders are now deleted after successful test completion and file retrieval.
  • The Citrix recorder now uses the FontSmoothingTypePref property as part of its default settings.
  • Use of commas is now prevented when naming Recording and Tests.
  • You can now view the Previous run data even if only some logs are retrieved from the injectors.

Features and Improvements 9.0.2 (Apr 2019)

• The Referer header is now used to determine sub request's parent request during web script generation.
• The Eggplant Performance Web Log Viewer now shows an improved title to distinguish between the type of web logs, whether it is Recording, Replay, or Comparison log.
• Speed up switching between tests when the test in question contains very large data files or very large recordings.
• Additional improvements and bug fixes
  • Removed the Support gzip or deflate encoding option from the Group Specification dialog box.
  • Fixed an issue with the workspace protection password that occurred when upgrading from an old workspace.
  • Fixed issues with the file transfer mechanism.
  • Updated the Custom Code rules such that they're applied to a request at the beginning of a redirect chain.
  • Improved HTTP Metrics charts for WebSockets and Websocket message rates to prevent exceptions when opened without websocket traffic.
  • Fixed an issue with timestamps that were reported incorrectly during startup of a test in Eggplant Performance.

Features and Improvements 9.0.1 (Jan 2019)

• Support for Windows server SUTs with Eggplant Cloud
  • Eggplant Functional virtual users can now execute against Windows Server 2016 instances running in Eggplant Cloud.
  • Windows instances now come prepackaged with Chrome, Firefox, and Internet Explorer.
• Support Brotli decompression format
  • Users can now record, generate, and replay websites that use the Brotli compression format.
• Password protection for the whole workspace
  • Added the ability to protect a workspace with a password.
  • Users can now switch to a different workspace when presented with a password-protected workspace on launching of Studio.
• Improved logging of errors and warnings in the VU Event Log to help with debugging of errors and warnings in the VU script(s).
• Additional improvements and bug fixes
  • A new option in Preferences dialog now enables detailed logging.
  • Improved algorithm to accommodate Data correlation rules.
  • Added the ability to turn off cookie comments when generating web scripts.

Features and Improvements 9.0.0 (Dec 2018)

• Hosted injectors with Eggplant Cloud
  • Provides hosted injector capacity running in the cloud.
  • Injectors are automatically created on demand when you start a test run.
  • Injectors can be hosted in multiple regions (Western Europe, US East Coast, US West Coast).
• Hosted Eggplant Functional SUTs with Eggplant Cloud
  • Provides hosted systems under test (SUTs) for use with Eggplant Functional virtual users (VUs).
  • The initial release of Eggplant Cloud provides one type of SUT, a Ubuntu desktop with Chrome and Firefox installed. This SUT is suitable for testing websites. More types of SUTs will be added to Eggplant Cloud over time.
  • SUTs are automatically created on demand when you start a test run, and are automatically terminated at the end of the test run.
  • Eggplant Functional connection details are managed automatically, so that each VU is mapped to a single SUT.
• Integration with Eggplant AI
  • Integration with Eggplant AI 2.2.1 allows creation, execution, and analysis of Eggplant Performance tests directly from the Eggplant AI interface.
  • Performance tests can be defined in Eggplant AI by allocating VUs to existing test cases.
  • Eggplant AI uses the Eggplant Performance REST APIs to create, execute, and analyze performance tests.
• REST API for test creation
  • The existing REST API has been extended to allow a user to create new test definitions.
  • Creation of workspaces, projects, injectors, Eggplant Functional suites, scripts, workflows, and tests can be fully automated.
• HTTP/2 support
  • The C# and Java web virtual users can now send and receive HTTP/2 traffic.
• Improved logging
  • Script names and line numbers are now written to the VUs' event log in the event of an error or warning.
  • WinHTTP error codes are written to the VUs' event log in the event of an error when making an HTTP request.
• Many more bug fixes and improvements.

Analyzer

• Added additional columns to the Transactions Summary table (count, minimum response time, maximum response time).
• Added methods to the REST API for retrieving the Transaction and Request summary tables.
• Increased the default chart width in HTML reports.