Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
ui-step
UI Steps
Info

The Test Repository concept enables the hierarchical organization of Tests at the project level by allowing you to organize Tests in folders.

Multiple folders can be created and Tests can be added to them. Similar to traditional operating systems (e.g., Windows, OSX, Linux), Tests can only be part of one folder.

UI Steps
UI Step

How to access it?

Go to Project side bar > Xray Test Repository


Image Added


A: Folders section

    • A1: "All" and "Orphans" metafolders
    • A2: the Test Repository itself, composed of folders and sub-folders with Tests organized within them
    • A3: CRUD actions for the current selected folder (e.g., create, rename, delete)
    • A4: information about the number of Tests within the current folder and the total Tests, including sub-folders

B: Tests section

    • B1: path of the folder
    • B2: filter for Tests 
    • B3: additional information about the shown Tests versus the actual total number of Tests within the current folder 
    • B4: ranked list of Tests within the current folder (only direct children)

C: Switch between "flat view" and "folders view." 

UI Step

Create Folder

Before adding Tests to the Test Repository, you may start to create folders and build the hierarchy needed to organize your Tests.


To create a new folder, go to Project side bar > Xray Test Repository

Step 1: Click on the parent folder.

Step 2: Click on the proper add icon at the bottom of folders section (+)


Image Added

Step 3: Type the name for the folder.

Image Added

Step 4: Press Enter or click outside of the selected folder.


Note

This is a different approach from the traditional way of organizing Tests in flat lists by using Test Sets, which was the only available method before Xray v3.0.

Users coming from legacy Test Management tools may find this approach more natural and intuitive. Other organizations may prefer to not enable this feature at all and choose the Test Set approach instead.

Thus, a general setting, available in Global Preferences, allows you to globally opt-in or opt-out of this hierarchical way of organizing Tests.

Key concepts

Image Removed

Within the Test Repository screen are meta-folders that provide you quick ways to see or filter relevant Tests. These folders are read-only and will be used mainly to select the proper Tests before adding them to folders within the Test Repository.

  • All: all Test issues within the current project (regardless of whether they're organized or not)
  • Orphans: all non-organized Test issues (i.e., Tests that are not part of the Test Repository), in the context of the current project

Aside from these folders, you can also see the actual Test Repository, which contains the hierarchically organized tests.

  • Test Repository: composed of multiple folders and sub-folders along with Tests, in the context of the current project. It corresponds to the root folder.

Within the Test Repository root folder, multiple folders can be created and Tests can be added to them.  The root folder may only contain folders. Similar to traditional operating systems (e.g., Windows, OSX, Linux), Tests may only be part of one folder.

Tests can be "added" (i.e., moved) from the All or from the Orphans meta-folders to the destination Test Repository folder by selecting and moving them using drag-and-drop. Tests can also be moved between folders. You can choose the Tests to add to a given folder by selecting the folder and clicking the Add Tests context action.

Folders can be created at the root of the Test Repository or in any sub-folder within it.

In a given parent folder, folders must not have similar names. For this, Xray does a case-insensitive check of the trimmed folder name whenever you create or rename folder. This means that these folder names would all be considered the same: "  phanTom", "phantom", "PHANTOM". Moreover, folder names must not use the following characters: "/", "\", apostrophe, "*".

UI Step

Move and Order Folders


A folder, including its descendants, can be moved to another folder just by dragging-and-dropping to the destination folder.

To change the position in the hierarchy simply drag-and-drop the folder in the interim space between two existing folders.

Image Added  Image Added

Tip

If you wish to rank it as the last one (i.e., move it to the last position) within some parent folder, you just need to drag it to the parent folder. By default, the folder will be placed in the last position.

Tip
  • Carefully structure the hierarchy of your folders, keeping in mind that a Test may only be in a single folder. How would you organize them in your laptop if you were dealing with documents? Start by identifying the folders that you want to place at the root, and then try to drill down and create sub-folders that are relevant to you.
  • If you're already using Test Sets, don't try to replicate the Test Sets model in the Test Repository because, most likely, it won't work. Again, a Test can only be part of one folder in the Test Repository; with Test Sets, a Test can belong to several Test Sets.  
  • Avoid semantics when it comes to the execution phase or else, your Test Repository will get messed up. Use the proper entities, such as Test Plans (and corresponding Boards) to make planning/execution-related organization.