mirror of
https://github.com/grafana/grafana.git
synced 2024-11-29 20:24:18 -06:00
9dc7e752b7
* optional custom description for OpsGenie * custom title and message, tests * update changelog * check for empty / whitespace only strings * truncate the title to 130 characters if needed * unnecessary validation removed * truncate title to 127 characters and add three dots
278 lines
9.9 KiB
Go
278 lines
9.9 KiB
Go
package channels
|
|
|
|
import (
|
|
"context"
|
|
"net/url"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/grafana/grafana/pkg/components/simplejson"
|
|
"github.com/grafana/grafana/pkg/services/secrets/fakes"
|
|
secretsManager "github.com/grafana/grafana/pkg/services/secrets/manager"
|
|
|
|
"github.com/prometheus/alertmanager/notify"
|
|
"github.com/prometheus/alertmanager/types"
|
|
"github.com/prometheus/common/model"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestOpsgenieNotifier(t *testing.T) {
|
|
tmpl := templateForTests(t)
|
|
|
|
externalURL, err := url.Parse("http://localhost")
|
|
require.NoError(t, err)
|
|
tmpl.ExternalURL = externalURL
|
|
|
|
cases := []struct {
|
|
name string
|
|
settings string
|
|
alerts []*types.Alert
|
|
expMsg string
|
|
expInitError string
|
|
expMsgError error
|
|
}{
|
|
{
|
|
name: "Default config with one alert",
|
|
settings: `{"apiKey": "abcdefgh0123456789"}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1", "__dashboardUid__": "abcd", "__panelId__": "efgh"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "[FIRING:1] (val1)\nhttp://localhost/alerting/list\n\n**Firing**\n\nValue: [no value]\nLabels:\n - alertname = alert1\n - lbl1 = val1\nAnnotations:\n - ann1 = annv1\nSilence: http://localhost/alerting/silence/new?alertmanager=grafana&matcher=alertname%3Dalert1&matcher=lbl1%3Dval1\nDashboard: http://localhost/d/abcd\nPanel: http://localhost/d/abcd?viewPanel=efgh\n",
|
|
"details": {
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "[FIRING:1] (val1)",
|
|
"source": "Grafana",
|
|
"tags": ["alertname:alert1", "lbl1:val1"]
|
|
}`,
|
|
},
|
|
{
|
|
name: "Default config with one alert, custom message and description",
|
|
settings: `{"apiKey": "abcdefgh0123456789", "message": "test message", "description": "test description"}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1", "__dashboardUid__": "abcd", "__panelId__": "efgh"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "test description",
|
|
"details": {
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "test message",
|
|
"source": "Grafana",
|
|
"tags": ["alertname:alert1", "lbl1:val1"]
|
|
}`,
|
|
},
|
|
{
|
|
name: "Default config with one alert, message length > 130",
|
|
settings: `{
|
|
"apiKey": "abcdefgh0123456789",
|
|
"message": "IyJnsW78xQoiBJ7L7NqASv31JCFf0At3r9KUykqBVxSiC6qkDhvDLDW9VImiFcq0Iw2XwFy5fX4FcbTmlkaZzUzjVwx9VUuokhzqQlJVhWDYFqhj3a5wX0LjyvNQjsqT9WaWJAWOJanwOAWon"
|
|
}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1", "__dashboardUid__": "abcd", "__panelId__": "efgh"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "[FIRING:1] (val1)\nhttp://localhost/alerting/list\n\n**Firing**\n\nValue: [no value]\nLabels:\n - alertname = alert1\n - lbl1 = val1\nAnnotations:\n - ann1 = annv1\nSilence: http://localhost/alerting/silence/new?alertmanager=grafana&matcher=alertname%3Dalert1&matcher=lbl1%3Dval1\nDashboard: http://localhost/d/abcd\nPanel: http://localhost/d/abcd?viewPanel=efgh\n",
|
|
"details": {
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "IyJnsW78xQoiBJ7L7NqASv31JCFf0At3r9KUykqBVxSiC6qkDhvDLDW9VImiFcq0Iw2XwFy5fX4FcbTmlkaZzUzjVwx9VUuokhzqQlJVhWDYFqhj3a5wX0LjyvNQjsq...",
|
|
"source": "Grafana",
|
|
"tags": ["alertname:alert1", "lbl1:val1"]
|
|
}`,
|
|
},
|
|
{
|
|
name: "Default config with one alert, templated message and description",
|
|
settings: `{"apiKey": "abcdefgh0123456789", "message": "Firing: {{ len .Alerts.Firing }}", "description": "{{ len .Alerts.Firing }} firing, {{ len .Alerts.Resolved }} resolved."}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1", "__dashboardUid__": "abcd", "__panelId__": "efgh"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "1 firing, 0 resolved.",
|
|
"details": {
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "Firing: 1",
|
|
"source": "Grafana",
|
|
"tags": ["alertname:alert1", "lbl1:val1"]
|
|
}`,
|
|
},
|
|
{
|
|
name: "Default config with one alert and send tags as tags, empty description and message",
|
|
settings: `{
|
|
"apiKey": "abcdefgh0123456789",
|
|
"sendTagsAs": "tags",
|
|
"message": " ",
|
|
"description": " "
|
|
}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "[FIRING:1] (val1)\nhttp://localhost/alerting/list\n\n**Firing**\n\nValue: [no value]\nLabels:\n - alertname = alert1\n - lbl1 = val1\nAnnotations:\n - ann1 = annv1\nSilence: http://localhost/alerting/silence/new?alertmanager=grafana&matcher=alertname%3Dalert1&matcher=lbl1%3Dval1\n",
|
|
"details": {
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "[FIRING:1] (val1)",
|
|
"source": "Grafana",
|
|
"tags": ["alertname:alert1", "lbl1:val1"]
|
|
}`,
|
|
},
|
|
{
|
|
name: "Default config with one alert and send tags as details",
|
|
settings: `{
|
|
"apiKey": "abcdefgh0123456789",
|
|
"sendTagsAs": "details"
|
|
}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "[FIRING:1] (val1)\nhttp://localhost/alerting/list\n\n**Firing**\n\nValue: [no value]\nLabels:\n - alertname = alert1\n - lbl1 = val1\nAnnotations:\n - ann1 = annv1\nSilence: http://localhost/alerting/silence/new?alertmanager=grafana&matcher=alertname%3Dalert1&matcher=lbl1%3Dval1\n",
|
|
"details": {
|
|
"alertname": "alert1",
|
|
"lbl1": "val1",
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "[FIRING:1] (val1)",
|
|
"source": "Grafana",
|
|
"tags": []
|
|
}`,
|
|
},
|
|
{
|
|
name: "Custom config with multiple alerts and send tags as both details and tag",
|
|
settings: `{
|
|
"apiKey": "abcdefgh0123456789",
|
|
"sendTagsAs": "both"
|
|
}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1"},
|
|
},
|
|
}, {
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val2"},
|
|
Annotations: model.LabelSet{"ann1": "annv1"},
|
|
},
|
|
},
|
|
},
|
|
expMsg: `{
|
|
"alias": "6e3538104c14b583da237e9693b76debbc17f0f8058ef20492e5853096cf8733",
|
|
"description": "[FIRING:2] \nhttp://localhost/alerting/list\n\n**Firing**\n\nValue: [no value]\nLabels:\n - alertname = alert1\n - lbl1 = val1\nAnnotations:\n - ann1 = annv1\nSilence: http://localhost/alerting/silence/new?alertmanager=grafana&matcher=alertname%3Dalert1&matcher=lbl1%3Dval1\n\nValue: [no value]\nLabels:\n - alertname = alert1\n - lbl1 = val2\nAnnotations:\n - ann1 = annv1\nSilence: http://localhost/alerting/silence/new?alertmanager=grafana&matcher=alertname%3Dalert1&matcher=lbl1%3Dval2\n",
|
|
"details": {
|
|
"alertname": "alert1",
|
|
"url": "http://localhost/alerting/list"
|
|
},
|
|
"message": "[FIRING:2] ",
|
|
"source": "Grafana",
|
|
"tags": ["alertname:alert1"]
|
|
}`,
|
|
expMsgError: nil,
|
|
},
|
|
{
|
|
name: "Resolved is not sent when auto close is false",
|
|
settings: `{"apiKey": "abcdefgh0123456789", "autoClose": false}`,
|
|
alerts: []*types.Alert{
|
|
{
|
|
Alert: model.Alert{
|
|
Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
|
|
Annotations: model.LabelSet{"ann1": "annv1"},
|
|
EndsAt: time.Now().Add(-1 * time.Minute),
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "Error when incorrect settings",
|
|
settings: `{}`,
|
|
expInitError: `could not find api key property in settings`,
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
t.Run(c.name, func(t *testing.T) {
|
|
settingsJSON, err := simplejson.NewJson([]byte(c.settings))
|
|
require.NoError(t, err)
|
|
secureSettings := make(map[string][]byte)
|
|
|
|
m := &NotificationChannelConfig{
|
|
Name: "opsgenie_testing",
|
|
Type: "opsgenie",
|
|
Settings: settingsJSON,
|
|
SecureSettings: secureSettings,
|
|
}
|
|
|
|
webhookSender := mockNotificationService()
|
|
webhookSender.Webhook.Body = "<not-sent>"
|
|
secretsService := secretsManager.SetupTestService(t, fakes.NewFakeSecretsStore())
|
|
decryptFn := secretsService.GetDecryptedValue
|
|
cfg, err := NewOpsgenieConfig(m, decryptFn)
|
|
if c.expInitError != "" {
|
|
require.Error(t, err)
|
|
require.Equal(t, c.expInitError, err.Error())
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
|
|
ctx := notify.WithGroupKey(context.Background(), "alertname")
|
|
ctx = notify.WithGroupLabels(ctx, model.LabelSet{"alertname": ""})
|
|
pn := NewOpsgenieNotifier(cfg, webhookSender, &UnavailableImageStore{}, tmpl, decryptFn)
|
|
ok, err := pn.Notify(ctx, c.alerts...)
|
|
if c.expMsgError != nil {
|
|
require.False(t, ok)
|
|
require.Error(t, err)
|
|
require.Equal(t, c.expMsgError.Error(), err.Error())
|
|
return
|
|
}
|
|
require.True(t, ok)
|
|
require.NoError(t, err)
|
|
|
|
if c.expMsg == "" {
|
|
// No notification was expected.
|
|
require.Equal(t, "<not-sent>", webhookSender.Webhook.Body)
|
|
} else {
|
|
require.JSONEq(t, c.expMsg, webhookSender.Webhook.Body)
|
|
}
|
|
})
|
|
}
|
|
}
|