Context

Sending messages to Slack with the results of automated tests after the build on the CI server gave me a lot of value. This mechanism facilitates access to test reports for the entire team. It encourages a deeper analysis of the tests. Moreover, additional analytics are very helpful in detecting flaky tests. Read how to achieve it.

Do you like my blog?

Subscribe to mail list, to be first which will be notified about new posts and informations:

I will add you to mailing list. You can unsubscribe at any time (one click). Privacy policy

How to achieve it?

The details of creating such a tool depend on the infrastructure we have built around the code, i.e. the technological stack and the CI tools we use. In my case, I use Azure DevOps, it has, for example, built-in plugins that allow you to send messages by filling in the fields in the graphical interface. I will use a more universal method, but requiring a bit more technical skills.

The solution is based on the Slack API, Webhooks and Powershell script. This is very well documented in the Slack documentation:

https://api.slack.com/messaging/webhooks

We need a webhook URL to be able to continue with the “Create an Incoming Webhook” section. The next step is API consumption, also described in the documentation at the link provided above. To combine all these elements I will use a Powershell script:

function SendSlackTestReport {
    param (    
        [Parameter(Mandatory = $true, Position = 1)]$Url
    )
    $nl = [Environment]::NewLine
    $icon = $env:E2E_RESULTS_ICON
    $buildid = $env:BUILD_BUILDID
    $testresultslink = "https://dev.azure.com/marcinstanekpl/Conduit%20e2e%20tests/_build/results?buildId=$buildid&view=ms.vss-test-web.build-test-results-tab"
    $pipelinepassratelink = "https://dev.azure.com/marcinstanekpl/Conduit%20e2e%20tests/_pipeline/analytics/stageawareoutcome?definitionId=1&contextType=build"
    $testpassrate = "https://dev.azure.com/marcinstanekpl/Conduit%20e2e%20tests/_test/analytics?definitionId=1&contextType=build"
    $pipelineduration = "https://dev.azure.com/marcinstanekpl/Conduit%20e2e%20tests/_pipeline/analytics/duration?definitionId=1&contextType=build"

    $payload = @{
        "icon_emoji"  = "$icon"	
        "username"    = "Test reporter"
        "attachments" = @(
            @{
                "text"   = "*<$testresultslink|E2e test results $result>* $nl BuildId: $buildid $nl $nl Test results: $testresultslink $nl $nl Pipeline pass rate: $pipelinepassratelink $nl $nl Test pass rate: $testpassrate $nl $nl Pipeline duration: $pipelineduration"
                "footer" = "Message from Azure DevOps"
            }
        )
    }

    Write-Host "Payload:"
    Write-Host (ConvertTo-Json $payload)

    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    Invoke-RestMethod -Uri $Url -Method Post -Body (ConvertTo-Json -Compress -InputObject $payload) ` -ContentType "application/json"
}

Write-Host "Sending slack message for BUILD: $($env:BUILD_BUILDID)"

SendSlackTestReport $($env:WEBHOOK_URL)

Busniess logic

The business logic of the script is very simple. We create the SendSlackTestReport function responsible for sending the report. Then I define a variable nl which makes it easy to create new lines. icon, gets the emoticon from the E2E_RESULTS_ICON environment variable. buildid gets the value of the BUILD_BUILDID environment variable that stores the buildId from the Azure DevOps infrastructure. testresultslink link to test reports, replacing buildId in the link ensures that we always hit a good report from Slack news. The same is true for the pipelinepassratelink, testpassrate, and pipelineduration variables.

The payload variable, as the name suggests, stores the message that will be sent to the API. It must keep the appropriate contract, described in the link to Slack’s API. After these operations, I write messages to the payload screen for the purpose of a possible debugging session in the CI environment. Finally, I send the message built this way using the payload and the URL that I downloaded from the WEBHOOK_URL environment variable.

Azure DevOps

The step in azure-pipelines.yml looks like this:

- task: PowerShell@2
  inputs:
    filePath: 'devops/slack-message.ps1'
  displayName: 'Send Slack message with link to test report' 
  condition: always()

As you can see, the powershell script is located in the project’s repository in the devops directory. This way, CI tools know what script to run. I also added a condition section which will cause the step to run always regardless of the test result.

Summary

This is how I achieved the effect of monitoring automated tests on the Slack platform. This method is quite universal. It allows you to apply the script in any place supporting Powershell. It significantly increases the quality of automated tests and prompts the team to more often analyze the results of tests performed on the CI server at earlier scheduled times or when they are performed automatically after creating a PR to the code.

Still hungry for knowledge? Take it for free!

16 things which you have to know to efficiently automatize tests and library list which I use in every my test project, click here