Page History
...
The following screenshots shows an example of the sections you should expect in this report.
How to use
This report can be generated from the Issue details screen, from the Issue Search/navigator page, from the Test Repository, or from the Test Plan board.
...
- open the Issue Search/navigator (go to Issues > Search for issues)
- search by component "Account", or by other criteria based on the Test issue's fields
-
- Select the Document Generator" action and export it using this template
Export the test specification for all Tests contained in a Test Repository folder (excluding sub-folders)
- select a folder in the Test Repository
- Select the "Document Generator" action and export it using this template
Export the test specification for all Tests contained in a Test Repository folder (including sub-folders)
- select a folder in the Test Repository
- Select the "View Issues" action; you'll be redirected to the Issue Search/Navigator
- On the Issue Search/Navigator, select the "Document Generator" action and export it using this template
Export the test specification for all Tests contained in a Test Plan folder (excluding sub-folders)
- select a folder in the Test Plan
- Select the "Document Generator" action and export it using this template
Export the test specification for all Tests contained in a Test Plan or in one of its folders (including sub-folders)
- select a folder in the Test Plan
- Select the "View Issues" action; you'll be redirected to the Issue Search/Navigator
- On the Issue Search/Navigator, select the "Document Generator" action and export it using this template
Understanding the report
...
The output will have the following information.
Requirements covered by these Tests
...
The requirements are listed in a table as follows.
Tests
This section will gather all the information related to each Test, focused on its specification.
...
The description of the Test (${wiki:Description}).
Test Issue Attachments
...
This appears in the document in a table form. A thumbnail is shown for images.
Status of the last execution
This section shows the last execution status for the Test.
Requirements
In this section we have an overview of all the requirements that are covered by the Test.
...
The requirements are listed in a table as follows.
Preconditions
If the Test requires any Preconditions, they will be shown.
...
The Preconditions are listed in a table as follows.
Test Details
This section shows the Test details; for that we are considering the different possible Test Types we can have in Xray. For each type we will fetch different information.
...
| Type | Key | Description | Code | Output |
|---|---|---|---|---|
Unstructured (e.g., "Generic") | Test Type | Test Type field | ${Test Type} |
|
| Specification | Definition of the Generic test | ${Generic Test Definition} | ||
Gherkin (e.g., "Cucumber") | Test Type | Test Type field | ${Test Type} |
|
| Gherkin Specification | Gherkin specification of the Test | ${Cucumber Scenario} | ||
Structured (e.g., "Manual") | (Step) | Step Number | ${TestSteps[m].StepNumber} |
|
| Action | Action of the Test Step | ${TestSteps[m].Action} | ||
| Step Custom Fields | Step Custom Fields | ${TestSteps[m].StepCustomFieldXX} Note: needs to be explicitly defined on the template; by default, no step custom fields will be shown. | ||
| Data | Data of the Test Step | ${TestSteps[m].Data} | ||
| Expected Result | Expected Result of the Test Step | ${TestSteps[m].ExpectedResult} | ||
| Attachments | Attachment of the Test Step; images will be rendered | @{title=${TestSteps[m].Attachments[sa].Name}|href=${TestSteps[m].Attachments[sa].FileURL}} !{${TestSteps[m].Attachments[sa].FileURL}|width=100} |
...
The Test Sets are listed in a table as follows.
Test Plans
If the Test is part of Test Plans, they will be shown.
...
The Test Plans are listed in a table as follows.
Appendix A: Approval
This section is added for the cases where you need to have a signature validating the document.
Customizing the report
...