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.
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 files and database 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 7.2 is the latest major release.
- You must upgrade to Eggplant DAI 7.1 before you start your 7.2 installation.
- The upgrade may take 10-20 minutes to complete.
- Eggplant DAI 7.2 is only compatible with Eggplant Functional 23.2 and later. When upgrading to Eggplant DAI 7.2, you must also update your version of Eggplant Functional.
Release 7.2 (January 2024)
This version of DAI includes the following enhancements and bug fixes:
Significant changes to the Test Results page
Filtering on Test Results page
- Test results have new filtering options. You can now filter results on the Test Results page by Test case, Test configuration, Test configuration tag, Execution environment, and SUT. These options are in addition to the previous filter options: ID, Model, Suite, Status, and State. The SUT column is a new addition to the test results page. These enhancements will provide even more granularity to your test result analysis.
Sorting on the Test Results page
- You can now sort test results by Execution environment and SUT.
Exporting test results
- You can now export test results as CSV (comma-separated value) files from the Test Results page. In addition, you can export results based on the filters that you apply on the Test Results page. This will enable you to export test results based on your specific needs.
Rename of columns on Test Result page
-
The column name Test config/Live run replaces Run mode.
-
The column name Test case/Exploratory run replaces Type.
Merge of Columns
- The columns Status & ID are now combined on the Test Results page. However, you can still search on both the run status and test results ID.
Passing multiple parameters from EPF to DAI in Models
You can now use multiple output parameters (excluding Lists and Property Lists) to capture and pass data generated from Snippet runs into Actions in your models. This enhancement removes the need to use global parameters, passing parameters as strings and parsing them, or storing parameters in files.
Support for Schedule Test Runs with Cron Syntax
You can now schedule test configurations to run in DAI using Cron syntax. You can find more information cron syntax here.
Support of Tunneling with Sauce Labs Connections
DAI now supports Sauce Labs tunnel for both Sauce Labs device and browser and browser connections. This will enable you to access your private Sauce Labs resources.
DAI Run Agent
You can now install the DAI Run Agent as a Microsoft Windows service. This allows the Run Agent to continue running even when users log off the machine.
The DAI Run Agent now supports MacOS Sonoma.
New Eggplant AI Bug Hunter optimised for large datasets
This new AI Bug Hunter reduces memory consumption enabling it to process large volumes of test results through a configuration change on the DAI server.
UI/UX Improvements
Test Configuration Set Up Flow
The test configuration set up process is ehanched with new tabs to make it easier for you to create test configurations.
Documentation Enhancements
- You can now choose the to see older versions of the DAI documentation, in addition to the current version using a version selector at the top of the documentation pages. The current version is active by default.
- Japanese version of the documentation is now available.
Bug Fixes
- Fixed an issue where some DAI components did not reliably stop when the DAI Windows Service was stopped thereby causing some instability upon restart and upgrades to fail.
- Fixed an issue where it was not possible to disable the RESTART_EPF_AFTER_SECONDS parameter by setting it to zero.
- Fixed an issue where the DAI installation sent an email with incorrect information.
- Fixed an issue where scheduled test runs started at the wrong time after daylight savings.
- Fixed an issue where the nginx logs grew to an unsuitable size by logging errors only.
- Fixed an issue where SUTs and execution environments were not unlocked when DAI restarted.
- Fixed an issue where the DAI license page showed incorrect information.
- Fixed an issue to allow a script name to contain a plus (+) character.
Security Fixes
- Upgrade of Keycloak to remediate: CVE-2023-6134, CVE-2022-4361, CVE-2023-0105, CVE-2023-2422, CVE-2023-258
- Upgrade of Python to remediate: CVE-2023-4863, CVE-2023-40217
- Upgrade of PostgreSQL Database Server to remediate: CVE-2023-5868, CVE-2023-5870, CVE-2023-5869
- Upgrade of Nginx to remediate: CVE-2023-44487
- Upgrade of webpack/loader-utils to remediate: CVE-2022-37603, CVE-2022-37599, CVE-2022-37601, CVE-2023-28154
Release 7.1 (October 2023)
This version of DAI includes the following enhancements and bug fixes:
RESTART_EPF_AFTER_SECONDS Environment Variable
As a measure to improve stability, DAI now provides an environment variable you can set for test configuration runs to specify the amount of time Eggplant Functional (EPF) runs before restarting. This variable takes effect after the current step is finished and before moving to the next. The default value is 30 minutes. This variable setting only applies to runs with the DAI Run Agent. During live runs, EPF continuously runs without restarting. See Eggplant Functional Stop and Restart Settings for Test Configuration Runs for details.
Test Case Dashboard
DAI now provides a dashboard that aggregates the results of all your test cases. You can filter the data you see by date range, models, or suites. This aggregation capability will help you understand the current state as well as the evolution of your testing effort in a single view.
Automatic Retry for Failed Tests
DAI now provides the option to automatically rerun failed and errored test steps as these occur to ensure your tests complete successfully within the allocated testing timeframe. This new feature includes the options to rerun test steps within your test configuration, specify the number of times you want failed or errored tests to rerun, and the interval between reruns.
“Viewer” (Read-Only) User Role
DAI now provides a read-only user role. This role is for users, such as managers, who need access to view test results in DAI, but do not need to create or update test artifacts.
Single Sign-On (SSO) Capability
DAI now supports SSO capability for Eggplant users whose companies use Microsoft Entra ID (formerly "Azure" Active Directory) configured over the OpenID Connect (OIDC) or Security Assertion Markup Language (SAML) protocols to control user access in a unified way. DAI also now provides SSO capability for SAML with ADFS. This is in addition to the existing support for ADFS with OIDC. If you’re interested in learning more, please reach out to your Account Manager who can assist.
Bug Fixes
- Fixed an issue where a support request appears each time EPF auto restarts when the Run Agent with GUI setting is set to TRUE
- Fixed an issue in Designer->Test Cases Console where first twenty test cases are skipped
- Fixed an issue in the Controller and SUT Execution Environment where the user-entered value is not displayed
- Fixed an issue in Controller-> SUTs where Name and Description appear in add new connection slider in minimize mode
- Fixed an issue in Controller-> SUTs where fields remain unfocused after clicked label text
- Fixed an issue in Controller-> Result where the Search field loses focus when typing
- Fixed issues with filter test case with special characters
- Fixed issues with Model import clickable area outside of button area ‘Choose file’
- Fixed issues in System Git Connections: 'Choose branch or tag' section is out of the card (with scroll bar)
- Fixed issues in Run Agent: EPF log level is different from run agent parameter set
- Fixed issues in Test Case Builder where fields are not full width when disabled in Parameters tab
- Fixed issues in Test Case Details where Tooltip is not next to the label when scrolling.
- Fixed issue EPF Memory leaks requiring frequent Agent restarts (CRD-1424)
- Fixed issue of Python.exe in the PgAdmin 4 folder in DAI is still version v3.10 instead of v3.11 (CRD-1471)
- Fixed issue adding "/" to Version in agent causes Fail to upload suite Error (CRD-1483)
- Fixed issue unable to import a model in DAI that is more than 2 MB in size (CRD-1481)
- Fixed issue unable to assign a value to a 'Record' type global parameter in a test case (CRD-1449)
Security updates
- Upgraded Python to remediate: CVE-2023-24329, CVE-2023-36632
- Upgraded MinIO to remediate: CVE-2023-28434, BDSA-2020-2649, BDSA-2021-0784
- Upgraded PostgreSQL to remediate: CVE-2023-39417, CVE-2023-2454, CVE-2023-2455
Release 7.0.1-1 (August 2023)
This version of DAI includes the following enhancements and bug fixes:
Keycloak Security Update 21.1.2 – DAI now includes Keycloak version 21.1.2, which resolves a cross-scripting (XSS) security vulnerability.
Library Upgrades for Improved Security – DAI received python and cryptography library upgrades for improved security.
Support for Reruns of the DAI 7.0 Upgrade – DAI now gracefully handles a rerun of the 7.0 upgrade. This fix resolves an issue where the DAI Server would not start or allow user logins after the upgrade.
MinIO Migration Timeout Increased - The timeout for a MinIO migration is now 3 hours. Previously, the migration timeout was 1 hour.
Release 7.0 (July 2023)
MinIO deployment upgrade
An upgrade has been made to the latest stable release of MinIO. Upgrading an existing installation of DAI 6.5 to DAI 7.0 will bring about a migration of MinIO assets(mainly suites and screenshots) which may take up to an hour.
Agent redesigned
The agent has been redesigned into separate dedicated agents for design and run. There are two types of agents, namely DAI Design Agent for uploading suites to DAI and executing tests in the designer, and DAI Run Agent for executing test configuration runs. Both agents are required.
[Windows Only] From version 7.0.0-0 onwards, if you have an older agent installed i.e. eggplantAIagent
, it will be removed during the installation of either the newer DAI Design Agent or the newer DAI Run Agent.
Execution Environment List
On the SUTs page, you no longer need to type the Execution Environment name that will be used by a SUT. You can now pick your Execution Environment from a list of Execution Environments that can also be filtered. You may also leave the Execution Environment field blank except for connections to Android and iOS devices.
SUT connection configuration
Made it easier for you to avoid misconfiguring your connections. If RDP or VNC are the primary connections, then only Webdriver will be available as secondary connection and vice versa. There can only be one connection if Citrix, Sauce Labs Browser, Sauce Labs Browser, Android Device or iOS Device is selected.
Email notification by test result type
Choose to receive email notification based on the type of test result; Pass, Fail, Error, Cancelled. By default all options are selected on creation of a test configuration.
Single Sign-On (ADFS with OIDC)
Single Sign-On functionality for DAI will enable our users who use Active Directory configured over the OIDC protocol to control their users' access in a unified way. If you’re interested in learning more, please reach out to your Account Manager who can assist.
Source code management integration - GIT
Support for GIT Integration has been added. This makes it possible for test runs to use scripts from GIT repositories. Does not support SVN.
Natively connect to Android and iOS devices
This option is available in the SUT connection type list. Your device will connect through the Eggplant Gateway.
Filtering on test result page
Filtering by suite added in test result page.
Security updates
A number of security enhancements have been made to DAI 7.0, including the latest stable release of MinIO.
Known Issues
When upgrading from DAI 6.5 you may need to manually end a process to allow the install to proceed, see Upgrading from DAI 6.5 for details.
Release 6.5
Test Case result trend
DAI provides a result trend of the last ten test runs in the test case view. This is an overview of test runs that have completed successfully or failed. The result trend will enable you to understand how well your test runs are performing. The trend also shows when the test was run and its duration.
Support for Citrix
Added native support for Citrix Desktop connections
Support for Sauce Lab Devices
Added native support for Sauce Labs Browser and Sauce Labs Real Devices (private and Public) in DAI.
Automatic Cleanup of DAI server logs
DAI can be set to automatically delete DAI server log files.
Release 6.4
Test Results by Email
You can now receive notification of your test results by email. The results will show whether a test has been successful or not. Email notification will allow you to take prompt action and save you from having to constantly log into DAI to check the status of your test configuration runs.
Calendar View for Scheduling Test runs
The new calendar provides you with full visibility of your test configuration schedules. The new calendar will facilitate optimisation of your execution environments according to availability of the environments and licenses.
Script-Based Test Cases
Test cases with a sequence of scripts are now available in this release. You can quickly and easily create test cases with your scripts in a similar way to model based testing.
All script-based steps that were referenced from within Test Configurations will be migrated to Test Cases and these will be automatically included within the original Test Configuration. New script-based tests can also be created within Test Cases. Test Configurations will hold your script-based test cases.
The above changes align DAI with how you create Models and Test Configurations for Models.
The test results for migrated script test cases will be displayed in Test Results with the relevant suite name and test configuration (type). However, the suite name and type will be missing links to their suite and test configuration respectively. You will need to manually navigate to the relevant suite or test configuration if needed.
In addition, in the test results logs, the name of the scripts that were executed will not be available. This is because test results are not associated to test steps. However, once these test cases are run again, the details of the test steps will be available in the new test results.
Visibility of Suite Contents
You can view the contents of your suites (files, images and resources) that are stored in DAI. You will also have details of the suites such as version and time when it was last updated. With this information, you can easily determine whether you are using the correct suite version.
SMTP Settings
SMTP settings are now configurable within DAI.
Security
A number of security updates have been made, including upgrades to Python (v3.11.3), Keycloak (v19.0.3) and the latest stable releases of PostgreSQL, Nginx, RabbitMQ and MinIO.
Previous versions of DAI shipped with a pre-configured Third Party Client client:dai:agent:integration
. This has now been removed to enhance security. Users can create their own Third Party Client if needed instead.
Release 6.3
Ability to edit test cases
You are now able to edit existing test cases. You can add and remove test case steps anywhere in your test case.
Test results page displays environment details
The execution environment against which your test ran is now shown in the test results page. If there are problems with the environment, the details of the environment can be more easily identified thereby facilitating troubleshooting.
Cancel test runs
Live test runs can now be canceled more easily. Navigate to the test results page, find the test run that is in progress and that you wish to cancel and cancel it at a click of a button.
Cloning of test configuration
Duplication of your test configuration is now possible. This will allow you to quickly build new test configurations.
Group Migration
An access group with the same name as the user used to get automatically created for every user up until DAI version 6.3. We now allow sharing access to models directly with users and will no longer create those user-aligned access groups. With that design decision in mind, during the 6.3 upgrade process:
- Groups not associated with any models get removed.
- True user-aligned groups with only their original user as a member get removed.
- Permissions of the removed true user-aligned groups get reassigned to their respective users.
Additionally, please note that:
- If a user-aligned group has been renamed, it will remain in the system unchanged.
- If there are multiple users in a user-aligned group, we prepend
group_
to the name. - If the original user is no longer in the group or the system, but the group is and still has models associated with it, the group will remain unchanged.
Release 6.2.1 (28 July 2022)
Return Test Results to CI/CD Pipeline
DAI CI/CD integration can now return the results of tests triggered as part of your build pipeline, so that these can be viewed directly from the UI of your chosen build platform.
Visit the downloads page to begin your upgrade.
Release 6.2 (7 July 2022)
Support Parameters in Test Configuration
You are now able to pass parameters in your scheduled Test Configurations thereby allowing you to reuse your Test Configurations for different testing combinations.