2021-03-31 01:38:34 +02:00
package telegram
import (
"encoding/json"
2021-12-02 23:10:21 -05:00
"net/http"
2021-03-31 01:38:34 +02:00
"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"
2021-03-31 01:38:34 +02:00
)
2024-12-16 20:32:13 -05:00
func TestAlertProvider_Validate ( t * testing . T ) {
2022-09-07 19:02:30 -04:00
t . Run ( "invalid-provider" , func ( t * testing . T ) {
2024-12-16 20:32:13 -05:00
invalidProvider := AlertProvider { DefaultConfig : Config { Token : "" , ID : "" }}
if err := invalidProvider . Validate (); err == nil {
2022-09-07 19:02:30 -04:00
t . Error ( "provider shouldn't have been valid" )
}
})
t . Run ( "valid-provider" , func ( t * testing . T ) {
2024-12-16 20:32:13 -05:00
validProvider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }}
if err := validProvider . Validate (); err != nil {
2022-09-07 19:02:30 -04:00
t . Error ( "provider should've been valid" )
}
})
2024-07-28 02:05:17 +03:00
t . Run ( "invalid-provider-override-nonexist-group" , func ( t * testing . T ) {
2024-12-16 20:32:13 -05:00
invalidProvider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Config : Config { Token : "token" , ID : "id" }}}}
if err := invalidProvider . Validate (); err == nil {
2024-07-28 02:05:17 +03:00
t . Error ( "provider shouldn't have been valid" )
}
})
t . Run ( "invalid-provider-override-duplicate-group" , func ( t * testing . T ) {
2024-12-16 20:32:13 -05:00
invalidProvider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Group : "group1" , Config : Config { Token : "token" , ID : "id" }}, { Group : "group1" , Config : Config { ID : "id2" }}}}
if err := invalidProvider . Validate (); err == nil {
2024-07-28 02:05:17 +03:00
t . Error ( "provider shouldn't have been valid" )
}
})
2024-12-16 20:32:13 -05:00
t . Run ( "valid-provider-with-overrides" , func ( t * testing . T ) {
validProvider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Group : "group" , Config : Config { Token : "token" , ID : "id" }}}}
if err := validProvider . Validate (); err != nil {
2024-07-28 02:05:17 +03:00
t . Error ( "provider should've been valid" )
}
})
}
2021-12-02 23:10:21 -05: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 { ID : "123" , Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" }},
2021-12-02 23:10:21 -05: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 { ID : "123" , Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" }},
2021-12-02 23:10:21 -05: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 { ID : "123" , Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" }},
2021-12-02 23:10:21 -05: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 { ID : "123" , Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" }},
2021-12-02 23:10:21 -05: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" },
2021-12-02 23:10:21 -05:00
& scenario . Alert ,
2024-05-09 22:56:16 -04:00
& endpoint . Result {
ConditionResults : [] * endpoint . ConditionResult {
2021-12-02 23:10:21 -05: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 ())
}
})
}
}
2021-12-02 21:05:17 -05:00
func TestAlertProvider_buildRequestBody ( t * testing . T ) {
firstDescription := "description-1"
secondDescription := "description-2"
2025-10-05 22:00:45 +03:00
descriptionWithLink := "[link](https://example.org/)"
2021-12-02 21:05:17 -05:00
scenarios := [] struct {
Name string
Provider AlertProvider
Alert alert . Alert
2024-04-10 20:46:17 -04:00
NoConditions bool
2021-12-02 21:05:17 -05:00
Resolved bool
ExpectedBody string
}{
{
Name : "triggered" ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { ID : "123" }},
2021-12-02 21:05:17 -05:00
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
2025-10-05 22:00:45 +03:00
ExpectedBody : "{\"chat_id\":\"123\",\"text\":\"⛑ *Gatus* \\nAn alert for *endpoint-name* has been triggered:\\n—\\n _healthcheck failed 3 time(s) in a row_\\n— \\n*Description* \\ndescription-1 \\n\\n*Condition results*\\n❌ - `[CONNECTED] == true`\\n❌ - `[STATUS] == 200`\\n\",\"parse_mode\":\"MARKDOWN\"}" ,
2021-12-02 21:05:17 -05:00
},
{
Name : "resolved" ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { ID : "123" }},
2021-12-02 21:05:17 -05:00
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2025-10-05 22:00:45 +03:00
ExpectedBody : "{\"chat_id\":\"123\",\"text\":\"⛑ *Gatus* \\nAn alert for *endpoint-name* has been resolved:\\n—\\n _healthcheck passing successfully 5 time(s) in a row_\\n— \\n*Description* \\ndescription-2 \\n\\n*Condition results*\\n✅ - `[CONNECTED] == true`\\n✅ - `[STATUS] == 200`\\n\",\"parse_mode\":\"MARKDOWN\"}" ,
2021-12-02 21:05:17 -05:00
},
2024-04-10 20:46:17 -04:00
{
Name : "resolved-with-no-conditions" ,
NoConditions : true ,
2024-12-16 20:32:13 -05:00
Provider : AlertProvider { DefaultConfig : Config { ID : "123" }},
2024-04-10 20:46:17 -04:00
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2025-10-05 22:00:45 +03:00
ExpectedBody : "{\"chat_id\":\"123\",\"text\":\"⛑ *Gatus* \\nAn alert for *endpoint-name* has been resolved:\\n—\\n _healthcheck passing successfully 5 time(s) in a row_\\n— \\n*Description* \\ndescription-2 \\n\",\"parse_mode\":\"MARKDOWN\"}" ,
2024-04-10 20:46:17 -04:00
},
2025-07-11 20:55:42 +03:00
{
Name : "send to topic" ,
Provider : AlertProvider { DefaultConfig : Config { ID : "123" , TopicID : "7" }},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
2025-10-05 22:00:45 +03:00
ExpectedBody : "{\"chat_id\":\"123\",\"text\":\"⛑ *Gatus* \\nAn alert for *endpoint-name* has been triggered:\\n—\\n _healthcheck failed 3 time(s) in a row_\\n— \\n*Description* \\ndescription-1 \\n\\n*Condition results*\\n❌ - `[CONNECTED] == true`\\n❌ - `[STATUS] == 200`\\n\",\"parse_mode\":\"MARKDOWN\",\"message_thread_id\":\"7\"}" ,
},
{
Name : "triggered with link in description" ,
Provider : AlertProvider { DefaultConfig : Config { ID : "123" }},
Alert : alert . Alert { Description : & descriptionWithLink , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
ExpectedBody : "{\"chat_id\":\"123\",\"text\":\"⛑ *Gatus* \\nAn alert for *endpoint-name* has been triggered:\\n—\\n _healthcheck failed 3 time(s) in a row_\\n— \\n*Description* \\n[link](https://example.org/) \\n\\n*Condition results*\\n❌ - `[CONNECTED] == true`\\n❌ - `[STATUS] == 200`\\n\",\"parse_mode\":\"MARKDOWN\"}" ,
2025-07-11 20:55:42 +03:00
},
2021-12-02 21:05:17 -05:00
}
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
2024-05-09 22:56:16 -04:00
var conditionResults [] * endpoint . ConditionResult
2024-04-10 20:46:17 -04:00
if ! scenario . NoConditions {
2024-05-09 22:56:16 -04:00
conditionResults = [] * endpoint . ConditionResult {
2024-04-10 20:46:17 -04:00
{ Condition : "[CONNECTED] == true" , Success : scenario . Resolved },
{ Condition : "[STATUS] == 200" , Success : scenario . Resolved },
}
}
2021-12-02 21:05:17 -05:00
body := scenario . Provider . buildRequestBody (
2024-12-16 20:32:13 -05:00
& scenario . Provider . DefaultConfig ,
2024-05-09 22:56:16 -04:00
& endpoint . Endpoint { Name : "endpoint-name" },
2021-12-02 21:05:17 -05:00
& scenario . Alert ,
2024-05-09 22:56:16 -04:00
& endpoint . Result { ConditionResults : conditionResults },
2021-12-02 21:05:17 -05:00
scenario . Resolved ,
)
2022-10-20 15:22:27 -04:00
if string ( body ) != scenario . ExpectedBody {
t . Errorf ( "expected:\n%s\ngot:\n%s" , scenario . ExpectedBody , body )
2021-12-02 21:05:17 -05:00
}
out := make ( map [ string ] interface {})
2022-10-20 15:22:27 -04:00
if err := json . Unmarshal ( body , & out ); err != nil {
2021-12-02 21:05:17 -05:00
t . Error ( "expected body to be valid JSON, got error:" , err . Error ())
}
})
2021-03-31 01:38:34 +02:00
}
}
2021-12-02 22:15:51 -05:00
func TestAlertProvider_GetDefaultAlert ( t * testing . T ) {
2024-02-07 20:09:45 -05:00
if ( & AlertProvider { DefaultAlert : & alert . Alert {}}). GetDefaultAlert () == nil {
2021-12-02 22:15:51 -05:00
t . Error ( "expected default alert to be not nil" )
}
2024-02-07 20:09:45 -05:00
if ( & AlertProvider { DefaultAlert : nil }). GetDefaultAlert () != nil {
2021-12-02 22:15:51 -05:00
t . Error ( "expected default alert to be nil" )
}
}
2024-12-16 20:32:13 -05:00
func TestAlertProvider_GetConfig ( t * testing . T ) {
t . Run ( "get-token-with-override" , func ( t * testing . T ) {
provider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Group : "group" , Config : Config { Token : "groupToken" , ID : "overrideID" }}}}
cfg , err := provider . GetConfig ( "group" , & alert . Alert {})
if err != nil {
t . Error ( "expected no error, got" , err )
}
if cfg . Token != "groupToken" {
t . Error ( "token should have been 'groupToken'" )
}
if cfg . ID != "overrideID" {
t . Error ( "id should have been 'overrideID'" )
}
})
t . Run ( "get-default-token-with-overridden-id" , func ( t * testing . T ) {
provider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Group : "group" , Config : Config { ID : "overrideID" }}}}
cfg , err := provider . GetConfig ( "group" , & alert . Alert {})
if err != nil {
t . Error ( "expected no error, got" , err )
}
if cfg . Token != provider . DefaultConfig . Token {
t . Error ( "token should have been the default token" )
}
if cfg . ID != "overrideID" {
t . Error ( "id should have been 'overrideID'" )
}
})
t . Run ( "get-default-token-with-overridden-token" , func ( t * testing . T ) {
provider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Group : "group" , Config : Config { Token : "groupToken" }}}}
cfg , err := provider . GetConfig ( "group" , & alert . Alert {})
if err != nil {
t . Error ( "expected no error, got" , err )
}
if cfg . Token != "groupToken" {
t . Error ( "token should have been 'groupToken'" )
}
if cfg . ID != provider . DefaultConfig . ID {
t . Error ( "id should have been the default id" )
}
})
t . Run ( "get-default-token-with-overridden-token-and-alert-token-override" , func ( t * testing . T ) {
provider := AlertProvider { DefaultConfig : Config { Token : "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" , ID : "12345678" }, Overrides : [] * Override {{ Group : "group" , Config : Config { Token : "groupToken" }}}}
alert := & alert . Alert { ProviderOverride : map [ string ] any { "token" : "alertToken" }}
cfg , err := provider . GetConfig ( "group" , alert )
if err != nil {
t . Error ( "expected no error, got" , err )
}
if cfg . Token != "alertToken" {
t . Error ( "token should have been 'alertToken'" )
}
if cfg . ID != provider . DefaultConfig . ID {
t . Error ( "id should have been the default id" )
}
// Test ValidateOverrides as well, since it really just calls GetConfig
if err = provider . ValidateOverrides ( "group" , alert ); err != nil {
t . Errorf ( "unexpected error: %s" , err )
}
})
}