2021-12-02 21:05:17 -05:00
package email
import (
"testing"
2022-12-06 01:41:09 -05:00
"github.com/TwiN/gatus/v5/alerting/alert"
2024-05-09 22:56:16 -04:00
"github.com/TwiN/gatus/v5/config/endpoint"
2021-12-02 21:05:17 -05:00
)
2024-12-16 20:32:13 -05:00
func TestAlertProvider_Validate ( t * testing . T ) {
2021-12-02 21:05:17 -05:00
invalidProvider := AlertProvider {}
2024-12-16 20:32:13 -05:00
if err := invalidProvider . Validate (); err == nil {
2021-12-02 21:05:17 -05:00
t . Error ( "provider shouldn't have been valid" )
}
2024-12-16 20:32:13 -05:00
validProvider := AlertProvider { DefaultConfig : Config { From : "from@example.com" , Password : "password" , Host : "smtp.gmail.com" , Port : 587 , To : "to@example.com" }}
if err := validProvider . Validate (); err != nil {
2021-12-02 21:05:17 -05:00
t . Error ( "provider should've been valid" )
}
}
2024-12-16 20:32:13 -05:00
func TestAlertProvider_ValidateWithNoCredentials ( t * testing . T ) {
validProvider := AlertProvider { DefaultConfig : Config { From : "from@example.com" , Host : "smtp-relay.gmail.com" , Port : 587 , To : "to@example.com" }}
if err := validProvider . Validate (); err != nil {
2023-11-04 19:28:06 -04:00
t . Error ( "provider should've been valid" )
}
}
2024-12-16 20:32:13 -05:00
func TestAlertProvider_ValidateWithOverride ( t * testing . T ) {
2022-03-21 09:54:20 +08:00
providerWithInvalidOverrideGroup := AlertProvider {
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { To : "to@example.com" },
Group : "" ,
2022-03-21 09:54:20 +08:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithInvalidOverrideGroup . Validate (); err == nil {
2022-03-21 09:54:20 +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 { To : "" },
Group : "group" ,
2022-03-21 09:54:20 +08:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithInvalidOverrideTo . Validate (); err == nil {
2022-03-21 09:54:20 +08:00
t . Error ( "provider integration key shouldn't have been valid" )
}
providerWithValidOverride := AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config {
From : "from@example.com" ,
Password : "password" ,
Host : "smtp.gmail.com" ,
Port : 587 ,
To : "to@example.com" ,
},
2022-03-21 09:54:20 +08:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Config : Config { To : "to@example.com" },
Group : "group" ,
2022-03-21 09:54:20 +08:00
},
},
}
2024-12-16 20:32:13 -05:00
if err := providerWithValidOverride . Validate (); err != nil {
2022-03-21 09:54:20 +08:00
t . Error ( "provider should've been valid" )
}
}
2021-12-02 21:05:17 -05:00
func TestAlertProvider_buildRequestBody ( t * testing . T ) {
firstDescription := "description-1"
secondDescription := "description-2"
scenarios := [] struct {
Name string
Provider AlertProvider
Alert alert . Alert
Resolved bool
2025-08-18 00:28:04 +08:00
Endpoint * endpoint . Endpoint
2021-12-02 21:05:17 -05:00
ExpectedSubject string
ExpectedBody string
}{
{
Name : "triggered" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
2025-08-18 00:28:04 +08:00
Endpoint : & endpoint . Endpoint { Name : "endpoint-name" },
2026-03-21 18:25:52 -07:00
ExpectedSubject : "endpoint-name: Alert triggered" ,
2021-12-02 21:05:17 -05:00
ExpectedBody : "An alert for endpoint-name has been triggered due to having failed 3 time(s) in a row\n\nAlert description: description-1\n\nCondition results:\n❌ [CONNECTED] == true\n❌ [STATUS] == 200\n" ,
},
{
Name : "resolved" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2025-08-18 00:28:04 +08:00
Endpoint : & endpoint . Endpoint { Name : "endpoint-name" },
2026-03-21 18:25:52 -07:00
ExpectedSubject : "endpoint-name: Alert resolved" ,
2021-12-02 21:05:17 -05:00
ExpectedBody : "An alert for endpoint-name has been resolved after passing successfully 5 time(s) in a row\n\nAlert description: description-2\n\nCondition results:\n✅ [CONNECTED] == true\n✅ [STATUS] == 200\n" ,
},
2025-08-18 00:28:04 +08:00
{
Name : "triggered-with-single-extra-label" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
Endpoint : & endpoint . Endpoint { Name : "endpoint-name" , ExtraLabels : map [ string ] string { "environment" : "production" }},
2026-03-21 18:25:52 -07:00
ExpectedSubject : "endpoint-name: Alert triggered" ,
2025-08-18 00:28:04 +08:00
ExpectedBody : "An alert for endpoint-name has been triggered due to having failed 3 time(s) in a row\n\nAlert description: description-1\n\nExtra labels:\n environment: production\n\n\nCondition results:\n❌ [CONNECTED] == true\n❌ [STATUS] == 200\n" ,
},
{
Name : "resolved-with-single-extra-label" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
Endpoint : & endpoint . Endpoint { Name : "endpoint-name" , ExtraLabels : map [ string ] string { "service" : "api" }},
2026-03-21 18:25:52 -07:00
ExpectedSubject : "endpoint-name: Alert resolved" ,
2025-08-18 00:28:04 +08:00
ExpectedBody : "An alert for endpoint-name has been resolved after passing successfully 5 time(s) in a row\n\nAlert description: description-2\n\nExtra labels:\n service: api\n\n\nCondition results:\n✅ [CONNECTED] == true\n✅ [STATUS] == 200\n" ,
},
{
Name : "triggered-with-no-extra-labels" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
Endpoint : & endpoint . Endpoint { Name : "endpoint-name" , ExtraLabels : map [ string ] string {}},
2026-03-21 18:25:52 -07:00
ExpectedSubject : "endpoint-name: Alert triggered" ,
2025-08-18 00:28:04 +08:00
ExpectedBody : "An alert for endpoint-name has been triggered due to having failed 3 time(s) in a row\n\nAlert description: description-1\n\nCondition results:\n❌ [CONNECTED] == true\n❌ [STATUS] == 200\n" ,
},
2021-12-02 21:05:17 -05:00
}
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
subject , body := scenario . Provider . buildMessageSubjectAndBody (
2025-08-18 00:28:04 +08:00
scenario . Endpoint ,
2021-12-02 21:05:17 -05:00
& scenario . Alert ,
2024-05-09 22:56:16 -04:00
& endpoint . Result {
ConditionResults : [] * endpoint . ConditionResult {
2021-12-02 21:05:17 -05:00
{ Condition : "[CONNECTED] == true" , Success : scenario . Resolved },
{ Condition : "[STATUS] == 200" , Success : scenario . Resolved },
},
},
scenario . Resolved ,
)
if subject != scenario . ExpectedSubject {
t . Errorf ( "expected subject to be %s, got %s" , scenario . ExpectedSubject , subject )
}
if body != scenario . ExpectedBody {
t . Errorf ( "expected body to be %s, got %s" , scenario . ExpectedBody , body )
}
})
}
}
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" )
}
}
2022-03-21 09:54:20 +08:00
2024-12-16 20:32:13 -05:00
func TestAlertProvider_GetConfig ( t * testing . T ) {
scenarios := [] struct {
2022-03-21 09:54:20 +08:00
Name string
Provider AlertProvider
InputGroup string
2024-12-16 20:32:13 -05:00
InputAlert alert . Alert
ExpectedOutput Config
2022-03-21 09:54:20 +08:00
}{
{
Name : "provider-no-override-specify-no-group-should-default" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
Overrides : nil ,
2022-03-21 09:54:20 +08:00
},
InputGroup : "" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
2022-03-21 09:54:20 +08:00
},
{
Name : "provider-no-override-specify-group-should-default" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
Overrides : nil ,
2022-03-21 09:54:20 +08:00
},
InputGroup : "group" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
2022-03-21 09:54:20 +08:00
},
{
Name : "provider-with-override-specify-no-group-should-default" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
2022-03-21 09:54:20 +08:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Group : "group" ,
Config : Config { To : "to01@example.com" },
2022-03-21 09:54:20 +08:00
},
},
},
InputGroup : "" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
2022-03-21 09:54:20 +08:00
},
{
Name : "provider-with-override-specify-group-should-override" ,
Provider : AlertProvider {
2024-12-16 20:32:13 -05:00
DefaultConfig : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
2022-03-21 09:54:20 +08:00
Overrides : [] Override {
{
2024-12-16 20:32:13 -05:00
Group : "group" ,
Config : Config { To : "group-to@example.com" },
2022-03-21 09:54:20 +08:00
},
},
},
InputGroup : "group" ,
2024-12-16 20:32:13 -05:00
InputAlert : alert . Alert {},
ExpectedOutput : Config { From : "from@example.com" , To : "group-to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
},
{
Name : "provider-with-group-override-and-alert-override--alert-override-should-take-precedence" ,
Provider : AlertProvider {
DefaultConfig : Config { From : "from@example.com" , To : "to@example.com" , Host : "smtp.gmail.com" , Port : 587 , Password : "password" },
Overrides : [] Override {
{
Group : "group" ,
Config : Config { To : "group-to@example.com" },
},
},
},
InputGroup : "group" ,
InputAlert : alert . Alert { ProviderOverride : map [ string ] any { "to" : "alert-to@example.com" , "host" : "smtp.example.com" , "port" : 588 , "password" : "hunter2" }},
ExpectedOutput : Config { From : "from@example.com" , To : "alert-to@example.com" , Host : "smtp.example.com" , Port : 588 , Password : "hunter2" },
2022-03-21 09:54:20 +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 . From != scenario . ExpectedOutput . From {
t . Errorf ( "expected from to be %s, got %s" , scenario . ExpectedOutput . From , got . From )
}
if got . To != scenario . ExpectedOutput . To {
t . Errorf ( "expected to be %s, got %s" , scenario . ExpectedOutput . To , got . To )
}
if got . Host != scenario . ExpectedOutput . Host {
t . Errorf ( "expected host to be %s, got %s" , scenario . ExpectedOutput . Host , got . Host )
}
if got . Port != scenario . ExpectedOutput . Port {
t . Errorf ( "expected port to be %d, got %d" , scenario . ExpectedOutput . Port , got . Port )
}
if got . Password != scenario . ExpectedOutput . Password {
t . Errorf ( "expected password to be %s, got %s" , scenario . ExpectedOutput . Password , got . Password )
}
// 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-03-21 09:54:20 +08:00
}
})
}
}