grafana/pkg/tests/api/alerting/api_convert_prometheus_test.go

package alerting

import (
	"net/http"
	"testing"
	"time"

	prommodel "github.com/prometheus/common/model"
	"github.com/stretchr/testify/require"

	"github.com/grafana/grafana/pkg/services/datasources"
	apimodels "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
	"github.com/grafana/grafana/pkg/services/org"
	"github.com/grafana/grafana/pkg/services/user"
	"github.com/grafana/grafana/pkg/tests/testinfra"
	"github.com/grafana/grafana/pkg/util"
)

var (
	promGroup1 = apimodels.PrometheusRuleGroup{
		Name:     "test-group-1",
		Interval: prommodel.Duration(60 * time.Second),
		Rules: []apimodels.PrometheusRule{
			// Recording rule
			{
				Record: "test:requests:rate5m",
				Expr:   "sum(rate(test_requests_total[5m])) by (job)",
				Labels: map[string]string{
					"env":  "prod",
					"team": "infra",
				},
			},
			// Two alerting rules
			{
				Alert: "HighMemoryUsage",
				Expr:  "process_memory_usage > 80",
				For:   util.Pointer(prommodel.Duration(5 * time.Minute)),
				Labels: map[string]string{
					"severity": "warning",
					"team":     "alerting",
				},
				Annotations: map[string]string{
					"annotation-1": "value-1",
					"annotation-2": "value-2",
				},
			},
			{
				Alert: "ServiceDown",
				Expr:  "up == 0",
				For:   util.Pointer(prommodel.Duration(2 * time.Minute)),
				Labels: map[string]string{
					"severity": "critical",
				},
				Annotations: map[string]string{
					"annotation-1": "value-1",
				},
			},
		},
	}

	promGroup2 = apimodels.PrometheusRuleGroup{
		Name:     "test-group-2",
		Interval: prommodel.Duration(60 * time.Second),
		Rules: []apimodels.PrometheusRule{
			{
				Alert: "HighDiskUsage",
				Expr:  "disk_usage > 80",
				For:   util.Pointer(prommodel.Duration(1 * time.Minute)),
				Labels: map[string]string{
					"severity": "low",
					"team":     "alerting",
				},
				Annotations: map[string]string{
					"annotation-5": "value-5",
				},
			},
		},
	}

	promGroup3 = apimodels.PrometheusRuleGroup{
		Name:     "test-group-3",
		Interval: prommodel.Duration(60 * time.Second),
		Rules: []apimodels.PrometheusRule{
			{
				Alert: "ServiceDown",
				Expr:  "up == 0",
				For:   util.Pointer(prommodel.Duration(2 * time.Minute)),
				Labels: map[string]string{
					"severity": "critical",
				},
				Annotations: map[string]string{
					"annotation-1": "value-1",
				},
			},
		},
	}
)

func TestIntegrationConvertPrometheusEndpoints(t *testing.T) {
	testinfra.SQLiteIntegrationTest(t)

	// Setup Grafana and its Database
	dir, path := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{
		DisableLegacyAlerting: true,
		EnableUnifiedAlerting: true,
		DisableAnonymous:      true,
		AppModeProduction:     true,
		EnableFeatureToggles:  []string{"alertingConversionAPI"},
	})

	grafanaListedAddr, env := testinfra.StartGrafanaEnv(t, dir, path)

	// Create users to make authenticated requests
	createUser(t, env.SQLStore, env.Cfg, user.CreateUserCommand{
		DefaultOrgRole: string(org.RoleAdmin),
		Password:       "password",
		Login:          "admin",
	})
	apiClient := newAlertingApiClient(grafanaListedAddr, "admin", "password")

	createUser(t, env.SQLStore, env.Cfg, user.CreateUserCommand{
		DefaultOrgRole: string(org.RoleViewer),
		Password:       "password",
		Login:          "viewer",
	})
	viewerClient := newAlertingApiClient(grafanaListedAddr, "viewer", "password")

	namespace1 := "test-namespace-1"
	namespace2 := "test-namespace-2"

	ds := apiClient.CreateDatasource(t, datasources.DS_PROMETHEUS)

	t.Run("create rule groups and get them back", func(t *testing.T) {
		_, status, body := apiClient.ConvertPrometheusPostRuleGroup(t, namespace1, ds.Body.Datasource.UID, promGroup1, nil)
		requireStatusCode(t, http.StatusAccepted, status, body)
		_, status, body = apiClient.ConvertPrometheusPostRuleGroup(t, namespace1, ds.Body.Datasource.UID, promGroup2, nil)
		requireStatusCode(t, http.StatusAccepted, status, body)

		// create a third group in a different namespace
		_, status, body = apiClient.ConvertPrometheusPostRuleGroup(t, namespace2, ds.Body.Datasource.UID, promGroup3, nil)
		requireStatusCode(t, http.StatusAccepted, status, body)

		// And a non-provisioned rule in another namespace
		namespace3UID := util.GenerateShortUID()
		apiClient.CreateFolder(t, namespace3UID, "folder")
		createRule(t, apiClient, namespace3UID)

		// Now get the first group
		group1 := apiClient.ConvertPrometheusGetRuleGroupRules(t, namespace1, promGroup1.Name)
		require.Equal(t, promGroup1, group1)

		// Get namespace1
		ns1 := apiClient.ConvertPrometheusGetNamespaceRules(t, namespace1)
		expectedNs1 := map[string][]apimodels.PrometheusRuleGroup{
			namespace1: {promGroup1, promGroup2},
		}
		require.Equal(t, expectedNs1, ns1)

		// Get all namespaces
		namespaces := apiClient.ConvertPrometheusGetAllRules(t)
		expectedNamespaces := map[string][]apimodels.PrometheusRuleGroup{
			namespace1: {promGroup1, promGroup2},
			namespace2: {promGroup3},
		}
		require.Equal(t, expectedNamespaces, namespaces)
	})

	t.Run("without permissions to create folders cannot create rule groups either", func(t *testing.T) {
		_, status, raw := viewerClient.ConvertPrometheusPostRuleGroup(t, namespace1, ds.Body.Datasource.UID, promGroup1, nil)
		requireStatusCode(t, http.StatusForbidden, status, raw)
	})
}

