Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleLearn more

Please refer to Overview of the Automated Steps Library for a more detailed information of this feature.


Table of Contents

Settings

Enable/Disable

Xray allows you to globally enable/disable the Automated Steps Library.

Image Removed

Whenever enabled, there's an additional performance overhead on the creation/update of Cucumber Tests/Preconditions and upon the refactoring of existing steps within the Automated Steps Library UI. 

On the other hand, disabling the library will avoid that additional processing overhead.

Info
titlePlease note

if you disable the Automated Steps Library, all new steps that you added meanwhile or, in general, any changes that you have made to your existing Cucumber Tests/Preconditions afterwards will not be synchronized to the library. This means that the Automated Steps Library may be out-of-synch.

Synchronizing your existing steps with the library can be done with the Integrity Checker.

...


Integrity Checker may be used to force a per-project synchronization of steps, in case you find orphaned or missing steps in the library.

Overview of the Automated Steps UI

...

Step 3: The issues search will show all related issues.

Update / Refactor a step

...

titlePlease note

...

The step content can be updated (i.e. renaming the step) directly in the Automated Steps Library for easy refactoring; all updatable Tests/Preconditions will be updated accordingly.

Only non-readonly Tests/Preconditions that the user is allowed to edit are updated; the other ones will remain as-is, leading to the simultaneous existence of original step along with the updated one in the library, in this case.


Info
titlePlease note

It is also possibile to indirectly update steps during the edition of Cucumber Tests/Preconditions; however, this inhibits refactoring.

Whenever editing Cucumber Tests/Preconditions, if the changed steps aren't being used elsewhere, then the existing steps will be updated accordingly; otherwise, new steps will be created. In other words, the library will contain all the steps, including the new/changed ones along with the "original" ones that being used in other issues. Thus, some care should be taken whenever editing Cucumber Tests/Preconditions in order to avoid proliferation of similar steps.


To update the content of an existing step (i.e. refactor it):

...

Step 2: Click on the cross of the label in the labels input box or use the backspace after positioning the cursor after the desired label.

Step 3: Click on Save.


Settings

Enable/Disable

Upon installation of Xray or the upgrade from an earlier version of Xray, the Automated Steps Library is enabled by default.

Xray allows you to globally enable/disable the Automated Steps Library though.

A setting availabe in Xray Global Preferences allows the administrator to enable/disable the library.


Image Added

Whenever enabled, there's an additional performance overhead on the creation/update of Cucumber Tests/Preconditions and upon the refactoring of existing steps within the Automated Steps Library UI. 

On the other hand, disabling the library will avoid that additional processing overhead.


Info
titlePlease note

if you disable the Automated Steps Library, all new steps that you added meanwhile or, in general, any changes that you have made to your existing Cucumber Tests/Preconditions afterwards will not be synchronized to the library. This means that the Automated Steps Library may be out-of-synch.

Synchronizing your existing steps with the library can be done with the Integrity Checker.


Maintenance

Using the JIRA administration

Integrity Checker may be used to force a per-project synchronization of steps, in case you find orphaned or missing steps in the library.

Using project settings

An action is available in the project settings to force a per-project synchronization of steps.

Step 1: Go to project settings, Summary section.

Step 2: Go to Actions, at the top-right corner and choose "XXX".