Rename override to provider-override

alerting/alert/alert.go

@@ -47,9 +47,9 @@ type Alert struct {
 	// or not for provider.ParseWithDefaultAlert to work. Use Alert.IsSendingOnResolved() for a non-pointer
 	SendOnResolved *bool `yaml:"send-on-resolved,omitempty"`
 
-	// Override is an optional field that can be used to override the provider's configuration
+	// ProviderOverride is an optional field that can be used to override the provider's configuration
 	// It is freeform so that it can be used for any provider-specific configuration.
-	Override map[string]any `yaml:"override,omitempty"`
+	ProviderOverride map[string]any `yaml:"provider-override,omitempty"`
 
 	// ResolveKey is an optional field that is used by some providers (i.e. PagerDuty's dedup_key) to resolve
 	// ongoing/triggered incidents
@@ -120,7 +120,7 @@ func (alert *Alert) Checksum() string {
 }
 
 func (alert *Alert) OverrideAsBytes() []byte {
-	yamlBytes, err := yaml.Marshal(alert.Override)
+	yamlBytes, err := yaml.Marshal(alert.ProviderOverride)
 	if err != nil {
 		logr.Warnf("[alert.OverrideAsBytes] Failed to marshal alert override of type=%s as bytes: %v", alert.Type, err)
 	}

alerting/provider/awsses/awsses.go

@@ -209,7 +209,7 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 		}
 	}
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -222,3 +222,9 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 	}
 	return &cfg, nil
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/awsses/awsses_test.go

@@ -212,7 +212,7 @@ func TestAlertProvider_getConfigWithOverrides(t *testing.T) {
 			},
 			InputGroup: "group",
 			InputAlert: alert.Alert{
-				Override: map[string]any{
+				ProviderOverride: map[string]any{
 					"to":            "[email protected]",
 					"access-key-id": 123,
 				},

alerting/provider/custom/custom.go

@@ -160,7 +160,7 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 		}
 	}
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -173,3 +173,9 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 	}
 	return &cfg, nil
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/custom/custom_test.go

@@ -348,7 +348,7 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 				},
 			},
 			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"url": "http://alert-example.com", "body": "alert-body"}},
+			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"},
 		},
 		{
@@ -363,7 +363,7 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 				},
 			},
 			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"body": "alert-body"}},
+			InputAlert:     alert.Alert{ProviderOverride: map[string]any{"body": "alert-body"}},
 			ExpectedOutput: Config{URL: "http://example.com", Body: "alert-body", Method: "POST"},
 		},
 	}

alerting/provider/discord/discord.go

@@ -180,7 +180,7 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 		}
 	}
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -193,3 +193,9 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 	}
 	return &cfg, nil
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/discord/discord_test.go

@@ -127,7 +127,7 @@ func TestAlertProvider_Send(t *testing.T) {
 		{
 			Name:     "triggered-with-webhook-override",
 			Provider: AlertProvider{DefaultConfig: Config{WebhookURL: "http://example.com"}},
-			Alert:    alert.Alert{Description: &firstDescription, SuccessThreshold: 5, FailureThreshold: 3, Override: map[string]any{"webhook-url": "http://example01.com"}},
+			Alert:    alert.Alert{Description: &firstDescription, SuccessThreshold: 5, FailureThreshold: 3, ProviderOverride: map[string]any{"webhook-url": "http://example01.com"}},
 			Resolved: false,
 			MockRoundTripper: test.MockRoundTripper(func(r *http.Request) *http.Response {
 				return &http.Response{StatusCode: http.StatusOK, Body: http.NoBody}
@@ -310,7 +310,7 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 				},
 			},
 			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"webhook-url": "http://alert-example.com"}},
+			InputAlert:     alert.Alert{ProviderOverride: map[string]any{"webhook-url": "http://alert-example.com"}},
 			ExpectedOutput: Config{WebhookURL: "http://alert-example.com"},
 		},
 	}

alerting/provider/email/email.go

@@ -187,7 +187,7 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 		}
 	}
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -200,3 +200,9 @@ func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Con
 	}
 	return &cfg, nil
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/email/email_test.go

