23 December 2021

The Xray team is proud to announce the release of Xray 6.0.0.

This version features Modular Test Design, creating Test Executions for all failed tests in a requirement and importing screenshots from Robot Framework reports.

Upgrade Notes

Upgrading Xray to 6


If you are upgrading from a version lower than 3.2, this implies that an upgrade task will run to pre-calculate historical data. This is a one-time action that will run in the background so that Xray is still available during the upgrade. A  re-index operation of your Jira instance is required so that the internal data becomes searchable and usable by Xray.

Please be aware that this upgrade task will run immediately after updating Xray. As this operation can take some time and use a considerable amount of server resources, we suggest scheduling the upgrade of Xray outside of business hours. It is always possible to cancel the recalculation operation in the Xray configuration section → Custom Fields → Maintenance.

If you are upgrading from v3.2.x or v3.3.x to v6, you must recalculate data in the Xray configuration section → Custom Fields. This recalculation is necessary because of the huge improvement in the amount of data that Xray needs to add to the table and to the Lucene indexes.

As this operation can take some time and use a considerable amount of server resources, we suggest scheduling the upgrade of Xray and the recalculation of the custom fields, outside of business hours.

Downgrading from Xray 6


Downgrading from Xray 5.x.x to a previous version will have the following side-effects on Test Runs with a dataset:

  • Test parameters will no longer be converted on the Test Run page, this includes Test Step definitions and Pre-Conditions;
  • When loading a Test Run created on version 5.x.x, the merge/reset message will be displayed;
  • When merging a Test Run created on version 5.x.x with the new Test Step definition, all Test Step results will be updated but the reset/merge message will still be displayed;
  • A Test Run created on version 5.x.x with iterations will be displayed in a "flat mode." The iterations will no longer be available and all the Test Step results from each iteration will be presented on the Test Steps section;
  • After the downgrade, the integrity checker will fail on "Check for invalid Mementos" for all Test Runs created on version 5.x.x. We recommend running the integrity checker before downgrading to get rid of possible invalid mementos.

Downgrading from Xray 6.x.x to a previous version will have the following side-effects:

  • Test Issue:
    • A Call Test will be converted to a regular test step with a warning message
  • Test Run Page
    • The Merge/Reset action will be displayed

The Test Step Custom Fields and Test Run Custom Fields of the type "User Picker" will have to be deleted in the project configuration as they are not supported. Following that, the Test Runs that are using a User Picker field will have to be merged or reset. This includes Test Runs that have the field for the Test Run itself and also Test Runs for Manual Tests where the Test Steps contained the User Picker field.

Downgrading from Xray 6.x to a version less than 3.2.0 implies that you must perform a re-index afterward. This is because from Xray 3.2.0 onwards, the content and format of what Xray indexes have changed.

Historical Coverage Gadget

Some configuration parameters for this gadget were modified as a result of supporting multiple projects whenever using a saved filter as a source. It is possible that some users will get errors on the gadget after downgrading from 4.x. If this happens, please edit the configuration to ensure the gadget is configured properly. 



Release highlights 

Modular Test Design (smile)

modular_tests.png

Modular test design is a way of promoting test case reusability and composition across a large test repository. In order to design modular tests, you can create a test where some steps call or include other test cases. This prevents testers from having to write the same steps over and over again in different high-level tests.

Using a modular design approach, any test becomes a building block of more extensive test scenarios. Still, they can also be executed individually if needed.

A common use case for modular tests is end-to-end testing. End-to-end tests often need to pass through the same area or component of the application before asserting the final result. With modular test design, you can reuse the tests for these common areas or components.


Find out more about this feature here.



Quickly create executions for failed tests from a requirement issue

We have added a new option that allows users to create new Sub-Test Executions (or Test Executions) for tests in a specific status from the requirement issue screen.

A common usage scenario is to create a new Sub-Test Execution for all failed tests within a Story.


Learn more here.



Importing screenshots from Robot Framework


When executing Robot Framework tests, we can capture screenshots after executing certain steps and include them in the execution report.

These screenshots will now be imported by Xray and will be provided on the execution screen as evidence of the execution.


Learn more about this feature here.


And more...

UI/UX Improvements

  • XRAY-2865: As a user, I can view the user's display name in the Test Runs report

REST API

  • XRAY-3692: Test repository REST API folder call

JQL functions

  • XRAY-2552: As a user, I can filter obtain a list of Tests based on the Test Run fields from a Test Execution using a JQL function

Configuration

  • XRAY-8073: The Test Evolution gadget limit should be defined by the admins


All New Features and Bug Fixes in this release

 

Key Summary T Created P Status Resolution
Refresh


  • No labels