Features and Limitations
The current integration allows to:
- see the Tests associated with a Test Set, Test Execution, Test Plan or Pre-conditions in the Structure Tree;
- add/remove Tests to Test Sets, Test Executions or Test Plans by dragging Tests or Test Sets to other Test Sets, Test Executions Test Plans or Pre-conditions;
- see and manage association between Tests and requirements (supported indirectly, by Structure itself);
- see Sub Test Executions bellow requirement issues (supported indirectly, by Structure itself);.
- associate Tests contained in folders to Test Sets, Test Executions and Test Plans;
- manage folders inside Test Sets, Test Executions, Test Plans.
Things to be aware
Default Structure Action - Try not to use the Structure default action as it might cause confusion and errors.
Installation
In order to obtain the new extenders that Xray provides you need to:
- Install Structure plugin version 3.4.x or above;
- Install Xray version 2.1 or above.
Note: If you already had Xray before you installed Structure, you need to restart your JIRA server.
For more information about the Structure plugin you can check its documentation here.
Adding Xray Extender to the Structure:
1. Set your structure to Automation
2. Choose the correct extender
3. Click "Apply" on the dialog
After you click apply on the dialog you should have something like this assuming your structure was empty before
Test Set
With the Extender added you can now do the following actions:
- Drag a Test Set to a structure and have its Tests dynamically appear;
- Drag a Test to a Test Set and have it automatically associated to the Test Set;
When you drag a Test to a Test Set you are going to have a message appear as displayed in the image below you should always choose the "Add Tests to Test Set" since its the one that will use the Test Set Extender.
- Drag a Test Set to a Test Set and have all the Test in the Test Set automatically associated to the other Test Set;
When you drag a Test Set to another Test set you might get an extra message telling you that you might be doing an action that will affect more than 1 item, just click continue after you do a message like the one described above will appear and you press the "Add Tests to Test Set" button.
- Remove a Test from a Test Set and have the association automatically removed from the Test Set;
When you click on the X and you have a Test select the Test will be removed from the Test Set
Test Execution
With the Extender added you can now do the following actions:
- Drag a Test Execution to a structure and have its Tests dynamically appear;
- Drag a Test to a Test Execution and have it automatically associated to the Test Execution;
When you drag a Test to a Test Execution you are going to have a message appear as displayed in the image below you should always choose the "Add Tests to Test Execution" since its the one that will use the Test Execution Extender. - Drag a Test Set to a Test Execution and have all the Test in the Test Set automatically associated to the other Test Execution;
You will get the same message as above - Remove a Test from a Test Execution and have the association automatically removed from the Test Execution;
When you click on the X and you have a Test select the Test will be removed from the Test Execution
Sub Test Execution
With the Extender added you can now do the following actions:
- Drag a Sub Test Execution to a structure and have its Tests dynamically appear;
- Drag a Test to a Sub Test Execution and have it automatically associated to the Sub Test Execution;
When you drag a Test to a Sub Test Execution you are going to have a message appear as displayed in the image below. You should always choose the "Add Tests" to Sub Test Execution since its the one that will use the Test Execution Extender.
- Drag a Test Set to a Sub Test Execution and have all the Test in the Test Set automatically associated to the Sub Test Execution;
You will get the same message as above - Remove a Test from a Sub Test Execution and have the association automatically removed from the Sub Test Execution;
When you click on the X and you have a Test select the Test will be removed from the Sub Test Execution
Test Plan
With the Extender added you can now do the following actions:
- Drag a Test Plan to a structure and have its Tests dynamically appear;
- Drag a Test to a Test Plan and have it automatically associated to the Test Plan;
When you drag a Test to a Test Plan you are going to have a message appear as displayed in the image below you should always choose the "Add Tests to Test Plan" since its the one that will use the Test Plan Extender. - Drag a Test Set to a Test Plan and have all the Test in the Test Set automatically associated to the other Test Plan;
You will get the same message as above - Remove a Test from a Test Plan and have the association automatically removed from the Test Plan;
When you click on the X and you have a Test select the Test will be removed from the Test Plan
Pre-Conditions
With the Extender added you can now do the following actions:
- Drag a Pre-Condition to a structure and have its associated Tests dynamically appear;
- Drag a Test to a Pre-Condition and have it automatically associated to the Pre-Condition;
When you drag a Test to a Pre-Condition you are going to have a message appear as displayed in the image below. You should always choose the "Add Tests" to the Pre-Condition since its the one that will use the Pre-Condition Extender.
- Drag a Test Set to a Pre-Condition and have all the Tests in the Test Set automatically associated to the Pre-Condition;
You will get the same message as above - Remove a Test from a Pre-Condition and have the association automatically removed from the Pre-Condition;
When you click on the X and you have a Test select the Test will be removed from the Pre-Condition.
Note
When moving a Test from different issues types the Test will not be removed from source issue.
Example: Moving Test A from Test Set B into Test Execution C - Test will be added to the Test Execution C but not removed from Test Set B.
Other possible features
Association between Tests and requirements
Since the association between Tests and requirements is done using the "Tests" link, we are able to take advantage of Structure built-in extender for dealing with linked issues and therefore manage this association.
For this, you must have "Automation" enabled, choose "Extend with..." and then "Linked issues...".
Then choose the "Tests" link type.
As soon as you do this, you're able to see the association between Tests and requirements, as shown in the next screenshot where you can see the story being validated by the manual Test.
You can also link your Test with other requirements easily, just be dragging them under the Test and choose the action that will create the proper issue link between the Test and the requirement.
Note
If you want, you can also manage the association in the opposite way, by looking from the requirement's perspective.
This will allow you to see and manage the Tests that validate a given requirement.
For this, you just need to create an extender for the "Tested by" link type.
Association between Sub Test Executions and requirements
Sub Test Executions are created as sub-tasks for requirement issues. We are able to take advantage of Structure built-in extender for dealing with sub-tasks and therefore see this association.
For this, you must have "Automation" enabled, choose "Extend with..." and then "Sub-tasks...", choosing the Sub Test Executio issue type.
Afterwards, you're able to see all the Sub Test Executions created in the context of a requirement issue that is part of the structure.
