feat(rdb): acl: set with generated args + lint

Author: Mia-Cross

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

@@ -3,12 +3,13 @@
 Replace all the ACL rules of a Database Instance.
 
 USAGE:
-  scw rdb acl set <acl-rule-ips ...> [arg=value ...]
+  scw rdb acl set [arg=value ...]
 
 ARGS:
-  acl-rule-ips      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
+  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)
 
 FLAGS:
   -h, --help   help for set

docs/commands/rdb.md

@@ -175,17 +175,18 @@ Replace all the ACL rules of a Database Instance.
 **Usage:**
 
 ```
-scw rdb acl set <acl-rule-ips ...> [arg=value ...]
+scw rdb acl set [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| acl-rule-ips | Required | 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 |
+| 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 |
 
 
 

internal/namespaces/rdb/v1/custom.go

@@ -32,6 +32,7 @@ func GetCommands() *core.Commands {
 	))
 	cmds.MustFind("rdb", "acl", "add").Override(aclAddBuilder)
 	cmds.MustFind("rdb", "acl", "delete").Override(aclDeleteBuilder)
+	cmds.MustFind("rdb", "acl", "set").Override(aclSetBuilder)
 
 	cmds.MustFind("rdb", "backup", "create").Override(backupCreateBuilder)
 	cmds.MustFind("rdb", "backup", "export").Override(backupExportBuilder)

internal/namespaces/rdb/v1/custom_acl.go

@@ -50,7 +50,6 @@ func rdbACLCustomMultiResultMarshalerFunc(i interface{}, opt *human.MarshalOpt)
 	case *rdbACLCustomResult:
 		finalMessage := ""
 		for _, result := range results {
-
 			aclResult := result.(*rdbACLCustomResult)
 			messageStr, err := aclResult.Success.MarshalHuman()
 			if err != nil {
@@ -224,7 +223,6 @@ func aclDeleteBuilder(c *core.Command) *core.Command {
 				Message: message,
 			},
 		}, nil
-
 	}
 
 	c.WaitFunc = func(ctx context.Context, argsI, respI interface{}) (interface{}, error) {
@@ -248,52 +246,26 @@ func aclDeleteBuilder(c *core.Command) *core.Command {
 }
 
 func aclSetBuilder(c *core.Command) *core.Command {
-	c.ArgsType = reflect.TypeOf(rdbACLCustomArgs{})
-	c.ArgSpecs = core.ArgSpecs{
-		{
-			Name:       "acl-rule-ips",
-			Short:      "IP addresses defined in the ACL rules of the Database Instance",
-			Required:   true,
-			Positional: true,
-		},
-		{
-			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.(*rdbACLCustomArgs)
+		args := argsI.(*rdb.SetInstanceACLRulesRequest)
 		client := core.ExtractClient(ctx)
 		api := rdb.NewAPI(client)
 
-		rule, err := api.SetInstanceACLRules(&rdb.SetInstanceACLRulesRequest{
-			Region:     args.Region,
-			InstanceID: args.InstanceID,
-			Rules: []*rdb.ACLRuleRequest{
-				{
-					IP:          args.ACLRuleIPs,
-					Description: fmt.Sprintf("Allow %s", args.ACLRuleIPs.String()),
-				},
-			},
-		}, scw.WithContext(ctx))
+		rule, err := api.SetInstanceACLRules(args, scw.WithContext(ctx))
 		if err != nil {
 			return nil, fmt.Errorf("failed to set ACL rule: %w", err)
 		}
 
 		return &rdbACLCustomResult{
 			Rules: rule.Rules,
 			Success: core.SuccessResult{
-				Message: fmt.Sprintf("ACL rules successfully set"),
+				Message: "ACL rules successfully set",
 			},
 		}, nil
 	}
 
 	c.WaitFunc = func(ctx context.Context, argsI, respI interface{}) (interface{}, error) {
-		args := argsI.(*rdbACLCustomArgs)
+		args := argsI.(*rdb.SetInstanceACLRulesRequest)
 		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 1.2.3.4 instance-id={{ .Instance.ID }} --wait",
+		Cmd:        "scw rdb acl set rules.0.ip=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 1.2.3.4 192.168.1.0/31 11.11.11.11 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",
 		Check: core.TestCheckCombine(
 			core.TestCheckGolden(),
 			func(t *testing.T, ctx *core.CheckFuncCtx) {