-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
simonpasquier
merged 2 commits into
prometheus:release-0.24
from
simonpasquier:fix-opsgenie-configuration-validation
May 5, 2022
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -590,6 +590,72 @@ func TestOpsgenieTypeMatcher(t *testing.T) { | |
} | ||
} | ||
|
||
func TestOpsGenieConfiguration(t *testing.T) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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.
alertmanager/config/config.go
Line 591 in 23f961e
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤦