config: fix validation of OpsGenie configuration

The validation should fail if both `api_key` and `api_key_file` are defined. I think there was a typo in the original PR (prometheus#2728) that enforced `api_url` and `api_key_file` not being defined at the same time. Signed-off-by: Simon Pasquier <[email protected]> Signed-off-by: Yijie Qin <[email protected]>
qinxx108 · Dec 13, 2022 · f5a5090 · f5a5090
1 parent 93793d3
commit f5a5090
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 1 deletion.
diff --git a/config/notifiers.go b/config/notifiers.go
@@ -491,7 +491,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 {
 		return fmt.Errorf("at most one of api_key & api_key_file must be configured")
 	}
 

diff --git a/config/notifiers_test.go b/config/notifiers_test.go
@@ -590,6 +590,72 @@ func TestOpsgenieTypeMatcher(t *testing.T) {
 	}
 }
 
+func TestOpsGenieConfiguration(t *testing.T) {
+	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