Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

config: fix validation of OpsGenie configuration #2910

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/notifiers.go
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ func (c *OpsGenieConfig) UnmarshalYAML(unmarshal func(interface{}) error) error
return err
}

if c.APIURL != nil && len(c.APIKeyFile) > 0 {
if c.APIKey != "" && len(c.APIKeyFile) > 0 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if c.APIKey != "" && len(c.APIKeyFile) > 0 {
if c.APIURL == nil {
return fmt.Errorf("missing URL in config")
}
if c.APIKey != "" && len(c.APIKeyFile) > 0 {

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to validate the URL as well, DefaultOpsGenieConfig does not contain a default URL.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's a default OpsGenie URL in the global config.

OpsGenieAPIURL: mustParseURL("https://api.opsgenie.com/"),

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦

return fmt.Errorf("at most one of api_key & api_key_file must be configured")
}

Expand Down
66 changes: 66 additions & 0 deletions config/notifiers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -590,6 +590,72 @@ func TestOpsgenieTypeMatcher(t *testing.T) {
}
}

func TestOpsGenieConfiguration(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also include a test here if we decide to include the URL validation?

for _, tc := range []struct {
name string
in string

err bool
}{
{
name: "valid configuration",
in: `api_key: xyz
responders:
- id: foo
type: scheDule
- name: bar
type: teams
- username: fred
type: USER
api_url: http://example.com
`,
},
{
name: "api_key and api_key_file both defined",
in: `api_key: xyz
api_key_file: xyz
api_url: http://example.com
`,
err: true,
},
{
name: "invalid responder type",
in: `api_key: xyz
responders:
- id: foo
type: wrong
api_url: http://example.com
`,
err: true,
},
{
name: "missing responder field",
in: `api_key: xyz
responders:
- type: schedule
api_url: http://example.com
`,
err: true,
},
} {
t.Run(tc.name, func(t *testing.T) {
var cfg OpsGenieConfig

err := yaml.UnmarshalStrict([]byte(tc.in), &cfg)
if tc.err {
if err == nil {
t.Fatalf("expected error but got none")
}
return
}

if err != nil {
t.Errorf("expected no error, got %v", err)
}
})
}
}

func TestSNS(t *testing.T) {
for _, tc := range []struct {
in string
Expand Down
4 changes: 2 additions & 2 deletions doc/alertmanager-mixin/.lint
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
exclusions:
panel-job-instance-rule:
target-instance-rule:
reason: no need to have every query contains two matchers within every selector - `{job=~"$job", instance=~"$instance"}`
template-job-rule:
template-job-rule:
entries:
- dashboard: Alertmanager / Overview
reason: multi-select is not always required