Skip to main content

Katalon Studio Release Notes: Version 10.x

Note:
  • The in-app upgrade from version 9.x to 10.x is not available. To download the latest version 10.x, go to Katalon website: Download Katalon Studio.

  • Katalon Studio 10.x now adopts Selenium 4, bringing major changes to align with the W3C WebDriver standard. For a complete overview of these updates and required migration actions, see Migrate Katalon Studio from 9.x to 10.0.0.

  • Windows Desktop application testing is temporarily unavailable in version 10.x. For more details, see FAQs.

  • Custom keywords have been reintroduced in the free edition starting from version 10.0.0.

  • Docker latest and latest-slim tags now point to the latest version 10.x.

Version 10.1.0

Release date: January 21, 2025

New features

Introduced StudioAssist chat window and improved StudioAssist accuracy by upgrading to the GPT 4o-mini model. You can now instantly access and chat with StudioAssist from within your Katalon Studio app. See StudioAssist chat window.

Enhancements

  • [Email report]:

    • The email summary report now includes the numbers of skipped and incomplete test cases.

    • In Project Settings > Email > Template > Test Suite, you can now add the ${test_case_result_table} variable in the Test Suite's email body template to display a detailed table of test case IDs and their results in an email report.

    • When images are split out of the HTML file, the PNG files option is now auto-selected in Project > Settings > Email for projects created in version 10.1.0 and later.

  • [HTML report] Added Attach reference images using linked screenshots (not embedded) to reduce report file size option in Project > Settings > Plugins > Report to split images as reference files instead of embedding them directly into the HTML test suite report. This option helps reduce the file size of a HTML test suite report.

  • [Video recording]:

    • Video recordings now use the test case name as the file name instead of sequential numbers.

    • In Project > Settings > Execution, added new video format options, including webM and mp4, for browser-based recorder.

  • Added Tap at position on Mobile Recorder Available Action.

  • Added a new mobile keyword: [Mobile] Press Keycode.

  • Added the Platform value to the Result section in Report history.

  • Updated logs and report files to display detailed browser versions instead of rounded versions.

  • Added the Data Binding section to JUnit Report.xml and CSV reports.

  • Debug mode now generates reports in HTML, PDF, and CSV formats.

  • StudioAssist now uses GPT-4o-mini instead of GPT-3.5-turbo to deliver more accurate responses.

  • Upgraded JRE to version 17.0.13+11 in Katalon Studio and Katalon Runtime Engine.

  • Set the default encoding to UTF-8 for reports generated in Katalon Runtime Engine. This ensures support for special characters in reports, including when running tests scheduled from TestOps or locally on a VM machine.

  • Test reports now display the actual device used when selecting the Any option in TestCloud for mobile browsers and native apps.

  • Added the respectSystemAlerts = true configuration to Appium’s settings to capture system alert and permission dialogs during iOS testing.

  • Adjusted default video codecs to improve compatibility with common media players. MP4 and MOV now use H.264, while WebM uses VP9 for better compression efficiency.

  • Updated .har file names to reflect Web Service (WS) request names instead of sequential numbering.

  • [TestOps integration] Added support for parallel asset uploading, retry mechanism, and detailed logging to enhance upload speed and reliability in TestOps integration.

  • Embedded WebDrivers have been updated to support the latest browser versions: Chrome 132, Firefox 134.

  • Renamed all 3.0.17-fat.jar​ files to ​3.0.17.jar​ to resolve classpath issues without requiring manual updates.

  • [TestCloud] Introduced a setting to switch between legacy and new TestCloud Hub configurations in Project > Settings > Katalon Platform. This option is available when Enable Katalon TestCloud Integration checkbox is ticked, but this feature is not yet accessible to all users.

  • Automatically tags AI-generated test cases with GenAI. The icon of test cases tagged only with GenAI changes to purple.

  • Updated the CDN links for EdgeDriver downloads.

  • [KRE] Added support to enable TestOps integration directly from the CI/CD pipeline.

  • You can send test results to Azure DevOps Server 2022 when running tests from KSE.

Fixes

  • The Use first row as header option in Data Files did not function correctly when linking test data to a checkpoint.

  • [KRE]:

    • Using a global variable in the email report template threw an error: System is unable to email report. Reason: groovy.lang.MissingPropertyException: No such property: G_email for class: Script1.

    • KRE did not generate HTML, PDF, or CSV report files when running tests with offline activation.

  • The user profile displayed the wrong name after switching organizations and logging in with another account.

  • Dragging and dropping a class from one package to another caused the class to disappear instead of moving it.

  • Canceling an action in the Mobile Recorder did not stop the object-capturing process.

  • Closing a project did not automatically close the associated README file.

  • The Name field was not automatically focused when creating a new project.

  • The error Failed to install the WebDriverAgent occurred when importing provisioning profiles from Xcode 16.

  • StudioAssist did not work after the token was refreshed. The "Unauthorized" error appeared during attempts to explain or generate code.

  • Objects could not be highlighted correctly when using Mobile Object Spy.

  • Self-Healing incorrectly marked the test step as passed by recovering a failed object using the Smart Locator, even though the locator contained an empty item, and the object could not be found.

  • The TestCloud option in Run dropdown menu of a test case disappeared.

Changes

  • Updated the banner for StudioAssist on the Start Page to introduce the new chat window feature.

  • Removed the Internet Explorer (IE) option from Web Recorder and Object Spy.

  • [UI Changes] Removed the Gitter chat and Survicate feedback options.

  • [StudioAssist Preferences] Updated Max token to Max completion token to align with OpenAI's new parameter. Max completion token now limits the number of tokens returned in a response. The default value has been increased from 2000 to 16000 to provide more detailed and comprehensive responses.

Known limitations

  • Reloading the Start Page results in a blank page.

  • When opening an existing project already integrated with TestCloud, the TestCloud option does not appear in the Run menu. This happens when the logged-in user does not have access to the project ID specified in the TestOps integration.

  • [StudioAssist chat window]:

    • StudioAssist doesn't pull information from Katalon documentation. For complex or uncommon queries, you may need to refer to Katalon documentation manually.
    • StudioAssist lacks awareness of test object libraries, variables, or test cases. You should specify details in your question to ensure correct outputs.
    • StudioAssist supports one conversation at a time. Use Clear conversation regularly to prevent context errors. Closing the chat also clears the conversation.
    • Responses may be inaccurate. Verify outputs and rate them as Good or Not Relevant to improve StudioAssist. Your feedback is not used to train the AI model or track your conversations.
    • On Windows, there is no functioning hotkey to open the StudioAssist chat window.

Version 10.0.1

Release date: December 5, 2024

New features

  • Introduced Katalon Web Recorder Plus (beta) - a new recording engine in Studio that helps you capture more reliable locators, test on more complex scenarios of shadow DOM/iframe, and support Flutter-based web AUT. To learn more about this beta feature, see Katalon Web Recorder Plus.
    • Recorder Plus is available for Web Recorder and Object Spy with Chrome and Edge Chromium, both on Active Browsers and New Browsers.

Enhancements

  • [TestCloud]:
    • You can now run a test case with TestCloud mobile browser and desktop browser environment.

    • Changed the availability of private devices from MEDIUM to HIGH in the TestCloud mobile device list.

    • Added a note (*): This device has limited availability and may take longer to load. in the Mobile Browser tab of the TestCloud Configuration dialog.

    • Added execution session id in the console log when executing with TestCloud Mobile native app.

  • Added support for mobile testing with Android 15 official.

  • [Web testing]:
    • Added Chrome 131, Edge 131, and Firefox 132 compatibilities.

    • Web Recorder and Object Spy using Firefox browser is now up-to-date as when using Chrome and Edge browser.

    • Officially supported keyword: WebUI.scrollFromViewportOffset. See: [WebUI] Scroll From Viewport Offset.

  • Supported JDBC Databricks integration.

Fixes

  • The Default value of test case variables were not auto-updated when the file in the reference call was changed.

  • [Web Recorder]:
    • Clicking the Stop button during playback in Web Recorder did not terminate the playback process.

    • Error Your browser version or type does not support the BiDirectional WebDriver Protocol which is required for Smart Locator functionality. Please update your browser or switch to a compatible one. when playback captured script in Web Recorder.

    • Playback in the Recorder dialog used both BiDi and internal recorder extensions when starting a new browser, instead of using only one as expected.

    • Unable to record step for select value in the drop-down list of the website https://opensource-demo.orangehrmlive.com/web/index.php/auth/login.

    • Delay Between Actions did not work if SmartWait was disabled.

  • Creating a new folder in Test Explorer caused Katalon Studio to freeze.

  • [KRE] Unable to override argument values from the command line to the console.properties file.

  • Closing and cleaning up a project did not clear the Request History.

  • CustomKeywords descriptions were truncated in Manual mode and did not display fully.

  • Unable to import certain Postman collections into Katalon Studio.

  • Opening a new project after modifying a Test Suite Collection did not push through, even after saving changes via the Save Resource dialog.

  • [Mobile]:
    • Adjusting the time for the Mobile.tapAndHold keyword in Mobile Recorder caused the captured Test Object to be removed.

    • The Mobile.doubleTap keyword did not work on Android apps.

    • The long name warning shows twice when captured in the Mobile Recorder.

    • Unable to start mobile recording with app ID input for a remote mobile device.

  • Adding a p12 keystore under Project > Settings > Network caused API testing to fail with the error: Could not initialize class org.apache.commons.ssl.KeyMaterial.

  • Katalon Studio failed to return to default content after handling an alert, causing subsequent Test Objects to be unrecognized.

  • In the Manual tab, adding a new test step did not automatically focus the cursor, requiring users to click on the step before typing.

  • [JDBC]:
    • JDBC properties in the Set Connection Properties for JDBC Driver section, under Project > Settings > Database, were not correctly applied when reusing the global database connection.

    • Unable to fetch data from SolidDB using the solidDB JDBC driver, despite successfully establishing a connection.

    • Unable to connect to the database via JDBC when the Secure User and Password option was unchecked.

    • Unable to connect to Databricks using the JDBC driver due to unsupported setAutoCommit functionality in Katalon Studio.

  • Unable to get the time value in the Har file.

  • Error Unable to create the selected preference page appeared when navigating to Katalon Studio Enterprise > Settings... > Cucumber > Java.

  • [BDD testing] Step navigation from a BDD feature file to the corresponding step definition did not work.

  • Response size in KB was displayed incorrectly for API calls.

  • Error Unable to create the request object occurred when starting step 2 of the API tour on macOS.

  • Jira integration sent test results to Xray tests even when result sending was disabled.

  • Error TestObject called before the type class is set occurred when restoring a session with an open custom keyword file using the TestObject type.

  • The list of devices was reset when reopening the TestCloud Configuration dialog of a test suite collection.

  • The Save All button did not save all changes made to a Web Service object after updating an authentication token.

  • TestCloud failed to run web test cases on iOS devices.

Changes

  • [UI Changes]:
    • Added a new Preferences page to enable or disable experimental features, starting with the Katalon Web Recorder Plus (beta). You can see the new page under Katalon Studio > Settings... > Preferences > Katalon > Beta Features.

    • Added a new static button with a call-to-action to review Katalon Studio on G2.

  • In Katalon Studio Web Recorder Plus (Beta), attributes like src and href are automatically escaped using CSS.escape() function. This adds backslashes (\) before special characters like slashes (/) and dots (.) to enhance stability and compatibility. Do note that these backslashes will not affect the execution of your test scripts. To learn more about the standard escaping function, refer to the following MDN documentation on CSS.escape(): CSS: escape() static method.

  • Testing with Android 15:
    • Horizontal swipes in scripts may fail on Android 15 due to the swipe-back gesture, which triggers a return to the previous screen. To workaround this issue, on your device, navigate to Settings > System > Navigation mode, switch to 3-button navigation, and then switch back to Gesture navigation. If the issue persists, reboot the device.

    • When using the takeElementScreenshot keyword, it occasionally fails with the following error message displayed: com.assertthat.selenium_shutterbug.utils.web.ElementOutsideViewportException: Requested element is outside the viewport, even if the element previously passed.

Known limitations

  • [BDD testing] Unable to rename a .feature file after it has been run.

Version 10.0.0

Release date: October 30, 2024

