2022-07-15 22:08:06 -07:00
package matrix
import (
"encoding/json"
"net/http"
"testing"
"github.com/TwiN/gatus/v4/alerting/alert"
"github.com/TwiN/gatus/v4/client"
"github.com/TwiN/gatus/v4/core"
"github.com/TwiN/gatus/v4/test"
)
func TestAlertProvider_IsValid ( t * testing . T ) {
2022-07-19 10:15:41 -07:00
invalidProvider := AlertProvider {
MatrixProviderConfig : MatrixProviderConfig {
AccessToken : "" ,
InternalRoomID : "" ,
},
}
2022-07-15 22:08:06 -07:00
if invalidProvider . IsValid () {
t . Error ( "provider shouldn't have been valid" )
}
2022-07-19 10:15:41 -07:00
validProvider := AlertProvider {
MatrixProviderConfig : MatrixProviderConfig {
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
}
2022-07-15 22:08:06 -07:00
if ! validProvider . IsValid () {
t . Error ( "provider should've been valid" )
}
2022-07-19 10:15:41 -07:00
validProviderWithHomeserver := AlertProvider {
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example.com" ,
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
}
2022-07-15 22:08:06 -07:00
if ! validProviderWithHomeserver . IsValid () {
t . Error ( "provider with homeserver should've been valid" )
}
}
func TestAlertProvider_IsValidWithOverride ( t * testing . T ) {
providerWithInvalidOverrideGroup := AlertProvider {
Overrides : [] Override {
{
2022-07-19 10:15:41 -07:00
Group : "" ,
MatrixProviderConfig : MatrixProviderConfig {
AccessToken : "" ,
InternalRoomID : "" ,
},
2022-07-15 22:08:06 -07:00
},
},
}
if providerWithInvalidOverrideGroup . IsValid () {
t . Error ( "provider Group shouldn't have been valid" )
}
providerWithInvalidOverrideTo := AlertProvider {
Overrides : [] Override {
{
2022-07-19 10:15:41 -07:00
Group : "group" ,
MatrixProviderConfig : MatrixProviderConfig {
AccessToken : "" ,
InternalRoomID : "" ,
},
2022-07-15 22:08:06 -07:00
},
},
}
if providerWithInvalidOverrideTo . IsValid () {
t . Error ( "provider integration key shouldn't have been valid" )
}
providerWithValidOverride := AlertProvider {
2022-07-19 10:15:41 -07:00
MatrixProviderConfig : MatrixProviderConfig {
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
2022-07-15 22:08:06 -07:00
Overrides : [] Override {
{
2022-07-19 10:15:41 -07:00
Group : "group" ,
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example.com" ,
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
2022-07-15 22:08:06 -07:00
},
},
}
if ! providerWithValidOverride . IsValid () {
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" ,
Provider : AlertProvider {},
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" ,
Provider : AlertProvider {},
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" ,
Provider : AlertProvider {},
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" ,
Provider : AlertProvider {},
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 (
& core . Endpoint { Name : "endpoint-name" },
& scenario . Alert ,
& core . Result {
ConditionResults : [] * core . 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
Resolved bool
ExpectedBody string
}{
{
Name : "triggered" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & firstDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : false ,
2022-10-20 15:48:51 -04:00
ExpectedBody : "{\"msgtype\":\"m.text\",\"format\":\"org.matrix.custom.html\",\"body\":\"An alert for `endpoint-name` has been triggered due to having failed 3 time(s) in a row\\ndescription-1\\n\\n✕ - [CONNECTED] == true\\n✕ - [STATUS] == 200\",\"formatted_body\":\"\\u003ch3\\u003eAn alert for \\u003ccode\\u003eendpoint-name\\u003c/code\\u003e has been triggered due to having failed 3 time(s) in a row\\u003c/h3\\u003e\\n\\u003cblockquote\\u003edescription-1\\u003c/blockquote\\u003e\\n\\u003ch5\\u003eCondition results\\u003c/h5\\u003e\\u003cul\\u003e\\u003cli\\u003e❌ - \\u003ccode\\u003e[CONNECTED] == true\\u003c/code\\u003e\\u003c/li\\u003e\\u003cli\\u003e❌ - \\u003ccode\\u003e[STATUS] == 200\\u003c/code\\u003e\\u003c/li\\u003e\\u003c/ul\\u003e\"}" ,
2022-07-15 22:08:06 -07:00
},
{
Name : "resolved" ,
Provider : AlertProvider {},
Alert : alert . Alert { Description : & secondDescription , SuccessThreshold : 5 , FailureThreshold : 3 },
Resolved : true ,
2022-10-20 15:48:51 -04:00
ExpectedBody : "{\"msgtype\":\"m.text\",\"format\":\"org.matrix.custom.html\",\"body\":\"An alert for `endpoint-name` has been resolved after passing successfully 5 time(s) in a row\\ndescription-2\\n\\n✓ - [CONNECTED] == true\\n✓ - [STATUS] == 200\",\"formatted_body\":\"\\u003ch3\\u003eAn alert for \\u003ccode\\u003eendpoint-name\\u003c/code\\u003e has been resolved after passing successfully 5 time(s) in a row\\u003c/h3\\u003e\\n\\u003cblockquote\\u003edescription-2\\u003c/blockquote\\u003e\\n\\u003ch5\\u003eCondition results\\u003c/h5\\u003e\\u003cul\\u003e\\u003cli\\u003e✅ - \\u003ccode\\u003e[CONNECTED] == true\\u003c/code\\u003e\\u003c/li\\u003e\\u003cli\\u003e✅ - \\u003ccode\\u003e[STATUS] == 200\\u003c/code\\u003e\\u003c/li\\u003e\\u003c/ul\\u003e\"}" ,
2022-07-15 22:08:06 -07:00
},
}
for _ , scenario := range scenarios {
t . Run ( scenario . Name , func ( t * testing . T ) {
body := scenario . Provider . buildRequestBody (
& core . Endpoint { Name : "endpoint-name" },
& scenario . Alert ,
& core . Result {
ConditionResults : [] * core . ConditionResult {
{ Condition : "[CONNECTED] == true" , Success : scenario . Resolved },
{ Condition : "[STATUS] == 200" , Success : scenario . Resolved },
},
},
scenario . Resolved ,
)
2022-10-20 15:48:51 -04:00
if string ( body ) != scenario . ExpectedBody {
t . Errorf ( "expected:\n%s\ngot:\n%s" , scenario . ExpectedBody , body )
2022-07-15 22:08:06 -07:00
}
out := make ( map [ string ] interface {})
2022-10-20 15:48:51 -04:00
if err := json . Unmarshal ( body , & out ); err != nil {
2022-07-15 22:08:06 -07:00
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" )
}
}
func TestAlertProvider_getConfigForGroup ( t * testing . T ) {
tests := [] struct {
Name string
Provider AlertProvider
InputGroup string
2022-07-19 10:15:41 -07:00
ExpectedOutput MatrixProviderConfig
2022-07-15 22:08:06 -07:00
}{
{
Name : "provider-no-override-specify-no-group-should-default" ,
Provider : AlertProvider {
2022-07-19 10:15:41 -07:00
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example.com" ,
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
Overrides : nil ,
2022-07-15 22:08:06 -07:00
},
InputGroup : "" ,
2022-07-19 10:15:41 -07:00
ExpectedOutput : MatrixProviderConfig {
ServerURL : "https://example.com" ,
2022-07-15 22:08:06 -07:00
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
},
{
Name : "provider-no-override-specify-group-should-default" ,
Provider : AlertProvider {
2022-07-19 10:15:41 -07:00
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example.com" ,
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
Overrides : nil ,
2022-07-15 22:08:06 -07:00
},
InputGroup : "group" ,
2022-07-19 10:15:41 -07:00
ExpectedOutput : MatrixProviderConfig {
ServerURL : "https://example.com" ,
2022-07-15 22:08:06 -07:00
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
},
{
Name : "provider-with-override-specify-no-group-should-default" ,
Provider : AlertProvider {
2022-07-19 10:15:41 -07:00
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example.com" ,
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
2022-07-15 22:08:06 -07:00
Overrides : [] Override {
{
2022-07-19 10:15:41 -07:00
Group : "group" ,
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example01.com" ,
AccessToken : "12" ,
InternalRoomID : "!a:example01.com" ,
},
2022-07-15 22:08:06 -07:00
},
},
},
InputGroup : "" ,
2022-07-19 10:15:41 -07:00
ExpectedOutput : MatrixProviderConfig {
ServerURL : "https://example.com" ,
2022-07-15 22:08:06 -07:00
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
},
{
Name : "provider-with-override-specify-group-should-override" ,
Provider : AlertProvider {
2022-07-19 10:15:41 -07:00
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example.com" ,
AccessToken : "1" ,
InternalRoomID : "!a:example.com" ,
},
2022-07-15 22:08:06 -07:00
Overrides : [] Override {
{
2022-07-19 10:15:41 -07:00
Group : "group" ,
MatrixProviderConfig : MatrixProviderConfig {
ServerURL : "https://example01.com" ,
AccessToken : "12" ,
InternalRoomID : "!a:example01.com" ,
},
2022-07-15 22:08:06 -07:00
},
},
},
InputGroup : "group" ,
2022-07-19 10:15:41 -07:00
ExpectedOutput : MatrixProviderConfig {
ServerURL : "https://example01.com" ,
2022-07-15 22:08:06 -07:00
AccessToken : "12" ,
InternalRoomID : "!a:example01.com" ,
},
},
}
for _ , tt := range tests {
t . Run ( tt . Name , func ( t * testing . T ) {
if got := tt . Provider . getConfigForGroup ( tt . InputGroup ); got != tt . ExpectedOutput {
t . Errorf ( "AlertProvider.getConfigForGroup() = %v, want %v" , got , tt . ExpectedOutput )
}
})
}
}