mirror of
https://github.com/TwiN/gatus.git
synced 2025-01-03 12:39:39 +01:00
79c9f24c15
* feat(alerting): Implement alert-level provider overrides Fixes #96 * Fix tests * Add missing test cases for alerting providers * feat(alerting): Implement alert-level overrides on all providers * chore: Add config.yaml to .gitignore * fix typo in discord provider * test: Start fixing tests for alerting providers * test: Fix GitLab tests * Fix all tests * test: Improve coverage * test: Improve coverage * Rename override to provider-override * docs: Mention new provider-override config * test: Improve coverage * test: Improve coverage * chore: Rename Alert.OverrideAsBytes to Alert.ProviderOverrideAsBytes
396 lines
14 KiB
Go
396 lines
14 KiB
Go
package custom
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"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"
|
|
)
|
|
|
|
func TestAlertProvider_Validate(t *testing.T) {
|
|
t.Run("invalid-provider", func(t *testing.T) {
|
|
invalidProvider := AlertProvider{DefaultConfig: Config{URL: ""}}
|
|
if err := invalidProvider.Validate(); err == nil {
|
|
t.Error("provider shouldn't have been valid")
|
|
}
|
|
})
|
|
t.Run("valid-provider", func(t *testing.T) {
|
|
validProvider := AlertProvider{DefaultConfig: Config{URL: "https://example.com"}}
|
|
if err := validProvider.Validate(); err != nil {
|
|
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{DefaultConfig: Config{URL: "https://example.com"}},
|
|
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{DefaultConfig: Config{URL: "https://example.com"}},
|
|
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{DefaultConfig: Config{URL: "https://example.com"}},
|
|
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{DefaultConfig: Config{URL: "https://example.com"}},
|
|
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_buildHTTPRequest(t *testing.T) {
|
|
alertProvider := &AlertProvider{
|
|
DefaultConfig: Config{
|
|
URL: "https://example.com/[ENDPOINT_GROUP]/[ENDPOINT_NAME]?event=[ALERT_TRIGGERED_OR_RESOLVED]&description=[ALERT_DESCRIPTION]&url=[ENDPOINT_URL]",
|
|
Body: "[ENDPOINT_NAME],[ENDPOINT_GROUP],[ALERT_DESCRIPTION],[ENDPOINT_URL],[ALERT_TRIGGERED_OR_RESOLVED]",
|
|
},
|
|
}
|
|
alertDescription := "alert-description"
|
|
scenarios := []struct {
|
|
AlertProvider *AlertProvider
|
|
Resolved bool
|
|
ExpectedURL string
|
|
ExpectedBody string
|
|
}{
|
|
{
|
|
AlertProvider: alertProvider,
|
|
Resolved: true,
|
|
ExpectedURL: "https://example.com/endpoint-group/endpoint-name?event=RESOLVED&description=alert-description&url=https://example.com",
|
|
ExpectedBody: "endpoint-name,endpoint-group,alert-description,https://example.com,RESOLVED",
|
|
},
|
|
{
|
|
AlertProvider: alertProvider,
|
|
Resolved: false,
|
|
ExpectedURL: "https://example.com/endpoint-group/endpoint-name?event=TRIGGERED&description=alert-description&url=https://example.com",
|
|
ExpectedBody: "endpoint-name,endpoint-group,alert-description,https://example.com,TRIGGERED",
|
|
},
|
|
}
|
|
for _, scenario := range scenarios {
|
|
t.Run(fmt.Sprintf("resolved-%v-with-default-placeholders", scenario.Resolved), func(t *testing.T) {
|
|
request := alertProvider.buildHTTPRequest(
|
|
&alertProvider.DefaultConfig,
|
|
&endpoint.Endpoint{Name: "endpoint-name", Group: "endpoint-group", URL: "https://example.com"},
|
|
&alert.Alert{Description: &alertDescription},
|
|
&endpoint.Result{Errors: []string{}},
|
|
scenario.Resolved,
|
|
)
|
|
if request.URL.String() != scenario.ExpectedURL {
|
|
t.Error("expected URL to be", scenario.ExpectedURL, "got", request.URL.String())
|
|
}
|
|
body, _ := io.ReadAll(request.Body)
|
|
if string(body) != scenario.ExpectedBody {
|
|
t.Error("expected body to be", scenario.ExpectedBody, "got", string(body))
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestAlertProviderWithResultErrors_buildHTTPRequest(t *testing.T) {
|
|
alertProvider := &AlertProvider{
|
|
DefaultConfig: Config{
|
|
URL: "https://example.com/[ENDPOINT_GROUP]/[ENDPOINT_NAME]?event=[ALERT_TRIGGERED_OR_RESOLVED]&description=[ALERT_DESCRIPTION]&url=[ENDPOINT_URL]&error=[RESULT_ERRORS]",
|
|
Body: "[ENDPOINT_NAME],[ENDPOINT_GROUP],[ALERT_DESCRIPTION],[ENDPOINT_URL],[ALERT_TRIGGERED_OR_RESOLVED],[RESULT_ERRORS]",
|
|
},
|
|
}
|
|
alertDescription := "alert-description"
|
|
scenarios := []struct {
|
|
AlertProvider *AlertProvider
|
|
Resolved bool
|
|
ExpectedURL string
|
|
ExpectedBody string
|
|
Errors []string
|
|
}{
|
|
{
|
|
AlertProvider: alertProvider,
|
|
Resolved: true,
|
|
ExpectedURL: "https://example.com/endpoint-group/endpoint-name?event=RESOLVED&description=alert-description&url=https://example.com&error=",
|
|
ExpectedBody: "endpoint-name,endpoint-group,alert-description,https://example.com,RESOLVED,",
|
|
},
|
|
{
|
|
AlertProvider: alertProvider,
|
|
Resolved: false,
|
|
ExpectedURL: "https://example.com/endpoint-group/endpoint-name?event=TRIGGERED&description=alert-description&url=https://example.com&error=error1,error2",
|
|
ExpectedBody: "endpoint-name,endpoint-group,alert-description,https://example.com,TRIGGERED,error1,error2",
|
|
Errors: []string{"error1", "error2"},
|
|
},
|
|
}
|
|
for _, scenario := range scenarios {
|
|
t.Run(fmt.Sprintf("resolved-%v-with-default-placeholders-and-result-errors", scenario.Resolved), func(t *testing.T) {
|
|
request := alertProvider.buildHTTPRequest(
|
|
&alertProvider.DefaultConfig,
|
|
&endpoint.Endpoint{Name: "endpoint-name", Group: "endpoint-group", URL: "https://example.com"},
|
|
&alert.Alert{Description: &alertDescription},
|
|
&endpoint.Result{Errors: scenario.Errors},
|
|
scenario.Resolved,
|
|
)
|
|
if request.URL.String() != scenario.ExpectedURL {
|
|
t.Error("expected URL to be", scenario.ExpectedURL, "got", request.URL.String())
|
|
}
|
|
body, _ := io.ReadAll(request.Body)
|
|
if string(body) != scenario.ExpectedBody {
|
|
t.Error("expected body to be", scenario.ExpectedBody, "got", string(body))
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestAlertProvider_buildHTTPRequestWithCustomPlaceholder(t *testing.T) {
|
|
alertProvider := &AlertProvider{
|
|
DefaultConfig: Config{
|
|
URL: "https://example.com/[ENDPOINT_GROUP]/[ENDPOINT_NAME]?event=[ALERT_TRIGGERED_OR_RESOLVED]&description=[ALERT_DESCRIPTION]",
|
|
Body: "[ENDPOINT_NAME],[ENDPOINT_GROUP],[ALERT_DESCRIPTION],[ALERT_TRIGGERED_OR_RESOLVED]",
|
|
Headers: nil,
|
|
Placeholders: map[string]map[string]string{
|
|
"ALERT_TRIGGERED_OR_RESOLVED": {
|
|
"RESOLVED": "fixed",
|
|
"TRIGGERED": "boom",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
alertDescription := "alert-description"
|
|
scenarios := []struct {
|
|
AlertProvider *AlertProvider
|
|
Resolved bool
|
|
ExpectedURL string
|
|
ExpectedBody string
|
|
}{
|
|
{
|
|
AlertProvider: alertProvider,
|
|
Resolved: true,
|
|
ExpectedURL: "https://example.com/endpoint-group/endpoint-name?event=fixed&description=alert-description",
|
|
ExpectedBody: "endpoint-name,endpoint-group,alert-description,fixed",
|
|
},
|
|
{
|
|
AlertProvider: alertProvider,
|
|
Resolved: false,
|
|
ExpectedURL: "https://example.com/endpoint-group/endpoint-name?event=boom&description=alert-description",
|
|
ExpectedBody: "endpoint-name,endpoint-group,alert-description,boom",
|
|
},
|
|
}
|
|
for _, scenario := range scenarios {
|
|
t.Run(fmt.Sprintf("resolved-%v-with-custom-placeholders", scenario.Resolved), func(t *testing.T) {
|
|
request := alertProvider.buildHTTPRequest(
|
|
&alertProvider.DefaultConfig,
|
|
&endpoint.Endpoint{Name: "endpoint-name", Group: "endpoint-group"},
|
|
&alert.Alert{Description: &alertDescription},
|
|
&endpoint.Result{},
|
|
scenario.Resolved,
|
|
)
|
|
if request.URL.String() != scenario.ExpectedURL {
|
|
t.Error("expected URL to be", scenario.ExpectedURL, "got", request.URL.String())
|
|
}
|
|
body, _ := io.ReadAll(request.Body)
|
|
if string(body) != scenario.ExpectedBody {
|
|
t.Error("expected body to be", scenario.ExpectedBody, "got", string(body))
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestAlertProvider_GetAlertStatePlaceholderValueDefaults(t *testing.T) {
|
|
alertProvider := &AlertProvider{
|
|
DefaultConfig: Config{
|
|
URL: "https://example.com/[ENDPOINT_NAME]?event=[ALERT_TRIGGERED_OR_RESOLVED]&description=[ALERT_DESCRIPTION]",
|
|
Body: "[ENDPOINT_NAME],[ENDPOINT_GROUP],[ALERT_DESCRIPTION],[ALERT_TRIGGERED_OR_RESOLVED]",
|
|
},
|
|
}
|
|
if alertProvider.GetAlertStatePlaceholderValue(&alertProvider.DefaultConfig, true) != "RESOLVED" {
|
|
t.Error("expected RESOLVED, got", alertProvider.GetAlertStatePlaceholderValue(&alertProvider.DefaultConfig, true))
|
|
}
|
|
if alertProvider.GetAlertStatePlaceholderValue(&alertProvider.DefaultConfig, false) != "TRIGGERED" {
|
|
t.Error("expected TRIGGERED, got", alertProvider.GetAlertStatePlaceholderValue(&alertProvider.DefaultConfig, false))
|
|
}
|
|
}
|
|
|
|
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_GetConfig(t *testing.T) {
|
|
scenarios := []struct {
|
|
Name string
|
|
Provider AlertProvider
|
|
InputGroup string
|
|
InputAlert alert.Alert
|
|
ExpectedOutput Config
|
|
}{
|
|
{
|
|
Name: "provider-no-override-specify-no-group-should-default",
|
|
Provider: AlertProvider{
|
|
DefaultConfig: Config{URL: "http://example.com", Body: "default-body"},
|
|
Overrides: nil,
|
|
},
|
|
InputGroup: "",
|
|
InputAlert: alert.Alert{},
|
|
ExpectedOutput: Config{URL: "http://example.com", Body: "default-body"},
|
|
},
|
|
{
|
|
Name: "provider-no-override-specify-group-should-default",
|
|
Provider: AlertProvider{
|
|
DefaultConfig: Config{URL: "http://example.com"},
|
|
Overrides: nil,
|
|
},
|
|
InputGroup: "group",
|
|
InputAlert: alert.Alert{},
|
|
ExpectedOutput: Config{URL: "http://example.com"},
|
|
},
|
|
{
|
|
Name: "provider-with-override-specify-no-group-should-default",
|
|
Provider: AlertProvider{
|
|
DefaultConfig: Config{URL: "http://example.com"},
|
|
Overrides: []Override{
|
|
{
|
|
Group: "group",
|
|
Config: Config{URL: "http://group-example.com", Headers: map[string]string{"Cache": "true"}},
|
|
},
|
|
},
|
|
},
|
|
InputGroup: "",
|
|
InputAlert: alert.Alert{},
|
|
ExpectedOutput: Config{URL: "http://example.com", Headers: map[string]string{"Cache": "true"}},
|
|
},
|
|
{
|
|
Name: "provider-with-override-specify-group-should-override",
|
|
Provider: AlertProvider{
|
|
DefaultConfig: Config{URL: "http://example.com", Body: "default-body"},
|
|
Overrides: []Override{
|
|
{
|
|
Group: "group",
|
|
Config: Config{URL: "http://group-example.com", Body: "group-body"},
|
|
},
|
|
},
|
|
},
|
|
InputGroup: "group",
|
|
InputAlert: alert.Alert{},
|
|
ExpectedOutput: Config{URL: "http://group-example.com", Body: "group-body"},
|
|
},
|
|
{
|
|
Name: "provider-with-group-override-and-alert-override--alert-override-should-take-precedence",
|
|
Provider: AlertProvider{
|
|
DefaultConfig: Config{URL: "http://example.com"},
|
|
Overrides: []Override{
|
|
{
|
|
Group: "group",
|
|
Config: Config{URL: "http://group-example.com"},
|
|
},
|
|
},
|
|
},
|
|
InputGroup: "group",
|
|
InputAlert: alert.Alert{ProviderOverride: map[string]any{"url": "http://alert-example.com", "body": "alert-body"}},
|
|
ExpectedOutput: Config{URL: "http://alert-example.com", Body: "alert-body"},
|
|
},
|
|
{
|
|
Name: "provider-with-partial-overrides",
|
|
Provider: AlertProvider{
|
|
DefaultConfig: Config{URL: "http://example.com"},
|
|
Overrides: []Override{
|
|
{
|
|
Group: "group",
|
|
Config: Config{Method: "POST"},
|
|
},
|
|
},
|
|
},
|
|
InputGroup: "group",
|
|
InputAlert: alert.Alert{ProviderOverride: map[string]any{"body": "alert-body"}},
|
|
ExpectedOutput: Config{URL: "http://example.com", Body: "alert-body", Method: "POST"},
|
|
},
|
|
}
|
|
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.URL != scenario.ExpectedOutput.URL {
|
|
t.Errorf("expected webhook URL to be %s, got %s", scenario.ExpectedOutput.URL, got.URL)
|
|
}
|
|
if got.Body != scenario.ExpectedOutput.Body {
|
|
t.Errorf("expected body to be %s, got %s", scenario.ExpectedOutput.Body, got.Body)
|
|
}
|
|
if got.Headers != nil {
|
|
for key, value := range scenario.ExpectedOutput.Headers {
|
|
if got.Headers[key] != value {
|
|
t.Errorf("expected header %s to be %s, got %s", key, value, got.Headers[key])
|
|
}
|
|
}
|
|
}
|
|
// 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)
|
|
}
|
|
})
|
|
}
|
|
}
|