New features

  • Upgraded Katalon Studio to Selenium 4.22.

  • Upgraded Java Client to version 9.2.3.

  • Upgraded Appium server to version 2.11.1.

  • Updated drivers' versions:
    • Appium XCUITest Driver for iOS: 7.21.1

    • Appium UiAutomator2 Driver for Android: 3.7.0

  • [Smart Wait and Smart Locator]:
    • You can now execute scripts containing Smart Locator without installing an extension.

    • You can now execute scripts using the Smart Wait function without installing an extension.

    • Added support for enabling or disabling BiDi by adding the following desired capability: "webSocketUrl": true/false, as shown in the sample screenshot below.

  • Added support for mobile testing with iOS 18 official.

  • Added new keywords:
    • WebUI.newTab

    • WebUI.scrollFromViewportOffset (beta)

  • Added support for Katalon Runtime Engine Docker image on the ARM64 platform.

Enhancements

  • Added the Excludes field to the Proxy setting in the Login dialog.

  • [TestCloud]:
    • Added the option to record, spy, and execute with randomly selected high-availability mobile devices.

    • Added the ability to view and execute with private devices on TestCloud.

  • Added Chrome 130, Edge 130, and Firefox 131 compatibilities.

  • [Security Compliance]:
    • Updated WebDriverManager to version 5.9.2.

    • Addressed multiple high-severity CVEs in dnsjava-2.1.8.jar.

    • Upgraded graphql-java_17.5.0.jar to newer version.

Fixes

  • Error when running recorded test steps on Web Recorder for the second time.

  • [Email report] Unable to send email reports to recipients configured in the test suite while executing tests with KRE.

  • Alert and confirmation dialogs disappeared too quickly for WebUI.acceptAlert to interact.

  • [Web Testing]:
    • switchToWindowTitle took too long to execute.

    • Issue with width/height returned when using getViewportHeight & getViewportWidth.

  • [Test Cloud]:
    • TestCloud Device list was not reset to the first OS version when switching OS.

    • Medium/low selected device was not retained when reopening the run dialog.

    • -orgID showed different values in the command line and TestCloud log information.

  • Enable Katalon Platform Integration automatically enabled after closing the TestOps integration dialog.

  • Katalon Studio unable to detect dateutil in scripts.

  • [Mobile]:
    • Issues with Mobile.swipe keyword.

    • Mobile.pinchToZoomInAtPosition keyword not working.

    • [Mobile Recorder] Error during Swipe action in Recorder tool when using Appium 2.x.

    • Not able to swipe pop-ups.

    • Tooltip display issues and difficulty clicking See document hyperlink.

    • Error when double-clicking an object in Mobile Recorder.

    • Mobile.dragAndDrop keyword not working on Android Emulator.

  • Open notification in iOS partially dragged instead of fully opening.

  • [Remote] Recorder/Spy tools unresponsive when starting a remote session without Application Path/ID.

  • Incorrect Custom Desired capability for Edge.

  • Object data type changes on formatting test file with Ctrl + Shift + F.

  • Unable to track dynamic test suite and data binding.

  • Previously opened tabs not automatically reopened in Katalon Studio, except Test Cases tabs.

  • Multi-threading issues in Katalon Studio version 9.x.

  • Import from OpenAPI/Swagger icon on the main menu disabled when navigating to Verification or Validation tab.

  • WARNING: The 'isStretchWithOverflow' attribute is deprecated. Use the 'textAdjust' attribute instead. was thrown when generating PDF reports on 9.7.0.

  • Added HTTP Header was removed automatically after modifying HTTP Body in a Web Service Request.

  • Close and Close & Clean up project options did not work when there was an unsaved Test Suite Collection.

  • About dialog showed null in its title.

  • Take Screenshot when execution failed option was turned off by default.

  • Recorded scripts could not be executed on Katalon Recorder.

  • Error faultCode=PARSER_ERROR:....Invalid byte 1 of 1-byte UTF-8 sequence. occurred when running SOAP requests with validation.

  • Clicking Explore Analytics in Studio Walkthrough did not initiate any action.

  • Installer for Katalon Studio Enterprise and Katalon Studio extracted with duplicate folder names.

  • [Git integration] Tracking branch was changed after pulling code from a different branch.

  • [API] Missing space between Bearer and token occurred when adding Bearer Authorization Header.

  • Only one local plugin was loaded when reloading plugins.

  • [Mac] Web Recorder window was minimized when clicking Record button or rerunning the recorded script.

  • Use system proxy configuration option did not work on Windows.

  • Error occurred when logging into Katalon Studio with proxy set to use .pac file.

  • Excludes value required reloading after saving and reopening advanced settings.

  • Log parsing errors in HAR file were encountered.

  • Plugin did not reload when running Katalon Runtime Engine with TestCloud license only.

  • Internal error occurred during Downloading Update...". 'byte[] org.apache.commons.io.IOUtils.byteArray() when downloading version 9.7.2 from 9.6.0.

Changes

  • Application names updated:
    • Free Edition: Katalon Studio

    • Enterprise Edition: Katalon Studio Enterprise

    • Apple Silicon Chip: Removed the Arm64 suffix.

  • Updated MobileBy to AppiumBy class.

  • Adjusted offline license and On-Premises flow where login dialog is triggered.

  • Ordered test cases alphabetically in Dynamic Test Suite.

  • Any test case referencing SmartWaitWebDriver will encounter a runtime error as the class has been removed.

  • Updated WebUI.setViewPortSize to align with WebUI.getViewportWidth and WebUI.getViewportHeight, ensuring consistent viewport size results.

  • The licenseServer.properties file has been removed as of version 10.0.0.

  • Corrected the behavior of setViewportSize to ensure that the values returned by getViewportWidth and getViewportHeight are consistent with the dimensions set by setViewportSize. Note: When using the --window-size in Desired Capabilities, getViewportWidth and getViewportHeight may return different values because this setting adjusts the window size, not the viewport size.

  • Refactored DriverFactory. Moved getChromeDriverPath to ChromeDriverUtil. To use getChromeDriverPath(), add import com.kms.katalon.core.webui.driver.chrome and retrieve the path with:
    String chromeDriverPath = ChromeDriverUtil.getChromeDriverPath() 
  • Based on Selenium 4 documentation, test capabilities that are not structured to be W3C compliant may prevent a session from starting. The following list outlines the W3C WebDriver standard capabilities:
    • browserName

    • browserVersion (replaces version)

    • platformName (replaces platform)

    • acceptInsecureCerts

    • pageLoadStrategy

    • proxy

    • timeouts

    • unhandledPromptBehavior

  • Any capability not listed above must include a vendor prefix. For example, when running on TestCloud, using app and deviceName in desired capabilities can disrupt the session creation process. The correct format for custom capabilities requires a vendor prefix, such as katalon:option for Katalon.

Known limitations

  • Katalon Compact Utility (KCU) is not supported with BiDi due to a Chrome limitation with profile management.

  • When using BiDi, a BiDi-CDP Mapper tab opens to start the connection.

  • BiDi does not work with Incognito mode in Chrome and Edge Chromium. Attempting to open a session in Incognito mode with BiDi enabled causes the browser session to open briefly and then close automatically. This issue affects: Chrome, Edge Chromium, and Chrome Headless. Workaround:
    • Set webSocketUrl = false in desired capabilities to disable BiDi if Incognito mode is required.

  • BiDi does not work with custom profiles in Chrome and Edge Chromium. Attempting to open a session with a custom profile and BiDi enabled causes the session to fail with an initialization error.

  • Docker image on linux/arm64 supports Firefox version 129 instead of the latest version 131.

  • Removal of AbstractEventListener, EventFiringWebDriver, and WebDriverEventListener in Selenium. Follow Selenium documentation to migrate test scripts that use these classes: Removal of AbstractEventListener + EventFiringWebDriver + WebDriverEventListener.

  • Simple dialogs (alert/prompt) handler behavior: The unhandledPromptBehavior capability, which defaults to "dismiss and notify" per W3C standards, dismisses simple dialogs automatically. Workaround:
    • Set unhandledPromptBehavior to ignore so that you can handle dialogs manually.

  • Install dependencies: Node installation failed during dependency setup, including manual installation (without Katalon Studio). A warning may appear stating, The post-install step did not complete successfully. Workaround:
    • Run the following commands to resolve the issue:
      /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
      brew update
      brew uninstall node
      brew install node
Was this page helpful?