feat(rdb): acl: set with custom args but not positional yet

Author: Mia-Cross

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

@@ -6,10 +6,9 @@ USAGE:
   scw rdb acl set [arg=value ...]
 
 ARGS:
-  instance-id                   UUID of the Database Instance where the ACL rules must be set
-  [rules.{index}.ip]            
-  [rules.{index}.description]   
-  [region=fr-par]               Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  [acl-rule-ips.{index}]   IP addresses defined in the ACL rules of the Database Instance
+  instance-id              ID of the Database Instance
+  [region=fr-par]          Region to target. If none is passed will use default region from the config
 
 FLAGS:
   -h, --help   help for set

docs/commands/rdb.md

@@ -185,10 +185,9 @@ scw rdb acl set [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| instance-id | Required | UUID of the Database Instance where the ACL rules must be set |
-| rules.{index}.ip |  |  |
-| rules.{index}.description |  |  |
-| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
+| acl-rule-ips.{index} |  | IP addresses defined in the ACL rules of the Database Instance |
+| instance-id | Required | ID of the Database Instance |
+| 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

@@ -245,13 +245,48 @@ func aclDeleteBuilder(c *core.Command) *core.Command {
 	return c
 }
 
+type rdbACLSetCustomArgs struct {
+	Region      scw.Region
+	InstanceID  string
+	ACLRulesIPs []scw.IPNet
+}
+
 func aclSetBuilder(c *core.Command) *core.Command {
+	c.ArgsType = reflect.TypeOf(rdbACLSetCustomArgs{})
+	c.ArgSpecs = core.ArgSpecs{
+		{
+			Name:       "acl-rule-ips.{index}",
+			Short:      "IP addresses defined in the ACL rules of the Database Instance",
+			Required:   false,
+			Positional: false,
+		},
+		{
+			Name:       "instance-id",
+			Short:      "ID of the Database Instance",
+			Required:   true,
+			Positional: false,
+		},
+		core.RegionArgSpec(),
+	}
+
 	c.Run = func(ctx context.Context, argsI interface{}) (i interface{}, e error) {
-		args := argsI.(*rdb.SetInstanceACLRulesRequest)
+		args := argsI.(*rdbACLSetCustomArgs)
 		client := core.ExtractClient(ctx)
 		api := rdb.NewAPI(client)
 
-		rule, err := api.SetInstanceACLRules(args, scw.WithContext(ctx))
+		aclRules := []*rdb.ACLRuleRequest(nil)
+		for _, ip := range args.ACLRulesIPs {
+			aclRules = append(aclRules, &rdb.ACLRuleRequest{
+				IP:          ip,
+				Description: fmt.Sprintf("Allow %s", ip.String()),
+			})
+		}
+
+		rule, err := api.SetInstanceACLRules(&rdb.SetInstanceACLRulesRequest{
+			Region:     args.Region,
+			InstanceID: args.InstanceID,
+			Rules:      aclRules,
+		}, scw.WithContext(ctx))
 		if err != nil {
 			return nil, fmt.Errorf("failed to set ACL rule: %w", err)
 		}
@@ -265,7 +300,7 @@ func aclSetBuilder(c *core.Command) *core.Command {
 	}
 
 	c.WaitFunc = func(ctx context.Context, argsI, respI interface{}) (interface{}, error) {
-		args := argsI.(*rdb.SetInstanceACLRulesRequest)
+		args := argsI.(*rdbACLSetCustomArgs)
 		api := rdb.NewAPI(core.ExtractClient(ctx))
 
 		_, err := api.WaitForInstance(&rdb.WaitForInstanceRequest{

internal/namespaces/rdb/v1/custom_acl_test.go

@@ -85,7 +85,7 @@ func Test_SetACL(t *testing.T) {
 	t.Run("Simple", core.Test(&core.TestConfig{
 		Commands:   GetCommands(),
 		BeforeFunc: createInstance("PostgreSQL-12"),
-		Cmd:        "scw rdb acl set rules.0.ip=1.2.3.4 instance-id={{ .Instance.ID }} --wait",
+		Cmd:        "scw rdb acl set acl-rule-ips.0=1.2.3.4 instance-id={{ .Instance.ID }} --wait",
 		Check: core.TestCheckCombine(
 			core.TestCheckGolden(),
 			func(t *testing.T, ctx *core.CheckFuncCtx) {
@@ -101,7 +101,7 @@ func Test_SetACL(t *testing.T) {
 			createInstance("PostgreSQL-12"),
 			core.ExecBeforeCmd("scw rdb acl add 1.2.3.4 192.168.1.0/32 10.10.10.10 instance-id={{ .Instance.ID }} --wait"),
 		),
-		Cmd: "scw rdb acl set rules.0.ip=1.2.3.4 rules.1.ip=192.168.1.0/31 rules.2.ip=11.11.11.11 instance-id={{ .Instance.ID }} --wait",
+		Cmd: "scw rdb acl set acl-rule-ips.0=1.2.3.4 acl-rule-ips.1=192.168.1.0/31 acl-rule-ips.2=11.11.11.11 instance-id={{ .Instance.ID }} --wait",
 		Check: core.TestCheckCombine(
 			core.TestCheckGolden(),
 			func(t *testing.T, ctx *core.CheckFuncCtx) {

internal/namespaces/rdb/v1/testdata/test-set-acl-multiple.cassette.yaml

@@ -1,40 +1,12 @@
-🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
-🟩🟩🟩 STDOUT️ 🟩🟩🟩️
-✅ ACL rules successfully set.
-IP              PORT   PROTOCOL  DIRECTION  ACTION  DESCRIPTION
-1.2.3.4/32      13729  tcp       inbound    allow   IP allowed
-11.11.11.11/32  13729  tcp       inbound    allow   IP allowed
-192.168.1.0/31  13729  tcp       inbound    allow   IP allowed
-🟩🟩🟩 JSON STDOUT 🟩🟩🟩
+🎲🎲🎲 EXIT CODE: 1 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Unknown argument 'acl-rule-ips.0'
+
+Hint:
+Valid arguments are: acl-rule-ips.{index}, instance-id, region
+🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "Rules": [
-    {
-      "ip": "1.2.3.4/32",
-      "port": 13729,
-      "protocol": "tcp",
-      "direction": "inbound",
-      "action": "allow",
-      "description": "IP allowed"
-    },
-    {
-      "ip": "11.11.11.11/32",
-      "port": 13729,
-      "protocol": "tcp",
-      "direction": "inbound",
-      "action": "allow",
-      "description": "IP allowed"
-    },
-    {
-      "ip": "192.168.1.0/31",
-      "port": 13729,
-      "protocol": "tcp",
-      "direction": "inbound",
-      "action": "allow",
-      "description": "IP allowed"
-    }
-  ],
-  "Success": {
-    "message": "ACL rules successfully set",
-    "details": ""
-  }
+  "message": "unknown argument 'acl-rule-ips.0'",
+  "error": {},
+  "hint": "Valid arguments are: acl-rule-ips.{index}, instance-id, region"
 }