Page History
...
In this article, we'll see an everyday use case: sharing test results with the team in their collaboration tool (i.e., "MS Teams"). However, Xray and Jira's built-in automation capabilities can implement many more use cases.
Prerequisites
To integrate with Teams, we can set up an incoming webhook in a channel and use it to send notifications (i.e., "messages").
...
Info |
---|
At high-level, we will:
|
Step-by-step implementation with Jira automation
- .In Jira's project settings, under Automation, create the Jira automation rule
- define the trigger; we can have a manual trigger that will provide an action from the issue screen or a trigger based on creating a specific issue type. In this case, it would probably make the most sense to have a trigger based on the transition to some status (e.g., "Done"). We can also restrict this to the issue types "Test Execution" and "Sub-Test Execution" using an IF condition.
- create an action using the "Send web request" template to make the authentication request and obtain a token to be used on the GraphQL queries; we need a client_id and a client_secret (please see how to create API keys).
- save the response on a variable (e.g., "token")
Info title Please note Xray provides an automatic mechanism to transition Test Execution issues if all of its tests have a final status (i.e., if all tests have reported results). This is useful whenever uploading test automation results from a CI/CD pipeline. Please read the available configuration options to enable this under the Miscellaneous tab in Xray global settings.
- define the trigger; we can have a manual trigger that will provide an action from the issue screen or a trigger based on creating a specific issue type. In this case, it would probably make the most sense to have a trigger based on the transition to some status (e.g., "Done"). We can also restrict this to the issue types "Test Execution" and "Sub-Test Execution" using an IF condition.
- make a IF THEN ELSE block to adjust the text message and image of the notification, to tailor our notification for successful and unsuccessful testing case
We can compare the number of tests that passed vs the total number of tests on the Test Execution, to identify wether all test results were successful or not. We'll use information from the "Test Execution Status" custom field that is associated with the Test Execution issue; if you want to see what's within this field, you can use the "Add value to the audit log"
Code Block collapse true {{Test Execution Status.statuses.get(0).statusCount}} ... {{Test Execution Status.count}}
- Note: we could also do it by looking at the number of failed tests using the expression
{{Test Execution Status.statuses.get(1).statusCount)}}
- send the notification by using a "Send web request" to invoke the webhook on Teams (two requests, one for success and another if tests failed)
If not all tests passed, we can send the following content.
Code Block
Code Block Use the GraphQL API, namely the getTestExecution function. We'll need the issue id of the Test Execution that was triggered; we can use the smart values feature from Jira automation to obtain it. We need to also obtain the custom field id of the "Revision" custom field under the "Issue Fields" section of your Jira administration.
Code Block title sample GraphQL query
getTestExecution(issueIdcollapse true {
id"@type": "MessageCard", "@context": "http://schema.org/extensions", "themeColor": "0076D7", "summary": "{{issue.
") {summary}}
issueId", "sections": [{
jira(fields"activitySubtitle": "{{issue.summary}}",
["key","customfield_10033"])"activityTitle":
"Test results for project {{project.name}}", "activityImage": "https://docs.getxray.app/s/e1tqew/8402/f0863dd17de361916f7914addff17e0432a0be98/_/images/icons/emoticons/error.png",
testRuns(limit:"facts": [
100)
results{{
status{"name": "Test Execution",
"value": "[{{issue.key}}]({{issue.url}})" }, { "name": "Reporter", "value": "{{issue.reporter.displayName}}" }, {
test"name": "Version",
jira(fields"value": "{{issue.fixVersions.name}}" }, {
["name":
key"
])Revision"
, "value": "{{issue.Revision}}" }
testEnvironments testPlans(limit: 1) { results{ jira(fields: ["key"]) } } } }, { "name": "Test Environment(s)", "value": "{{issue.Test Environments}}" }
- Escape the GraphQL query (e.g., using the online GraphQL to JSON Body Converter tool)
- get the total tests and store it in a variable(note that this is an approximate value as GraphQL results can be limited and paginated)
Code Block {{webResponse.body.data.getTestExecution.testRuns.results.size|0}}
- get the total tests passing and store it in a variable (note that this is an approximate value as GraphQL results can be limited and paginated)
Code Block {{webResponse.body.data.getTestExecution.testRuns.results.status.name.match(".*(PASSED).*").size|0}}
- get the total failed tests and store it in a variable (note that this is an approximate value as GraphQL results can be limited and paginated)
Code Block {{webResponse.body.data.getTestExecution.testRuns.results.status.name.match(".*(FAILED).*").size|0}}
- get the total tests in TO DO and store it in a variable (note that this is an approximate value as GraphQL results can be limited and paginated)
Code Block {{webResponse.body.data.getTestExecution.testRuns.results.status.name.match(".*(TO DO).*").size|0}}
, { "name": "Test Plan", "value": "[{{issue.Test Plan}}]({{baseUrl}}/browse/{{issue.Test Plan}})" }, { "name": "Total tests", "value": "{{Test Execution Status.count}}" }, { "name": "Passed tests", "value": "{{Test Execution Status.statuses.get(0).statusCount}}" }, { "name": "Failed tests", "value": "{{Test Execution Status.statuses.get(1).statusCount}}" }, { "name": "Other tests", "value": "{{#=}}{{
Test Execution Status.count}} - {{
Test
Execution Status.statuses.get(0).statusCount}} - {{
- get the linked Test Plan and store it in a variable
Code Block {{webResponse.body.data.getTestExecution.testPlans.results.jira.key}}
- Use a "IF" block to store the URL of the linked Test Plan, if any
- get the associated Test Environments and store it in a variable
Code Block {{webResponse.body.data.getTestExecution.testEnvironments.join(",")}}
- get the list of distinct statuses reported and store it in a temporary variable
Code Block {{webResponse.body.data.getTestExecution.testEnvironments.join(",")}}
- make a IF THEN ELSE block to adjust the text message and image of the notification, to tailor our notification for successful and unsuccessful testing cases
As a mere example, for the "failure" image we can use the following one.
Code Block https://docs.getxray.app/s/e1tqew/8402/f0863dd17de361916f7914addff17e0432a0be98/_/images/icons/emoticons/error.png
As a mere example, for the "success" image we can use the following one.
Code Block https://docs.getxray.app/s/e1tqew/8402/f0863dd17de361916f7914addff17e0432a0be98/_/images/icons/emoticons/check.png
Test Execution Status.statuses.get(1).statusCount}}{{/}}" }], "markdown": true }] }
If all tests passed, within the "ELSE" section of the IF block, we can send the following content.
Code Block collapse true { "@type": "MessageCard", "@context": "http://schema.org/extensions", "themeColor": "0076D7", "summary": "{{issue.summary}}", "sections": [{ "activitySubtitle": "{{issue.summary}}", "activityTitle": "Test results for project {{project.name}}", "activityImage": "
https://docs.getxray.app/s/e1tqew/8402/f0863dd17de361916f7914addff17e0432a0be98/_/images/icons/emoticons/check.png", "facts": [ { "name": "Test Execution", "value": "[{{issue.key}}]({{issue.url}})" }, { "name": "Reporter", "value": "{{issue.reporter.displayName}}" }, { "name": "Version", "value": "{{issue.fixVersions.name}}" }, { "name": "Revision", "value": "{{issue.Revision}}" }, { "name": "Test Environment(s)", "value": "{{
issue.Test Environments}}" }, { "name": "Test Plan", "value": "[{{
issue.Test Plan}}]({{baseUrl}}/browse/{{issue.Test Plan}})" }, { "name": "Total tests", "value": "{{
Test Execution Status.count}}" }, { "name": "Passed tests", "value": "{{
Test Execution Status.statuses.get(1).statusCount}}" }, { "name": "Failed tests", "value": "{{
Test Execution Status.statuses.get(0).statusCount}}" }, { "name": "
Other
tests", "value": "{{
#=}}
{{Test Execution Status.count}} - {{Test Execution Status.statuses.get(0).statusCount}} -
{{
Test
Execution Status.statuses.get(1).statusCount}}{{/}}" }], "markdown": true }] }
Example of the output
Further ideas to try out
- send the notification only if there are test failures
- send the notification only if there is a specific label or custom field on the Test Execution
- add comments and/or logs of the failed tests to the notification
Tips
To get information about test results using the "Test Execution Status" custom field, the scripts above use the "Test Execution Status" custom field that has an internal representation about the overall testing progress. Note that this internal representation may change in the future.
The table below presents some information you may obtain and how to perform it using Jira automation smart values/expressions. Please see the code snippets above to see how additional information.
Information to obtain | Jira Automation smart values | Notes |
---|---|---|
Total Tests | {{Test Execution Status.count}} | |
Number of tests passing (i.e., reported as "Pass") | {{Test Execution Status.statuses.get(0).statusCount}} | A more accurate expression would be:
|
Number of failed tests (i.e., reported as "FAIL") |
| A more accurate expression would be:
|
Test Environments | {{issue.Test Environments}} | |
Linked Test Plan(s) | {{issue.Test Plan}} |
References
- Teams
- GraphQL to JSON Body Converter
- Cloud