2024-10-15 22:25:02 +01:00
package teamsworkflows
import (
"encoding/json"
"net/http"
"testing"
"github.com/TwiN/gatus/v5/alerting/alert"
"github.com/TwiN/gatus/v5/client"
"github.com/TwiN/gatus/v5/config/endpoint"
"github.com/TwiN/gatus/v5/test"
)
2024-12-16 20:32:13 -05:00
func TestAlertProvider_Validate ( t * testing . T ) {
invalidProvider := AlertProvider { DefaultConfig : Config { WebhookURL : "" }}
if err := invalidProvider . Validate (); err == nil {
2024-10-15 22:25:02 +01:00
t . Error ( "provider shouldn't have been valid" )
}
2024-12-16 20:32:13 -05:00
validProvider := AlertProvider { DefaultConfig : Config { WebhookURL : "http://example.com" }}
if err := validProvider . Validate (); err != nil {
t . Error ( "provider should've been valid, got" , err . Error ())
2024-10-15 22:25:02 +01:00
}
}
2024-12-16 20:32:13 -05:00
func TestAlertProvider_ValidateWithOverride ( t * testing . T ) {
2024-10-15 22:25:02 +01:00
providerWithInvalidOverrideGroup := AlertProvider {
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { WebhookURL : "http://example.com" },
Group : "" ,
2024-10-15 22:25:02 +01:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithInvalidOverrideGroup . Validate (); err == nil {
2024-10-15 22:25:02 +01:00
t . Error ( "provider Group shouldn't have been valid" )
}
providerWithInvalidOverrideTo := AlertProvider {
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { WebhookURL : "" },
Group : "group" ,
2024-10-15 22:25:02 +01:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithInvalidOverrideTo . Validate (); err == nil {
2024-10-15 22:25:02 +01:00
t . Error ( "provider integration key shouldn't have been valid" )
}
providerWithValidOverride := AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { WebhookURL : "http://example.com" },
2024-10-15 22:25:02 +01:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { WebhookURL : "http://example.com" },
Group : "group" ,
2024-10-15 22:25:02 +01:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithValidOverride . Validate (); err != nil {
2024-10-15 22:25:02 +01:00
t . Error ( "provider should've been valid" )
}
}
func TestAlertProvider_Send ( t * testing . T ) {
defer client . InjectHTTPClient ( nil )
firstDescription := "description-1"
secondDescription := "description-2"
scenarios := [] struct {
Name string
Provider AlertProvider
Alert alert . Alert
Resolved bool
MockRoundTripper test . MockRoundTripper
ExpectedError bool
}{
{
Name : "triggered" ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { WebhookURL : "http://example.com" }},
2024-10-15 22:25:02 +01:00
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
MockRoundTripper : test . MockRoundTripper ( func ( r * http . Request ) * http . Response {
return & http . Response { StatusCode : http . StatusOK , Body : http . NoBody }
}),
ExpectedError : false ,
},
{
Name : "triggered-error" ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { WebhookURL : "http://example.com" }},
2024-10-15 22:25:02 +01:00
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
MockRoundTripper : test . MockRoundTripper ( func ( r * http . Request ) * http . Response {
return & http . Response { StatusCode : http . StatusInternalServerError , Body : http . NoBody }
}),
ExpectedError : true ,
},
{
Name : "resolved" ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { WebhookURL : "http://example.com" }},
2024-10-15 22:25:02 +01:00
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
MockRoundTripper : test . MockRoundTripper ( func ( r * http . Request ) * http . Response {
return & http . Response { StatusCode : http . StatusOK , Body : http . NoBody }
}),
ExpectedError : false ,
},
{
Name : "resolved-error" ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { WebhookURL : "http://example.com" }},
2024-10-15 22:25:02 +01:00
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
MockRoundTripper : test . MockRoundTripper ( func ( r * http . Request ) * http . Response {
return & http . Response { StatusCode : http . StatusInternalServerError , Body : http . NoBody }
}),
ExpectedError : true ,
},
}
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
client . InjectHTTPClient ( & http . Client { Transport : scenario . MockRoundTripper })
err := scenario . Provider . Send (
& endpoint . Endpoint { Name : "endpoint-name" },
& scenario . Alert ,
& endpoint . Result {
ConditionResults : [] * endpoint . ConditionResult {
{ Condition : "[CONNECTED] == true" , Success : scenario . Resolved },
{ Condition : "[STATUS] == 200" , Success : scenario . Resolved },
},
},
scenario . Resolved ,
)
if scenario . ExpectedError && err == nil {
t . Error ( "expected error, got none" )
}
if ! scenario . ExpectedError && err != nil {
t . Error ( "expected no error, got" , err . Error ())
}
})
}
}
func TestAlertProvider_buildRequestBody ( t * testing . T ) {
firstDescription := "description-1"
secondDescription := "description-2"
scenarios := [] struct {
Name string
Provider AlertProvider
Alert alert . Alert
NoConditions bool
Resolved bool
ExpectedBody string
}{
{
Name : "triggered" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
2025-01-14 05:18:47 +01:00
ExpectedBody : "{\"attachments\":[{\"content\":{\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"Container\",\"wrap\":false,\"items\":[{\"type\":\"Container\",\"wrap\":false,\"items\":[{\"type\":\"TextBlock\",\"text\":\"⛑️ Gatus\",\"wrap\":false,\"size\":\"Medium\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"An alert for **endpoint-name** has been triggered due to having failed 3 time(s) in a row.\",\"wrap\":true},{\"type\":\"FactSet\",\"wrap\":false,\"facts\":[{\"title\":\"❌\",\"value\":\"[CONNECTED] == true\"},{\"title\":\"❌\",\"value\":\"[STATUS] == 200\"}]}],\"style\":\"Default\"}],\"style\":\"Attention\"}],\"msteams\":{\"width\":\"Full\"}},\"contentType\":\"application/vnd.microsoft.card.adaptive\"}],\"type\":\"message\"}" ,
2024-10-15 22:25:02 +01:00
},
{
Name : "resolved" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2025-01-14 05:18:47 +01:00
ExpectedBody : "{\"attachments\":[{\"content\":{\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"Container\",\"wrap\":false,\"items\":[{\"type\":\"Container\",\"wrap\":false,\"items\":[{\"type\":\"TextBlock\",\"text\":\"⛑️ Gatus\",\"wrap\":false,\"size\":\"Medium\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"An alert for **endpoint-name** has been resolved after passing successfully 5 time(s) in a row.\",\"wrap\":true},{\"type\":\"FactSet\",\"wrap\":false,\"facts\":[{\"title\":\"✅\",\"value\":\"[CONNECTED] == true\"},{\"title\":\"✅\",\"value\":\"[STATUS] == 200\"}]}],\"style\":\"Default\"}],\"style\":\"Good\"}],\"msteams\":{\"width\":\"Full\"}},\"contentType\":\"application/vnd.microsoft.card.adaptive\"}],\"type\":\"message\"}" ,
2024-10-15 22:25:02 +01:00
},
{
Name : "resolved-with-no-conditions" ,
NoConditions : true ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2025-01-14 05:18:47 +01:00
ExpectedBody : "{\"attachments\":[{\"content\":{\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"Container\",\"wrap\":false,\"items\":[{\"type\":\"Container\",\"wrap\":false,\"items\":[{\"type\":\"TextBlock\",\"text\":\"⛑️ Gatus\",\"wrap\":false,\"size\":\"Medium\",\"weight\":\"Bolder\"},{\"type\":\"TextBlock\",\"text\":\"An alert for **endpoint-name** has been resolved after passing successfully 5 time(s) in a row.\",\"wrap\":true},{\"type\":\"FactSet\",\"wrap\":false}],\"style\":\"Default\"}],\"style\":\"Good\"}],\"msteams\":{\"width\":\"Full\"}},\"contentType\":\"application/vnd.microsoft.card.adaptive\"}],\"type\":\"message\"}" ,
2024-10-15 22:25:02 +01:00
},
}
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
var conditionResults [] * endpoint . ConditionResult
if ! scenario . NoConditions {
conditionResults = [] * endpoint . ConditionResult {
{ Condition : "[CONNECTED] == true" , Success : scenario . Resolved },
{ Condition : "[STATUS] == 200" , Success : scenario . Resolved },
}
}
body := scenario . Provider . buildRequestBody (
2024-12-16 20:32:13 -05:00
& scenario . Provider . DefaultConfig ,
2024-10-15 22:25:02 +01:00
& endpoint . Endpoint { Name : "endpoint-name" },
& scenario . Alert ,
& endpoint . Result { ConditionResults : conditionResults },
scenario . Resolved ,
)
if string ( body ) != scenario . ExpectedBody {
t . Errorf ( "expected:\n%s\ngot:\n%s" , scenario . ExpectedBody , body )
}
out := make ( map [ string ] interface {})
if err := json . Unmarshal ( body , & out ); err != nil {
t . Error ( "expected body to be valid JSON, got error:" , err . Error ())
}
})
}
}
func TestAlertProvider_GetDefaultAlert ( t * testing . T ) {
if ( & AlertProvider { DefaultAlert : & alert . Alert {}}). GetDefaultAlert () == nil {
t . Error ( "expected default alert to be not nil" )
}
if ( & AlertProvider { DefaultAlert : nil }). GetDefaultAlert () != nil {
t . Error ( "expected default alert to be nil" )
}
}
2024-12-16 20:32:13 -05:00
func TestAlertProvider_GetConfig ( t * testing . T ) {
scenarios := [] struct {
2024-10-15 22:25:02 +01:00
Name string
Provider AlertProvider
InputGroup string
2024-12-16 20:32:13 -05:00
InputAlert alert . Alert
ExpectedOutput Config
2024-10-15 22:25:02 +01:00
}{
{
Name : "provider-no-override-specify-no-group-should-default" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { WebhookURL : "http://example.com" },
Overrides : nil ,
2024-10-15 22:25:02 +01:00
},
InputGroup : "" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://example.com" },
2024-10-15 22:25:02 +01:00
},
{
Name : "provider-no-override-specify-group-should-default" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { WebhookURL : "http://example.com" },
Overrides : nil ,
2024-10-15 22:25:02 +01:00
},
InputGroup : "group" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://example.com" },
2024-10-15 22:25:02 +01:00
},
{
Name : "provider-with-override-specify-no-group-should-default" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { WebhookURL : "http://example.com" },
2024-10-15 22:25:02 +01:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Group : "group" ,
Config : Config { WebhookURL : "http://example01.com" },
2024-10-15 22:25:02 +01:00
},
},
},
InputGroup : "" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://example.com" },
2024-10-15 22:25:02 +01:00
},
{
Name : "provider-with-override-specify-group-should-override" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { WebhookURL : "http://example.com" },
2024-10-15 22:25:02 +01:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Group : "group" ,
Config : Config { WebhookURL : "http://group-example.com" },
2024-10-15 22:25:02 +01:00
},
},
},
InputGroup : "group" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://group-example.com" },
},
{
Name : "provider-with-group-override-and-alert-override--alert-override-should-take-precedence" ,
Provider : AlertProvider {
DefaultConfig : Config { WebhookURL : "http://example.com" },
Overrides : [] Override {
{
Group : "group" ,
Config : Config { WebhookURL : "http://group-example.com" },
},
},
},
InputGroup : "group" ,
InputAlert : alert . Alert { ProviderOverride : map [ string ] any { "webhook-url" : "http://alert-example.com" }},
ExpectedOutput : Config { WebhookURL : "http://alert-example.com" },
2024-10-15 22:25:02 +01:00
},
}
2024-12-16 20:32:13 -05:00
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
got , err := scenario . Provider . GetConfig ( scenario . InputGroup , & scenario . InputAlert )
if err != nil {
t . Fatalf ( "unexpected error: %s" , err )
}
if got . WebhookURL != scenario . ExpectedOutput . WebhookURL {
t . Errorf ( "expected webhook URL to be %s, got %s" , scenario . ExpectedOutput . WebhookURL , got . WebhookURL )
}
// Test ValidateOverrides as well, since it really just calls GetConfig
if err = scenario . Provider . ValidateOverrides ( scenario . InputGroup , & scenario . InputAlert ); err != nil {
t . Errorf ( "unexpected error: %s" , err )
2024-10-15 22:25:02 +01:00
}
})
}
}