Add command to delete the specified rule namespace (#8) (#8)

Signed-off-by: songjiayang <[email protected]>

Author: songjiayang

CHANGELOG.md

@@ -12,6 +12,7 @@ Order should be `CHANGE`, `FEATURE`, `ENHANCEMENT`, and `BUGFIX`
 * [CHANGE] Match prometheus/prometheus with version used by cortex v1.11.1 #5
 * [CHANGE] Remove loki support #7
 * [FEATURE] Support Arm64 on Darwin for all binaries (benchtool etc). #215
+* [FEATURE] Add `cortextool rules delete-namespace` command to delete the specified rule namespace. #8
 * [BUGFIX] Fix `cortextool rules` legends displaying wrong symbols for updates and deletions. #226
 
 ## v0.10.7

README.md

@@ -78,6 +78,12 @@ This command will delete the specified rule group from the specified namespace.
 
     cortextool rules delete example_namespace example_rule_group
 
+##### Rule Namespace Delete
+
+This command will delete the specified rule namespace.
+
+    cortextool rules delete-namespace example_namespace
+
 ##### Rules Load
 
 This command will load each rule group in the specified files and load them into Cortex. If a rule already exists in Cortex it will be overwritten, if a diff is found.

pkg/client/rules.go

@@ -33,7 +33,7 @@ func (r *CortexClient) CreateRuleGroup(ctx context.Context, namespace string, rg
 	return nil
 }
 
-// DeleteRuleGroup creates a new rule group
+// DeleteRuleGroup deletes a rule group
 func (r *CortexClient) DeleteRuleGroup(ctx context.Context, namespace, groupName string) error {
 	escapedNamespace := url.PathEscape(namespace)
 	escapedGroupName := url.PathEscape(groupName)
@@ -49,6 +49,21 @@ func (r *CortexClient) DeleteRuleGroup(ctx context.Context, namespace, groupName
 	return nil
 }
 
+// DeleteRuleNamespace deletes a rule namespace
+func (r *CortexClient) DeleteRuleNamespace(ctx context.Context, namespace string) error {
+	escapedNamespace := url.PathEscape(namespace)
+	path := r.apiPath + "/" + escapedNamespace
+
+	res, err := r.doRequest(path, "DELETE", nil)
+	if err != nil {
+		return err
+	}
+
+	res.Body.Close()
+
+	return nil
+}
+
 // GetRuleGroup retrieves a rule group
 func (r *CortexClient) GetRuleGroup(ctx context.Context, namespace, groupName string) (*rwrulefmt.RuleGroup, error) {
 	escapedNamespace := url.PathEscape(namespace)

pkg/client/rules_test.go

@@ -2,20 +2,18 @@ package client
 
 import (
 	"context"
-	"fmt"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 
 	"github.com/stretchr/testify/require"
 )
 
-func TestCortexClient_X(t *testing.T) {
+func TestCortexClient_DeleteRuleGroup(t *testing.T) {
 	requestCh := make(chan *http.Request, 1)
 
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		requestCh <- r
-		fmt.Fprintln(w, "hello")
 	}))
 	defer ts.Close()
 
@@ -57,7 +55,7 @@ func TestCortexClient_X(t *testing.T) {
 			expURLPath: "/api/v1/rules/My%2FNamespace/%2Ffirst-char-slash",
 		},
 		{
-			test:       "special-characters-slash-first",
+			test:       "special-characters-slash-last",
 			namespace:  "My/Namespace",
 			name:       "last-char-slash/",
 			expURLPath: "/api/v1/rules/My%2FNamespace/last-char-slash%2F",
@@ -69,7 +67,65 @@ func TestCortexClient_X(t *testing.T) {
 
 			req := <-requestCh
 			require.Equal(t, tc.expURLPath, req.URL.EscapedPath())
+			require.Equal(t, http.MethodDelete, req.Method)
+		})
+	}
+
+}
+
+func TestCortexClient_DeleteRuleNamespace(t *testing.T) {
+	requestCh := make(chan *http.Request, 1)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		requestCh <- r
+	}))
+	defer ts.Close()
 
