Page History
Since Xray v3.1, you can receive email notifications related with Test Runs. This has been extended in v3.2 to provide notifications related with changes in Tests and Pre-Conditions.
Emails are sent depending on the configuration of Jira notifications, defined in a Notification Scheme, for some specific JIRA events provided by Xray.
Since Concerning Test Runs related events, since the Test Run is not an issue type, events are triggered for the related Test Execution; this means that the notification recipients fields are mostly related with the Test Execution. However, in some events there can be some difference on the semantics of the fields (e.g. "current assignee" may be the assignee of the Test Run instead of the Test Execution issue).
Usually, notifications are configured to be delivered to the "current assignee" (e.g. the Test Run assignee or the Test/Pre-Condition/Test Execution assignee, depending on the context). Nevertheless, it's possible to configure other stakeholders, such as the watchers, to be notified on the changes related with Tests/Pre-Conditions/Test Runs.
Table of Contents |
---|
...
Xray reuses the notifications mechanism provided by Jira; this simplifies a lot the management of Test Run Xray related notifications.
In other words, email notifications are triggered based on the configuration of notifications of events, in the context of the Notification Scheme being used by the project.
When Xray is installed, the following events are also installed (if they don't exist yet):
- Test or Pre-Condition Updated
- Test Run Assigned
- Test Run Status set to Final
- Precedent Test Run Status set to Final
However, by default, no notifications will configured for those events upon installation; you'll need to add, and therefore enable, them explicitly.
...
There are some global settings related with Test Run Xray notifications. For more information on these settings, please see Global PreferencesMiscellaneous.
Project Setup
Quick setup
...
There is a quick setup, that will create a notification for each Test Run Xray related event and will configure it for the "current assignee".
...
Info | ||
---|---|---|
| ||
This option will only be available if:
|
To quickly enable Test Run Xray notifications,
- go to project settings => Summary
- from the Actions menu, choose "Enable Test Run Xray notifications". Note that this will impact the Notification Scheme being used by this project and all other projects that also use it.
- For each Test Run related event, a notification will be created and assigned to the "current assignee"; please have a look at the Events section below, for clarification on the meaning of this specific recipient.
Disable notifications
There is a quick way to "disable" (i.e. remove) notifications for each Test Run Xray related event.
Info | ||
---|---|---|
| ||
This option will only be available if:
|
To quickly disable Test Run TXray notifications,
- go to project settings => Summary
- from the Actions menu, choose "Disable Test Run Xray notifications". Note that this will impact the Notification Scheme being used by this project and all other projects that also use it.
Detailed setup
...
- go to project settings => Notifications
- from the Actions menu, choose "Edit notifications". Note that this will impact the Notification Scheme being used by this project and all other projects that also use it.
- in each Test Run related event, click on "Add" in order to add a notification to the related Notification Scheme
- in the notification configuration page, besides the Event that will be pre-selected, define who shall receive the email notifications related with that event
Events
Test or Pre-Condition Updated
The aim of this event is to notify a user (or users) that the specification of a Test or Pre-Condition has been changed.
This includes:
- adding/removing/updating steps in Manual Tests
- updating the "Generic Test Definition" of Generic Tests
- updating the "Cucumbert Scenario" of Cucumber Tests
- updating the "Conditions" of Pre-Conditions
The event is triggered for the related Test/Pre-Condition issue. This means that, in the notification configuration screen, most of the fields (e.g. "Reporter", "Project Lead", "Component Lead", "Project Role", "All Watchers", "User/Group custom field value") refer to the associated Test/Pre-Condition issue or to the Test/Pre-Condition issue's project.
Info | ||
---|---|---|
| ||
Changes on the typical fields (e.g. description, summary, etc) will trigger the standard "Issue Updated" event and won't trigger the "Test or Pre-Condition Updated" event. |
Test Run Assigned
The aim of this event is to notify a user (or users) that a Test Run has been assigned, so the tester can proceed with testing.
...