Alerting: API to pause all alert rules in a folder (#104674)

pkg/tests/api/alerting/api_ruler_pause_test.go

@@ -0,0 +1,107 @@
+package alerting
+
+import (
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	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"
+)
+
+func TestIntegrationAlertRulePauseNamespace(t *testing.T) {
+	testinfra.SQLiteIntegrationTest(t)
+
+	// Setup Grafana and its Database
+	dir, p := testinfra.CreateGrafDir(t, testinfra.GrafanaOpts{
+		DisableLegacyAlerting: true,
+		EnableUnifiedAlerting: true,
+		DisableAnonymous:      true,
+		AppModeProduction:     true,
+	})
+
+	grafanaListedAddr, env := testinfra.StartGrafanaEnv(t, dir, p)
+
+	// Create a user to make authenticated requests
+	createUser(t, env.SQLStore, env.Cfg, user.CreateUserCommand{
+		DefaultOrgRole: string(org.RoleAdmin),
+		Password:       "admin",
+		Login:          "admin",
+	})
+
+	createUser(t, env.SQLStore, env.Cfg, user.CreateUserCommand{
+		DefaultOrgRole: string(org.RoleViewer),
+		Password:       "viewer",
+		Login:          "viewer",
+	})
+
+	apiClient := newAlertingApiClient(grafanaListedAddr, "admin", "admin")
+	viewerClient := newAlertingApiClient(grafanaListedAddr, "viewer", "viewer")
+
+	// Create the folder we'll save our alerts to
+	folderUID := util.GenerateShortUID()
+	apiClient.CreateFolder(t, folderUID, "folder1")
+
+	// Create multiple rule groups in the folder
+	group1 := generateAlertRuleGroup(2, alertRuleGen())
+	apiClient.PostRulesGroup(t, folderUID, &group1, false)
+	group2 := generateAlertRuleGroup(3, alertRuleGen())
+	apiClient.PostRulesGroup(t, folderUID, &group2, false)
+
+	t.Run("pause all rules in namespace", func(t *testing.T) {
+		req := &apimodels.UpdateNamespaceRulesRequest{
+			IsPaused: util.Pointer(true),
+		}
+		response, status, _ := apiClient.UpdateNamespaceRules(t, folderUID, req)
+		require.Equal(t, http.StatusAccepted, status)
+		assert.Equal(t, "rules updated successfully", response.Message)
+
+		// Verify all rules are now paused
+		allRules, status, _ := apiClient.GetAllRulesWithStatus(t)
+		require.Equal(t, http.StatusOK, status)
+		for _, group := range allRules[folderUID] {
+			for _, rule := range group.Rules {
+				assert.True(t, rule.GrafanaManagedAlert.IsPaused, "Rule should be paused")
+			}
+		}
+	})
+
+	t.Run("unpause all rules in namespace", func(t *testing.T) {
+		req := &apimodels.UpdateNamespaceRulesRequest{
+			IsPaused: util.Pointer(false),
+		}
+		response, status, _ := apiClient.UpdateNamespaceRules(t, folderUID, req)
+		require.Equal(t, http.StatusAccepted, status)
+		assert.Equal(t, "rules updated successfully", response.Message)
+
+		// Verify all rules are now unpaused
+		allRules, status, _ := apiClient.GetAllRulesWithStatus(t)
+		require.Equal(t, http.StatusOK, status)
+		for _, group := range allRules[folderUID] {
+			for _, rule := range group.Rules {
+				assert.False(t, rule.GrafanaManagedAlert.IsPaused, "Rule should be unpaused")
+			}
+		}
+	})
+
+	t.Run("returns 403 for non-existent folder", func(t *testing.T) {
+		req := &apimodels.UpdateNamespaceRulesRequest{
+			IsPaused: util.Pointer(false),
+		}
+		_, status, _ := apiClient.UpdateNamespaceRules(t, "non-existent-folder", req)
+		require.Equal(t, http.StatusForbidden, status)
+	})
+
+	t.Run("viewer cannot pause rules", func(t *testing.T) {
+		req := &apimodels.UpdateNamespaceRulesRequest{
+			IsPaused: util.Pointer(false),
+		}
+		_, status, _ := viewerClient.UpdateNamespaceRules(t, folderUID, req)
+		require.Equal(t, http.StatusForbidden, status)
+	})
+}

pkg/tests/api/alerting/testing.go

@@ -1280,6 +1280,38 @@ func (a apiClient) RawConvertPrometheusDeleteNamespace(t *testing.T, namespaceTi
 	return sendRequestJSON[apimodels.ConvertPrometheusResponse](t, req, http.StatusAccepted)
 }
 
+func (a apiClient) UpdateNamespaceRules(t *testing.T, folder string, body *apimodels.UpdateNamespaceRulesRequest) (apimodels.UpdateNamespaceRulesResponse, int, string) {
+	t.Helper()
+
+	client := &http.Client{}
+
+	buf := bytes.Buffer{}
+	enc := json.NewEncoder(&buf)
+	err := enc.Encode(body)
+	require.NoError(t, err)
+
+	u := fmt.Sprintf("%s/api/ruler/grafana/api/v1/rules/%s", a.url, folder)
+
+	req, err := http.NewRequest(http.MethodPatch, u, &buf)
+	req.Header.Set("Content-Type", "application/json")
+	if err != nil {
+		t.Fatalf("failed to create request: %v", err)
+	}
+
+	resp, err := client.Do(req)
+	require.NoError(t, err)
+	defer func() {
+		_ = resp.Body.Close()
+	}()
+	b, err := io.ReadAll(resp.Body)
+	require.NoError(t, err)
+	var m apimodels.UpdateNamespaceRulesResponse
+	if resp.StatusCode == http.StatusAccepted {
+		require.NoError(t, json.Unmarshal(b, &m))
+	}
+	return m, resp.StatusCode, string(b)
+}
+
 func sendRequestRaw(t *testing.T, req *http.Request) ([]byte, int, error) {
 	t.Helper()
 	client := &http.Client{}