package schedule import ( "fmt" "math/rand" "net/url" "testing" "time" "github.com/go-openapi/strfmt" "github.com/prometheus/alertmanager/api/v2/models" "github.com/prometheus/common/model" "github.com/stretchr/testify/require" "github.com/grafana/grafana/pkg/services/ngalert/eval" ngModels "github.com/grafana/grafana/pkg/services/ngalert/models" "github.com/grafana/grafana/pkg/services/ngalert/state" "github.com/grafana/grafana/pkg/util" ) func Test_stateToPostableAlert(t *testing.T) { appURL := &url.URL{ Scheme: "http:", Host: fmt.Sprintf("host-%d", rand.Int()), Path: fmt.Sprintf("path-%d", rand.Int()), } testCases := []struct { name string state eval.State }{ { name: "when state is Normal", state: eval.Normal, }, { name: "when state is Alerting", state: eval.Alerting, }, { name: "when state is Pending", state: eval.Pending, }, { name: "when state is NoData", state: eval.NoData, }, { name: "when state is Error", state: eval.Error, }, } for _, tc := range testCases { t.Run(tc.name, func(t *testing.T) { t.Run("it generates proper URL", func(t *testing.T) { t.Run("to alert rule", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels[ngModels.RuleUIDLabel] = alertState.AlertRuleUID result := stateToPostableAlert(alertState, appURL) u := *appURL u.Path = u.Path + "/alerting/" + alertState.AlertRuleUID + "/edit" require.Equal(t, u.String(), result.Alert.GeneratorURL.String()) }) t.Run("app URL as is if rule UID is not specified", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels[ngModels.RuleUIDLabel] = "" result := stateToPostableAlert(alertState, appURL) require.Equal(t, appURL.String(), result.Alert.GeneratorURL.String()) delete(alertState.Labels, ngModels.RuleUIDLabel) result = stateToPostableAlert(alertState, appURL) require.Equal(t, appURL.String(), result.Alert.GeneratorURL.String()) }) t.Run("empty string if app URL is not provided", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels[ngModels.RuleUIDLabel] = alertState.AlertRuleUID result := stateToPostableAlert(alertState, nil) require.Equal(t, "", result.Alert.GeneratorURL.String()) }) }) t.Run("Start and End timestamps should be the same", func(t *testing.T) { alertState := randomState(tc.state) result := stateToPostableAlert(alertState, appURL) require.Equal(t, strfmt.DateTime(alertState.StartsAt), result.StartsAt) require.Equal(t, strfmt.DateTime(alertState.EndsAt), result.EndsAt) }) t.Run("should copy annotations", func(t *testing.T) { alertState := randomState(tc.state) alertState.Annotations = randomMapOfStrings() result := stateToPostableAlert(alertState, appURL) require.Equal(t, models.LabelSet(alertState.Annotations), result.Annotations) t.Run("add __value_string__ if it has results", func(t *testing.T) { alertState := randomState(tc.state) alertState.Annotations = randomMapOfStrings() expectedValueString := util.GenerateShortUID() alertState.Results = []state.Evaluation{ { EvaluationString: expectedValueString, }, } result := stateToPostableAlert(alertState, appURL) expected := make(models.LabelSet, len(alertState.Annotations)+1) for k, v := range alertState.Annotations { expected[k] = v } expected["__value_string__"] = expectedValueString require.Equal(t, expected, result.Annotations) // even overwrites alertState.Annotations["__value_string__"] = util.GenerateShortUID() result = stateToPostableAlert(alertState, appURL) require.Equal(t, expected, result.Annotations) }) }) switch tc.state { case eval.NoData: t.Run("should keep existing labels and change name", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels = randomMapOfStrings() alertName := util.GenerateShortUID() alertState.Labels[model.AlertNameLabel] = alertName result := stateToPostableAlert(alertState, appURL) expected := make(models.LabelSet, len(alertState.Labels)+1) for k, v := range alertState.Labels { expected[k] = v } expected[model.AlertNameLabel] = NoDataAlertName expected[Rulename] = alertName require.Equal(t, expected, result.Labels) t.Run("should not backup original alert name if it does not exist", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels = randomMapOfStrings() delete(alertState.Labels, model.AlertNameLabel) result := stateToPostableAlert(alertState, appURL) require.Equal(t, NoDataAlertName, result.Labels[model.AlertNameLabel]) require.NotContains(t, result.Labels[model.AlertNameLabel], Rulename) }) }) case eval.Error: t.Run("should keep existing labels and change name", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels = randomMapOfStrings() alertName := util.GenerateShortUID() alertState.Labels[model.AlertNameLabel] = alertName result := stateToPostableAlert(alertState, appURL) expected := make(models.LabelSet, len(alertState.Labels)+1) for k, v := range alertState.Labels { expected[k] = v } expected[model.AlertNameLabel] = ErrorAlertName expected[Rulename] = alertName require.Equal(t, expected, result.Labels) t.Run("should not backup original alert name if it does not exist", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels = randomMapOfStrings() delete(alertState.Labels, model.AlertNameLabel) result := stateToPostableAlert(alertState, appURL) require.Equal(t, ErrorAlertName, result.Labels[model.AlertNameLabel]) require.NotContains(t, result.Labels[model.AlertNameLabel], Rulename) }) }) default: t.Run("should copy labels as is", func(t *testing.T) { alertState := randomState(tc.state) alertState.Labels = randomMapOfStrings() result := stateToPostableAlert(alertState, appURL) require.Equal(t, models.LabelSet(alertState.Labels), result.Labels) }) } }) } } func randomMapOfStrings() map[string]string { max := 5 result := make(map[string]string, max) for i := 0; i < max; i++ { result[util.GenerateShortUID()] = util.GenerateShortUID() } return result } func randomDuration() time.Duration { return time.Duration(rand.Int63n(599)+1) * time.Second } func randomTimeInFuture() time.Time { return time.Now().Add(randomDuration()) } func randomTimeInPast() time.Time { return time.Now().Add(-randomDuration()) } func randomState(evalState eval.State) *state.State { return &state.State{ State: evalState, AlertRuleUID: util.GenerateShortUID(), StartsAt: time.Now(), EndsAt: randomTimeInFuture(), LastEvaluationTime: randomTimeInPast(), EvaluationDuration: randomDuration(), LastSentAt: randomTimeInPast(), Annotations: make(map[string]string), Labels: make(map[string]string), } }