Release Notes
The notes below provide descriptions of the new features and changes introduced with each release of Eggplant DAI. You are strongly encouraged to read about the relevant changes whenever you upgrade from an earlier version.
Potential compatibility issues are highlighted.
To the extent you are entitled to a copy of the source code for the open source software distributed with this product, a free copy will be provided. Please contact us with your request.
System Requirements
You can find supported operating systems and system recommendations on the Prerequisites page.
Before you upgrade, make sure that you stop all your DAI servers and services, and then take a backup of your database folders (data
and minio
) and configuration file (config.yml
) before you start your installation. If there is a problem with your upgrade, you will need to restore to this point. If you have any questions or would like help testing your database before you upgrade, please contact your Technical Success Manager or our Customer Support.
- Eggplant DAI 25.1 is the latest major release.
- You must upgrade to Eggplant DAI 7.5.x before you start your 25.1 upgrade.
- The upgrade may take 10-20 minutes to complete.
- Eggplant DAI 25.1 is only compatible with Eggplant Functional 25.1.x. When you upgrade to Eggplant DAI 25.1, you must also update your version of Eggplant Functional.
To ensure you see the latest DAI release information, check the DAI release notes on our website at: https://docs.eggplantsoftware.com/dai/dai-release-notes/
.
Release 25.1.1 (March 2025)
Release 25.1.1 is a minor update to DAI that applies the following defect fixes and 3rd party updates to the 25.1.0 release.
There are no special upgrade instructions for upgrading from 25.1.0 to 25.1.1 or from 7.5.1 directly to 25.1.1.
Defect Fixes
-
Fixes an issue where some EPF Run Log details were missing from the tabulated log layout feature that was added in 7.5.0 (CRD-1749).
-
Fixes an issue where DAI always assigns the same value to a model parameter of type "generated" (CRD-1788).
-
Fixes an issue where some users reported seeing the following error when trying to upload a suite via the Design Agent: "The selected suite is out of date with the remote version. Press download to fetch the latest version" (CRD-1779).
-
Fixes an issue where some users reported seeing the following error when more than 18 suites were added to a Git connection in DAI: "Timed out starting session on execution environment" (CRD-1789).
-
Fixes an issue with new DAI installations on machines without internet connections where some users reported seeing the following error when trying to load the license page in DAI: "Oops, you're offline" (CRD-1783).
-
Fixes a display issue where scripts in a sub folder of 635 scripts were not displaying correctly in DAI > Suites (CRD-1709).
3rd Party Updates
Keycloak 26.1.2
Release 25.1 (February 2025)
DAI release 25.1 includes the following enhancements and defect fixes:
You likely noticed the large jump in DAI version numbers, going from 7.5 to 25.1. To make it easier to identify compatible Eggplant products, version 25.1 and all future compatible products will share version numbers. For example, the DAI 25.1 release is compatible with Eggplant Functional 25.1, and so on.
BDD Feature File (Gherkin) Support
DAI now supports Gherkin feature files, and their Behavior-Driven Development (BDD) test scenario format, for execution in Test Configurations. If you have feature files (with the .feature file extension) in your script suites, you can now add them as individual steps in your test configurations. You can even add feature files alongside your script-based test cases if desired. This Gherkin support also enables you to use scenario tags to filter and define the set of scenarios that will be executed within a test configuration. For more information about using Gherkin files in test configurations, see Configuring Steps/Actions for Script-based Test Cases. For more information about using Gherkin feature files, scenarios, and tags in Eggplant tests and suites, see Gherkin Integration with Eggplant Functional.
To see a video example of how you can use Gherkin feature files in DAI, click here.
Custom Executable Scripts for Test Configurations
To enable you to set up more flexible test conditions, DAI now allows you to add custom shell scripts that you can reuse across multiple test configurations. DAI administrators can now write their own shell scripts in batch (.bat) or shell (.sh) format (depending on the execution platform) and add them for execution in the DAI Server. Once an administrator adds a custom script, you can configure DAI to execute it before the test steps of a test configuration, allowing you immense flexibility.
A key benefit of this shell script support is the ability to synchronize from different Git branches or repositories. For example, you can use different versions of test scripts depending on your software version under test, or sync shared helper suites that reside in a separate repository from your test suites. You could also use a shell script to set up test data on your execution environment before your tests run. For more information about using custom scripts in DAI, see the new Custom Scripts page.
To see a video example of how you can use custom shell scripts with DAI, click here.
The Custom Scripts feature is disabled by default. As with any command-line level execution capability, security is an important consideration. For information about enabling the Custom Scripts feature, see the Custom Scripts page. For general information about how you can secure your DAI setup, see Securing You DAI Installation.
Better Display of Fusion Engine (EPF) Logs
DAI 25.1 further enhances the display of test run logs from the Eggplant Functional (EPF)/Fusion Engine Sensetalk script executions. These enhancements include colorization to improve the visual experience, the ability to search and filter the logs, and the ability to click screenshot links within the logs to see a screenshot overlay in that page view. (To display run logs in DAI, navigate to the Test Results page (Controller > Test Results), and then click View > on the right side of a test listed there).
To see an example of the enhanced EPF log display, click here.
Requirements Traceability
DAI 25.1 also enhances the user experience for the Requirements Traceability feature. You can now export a report of all the requirements statuses, and relevant mapped requirements, after a test execution. This enables you to more easily report your requirements' validation progress to management and stakeholders. For more information, see Exporting Requirements.
Other requirements traceablity improvements include the ability to view requirement descriptions alongside the requirement IDs when mapping to test cases, easier navigation to the associated test cases from the Requirements page, and the ability to delete requirement groups and associated requirements as needed.
To see a video of the requirements traceability enhancements, click here.
Defect Fixes
DAI 25.1 contains the following defect fixes:
-
Fixes an issue where the Millisecond Test Config time format caused the Runner page to not load (CRD-1740).
-
Fixes an issue where submodel transitions could cause an "Action has outdated parameters" error (CRD-1720).
-
Fixes an issue that occurred during DAI recovery after a penetration testing crash (CRD-1706).
-
Fixes an issue where model line numbers did not match step numbers when there is a submodel (CRD-1747).
-
Fixes an issue where DAI was generating large API logs (CRD-1737).
-
Fixes an issue with directory deletion during a DAI upgrade (CRD-1734).
Security Fixes
DAI 25.1 remediates the following vulnerabilities:
-
Jinja has a sandbox breakout through indirect reference to format method (CVE-2024-56326 / GHSA-q2x7-8rv6-6q7h)
-
Jinja has a sandbox breakout through malicious filenames (CVE-2024-56201 / GHSA-gmj6-6f8f-6699)
-
axios 1.7.7 (BDSA-2023-4213)
-
Werkzeug 3.0.4 (CVE-2024-49767 / BDSA-2024-7832)
-
Postgres 14.13 (BDSA-2024-8514 / BDSA-2024-8512 / BDSA-2024-8452)
-
Werkzeug possible resource exhaustion when parsing file data in forms (CVE-2024-49767 / GHSA-q34m-jh98-gwm2 (ETD-5405))
-
python-jose algorithm confusion with OpenSSH ECDSA keys (GHSA-6c5p-j8vq-pqhj)
-
python-jose denial of service via compressed JWE content (GHSA-cjwg-qfpm-7377)
-
Binding to an unrestricted IP address (CWE-1327, SAST (Polaris))
3rd Party Updates
DAI 25.1 contains the following third-party product updates:
-
RabbitMQ to 4.0.4
-
Postgres to 14.15
-
Minio to RELEASE.2024-11-07T00-52-20Z
-
Nginx to 1.26.2
-
OpenJDK to 21.0.5_11
-
Python to 3.10.16
-
MinGit to 2.47.1
Known Issues
Gherkin execution currently does not support screenshots taken due to errors. An error screenshot will result in an exception raised in the terminal where the Run Agent is launched and in the Run Agent logs. The raised exception is a 400 Error at the /ai/screenshots
endpoint with a request body dump including the screenshot's binary data. The error message will be Scenario name blank for a gherkin run
despite the scenario name being populated.
Release 7.5.1 (December 2024)
Release 7.5.1 is a minor update to DAI that applies the following defect fixes and security updates to the 7.5 release.
There are no special upgrade instructions for upgrading from 7.5.0 to 7.5.1.
Defect Fixes
Fixed an issue where some EPF Run Log details were missing from the tabulated log layout feature that was added in 7.5.0 (CRD-1749).
Security Fixes
DAI 7.5.1 remediates the following vulnerabilities:
-
Python-multipart vulnerability CVE-2024-53981
-
Keycloak-services vulnerability CVE-2024-10270
-
Keycloak Vault vulnerability CVE-2024-10492
-
Keycloak vulnerability CVE-2024-9666
-
Keycloak bytecode vulnerability CVE-2024-10451
-
Keycloak vulnerability CVE-2024-10039
3rd party updates
Keycloak 26.0.7
Release 7.5 (November 2024)
This version of DAI includes the following enhancements and defect fixes:
Requirements Traceability
This addition enables you to import and reconcile requirements, that were stored in external requirement management systems, with the test cases and corresponding results in DAI. Now you can easily provide evidence that you met and tested the stated application requirements for contractual or compliance purposes. To use the Requirements Traceability feature, simply upload key requirements properties, like IDs and Descriptions, and map them to the steps of individual test cases that will exercise and validate that requirement. DAI will generate a viewable in-app report of your requirement coverage based on your successful test runs. See the new Requirements Traceability page for details.
To see the Requirements Traceability feature in action, click here.
Test Configuration Parameterization
You can now optionally override parameter values at the test configuration level for both model- and script-based test cases by setting a preferred value for any of the available test case parameters. With this new capability, you can change your application behavior, reduce maintenance overhead, and increase flexibility in your test cases. This eliminates the need to duplicate test configurations to change your application behavior thereby reducing your maintenance overhead. You can use a single set of test assets to drive the desired behavior by simply modifying different parameter values as required. See Configure Custom Parameters for Steps Added for instructions in the use of this option.
To see the Test Configuration Parameterization feature in action, click here.
DAI 7.5 also provides parameter value overrides for CI/CD integration with the Eggplant Runners for Azure, GitHub, and Jenkins. These parameter overrides provide you with the flexibility to modify many aspects of your test runs by injecting different parameter values for alternative contexts, such as target test environments (develop, test, or staging), versions of your application, or even user profiles. See the --param
option in the Advanced Options on the Running Automated Tests page for information about this parameter.
Auto-refresh of Runner Status
You can now configure your Runner page to refresh automatically, enabling real-time updates on the run status of your test configurations without the need to reload the page. You can also still freeze the display by toggling the refresh off, just as you could on the Test Results page provided in previous releases. See Using the Eggplant DAI Runner for information about the Runner page.
To see the auto-refresh of the Runner page status in action, click here.
The auto-refresh will also be disabled when you scroll down below the first pagination point to ensure stability during review of historical results. The refresh rate is set by default, but can be modified through a configuration update on the server by the DAI administrator.
Improved Display of Fusion Engine (EPF) Run Logs
The display of Sensetalk script execution output in the DAI Run Logs now more closely matches what you see in Eggplant Functional (EPF) and Eggplant Manager logs. You can see individual log lines in table rows with additional colorization, making debugging and troubleshooting easier should the test case fail or error. See Viewing Execution Results for information about viewing logs. In future releases, you will also be able to filter and search the logs.
In order for the EPF log to display correctly in the DAI Run Logs, you need to use the standard format of logging in EPF. If you customize the EPF log, the log may not display correctly because DAI depends on the number of the tab position to separate data into different columns.
To see the improved display of the Fusion Engine Run Logs, click here.