Overview

Microsoft Teams, or "Teams," is a popular communication platform many development and non-development teams adopt.

Teams use it daily to collaborate, make calls, share information, ask for help, and be notified of certain events to increase visibility of the status of the projects they're working on.

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").

  1. In Teams, select the channel and the "Connectors" option
  2.  Select the "Incoming Webhook"
  3. Configure the "Incoming Webhook", giving it a name and uploading an image to be associated with it. Copy the unique URL and keep it safe. 
    2. Note: You can use the following image containing the Xray logo
      1.   


Use cases

Share test results to a channel

This common use-case is about sharing information about test results, usually from test automation, to a Teams channel so the team can be aware of testing progress and analyze the results if needed.



At high-level, we will:

  1. obtain the Test Execution details, including recorded test results, using information stored as JSON on the "Test Execution Status" custom field of the corresponding Test Execution issue;
  2. build an HTTP request to send a notification with the test results summary by invoking a webhook on MS Teams

Step-by-step implementation with Jira automation

  1. In Jira's project settings, under Automation, create the Jira automation rule
    1. 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.

      3. 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.

  2. 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

    1. 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"

      3. {{Test Execution Status.statuses.get(0).statusCount}}

...

{{Test Execution Status.count}}
    2. Note: we could also do it by looking at the number of failed tests using the expression {{Test Execution Status.statuses.get(1).statusCount)}}
  3. 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)

    1. If not all tests passed, we can send the following content.


      1. {
    "@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/error.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(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}} - {{Test Execution Status.statuses.get(1).statusCount}}{{/}}"
        }],
        "markdown": true
    }]
}

    2. If all tests passed, within the "ELSE" section of the IF block, we can send the following content.



      1. {
    "@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 obtainJira Automation smart valuesNotes
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:


{{#issue.Test Execution Status.statuses}}{{#if(equals(name,"PASS"))}}{{statusCount}}{{/}}{{/}}

Number of failed tests (i.e., reported as "FAIL")

{{Test Execution Status.statuses.get(1).statusCount}}

A more accurate expression would be:


{{#issue.Test Execution Status.statuses}}{{#if(equals(name,"FAIL"))}}{{statusCount}}{{/}}{{/}}

Test Environments{{issue.Test Environments}}
Linked Test Plan(s) {{issue.Test Plan}}

References


  • No labels