@@ -198,7 +198,7 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 				},
 			},
 			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"to": "[email protected]"}},
+			InputAlert:     alert.Alert{ProviderOverride: map[string]any{"to": "[email protected]"}},
 			ExpectedOutput: Config{From: "[email protected]", To: "[email protected]", Host: "smtp.gmail.com", Port: 587, Password: "password"},
 		},
 	}

alerting/provider/gitea/gitea.go

@@ -52,6 +52,10 @@ func (cfg *Config) Validate() error {
 	if len(pathParts) != 3 {
 		return ErrInvalidRepositoryURL
 	}
+	if cfg.repositoryOwner == pathParts[1] && cfg.repositoryName == pathParts[2] && cfg.giteaClient != nil {
+		// Already validated, let's skip the rest of the validation to avoid unnecessary API calls
+		return nil
+	}
 	cfg.repositoryOwner = pathParts[1]
 	cfg.repositoryName = pathParts[2]
 	opts := []gitea.ClientOption{
@@ -109,7 +113,7 @@ func (provider *AlertProvider) Validate() error {
 // Send creates an issue in the designed RepositoryURL if the resolved parameter passed is false,
 // or closes the relevant issue(s) if the resolved parameter passed is true.
 func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
-	cfg, err := provider.GetConfig(alert)
+	cfg, err := provider.GetConfig(ep.Group, alert)
 	if err != nil {
 		return err
 	}
@@ -191,10 +195,10 @@ func (provider *AlertProvider) GetDefaultAlert() *alert.Alert {
 }
 
 // GetConfig returns the configuration for the provider with the overrides applied
-func (provider *AlertProvider) GetConfig(alert *alert.Alert) (*Config, error) {
+func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error) {
 	cfg := provider.DefaultConfig
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -205,3 +209,9 @@ func (provider *AlertProvider) GetConfig(alert *alert.Alert) (*Config, error) {
 	err := cfg.Validate()
 	return &cfg, err
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/gitea/gitea_test.go

@@ -86,7 +86,7 @@ func TestAlertProvider_Send(t *testing.T) {
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.Name, func(t *testing.T) {
-			cfg, err := scenario.Provider.GetConfig(&scenario.Alert)
+			cfg, err := scenario.Provider.GetConfig("", &scenario.Alert)
 			if err != nil && !strings.Contains(err.Error(), "user does not exist") && !strings.Contains(err.Error(), "no such host") {
 				t.Error("expected no error, got", err.Error())
 			}
@@ -180,7 +180,6 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 	scenarios := []struct {
 		Name           string
 		Provider       AlertProvider
-		InputGroup     string
 		InputAlert     alert.Alert
 		ExpectedOutput Config
 	}{
@@ -189,7 +188,6 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 			Provider: AlertProvider{
 				DefaultConfig: Config{RepositoryURL: "https://gitea.com/TwiN/test", Token: "12345"},
 			},
-			InputGroup:     "",
 			InputAlert:     alert.Alert{},
 			ExpectedOutput: Config{RepositoryURL: "https://gitea.com/TwiN/test", Token: "12345"},
 		},
@@ -198,14 +196,13 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 			Provider: AlertProvider{
 				DefaultConfig: Config{RepositoryURL: "https://gitea.com/TwiN/test", Token: "12345"},
 			},
-			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"repository-url": "https://gitea.com/TwiN/alert-test", "token": "54321", "assignees": []string{"TwiN"}}},
+			InputAlert:     alert.Alert{ProviderOverride: map[string]any{"repository-url": "https://gitea.com/TwiN/alert-test", "token": "54321", "assignees": []string{"TwiN"}}},
 			ExpectedOutput: Config{RepositoryURL: "https://gitea.com/TwiN/alert-test", Token: "54321", Assignees: []string{"TwiN"}},
 		},
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.Name, func(t *testing.T) {
-			got, err := scenario.Provider.GetConfig(&scenario.InputAlert)
+			got, err := scenario.Provider.GetConfig("", &scenario.InputAlert)
 			if err != nil && !strings.Contains(err.Error(), "user does not exist") && !strings.Contains(err.Error(), "no such host") {
 				t.Fatalf("unexpected error: %s", err)
 			}

alerting/provider/github/github.go

@@ -48,6 +48,10 @@ func (cfg *Config) Validate() error {
 	if len(pathParts) != 3 {
 		return ErrInvalidRepositoryURL
 	}
+	if cfg.repositoryOwner == pathParts[1] && cfg.repositoryName == pathParts[2] && cfg.githubClient != nil {
+		// Already validated, let's skip the rest of the validation to avoid unnecessary API calls
+		return nil
+	}
 	cfg.repositoryOwner = pathParts[1]
 	cfg.repositoryName = pathParts[2]
 	// Create oauth2 HTTP client with GitHub token
@@ -99,7 +103,7 @@ func (provider *AlertProvider) Validate() error {
 // Send creates an issue in the designed RepositoryURL if the resolved parameter passed is false,
 // or closes the relevant issue(s) if the resolved parameter passed is true.
 func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
-	cfg, err := provider.GetConfig(alert)
+	cfg, err := provider.GetConfig(ep.Group, alert)
 	if err != nil {
 		return err
 	}
@@ -164,10 +168,10 @@ func (provider *AlertProvider) GetDefaultAlert() *alert.Alert {
 }
 
 // GetConfig returns the configuration for the provider with the overrides applied
-func (provider *AlertProvider) GetConfig(alert *alert.Alert) (*Config, error) {
+func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error) {
 	cfg := provider.DefaultConfig
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -178,3 +182,9 @@ func (provider *AlertProvider) GetConfig(alert *alert.Alert) (*Config, error) {
 	err := cfg.Validate()
 	return &cfg, err
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/github/github_test.go

@@ -86,7 +86,7 @@ func TestAlertProvider_Send(t *testing.T) {
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.Name, func(t *testing.T) {
-			cfg, err := scenario.Provider.GetConfig(&scenario.Alert)
+			cfg, err := scenario.Provider.GetConfig("", &scenario.Alert)
 			if err != nil && !strings.Contains(err.Error(), "failed to retrieve GitHub user") && !strings.Contains(err.Error(), "no such host") {
 				t.Error("expected no error, got", err.Error())
 			}
@@ -180,7 +180,6 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 	scenarios := []struct {
 		Name           string
 		Provider       AlertProvider
-		InputGroup     string
 		InputAlert     alert.Alert
 		ExpectedOutput Config
 	}{
@@ -189,7 +188,6 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 			Provider: AlertProvider{
 				DefaultConfig: Config{RepositoryURL: "https://github.com/TwiN/test", Token: "12345"},
 			},
-			InputGroup:     "",
 			InputAlert:     alert.Alert{},
 			ExpectedOutput: Config{RepositoryURL: "https://github.com/TwiN/test", Token: "12345"},
 		},
@@ -198,14 +196,13 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 			Provider: AlertProvider{
 				DefaultConfig: Config{RepositoryURL: "https://github.com/TwiN/test", Token: "12345"},
 			},
-			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"repository-url": "https://github.com/TwiN/alert-test", "token": "54321"}},
+			InputAlert:     alert.Alert{ProviderOverride: map[string]any{"repository-url": "https://github.com/TwiN/alert-test", "token": "54321"}},
 			ExpectedOutput: Config{RepositoryURL: "https://github.com/TwiN/alert-test", Token: "54321"},
 		},
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.Name, func(t *testing.T) {
-			got, err := scenario.Provider.GetConfig(&scenario.InputAlert)
+			got, err := scenario.Provider.GetConfig("", &scenario.InputAlert)
 			if err != nil && !strings.Contains(err.Error(), "failed to retrieve GitHub user") && !strings.Contains(err.Error(), "no such host") {
 				t.Fatalf("unexpected error: %s", err)
 			}

alerting/provider/gitlab/gitlab.go

@@ -90,7 +90,7 @@ func (provider *AlertProvider) Validate() error {
 // Send creates an issue in the designed RepositoryURL if the resolved parameter passed is false,
 // or closes the relevant issue(s) if the resolved parameter passed is true.
 func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error {
-	cfg, err := provider.GetConfig(alert)
+	cfg, err := provider.GetConfig(ep.Group, alert)
 	if err != nil {
 		return err
 	}
@@ -182,10 +182,10 @@ func (provider *AlertProvider) GetDefaultAlert() *alert.Alert {
 }
 
 // GetConfig returns the configuration for the provider with the overrides applied
-func (provider *AlertProvider) GetConfig(alert *alert.Alert) (*Config, error) {
+func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error) {
 	cfg := provider.DefaultConfig
 	// Handle alert overrides
-	if len(alert.Override) != 0 {
+	if len(alert.ProviderOverride) != 0 {
 		overrideConfig := Config{}
 		if err := yaml.Unmarshal(alert.OverrideAsBytes(), &overrideConfig); err != nil {
 			return nil, err
@@ -196,3 +196,9 @@ func (provider *AlertProvider) GetConfig(alert *alert.Alert) (*Config, error) {
 	err := cfg.Validate()
 	return &cfg, err
 }
+
+// ValidateOverrides validates the alert's provider override and, if present, the group override
+func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error {
+	_, err := provider.GetConfig(group, alert)
+	return err
+}

alerting/provider/gitlab/gitlab_test.go

@@ -134,7 +134,7 @@ func TestAlertProvider_buildAlertBody(t *testing.T) {
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.Name, func(t *testing.T) {
-			cfg, err := scenario.Provider.GetConfig(&scenario.Alert)
+			cfg, err := scenario.Provider.GetConfig("", &scenario.Alert)
 			if err != nil {
 				t.Error("expected no error, got", err.Error())
 			}
@@ -170,7 +170,6 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 	scenarios := []struct {
 		Name           string
 		Provider       AlertProvider
-		InputGroup     string
 		InputAlert     alert.Alert
 		ExpectedOutput Config
 	}{
@@ -179,7 +178,6 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 			Provider: AlertProvider{
 				DefaultConfig: Config{WebhookURL: "https://github.com/TwiN/test", AuthorizationKey: "12345"},
 			},
-			InputGroup:     "",
 			InputAlert:     alert.Alert{},
 			ExpectedOutput: Config{WebhookURL: "https://github.com/TwiN/test", AuthorizationKey: "12345", Severity: DefaultSeverity, MonitoringTool: DefaultMonitoringTool},
 		},
@@ -188,14 +186,13 @@ func TestAlertProvider_GetConfig(t *testing.T) {
 			Provider: AlertProvider{
 				DefaultConfig: Config{WebhookURL: "https://github.com/TwiN/test", AuthorizationKey: "12345"},
 			},
-			InputGroup:     "group",
-			InputAlert:     alert.Alert{Override: map[string]any{"repository-url": "https://github.com/TwiN/alert-test", "authorization-key": "54321", "severity": "info", "monitoring-tool": "not-gatus", "environment-name": "prod", "service": "example"}},
+			InputAlert:     alert.Alert{ProviderOverride: map[string]any{"repository-url": "https://github.com/TwiN/alert-test", "authorization-key": "54321", "severity": "info", "monitoring-tool": "not-gatus", "environment-name": "prod", "service": "example"}},
 			ExpectedOutput: Config{WebhookURL: "https://github.com/TwiN/test", AuthorizationKey: "54321", Severity: "info", MonitoringTool: "not-gatus", EnvironmentName: "prod", Service: "example"},
 		},
 	}
 	for _, scenario := range scenarios {
 		t.Run(scenario.Name, func(t *testing.T) {
-			got, err := scenario.Provider.GetConfig(&scenario.InputAlert)
+			got, err := scenario.Provider.GetConfig("", &scenario.InputAlert)
 			if err != nil && !strings.Contains(err.Error(), "user does not exist") && !strings.Contains(err.Error(), "no such host") {
 				t.Fatalf("unexpected error: %s", err)
 			}