Breadcrumbs

How to use the Jira Snapshots Test Report Macro

Adding the Jira Snapshots Test Report Macro to a Confluence Page

  1. Navigate to the page and click the Edit icon, or just type E to open the editor. (Alternatively, you can create a new page.)

  2. In the Confluence editor, click the '+' icon and choose View More from the drop-down menu.

  3. Find the item to be inserted and select it.

  4. Click Insert.

  5. Configure the macro and Save. Further down on this page, you’ll find more configuration information. 💡 At this stage, the macro will display “No Data” which is expected. You need to publish the page and take a new snapshot before data appears.

You can also type '/' (forward slash symbol) while editing the page, to bring up the same list you'd see by in the View more menu.

Publishing and Generating the First Test Report Snapshot

  1. Once the macro is configured, continue editing the rest of the page, and click Publish when finished.

  2. After the page is published, click Update to generate the first snapshot.

Macro Configuration


In the Tests List tab: The Tests section

The Tests section is where you define the tests to be included in the test report.

💡 Whatever the search criteria, the only issues that are retrieved are Xray Test issues.
Specify the tests to fetch in one of three approaches:

  1. Search for Jira issues using the “Basic approach”: using the options provided in the configuration screen (Project, Fix versions, etc)

  2. Search for Jira issues using a JQL phrase. When searching with JQL, do not specify the issue type because only Xray Test issues are retrieved.

  3. Search for all tests included in an Xray test plan (or plans).

image-20250221-152842.png


Once the search criteria are defined, use the preview to ensure the list of issues is what you expect.

Detailed test report- search preview.gif



JQL is Jira Query Language. This is the native query language for Jira, and these macros use it directly when retrieving data from Jira.

New to JQL? We have put here Jira JQL Cheat Sheet some information to help you get started.


In the Tests List tab: The Tests Runs section

In this section, the main toggle is “Include Test Runs”.

When the toggle is on then for each test that is retrieved, its latest test run is included in the report as well.
To be selective about the scope- select specific Fix versions or Test environments. If these are used, then the latest test run that is associated with these specific versions and environments will be retrieved.

If the test does not have test runs within the specified scope, then the report will specify that test runs were not found.

image-20250221-155804.png

Selecting which sections are included in the report

In this tab, select sections you want to include or not in the report.


image-20250221-162126.png

Section name

Content and example

Test Info

These are data that are directly part of the Xray test issue

Test Run Info

Data that is part of the test run, but is not part of the technical details of the execution- like data that is specific to a step or an iteration (for manual tests).

Test Steps, Scenario, Definition

  • For manual tests: this is the data specific for each step

  • For Cucumber tests: this is the gherkin script

  • For Generic tests: this would be the definition

If Test Run Info is included in the report, the data will be retrieved from the test run (or will not exist if a test run is not found)

If Test Run Info is not included, then the data presented is from the Test.

Evidence

This is a section in the report where evidence attached to test runs is included- capturing almost the full width of the page.

For manual tests: Evidence for specific test steps will displayed in a smaller format within each step.