config: add global mattermost_api_url and mattermost_api_url_file

Default Mattermost receiver webhook_url/webhook_url_file from global settings

Signed-off-by: Kliachin Aleksei <madest92@gmail.com>

Author: madest92

config/config.go

@@ -479,6 +479,10 @@ func (c *Config) UnmarshalYAML(unmarshal func(any) error) error {
 		}
 	}
 
+	if c.Global.MattermostAPIURL != nil && len(c.Global.MattermostAPIURLFile) > 0 {
+		return errors.New("at most one of mattermost_api_url & mattermost_api_url_file must be configured")
+	}
+
 	if c.Global.OpsGenieAPIKey != "" && len(c.Global.OpsGenieAPIKeyFile) > 0 {
 		return errors.New("at most one of opsgenie_api_key & opsgenie_api_key_file must be configured")
 	}
@@ -773,6 +777,10 @@ func (c *Config) UnmarshalYAML(unmarshal func(any) error) error {
 			if mattermost.HTTPConfig == nil {
 				mattermost.HTTPConfig = c.Global.HTTPConfig
 			}
+			if mattermost.WebhookURL == nil && len(mattermost.WebhookURLFile) == 0 {
+				mattermost.WebhookURL = c.Global.MattermostAPIURL
+				mattermost.WebhookURLFile = c.Global.MattermostAPIURLFile
+			}
 		}
 
 		names[rcv.Name] = struct{}{}
@@ -994,6 +1002,8 @@ type GlobalConfig struct {
 	SMTPTLSConfig         *commoncfg.TLSConfig `yaml:"smtp_tls_config,omitempty" json:"smtp_tls_config,omitempty"`
 	SlackAPIURL           *SecretURL           `yaml:"slack_api_url,omitempty" json:"slack_api_url,omitempty"`
 	SlackAPIURLFile       string               `yaml:"slack_api_url_file,omitempty" json:"slack_api_url_file,omitempty"`
+	MattermostAPIURL      *SecretURL           `yaml:"mattermost_api_url,omitempty" json:"mattermost_api_url,omitempty"`
+	MattermostAPIURLFile  string               `yaml:"mattermost_api_url_file,omitempty" json:"mattermost_api_url_file,omitempty"`
 	SlackAppToken         Secret               `yaml:"slack_app_token,omitempty" json:"slack_app_token,omitempty"`
 	SlackAppTokenFile     string               `yaml:"slack_app_token_file,omitempty" json:"slack_app_token_file,omitempty"`
 	SlackAppURL           *URL                 `yaml:"slack_app_url,omitempty" json:"slack_app_url,omitempty"`

config/config_test.go

@@ -1016,6 +1016,31 @@ func TestEmptyFieldsAndRegex(t *testing.T) {
 	}
 }
 
+func TestMattermostGlobalAPIURLDefaulting(t *testing.T) {
+	conf, err := LoadFile("testdata/conf.mattermost-default-api-url-file.yml")
+	if err != nil {
+		t.Fatalf("Error parsing %s: %s", "testdata/conf.mattermost-default-api-url-file.yml", err)
+	}
+
+	// no override
+	firstConfig := conf.Receivers[0].MattermostConfigs[0]
+	if firstConfig.WebhookURLFile != "/global_mm_file" || firstConfig.WebhookURL != nil {
+		t.Fatalf("Invalid Mattermost URL file: %s\nExpected: %s", firstConfig.WebhookURLFile, "/global_mm_file")
+	}
+
+	// override the file
+	secondConfig := conf.Receivers[0].MattermostConfigs[1]
+	if secondConfig.WebhookURLFile != "/override_mm_file" || secondConfig.WebhookURL != nil {
+		t.Fatalf("Invalid Mattermost URL file: %s\nExpected: %s", secondConfig.WebhookURLFile, "/override_mm_file")
+	}
+
+	// override the global file with an inline URL
+	thirdConfig := conf.Receivers[0].MattermostConfigs[2]
+	if thirdConfig.WebhookURL.String() != "http://mysecret.example.com/" || thirdConfig.WebhookURLFile != "" {
+		t.Fatalf("Invalid Mattermost URL: %s\nExpected: %s", thirdConfig.WebhookURL.String(), "http://mysecret.example.com/")
+	}
+}
+
 func TestGlobalAndLocalHTTPConfig(t *testing.T) {
 	config, err := LoadFile("testdata/conf.http-config.good.yml")
 	if err != nil {

config/notifiers.go

@@ -1230,10 +1230,6 @@ func (c *MattermostConfig) UnmarshalYAML(unmarshal func(any) error) error {
 		return err
 	}
 
-	if c.WebhookURL == nil && c.WebhookURLFile == "" {
-		return errors.New("one of webhook_url or webhook_url_file must be configured")
-	}
-
 	if c.WebhookURL != nil && len(c.WebhookURLFile) > 0 {
 		return errors.New("at most one of webhook_url & webhook_url_file must be configured")
 	}

config/testdata/conf.mattermost-default-api-url-file.yml

@@ -0,0 +1,18 @@
+global:
+  mattermost_api_url_file: '/global_mm_file'
+route:
+  receiver: 'mm-notifications'
+receivers:
+  - name: 'mm-notifications'
+    mattermost_configs:
+      # Use global
+      - channel: 'alerts1'
+        text: 'test'
+      # Override global with other file
+      - channel: 'alerts2'
+        text: 'test'
+        webhook_url_file: '/override_mm_file'
+      # Override global with inline URL
+      - channel: 'alerts3'
+        text: 'test'
+        webhook_url: 'http://mysecret.example.com/'

docs/configuration.md

@@ -102,6 +102,8 @@ global:
   # The API URL to use for Slack notifications.
   [ slack_api_url: <secret> ]
   [ slack_api_url_file: <filepath> ]
+  [ mattermost_api_url: <secret> ]
+  [ mattermost_api_url_file: <filepath> ]
   [ victorops_api_key: <secret> ]
   [ victorops_api_key_file: <filepath> ]
   [ victorops_api_url: <string> | default = "https://alert.victorops.com/integrations/generic/20131114/alert/" ]
@@ -1019,10 +1021,10 @@ Mattermost notifications are sent via the [Mattermost webhook API](https://devel
 # Whether to notify about resolved alerts.
 [ send_resolved: <boolean> | default = true ]
 
-# The Mattermost webhook URL.
-# webhook_url and webhook_url_file are mutually exclusive.
-webhook_url: <secret>
-webhook_url_file: <filepath>
+# The Mattermost webhook URL. Either `webhook_url` or `webhook_url_file` should be set.
+# Defaults to global settings if none are set here.
+[ webhook_url: <secret> | default = global.mattermost_api_url ]
+[ webhook_url_file: <filepath> | default = global.mattermost_api_url_file ]
 
 # Overrides the channel the message posts in. Use the channel’s name and not the display name, e.g. use town-square, not Town Square.
 [ channel: <string> | default = '' ]