feat(rdb) add verb settings to namespace rdb engine (#2548)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Nathanael Demacon <nathanael.dmc@outlook.fr>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Scaleway Bot <github@scaleway.com>
Co-authored-by: Rémy Léone <rleone@scaleway.com>
Co-authored-by: Jules Castéran <jcasteran@scaleway.com>

Author: 6 people

cmd/scw/testdata/test-all-usage-rdb-engine-settings-usage.golden

@@ -0,0 +1,24 @@
+🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
+🟥🟥🟥 STDERR️️ 🟥🟥🟥️
+List available settings from an engine.
+
+USAGE:
+  scw rdb engine settings [arg=value ...]
+
+EXAMPLES:
+  List Engine Settings
+    scw rdb engine settings name=MySQL version=8
+
+ARGS:
+  name              The name of your engine where you want list the available settings.
+  version           The version of the engine.
+  [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 settings
+
+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-engine-usage.golden

@@ -7,6 +7,7 @@ USAGE:
 
 AVAILABLE COMMANDS:
   list        List available database engines
+  settings    List available settings from an engine.
 
 FLAGS:
   -h, --help   help for engine

docs/commands/rdb.md

@@ -22,6 +22,7 @@ Database RDB API
   - [List all database in a given instance](#list-all-database-in-a-given-instance)
 - [Database engines commands](#database-engines-commands)
   - [List available database engines](#list-available-database-engines)
+  - [List available settings from an engine.](#list-available-settings-from-an-engine.)
 - [Instance management commands](#instance-management-commands)
   - [Clone an instance](#clone-an-instance)
   - [Connect to an instance using locally installed CLI](#connect-to-an-instance-using-locally-installed-cli)
@@ -452,6 +453,37 @@ scw rdb engine list [arg=value ...]
 
 
 
+### List available settings from an engine.
+
+List available settings from an engine.
+
+**Usage:**
+
+```
+scw rdb engine settings [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| name | Required | The name of your engine where you want list the available settings. |
+| version | Required | The version of the engine. |
+| 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 |
+
+
+**Examples:**
+
+
+List Engine Settings
+```
+scw rdb engine settings name=MySQL version=8
+```
+
+
+
+
 ## Instance management commands
 
 A Database Instance is composed of one or more Nodes, depending of the is_ha_cluster setting. Autohealing is enabled by default for HA clusters. Database automated backup is enabled by default in order to prevent data loss.

internal/namespaces/rdb/v1/custom.go

@@ -36,6 +36,7 @@ func GetCommands() *core.Commands {
 		instanceConnectCommand(),
 		backupWaitCommand(),
 		backupDownloadCommand(),
+		engineSettingsCommand(),
 	))
 	cmds.MustFind("rdb", "acl", "add").Override(aclAddBuilder)
 	cmds.MustFind("rdb", "acl", "delete").Override(aclDeleteBuilder)
@@ -46,7 +47,6 @@ func GetCommands() *core.Commands {
 
 	cmds.MustFind("rdb", "instance", "create").Override(instanceCreateBuilder)
 	cmds.MustFind("rdb", "instance", "clone").Override(instanceCloneBuilder)
-	cmds.MustFind("rdb", "instance", "create").Override(instanceCreateBuilder)
 	cmds.MustFind("rdb", "instance", "upgrade").Override(instanceUpgradeBuilder)
 	cmds.MustFind("rdb", "instance", "update").Override(instanceUpdateBuilder)
 

internal/namespaces/rdb/v1/custom_engine_settings.go

@@ -0,0 +1,72 @@
+package rdb
+
+import (
+	"context"
+	"reflect"
+
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+	"github.com/scaleway/scaleway-sdk-go/api/rdb/v1"
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+func engineSettingsCommand() *core.Command {
+	type engineSettingsArgs struct {
+		Name    string
+		Version string
+		Region  scw.Region
+	}
+
+	return &core.Command{
+		Short:     `List available settings from an engine.`,
+		Long:      `List available settings from an engine.`,
+		Namespace: "rdb",
+		Resource:  "engine",
+		Verb:      "settings",
+		ArgsType:  reflect.TypeOf(engineSettingsArgs{}),
+		Run: func(ctx context.Context, argsI interface{}) (i interface{}, err error) {
+			args := argsI.(*engineSettingsArgs)
+			api := rdb.NewAPI(core.ExtractClient(ctx))
+
+			databaseEnginesRequest := &rdb.ListDatabaseEnginesRequest{
+				Region:  args.Region,
+				Name:    &args.Name,
+				Version: &args.Version,
+			}
+
+			engines, err := api.ListDatabaseEngines(databaseEnginesRequest)
+			if err != nil {
+				return nil, err
+			}
+
+			var responseEngineSettings []*rdb.EngineSetting
+			for _, e := range engines.Engines {
+				for _, ev := range e.Versions {
+					if ev.Version == args.Version {
+						responseEngineSettings = ev.AvailableSettings
+					}
+				}
+			}
+
+			return responseEngineSettings, nil
+		},
+		ArgSpecs: core.ArgSpecs{
+			{
+				Name:     "name",
+				Short:    `The name of your engine where you want list the available settings.`,
+				Required: true,
+			},
+			{
+				Name:     "version",
+				Required: true,
+				Short:    "The version of the engine.",
+			},
+			core.RegionArgSpec(scw.RegionFrPar, scw.RegionNlAms, scw.RegionPlWaw),
+		},
+		Examples: []*core.Example{
+			{
+				Short:    "List Engine Settings",
+				ArgsJSON: `{"name": "MySQL", "version": "8"}`,
+			},
+		},
+	}
+}

internal/namespaces/rdb/v1/custom_engine_settings_test.go

@@ -0,0 +1,27 @@
+package rdb
+
+import (
+	"testing"
+
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+)
+
+func Test_ListEngineSettings(t *testing.T) {
+	t.Run("Simple", core.Test(&core.TestConfig{
+		Commands: GetCommands(),
+		Cmd:      "scw rdb engine settings name=MySQL version=8",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			core.TestCheckExitCode(0),
+		),
+	}))
+
+	t.Run("Lowercase", core.Test(&core.TestConfig{
+		Commands: GetCommands(),
+		Cmd:      "scw rdb engine settings name=mysql version=8",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			core.TestCheckExitCode(0),
+		),
+	}))
+}