Skip to content

Commit 89f36f6

Browse files
authored
Add receiver validation for msteamsv2 and rocketchat (#6606)
Signed-off-by: SungJin1212 <tjdwls1201@gmail.com>
1 parent 72f03ab commit 89f36f6

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [ENHANCEMENT] StoreGateway: Emit more histogram buckets on the `cortex_querier_storegateway_refetches_per_query` metric. #6570
1111
* [ENHANCEMENT] Querier: Apply bytes limiter to LabelNames and LabelValuesForLabelNames. #6568
1212
* [ENHANCEMENT] Query Frontend: Add a `too_many_tenants` reason label value to `cortex_rejected_queries_total` metric to track the rejected query count due to the # of tenant limits. #6569
13+
* [ENHANCEMENT] Alertmanager: Add receiver validations for msteamsv2 and rocketchat. #6606
1314
* [BUGFIX] Ingester: Avoid error or early throttling when READONLY ingesters are present in the ring #6517
1415
* [BUGFIX] Ingester: Fix labelset data race condition. #6573
1516
* [BUGFIX] Compactor: Cleaner should not put deletion marker for blocks with no-compact marker. #6576

pkg/alertmanager/api.go

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ var (
5252
errPushOverUserKeyFileNotAllowed = errors.New("setting PushOver user_key_file is not allowed")
5353
errPushOverTokenFileNotAllowed = errors.New("setting PushOver token_file is not allowed")
5454
errTelegramBotTokenFileNotAllowed = errors.New("setting Telegram bot_token_file is not allowed")
55+
errMSTeamsWebhookUrlFileNotAllowed = errors.New("setting MSTeams webhook_url_file is not allowed")
56+
errMSTeamsV2WebhookUrlFileNotAllowed = errors.New("setting MSTeamsV2 webhook_url_file is not allowed")
57+
errRocketChatTokenIdFileNotAllowed = errors.New("setting RocketChat token_id_file is not allowed")
58+
errRocketChatTokenFileNotAllowed = errors.New("setting RocketChat token_file is not allowed")
5559
)
5660

5761
// UserConfig is used to communicate a users alertmanager configs
@@ -383,6 +387,18 @@ func validateAlertmanagerConfig(cfg interface{}) error {
383387
if err := validateTelegramConfig(v.Interface().(config.TelegramConfig)); err != nil {
384388
return err
385389
}
390+
case reflect.TypeOf(config.MSTeamsConfig{}):
391+
if err := validateMSTeamsConfig(v.Interface().(config.MSTeamsConfig)); err != nil {
392+
return err
393+
}
394+
case reflect.TypeOf(config.MSTeamsV2Config{}):
395+
if err := validateMSTeamsV2Config(v.Interface().(config.MSTeamsV2Config)); err != nil {
396+
return err
397+
}
398+
case reflect.TypeOf(config.RocketchatConfig{}):
399+
if err := validateRocketChatConfig(v.Interface().(config.RocketchatConfig)); err != nil {
400+
return err
401+
}
386402
}
387403

388404
// If the input config is a struct, recursively iterate on all fields.
@@ -540,3 +556,35 @@ func validateTelegramConfig(cfg config.TelegramConfig) error {
540556
}
541557
return nil
542558
}
559+
560+
// validateMSTeamsConfig validates the MSTeams Config and returns an error if it contains
561+
// settings not allowed by Cortex.
562+
func validateMSTeamsConfig(cfg config.MSTeamsConfig) error {
563+
if cfg.WebhookURLFile != "" {
564+
return errMSTeamsWebhookUrlFileNotAllowed
565+
}
566+
return nil
567+
}
568+
569+
// validateMSTeamsV2Config validates the MSTeamsV2 Config and returns an error if it contains
570+
// settings not allowed by Cortex.
571+
func validateMSTeamsV2Config(cfg config.MSTeamsV2Config) error {
572+
if cfg.WebhookURLFile != "" {
573+
return errMSTeamsV2WebhookUrlFileNotAllowed
574+
}
575+
return nil
576+
}
577+
578+
// validateRocketChatConfig validates the RocketChat Config and returns an error if it contains
579+
// settings not allowed by Cortex.
580+
func validateRocketChatConfig(cfg config.RocketchatConfig) error {
581+
if cfg.TokenIDFile != "" {
582+
return errRocketChatTokenIdFileNotAllowed
583+
}
584+
585+
if cfg.TokenFile != "" {
586+
return errRocketChatTokenFileNotAllowed
587+
}
588+
589+
return nil
590+
}

pkg/alertmanager/api_test.go

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,60 @@ alertmanager_config: |
649649
`,
650650
err: errors.Wrap(errTelegramBotTokenFileNotAllowed, "error validating Alertmanager config"),
651651
},
652+
{
653+
name: "Should return error if MSTeams webhook_url_file is set",
654+
cfg: `
655+
alertmanager_config: |
656+
receivers:
657+
- name: default-receiver
658+
msteams_configs:
659+
- webhook_url_file: /urlFile
660+
route:
661+
receiver: 'default-receiver'
662+
`,
663+
err: errors.Wrap(errMSTeamsWebhookUrlFileNotAllowed, "error validating Alertmanager config"),
664+
},
665+
{
666+
name: "Should return error if MSTeamsV2 webhook_url_file is set",
667+
cfg: `
668+
alertmanager_config: |
669+
receivers:
670+
- name: default-receiver
671+
msteamsv2_configs:
672+
- webhook_url_file: /urlFile
673+
route:
674+
receiver: 'default-receiver'
675+
`,
676+
err: errors.Wrap(errMSTeamsV2WebhookUrlFileNotAllowed, "error validating Alertmanager config"),
677+
},
678+
{
679+
name: "Should return error if RocketChat token_id_file is set",
680+
cfg: `
681+
alertmanager_config: |
682+
receivers:
683+
- name: default-receiver
684+
rocketchat_configs:
685+
- token_id_file: /tokenIdFile
686+
token: 'token'
687+
route:
688+
receiver: 'default-receiver'
689+
`,
690+
err: errors.Wrap(errRocketChatTokenIdFileNotAllowed, "error validating Alertmanager config"),
691+
},
692+
{
693+
name: "Should return error if RocketChat token_file is set",
694+
cfg: `
695+
alertmanager_config: |
696+
receivers:
697+
- name: default-receiver
698+
rocketchat_configs:
699+
- token_file: /tokenFile
700+
token_id: 'tokenId'
701+
route:
702+
receiver: 'default-receiver'
703+
`,
704+
err: errors.Wrap(errRocketChatTokenFileNotAllowed, "error validating Alertmanager config"),
705+
},
652706
}
653707

654708
limits := &mockAlertManagerLimits{}

0 commit comments

Comments
 (0)