func TestIntegrationConvertPrometheusEndpoints_CreatePausedRules(t *testing.T) {
	testinfra.SQLiteIntegrationTest(t)

	// Setup Grafana and its Database
	dir, path := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{
		DisableLegacyAlerting: true,
		EnableUnifiedAlerting: true,
		DisableAnonymous:      true,
		AppModeProduction:     true,
		EnableFeatureToggles:  []string{"alertingConversionAPI"},
	})

	grafanaListedAddr, env := testinfra.StartGrafanaEnv(t, dir, path)

	// Create users to make authenticated requests
	createUser(t, env.SQLStore, env.Cfg, user.CreateUserCommand{
		DefaultOrgRole: string(org.RoleAdmin),
		Password:       "password",
		Login:          "admin",
	})
	apiClient := newAlertingApiClient(grafanaListedAddr, "admin", "password")

	ds := apiClient.CreateDatasource(t, datasources.DS_PROMETHEUS)

	namespace1 := "test-namespace-1"

	namespace1UID := util.GenerateShortUID()
	apiClient.CreateFolder(t, namespace1UID, namespace1)

	t.Run("when pausing header is set, rules should be paused", func(t *testing.T) {
		tests := []struct {
			name            string
			recordingPaused bool
			alertPaused     bool
		}{
			{
				name:            "do not pause rules",
				recordingPaused: false,
				alertPaused:     false,
			},
			{
				name:            "pause recording rules",
				recordingPaused: true,
				alertPaused:     false,
			},
			{
				name:            "pause alert rules",
				recordingPaused: false,
				alertPaused:     true,
			},
			{
				name:            "pause both recording and alert rules",
				recordingPaused: true,
				alertPaused:     true,
			},
		}

		for _, tc := range tests {
			t.Run(tc.name, func(t *testing.T) {
				headers := map[string]string{}
				if tc.recordingPaused {
					headers["X-Grafana-Alerting-Recording-Rules-Paused"] = "true"
				}
				if tc.alertPaused {
					headers["X-Grafana-Alerting-Alert-Rules-Paused"] = "true"
				}

				apiClient.ConvertPrometheusPostRuleGroup(t, namespace1, ds.Body.Datasource.UID, promGroup1, headers)

				gr, _, _ := apiClient.GetRulesGroupWithStatus(t, namespace1UID, promGroup1.Name)

				require.Len(t, gr.Rules, 3)

				pausedRecordingRules := 0
				pausedAlertRules := 0

				for _, rule := range gr.Rules {
					if rule.GrafanaManagedAlert.IsPaused {
						if rule.GrafanaManagedAlert.Record != nil {
							pausedRecordingRules++
						} else {
							pausedAlertRules++
						}
					}
				}

				if tc.recordingPaused {
					require.Equal(t, 1, pausedRecordingRules)
				} else {
					require.Equal(t, 0, pausedRecordingRules)
				}

				if tc.alertPaused {
					require.Equal(t, 2, pausedAlertRules)
				} else {
					require.Equal(t, 0, pausedAlertRules)
				}
			})
		}
	})
}