fix(rdb): acl: add description field (#3683)

Author: Mia-Cross

cmd/scw/testdata/test-all-usage-rdb-acl-add-usage.golden

@@ -8,6 +8,7 @@ USAGE:
 ARGS:
   acl-rule-ips      IP addresses defined in the ACL rules of the Database Instance
   instance-id       ID of the Database Instance
+  [description]     Description of the ACL rule. Indexes are not yet supported so the description will be applied to all the rules of the command.
   [region=fr-par]   Region to target. If none is passed will use default region from the config
 
 FLAGS:

docs/commands/rdb.md

@@ -104,6 +104,7 @@ scw rdb acl add <acl-rule-ips ...> [arg=value ...]
 |------|---|-------------|
 | acl-rule-ips | Required | IP addresses defined in the ACL rules of the Database Instance |
 | instance-id | Required | ID of the Database Instance |
+| description |  | Description of the ACL rule. Indexes are not yet supported so the description will be applied to all the rules of the command. |
 | region | Default: `fr-par` | Region to target. If none is passed will use default region from the config |
 
 

internal/namespaces/rdb/v1/custom_acl.go

@@ -21,9 +21,10 @@ var (
 )
 
 type rdbACLCustomArgs struct {
-	Region     scw.Region
-	InstanceID string
-	ACLRuleIPs scw.IPNet
+	Region      scw.Region
+	InstanceID  string
+	ACLRuleIPs  scw.IPNet
+	Description string
 }
 
 type rdbACLCustomResult struct {
@@ -59,6 +60,12 @@ func aclAddBuilder(c *core.Command) *core.Command {
 			Required:   true,
 			Positional: false,
 		},
+		{
+			Name:       "description",
+			Short:      "Description of the ACL rule. Indexes are not yet supported so the description will be applied to all the rules of the command.",
+			Required:   false,
+			Positional: false,
+		},
 		core.RegionArgSpec(),
 	}
 
@@ -75,13 +82,18 @@ func aclAddBuilder(c *core.Command) *core.Command {
 		client := core.ExtractClient(ctx)
 		api := rdb.NewAPI(client)
 
+		description := args.Description
+		if description == "" {
+			description = fmt.Sprintf("Allow %s", args.ACLRuleIPs.String())
+		}
+
 		rule, err := api.AddInstanceACLRules(&rdb.AddInstanceACLRulesRequest{
 			Region:     args.Region,
 			InstanceID: args.InstanceID,
 			Rules: []*rdb.ACLRuleRequest{
 				{
 					IP:          args.ACLRuleIPs,
-					Description: fmt.Sprintf("Allow %s", args.ACLRuleIPs.String()),
+					Description: description,
 				},
 			},
 		}, scw.WithContext(ctx))

internal/namespaces/rdb/v1/custom_acl_test.go

@@ -20,6 +20,19 @@ func Test_AddACL(t *testing.T) {
 		AfterFunc: deleteInstance(),
 	}))
 
+	t.Run("Simple with description", core.Test(&core.TestConfig{
+		Commands:   GetCommands(),
+		BeforeFunc: createInstance("PostgreSQL-12"),
+		Cmd:        "scw rdb acl add 1.2.3.4 instance-id={{ .Instance.ID }} description=some-unique-description --wait",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			func(t *testing.T, ctx *core.CheckFuncCtx) {
+				verifyACL(ctx, t, []string{"0.0.0.0/0", "1.2.3.4/32"})
+			},
+		),
+		AfterFunc: deleteInstance(),
+	}))
+
 	t.Run("Multiple", core.Test(&core.TestConfig{
 		Commands:   GetCommands(),
 		BeforeFunc: createInstance("PostgreSQL-12"),
@@ -32,6 +45,19 @@ func Test_AddACL(t *testing.T) {
 		),
 		AfterFunc: deleteInstance(),
 	}))
+
+	t.Run("Multiple with description", core.Test(&core.TestConfig{
+		Commands:   GetCommands(),
+		BeforeFunc: createInstance("PostgreSQL-12"),
+		Cmd:        "scw rdb acl add 1.2.3.4 192.168.1.0/30 10.10.10.10 instance-id={{ .Instance.ID }} description=some-unique-description --wait",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			func(t *testing.T, ctx *core.CheckFuncCtx) {
+				verifyACL(ctx, t, []string{"0.0.0.0/0", "1.2.3.4/32", "192.168.1.0/30", "10.10.10.10/32"})
+			},
+		),
+		AfterFunc: deleteInstance(),
+	}))
 }
 
 func Test_DeleteACL(t *testing.T) {