Raport z testów na Slacku - automatycznie

Wysyłanie wiadomości na Slacka z rezultatem przeprowadzonych testów automatycznych po skończonym buildzie na serwerze CI dało mi bardzo dużo wartości. Mechanizm ten ułatwia dostęp do raportów z testów dla całego zespołu. Zachęca do głębszej analizy testów. Do tego, dodatkowa analityka jest bardzo pomocna w wykrywaniu niestabilnych testów, tj. flaky tests. Przeczytaj jak to osiągnąć.

Poprzedni post znajdziesz tutaj: Raportowanie testów Cypress w Azure DevOps

Chcesz zobaczyć jak rozwiązać zadanie na pozycję testera automatyzującego?

Nagranie znajdziesz tutaj, lub klikając na obrazek poniżej:

Jak to osiągnąć?

Szczegóły stworzenia takiego narzędzia zależą od infrastruktury, którą mamy zbudowaną wokół kodu tj. stosu technologicznego oraz narzędzi CI, z jakich korzystamy. W moim przypadku używam z Azure DevOps, ma on np. wbudowane wtyczki umożliwiające wysyłanie wiadomości poprzez wypełnienie pól w interfejsie graficznym. Ja wykorzystam bardziej uniwersalny sposób jednak wymagający odrobiny więcej umiejętności technicznych.

Rozwiązanie opiera się na API Slack, Webhooks i skryptu Powershell. Jest to bardzo dobrze opisane w dokumentacji Slacka:

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

Potrzebujemy webhook URL, aby móc kontynuować, sekcja “Create an Incoming Webhook”. Następnym krokiem jest konsumpcja API również opisana w dokumentacji pod linkiem podanym powyżej. Aby połączyć te wszystkie elementy wykorzystam skrypt Powershell:

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)

Logika biznesowa

Logika biznesowa skryptu jest bardzo prosta. Tworzymy funkcję SendSlackTestReport odpowiedzialną za wysłanie raportu. Następnie definiuję zmienną nl która ułatwia tworzenie nowych linii. icon, pobiera emotikonę ze zmiennej środowiskowej E2E_RESULTS_ICON. buildid pobiera wartość zmiennej środowiskowej BUILD_BUILDID która przechowuję buildId z infrastruktury Azure DevOps. testresultslink link do raportów z testów, podmiana buildId w linku zapewnia, że zawsze trafiamy z wiadomości Slack do dobrego raportu. Ta sama sytuacja zachodzi dla zmiennych pipelinepassratelink, testpassrate i pipelineduration.

Zmienna payload jak sama nazwa wskazuję przechowuję wiadomość, która zostanie wysłana do API. Musi ona zachować odpowiedni kontrakt, opisany w linku do API Slacka. Po tych operacjach wypisuję na ekran payload wiadomości w celach ewentualnej sesji debugowania na środowisku CI. Ostatecznie wysyłam zbudowaną w ten sposób wiadomość wykorzystująć payload oraz URL, który pobrałem ze zmiennej środowiskowej WEBHOOK_URL.

Azure DevOps

Krok w azure-pipelines.yml wygląda następująco:

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

Jak widać skrypt powershell jest umieszczony w repozytorium projektu w katalogu devops. W ten sposób narzędzia CI wiedzą jaki skrypt uruchomić. Dodałem również sekcje condition, która spowoduję, że krok uruchomi się zawsze niezależnie od rezultatu testów.

Podsumowanie

W ten właśnie sposób osiągnąłem efekt monitoringu testów automatycznych na platformie Slack. Sposób ten jest dość uniwersalny. Pozwala zastosować skrypt w każdym miejscu wspierającym Powershell. Znacznie zwiększa on jakość testów automatycznych oraz skłania zespół do częstszej analizy wyników testów wykonywanych na serwerze CI we wcześniejszych zaplanowanych porach czy też, kiedy wykonują się automatycznie po stworzeniu PR do kodu.

Wciąż głodny wiedzy? Weź za darmo!

16 rzeczy, które musisz wiedzieć, aby skutecznie zautomatyzować testy oraz lista bibliotek, z których korzystam w każdym moim projekcie testowym, kliknij tutaj