feat(rdb): add endpoints management (#3582)

Author: Mia-Cross

cmd/scw/testdata/test-all-usage-rdb-endpoint-create-usage.golden

@@ -3,16 +3,19 @@
 Create a new endpoint for a Database Instance. You can add `load_balancer` and `private_network` specifications to the body of the request.
 
 USAGE:
-  scw rdb endpoint create [arg=value ...]
+  scw rdb endpoint create <instance-id ...> [arg=value ...]
 
 ARGS:
-  instance-id                                          UUID of the Database Instance you to which you want to add an endpoint
-  [endpoint-spec.private-network.private-network-id]   UUID of the Private Network to be connected to the Database Instance
-  [endpoint-spec.private-network.service-ip]           Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.
-  [region=fr-par]                                      Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  instance-id                            UUID of the Database Instance to which you want to add an endpoint
+  [private-network.private-network-id]   UUID of the Private Network to be connected to the Database Instance
+  [private-network.service-ip]           Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations.
+  [private-network.enable-ipam=true]     Will configure your Private Network endpoint with Scaleway IPAM service if true
+  [load-balancer=true]                   Will configure a public Load-Balancer endpoint
+  [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 create
+  -w, --wait   wait until the endpoint is ready
 
 GLOBAL FLAGS:
   -c, --config string    The path to the config file

cmd/scw/testdata/test-all-usage-rdb-endpoint-delete-usage.golden

@@ -3,14 +3,16 @@
 Delete the endpoint of a Database Instance. You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint.
 
 USAGE:
-  scw rdb endpoint delete [arg=value ...]
+  scw rdb endpoint delete <endpoint-id ...> [arg=value ...]
 
 ARGS:
+  instance-id       UUID of the Database Instance from which you want to delete an endpoint
   endpoint-id       UUID of the endpoint you want to delete
   [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 delete
+  -w, --wait   wait until the endpoint is ready
 
 GLOBAL FLAGS:
   -c, --config string    The path to the config file

cmd/scw/testdata/test-all-usage-rdb-endpoint-get-usage.golden

@@ -3,7 +3,7 @@
 Retrieve information about a Database Instance endpoint. Full details about the endpoint, like `ip`, `port`, `private_network` and `load_balancer` specifications are returned in the response.
 
 USAGE:
-  scw rdb endpoint get [arg=value ...]
+  scw rdb endpoint get <endpoint-id ...> [arg=value ...]
 
 ARGS:
   endpoint-id       UUID of the endpoint you want to get

cmd/scw/testdata/test-all-usage-rdb-endpoint-list-usage.golden

@@ -0,0 +1,18 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+Lists all public and private endpoints of a Database Instance
+
+USAGE:
+  scw rdb endpoint list <instance-id ...> [arg=value ...]
+
+ARGS:
+  instance-id   ID of the Database Instance
+
+FLAGS:
+  -h, --help   help for list
+
+GLOBAL FLAGS:
+  -c, --config string    The path to the config file
+  -D, --debug            Enable debug mode
+  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
+  -p, --profile string   The config profile to use

cmd/scw/testdata/test-all-usage-rdb-endpoint-usage.golden

@@ -15,6 +15,7 @@ AVAILABLE COMMANDS:
   create      Create a new Database Instance endpoint
   delete      Delete a Database Instance endpoint
   get         Get a Database Instance endpoint
+  list        Lists a Database Instance's endpoints
   migrate     Migrate an existing instance endpoint to another instance
 
 FLAGS:

docs/commands/rdb.md

@@ -27,6 +27,7 @@ Managed Database for PostgreSQL and MySQL API
   - [Create a new Database Instance endpoint](#create-a-new-database-instance-endpoint)
   - [Delete a Database Instance endpoint](#delete-a-database-instance-endpoint)
   - [Get a Database Instance endpoint](#get-a-database-instance-endpoint)
+  - [Lists a Database Instance's endpoints](#lists-a-database-instance's-endpoints)
   - [Migrate an existing instance endpoint to another instance](#migrate-an-existing-instance-endpoint-to-another-instance)
 - [Database engines commands](#database-engines-commands)
   - [List available database engines](#list-available-database-engines)
@@ -520,17 +521,19 @@ Create a new endpoint for a Database Instance. You can add `load_balancer` and `
 **Usage:**
 
 ```
-scw rdb endpoint create [arg=value ...]
+scw rdb endpoint create <instance-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| instance-id | Required | UUID of the Database Instance you to which you want to add an endpoint |
-| endpoint-spec.private-network.private-network-id |  | UUID of the Private Network to be connected to the Database Instance |
-| endpoint-spec.private-network.service-ip |  | Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. |
+| instance-id | Required | UUID of the Database Instance to which you want to add an endpoint |
+| private-network.private-network-id |  | UUID of the Private Network to be connected to the Database Instance |
+| private-network.service-ip |  | Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. |
+| private-network.enable-ipam | Default: `true` | Will configure your Private Network endpoint with Scaleway IPAM service if true |
+| load-balancer | Default: `true` | Will configure a public Load-Balancer endpoint |
 | 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 |
 
 
@@ -542,14 +545,15 @@ Delete the endpoint of a Database Instance. You must specify the `region` and `e
 **Usage:**
 
 ```
-scw rdb endpoint delete [arg=value ...]
+scw rdb endpoint delete <endpoint-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
+| instance-id | Required | UUID of the Database Instance from which you want to delete an endpoint |
 | endpoint-id | Required | UUID of the endpoint you want to delete |
 | 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 |
 
@@ -562,7 +566,7 @@ Retrieve information about a Database Instance endpoint. Full details about the
 **Usage:**
 
 ```
-scw rdb endpoint get [arg=value ...]
+scw rdb endpoint get <endpoint-id ...> [arg=value ...]
 ```
 
 
@@ -575,6 +579,25 @@ scw rdb endpoint get [arg=value ...]
 
 
 
+### Lists a Database Instance's endpoints
+
+Lists all public and private endpoints of a Database Instance
+
+**Usage:**
+
+```
+scw rdb endpoint list <instance-id ...> [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| instance-id | Required | ID of the Database Instance |
+
+
+
 ### Migrate an existing instance endpoint to another instance
 
 Migrate an existing instance endpoint to another instance.

internal/namespaces/rdb/v1/custom.go

@@ -14,7 +14,7 @@ func GetCommands() *core.Commands {
 	human.RegisterMarshalerFunc(backupDownloadResult{}, backupResultMarshallerFunc)
 	human.RegisterMarshalerFunc(createInstanceResult{}, createInstanceResultMarshalerFunc)
 	human.RegisterMarshalerFunc(rdbACLCustomResult{}, rdbACLCustomResultMarshalerFunc)
-	human.RegisterMarshalerFunc(core.MultiResults{}, rdbACLCustomMultiResultMarshalerFunc)
+	human.RegisterMarshalerFunc(rdbEndpointCustomResult{}, rdbEndpointCustomResultMarshalerFunc)
 	human.RegisterMarshalerFunc(rdb.DatabaseBackup{}, backupExportDisplayBuilder)
 
 	human.RegisterMarshalerFunc(rdb.InstanceStatus(""), human.EnumMarshalFunc(instanceStatusMarshalSpecs))
@@ -24,35 +24,40 @@ func GetCommands() *core.Commands {
 	human.RegisterMarshalerFunc(rdb.ACLRuleAction(""), human.EnumMarshalFunc(aclRuleActionMarshalSpecs))
 
 	cmds.Merge(core.NewCommands(
-		instanceWaitCommand(),
-		instanceConnectCommand(),
-		backupWaitCommand(),
+		aclEditCommand(),
 		backupDownloadCommand(),
+		backupWaitCommand(),
+		databaseGetURLCommand(),
+		endpointListCommand(),
 		engineSettingsCommand(),
-		aclEditCommand(),
+		instanceConnectCommand(),
+		instanceWaitCommand(),
 		userGetURLCommand(),
-		databaseGetURLCommand(),
 	))
 	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)
-	cmds.MustFind("rdb", "backup", "restore").Override(backupRestoreBuilder)
 	cmds.MustFind("rdb", "backup", "list").Override(backupListBuilder)
+	cmds.MustFind("rdb", "backup", "restore").Override(backupRestoreBuilder)
+
+	cmds.MustFind("rdb", "endpoint", "create").Override(endpointCreateBuilder)
+	cmds.MustFind("rdb", "endpoint", "delete").Override(endpointDeleteBuilder)
+	cmds.MustFind("rdb", "endpoint", "get").Override(endpointGetBuilder)
+
+	cmds.MustFind("rdb", "engine", "list").Override(engineListBuilder)
 
 	cmds.MustFind("rdb", "instance", "create").Override(instanceCreateBuilder)
 	cmds.MustFind("rdb", "instance", "clone").Override(instanceCloneBuilder)
-	cmds.MustFind("rdb", "instance", "upgrade").Override(instanceUpgradeBuilder)
-	cmds.MustFind("rdb", "instance", "update").Override(instanceUpdateBuilder)
-	cmds.MustFind("rdb", "instance", "get").Override(instanceGetBuilder)
 	cmds.MustFind("rdb", "instance", "delete").Override(instanceDeleteBuilder)
+	cmds.MustFind("rdb", "instance", "get").Override(instanceGetBuilder)
+	cmds.MustFind("rdb", "instance", "update").Override(instanceUpdateBuilder)
+	cmds.MustFind("rdb", "instance", "upgrade").Override(instanceUpgradeBuilder)
 
-	cmds.MustFind("rdb", "engine", "list").Override(engineListBuilder)
-
-	cmds.MustFind("rdb", "user", "list").Override(userListBuilder)
 	cmds.MustFind("rdb", "user", "create").Override(userCreateBuilder)
+	cmds.MustFind("rdb", "user", "list").Override(userListBuilder)
 	cmds.MustFind("rdb", "user", "update").Override(userUpdateBuilder)
 
 	cmds.MustFind("rdb", "log", "prepare").Override(logPrepareBuilder)

internal/namespaces/rdb/v1/custom_acl.go

@@ -44,31 +44,6 @@ func rdbACLCustomResultMarshalerFunc(i interface{}, opt *human.MarshalOpt) (stri
 	return messageStr + "\n" + aclStr, nil
 }
 
-func rdbACLCustomMultiResultMarshalerFunc(i interface{}, opt *human.MarshalOpt) (string, error) {
-	results := i.(core.MultiResults)
-	switch results[0].(type) {
-	case *rdbACLCustomResult:
-		finalMessage := ""
-		for _, result := range results {
-			aclResult := result.(*rdbACLCustomResult)
-			messageStr, err := aclResult.Success.MarshalHuman()
-			if err != nil {
-				return "", err
-			}
-			finalMessage += messageStr + "\n"
-		}
-
-		aclStr, err := human.Marshal(results[len(results)-1].(*rdbACLCustomResult).Rules, opt)
-		if err != nil {
-			return "", err
-		}
-		return finalMessage + aclStr, nil
-
-	default:
-		return "", nil
-	}
-}
-
 func aclAddBuilder(c *core.Command) *core.Command {
 	c.ArgsType = reflect.TypeOf(rdbACLCustomArgs{})
 	c.ArgSpecs = core.ArgSpecs{