2022-01-15 04:00:00 +02:00
package googlechat
import (
"encoding/json"
"net/http"
"testing"
2022-12-06 01:41:09 -05:00
"github.com/TwiN/gatus/v5/alerting/alert"
"github.com/TwiN/gatus/v5/client"
2024-05-09 22:56:16 -04:00
"github.com/TwiN/gatus/v5/config/endpoint"
2022-12-06 01:41:09 -05:00
"github.com/TwiN/gatus/v5/test"
2022-01-15 04:00:00 +02:00
)
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 {
2022-01-15 04:00:00 +02: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 {
2022-01-15 04:00:00 +02:00
t . Error ( "provider should've been valid" )
}
}
2024-12-16 20:32:13 -05:00
func TestAlertProvider_ValidateWithOverride ( t * testing . T ) {
2022-05-08 02:34:21 +08:00
providerWithInvalidOverrideGroup := AlertProvider {
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { WebhookURL : "http://example.com" },
Group : "" ,
2022-05-08 02:34:21 +08:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithInvalidOverrideGroup . Validate (); err == nil {
2022-05-08 02:34:21 +08: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" ,
2022-05-08 02:34:21 +08:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithInvalidOverrideTo . Validate (); err == nil {
2022-05-08 02:34:21 +08: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" },
2022-05-08 02:34:21 +08:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { WebhookURL : "http://example.com" },
Group : "group" ,
2022-05-08 02:34:21 +08:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithValidOverride . Validate (); err != nil {
2022-05-08 02:34:21 +08:00
t . Error ( "provider should've been valid" )
}
}
2022-01-15 04:00:00 +02:00
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" }},
2022-01-15 04:00:00 +02: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" }},
2022-01-15 04:00:00 +02: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" }},
2022-01-15 04:00:00 +02: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" }},
2022-01-15 04:00:00 +02: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 (
2024-05-09 22:56:16 -04:00
& endpoint . Endpoint { Name : "endpoint-name" , Group : "endpoint-group" },
2022-01-15 04:00:00 +02:00
& scenario . Alert ,
2024-05-09 22:56:16 -04:00
& endpoint . Result {
ConditionResults : [] * endpoint . ConditionResult {
2022-01-15 04:00:00 +02:00
{ 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
2024-05-09 22:56:16 -04:00
Endpoint endpoint . Endpoint
2022-01-15 04:00:00 +02:00
Provider AlertProvider
Alert alert . Alert
Resolved bool
ExpectedBody string
}{
{
Name : "triggered" ,
2024-05-09 22:56:16 -04:00
Endpoint : endpoint . Endpoint { Name : "endpoint-name" , URL : "https://example.org" },
2022-01-15 04:00:00 +02:00
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
2022-11-10 17:51:24 -05:00
ExpectedBody : `{"cards":[{"sections":[{"widgets":[{"keyValue":{"topLabel":"endpoint-name","content":"\u003cfont color='#DD0000'\u003eAn alert has been triggered due to having failed 3 time(s) in a row\u003c/font\u003e","contentMultiline":"true","bottomLabel":":: description-1","icon":"BOOKMARK"}},{"keyValue":{"topLabel":"Condition results","content":"❌ [CONNECTED] == true\u003cbr\u003e❌ [STATUS] == 200\u003cbr\u003e","contentMultiline":"true","icon":"DESCRIPTION"}},{"buttons":[{"textButton":{"text":"URL","onClick":{"openLink":{"url":"https://example.org"}}}}]}]}]}]}` ,
2022-01-15 04:00:00 +02:00
},
{
Name : "resolved" ,
2024-05-09 22:56:16 -04:00
Endpoint : endpoint . Endpoint { Name : "endpoint-name" , URL : "https://example.org" },
2022-01-15 04:00:00 +02:00
Provider : AlertProvider {},
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2022-11-10 17:51:24 -05:00
ExpectedBody : `{"cards":[{"sections":[{"widgets":[{"keyValue":{"topLabel":"endpoint-name","content":"\u003cfont color='#36A64F'\u003eAn alert has been resolved after passing successfully 5 time(s) in a row\u003c/font\u003e","contentMultiline":"true","bottomLabel":":: description-2","icon":"BOOKMARK"}},{"keyValue":{"topLabel":"Condition results","content":"✅ [CONNECTED] == true\u003cbr\u003e✅ [STATUS] == 200\u003cbr\u003e","contentMultiline":"true","icon":"DESCRIPTION"}},{"buttons":[{"textButton":{"text":"URL","onClick":{"openLink":{"url":"https://example.org"}}}}]}]}]}]}` ,
2022-01-15 04:00:00 +02:00
},
2022-11-22 20:12:26 -05:00
{
Name : "icmp-should-not-include-url" , // See https://github.com/TwiN/gatus/issues/362
2024-05-09 22:56:16 -04:00
Endpoint : endpoint . Endpoint { Name : "endpoint-name" , URL : "icmp://example.org" },
2022-11-22 20:12:26 -05:00
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
ExpectedBody : `{"cards":[{"sections":[{"widgets":[{"keyValue":{"topLabel":"endpoint-name","content":"\u003cfont color='#DD0000'\u003eAn alert has been triggered due to having failed 3 time(s) in a row\u003c/font\u003e","contentMultiline":"true","bottomLabel":":: description-1","icon":"BOOKMARK"}},{"keyValue":{"topLabel":"Condition results","content":"❌ [CONNECTED] == true\u003cbr\u003e❌ [STATUS] == 200\u003cbr\u003e","contentMultiline":"true","icon":"DESCRIPTION"}}]}]}]}` ,
},
{
Name : "tcp-should-not-include-url" , // See https://github.com/TwiN/gatus/issues/362
2024-05-09 22:56:16 -04:00
Endpoint : endpoint . Endpoint { Name : "endpoint-name" , URL : "tcp://example.org" },
2022-11-22 20:12:26 -05:00
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
ExpectedBody : `{"cards":[{"sections":[{"widgets":[{"keyValue":{"topLabel":"endpoint-name","content":"\u003cfont color='#DD0000'\u003eAn alert has been triggered due to having failed 3 time(s) in a row\u003c/font\u003e","contentMultiline":"true","bottomLabel":":: description-1","icon":"BOOKMARK"}},{"keyValue":{"topLabel":"Condition results","content":"❌ [CONNECTED] == true\u003cbr\u003e❌ [STATUS] == 200\u003cbr\u003e","contentMultiline":"true","icon":"DESCRIPTION"}}]}]}]}` ,
},
2022-01-15 04:00:00 +02:00
}
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
body := scenario . Provider . buildRequestBody (
2022-11-22 20:12:26 -05:00
& scenario . Endpoint ,
2022-01-15 04:00:00 +02:00
& scenario . Alert ,
2024-05-09 22:56:16 -04:00
& endpoint . Result {
ConditionResults : [] * endpoint . ConditionResult {
2022-01-15 04:00:00 +02:00
{ Condition : "[CONNECTED] == true" , Success : scenario . Resolved },
{ Condition : "[STATUS] == 200" , Success : scenario . Resolved },
},
},
scenario . Resolved ,
)
2022-11-08 20:47:39 -05:00
if string ( body ) != scenario . ExpectedBody {
t . Errorf ( "expected:\n%s\ngot:\n%s" , scenario . ExpectedBody , body )
2022-01-15 04:00:00 +02:00
}
out := make ( map [ string ] interface {})
2022-11-08 20:47:39 -05:00
if err := json . Unmarshal ( body , & out ); err != nil {
2022-01-15 04:00:00 +02:00
t . Error ( "expected body to be valid JSON, got error:" , err . Error ())
}
})
}
}
func TestAlertProvider_GetDefaultAlert ( t * testing . T ) {
2024-02-07 20:09:45 -05:00
if ( & AlertProvider { DefaultAlert : & alert . Alert {}}). GetDefaultAlert () == nil {
2022-01-15 04:00:00 +02:00
t . Error ( "expected default alert to be not nil" )
}
2024-02-07 20:09:45 -05:00
if ( & AlertProvider { DefaultAlert : nil }). GetDefaultAlert () != nil {
2022-01-15 04:00:00 +02:00
t . Error ( "expected default alert to be nil" )
}
}
2022-05-08 02:34:21 +08:00
2024-12-16 20:32:13 -05:00
func TestAlertProvider_GetConfig ( t * testing . T ) {
scenarios := [] struct {
2022-05-08 02:34:21 +08:00
Name string
Provider AlertProvider
InputGroup string
2024-12-16 20:32:13 -05:00
InputAlert alert . Alert
ExpectedOutput Config
2022-05-08 02:34:21 +08: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 ,
2022-05-08 02:34:21 +08:00
},
InputGroup : "" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://example.com" },
2022-05-08 02:34:21 +08: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 ,
2022-05-08 02:34:21 +08:00
},
InputGroup : "group" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://example.com" },
2022-05-08 02:34:21 +08: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" },
2022-05-08 02:34:21 +08:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Group : "group" ,
Config : Config { WebhookURL : "http://example01.com" },
2022-05-08 02:34:21 +08:00
},
},
},
InputGroup : "" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { WebhookURL : "http://example.com" },
2022-05-08 02:34:21 +08: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" },
Overrides : [] Override {
{
Group : "group" ,
Config : Config { WebhookURL : "http://group-example.com" },
},
},
},
InputGroup : "group" ,
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" },
2022-05-08 02:34:21 +08:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Group : "group" ,
Config : Config { WebhookURL : "http://group-example.com" },
2022-05-08 02:34:21 +08:00
},
},
},
InputGroup : "group" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert { ProviderOverride : map [ string ] any { "webhook-url" : "http://alert-example.com" }},
ExpectedOutput : Config { WebhookURL : "http://alert-example.com" },
2022-05-08 02:34:21 +08: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 )
2022-05-08 02:34:21 +08:00
}
})
}
}