+	client, err := New(Config{
+		Address: ts.URL,
+		ID:      "my-id",
+		Key:     "my-key",
+	})
+	require.NoError(t, err)
+
+	for _, tc := range []struct {
+		test       string
+		namespace  string
+		expURLPath string
+	}{
+		{
+			test:       "regular-characters",
+			namespace:  "my-namespace",
+			expURLPath: "/api/v1/rules/my-namespace",
+		},
+		{
+			test:       "special-characters-spaces",
+			namespace:  "My: Namespace",
+			expURLPath: "/api/v1/rules/My:%20Namespace",
+		},
+		{
+			test:       "special-characters-slashes",
+			namespace:  "My/Namespace",
+			expURLPath: "/api/v1/rules/My%2FNamespace",
+		},
+		{
+			test:       "special-characters-slash-first",
+			namespace:  "/My/Namespace",
+			expURLPath: "/api/v1/rules/%2FMy%2FNamespace",
+		},
+		{
+			test:       "special-characters-slash-last",
+			namespace:  "My/Namespace/",
+			expURLPath: "/api/v1/rules/My%2FNamespace%2F",
+		},
+	} {
+		t.Run(tc.test, func(t *testing.T) {
+			ctx := context.Background()
+			require.NoError(t, client.DeleteRuleNamespace(ctx, tc.namespace))
+
+			req := <-requestCh
+			require.Equal(t, tc.expURLPath, req.URL.EscapedPath())
+			require.Equal(t, http.MethodDelete, req.Method)
 		})
 	}
 

pkg/commands/rules.go

@@ -103,6 +103,9 @@ func (r *RuleCommand) Register(app *kingpin.Application) {
 	deleteRuleGroupCmd := rulesCmd.
 		Command("delete", "Delete a rulegroup from the ruler.").
 		Action(r.deleteRuleGroup)
+	deleteRuleNamespaceCmd := rulesCmd.
+		Command("delete-namespace", "Delete a namespace from the ruler.").
+		Action(r.deleteRuleNamespace)
 	loadRulesCmd := rulesCmd.
 		Command("load", "load a set of rules to a designated cortex endpoint").
 		Action(r.loadRules)
@@ -123,7 +126,7 @@ func (r *RuleCommand) Register(app *kingpin.Application) {
 		Action(r.checkRecordingRuleNames)
 
 	// Require Cortex cluster address and tentant ID on all these commands
-	for _, c := range []*kingpin.CmdClause{listCmd, printRulesCmd, getRuleGroupCmd, deleteRuleGroupCmd, loadRulesCmd, diffRulesCmd, syncRulesCmd} {
+	for _, c := range []*kingpin.CmdClause{listCmd, printRulesCmd, getRuleGroupCmd, deleteRuleGroupCmd, deleteRuleNamespaceCmd, loadRulesCmd, diffRulesCmd, syncRulesCmd} {
 		c.Flag("address", "Address of the cortex cluster, alternatively set CORTEX_ADDRESS.").
 			Envar("CORTEX_ADDRESS").
 			Required().
@@ -168,6 +171,9 @@ func (r *RuleCommand) Register(app *kingpin.Application) {
 	deleteRuleGroupCmd.Arg("namespace", "Namespace of the rulegroup to delete.").Required().StringVar(&r.Namespace)
 	deleteRuleGroupCmd.Arg("group", "Name of the rulegroup ot delete.").Required().StringVar(&r.RuleGroup)
 
+	// Delete Rule Namespace Command
+	deleteRuleNamespaceCmd.Arg("namespace", "Namespace of the rule to delete.").Required().StringVar(&r.Namespace)
+
 	// Load Rules Command
 	loadRulesCmd.Arg("rule-files", "The rule files to check.").Required().ExistingFilesVar(&r.RuleFilesList)
 
@@ -367,6 +373,14 @@ func (r *RuleCommand) deleteRuleGroup(k *kingpin.ParseContext) error {
 	return nil
 }
 
+func (r *RuleCommand) deleteRuleNamespace(k *kingpin.ParseContext) error {
+	err := r.cli.DeleteRuleNamespace(context.Background(), r.Namespace)
+	if err != nil && err != client.ErrResourceNotFound {
+		log.Fatalf("unable to delete namespace from cortex, %v", err)
+	}
+	return nil
+}
+
 func (r *RuleCommand) loadRules(k *kingpin.ParseContext) error {
 	nss, err := rules.ParseFiles(r.RuleFilesList)
 	if err != nil {