feat(secret): add examples and tests to v1beta1 (#3740)

Co-authored-by: Rémy Léone <[email protected]>

Author: Codelax

cmd/scw/testdata/test-all-usage-secret-version-access-usage.golden

@@ -5,6 +5,10 @@ Access sensitive data in a secret's version specified by the `region`, `secret_i
 USAGE:
   scw secret version access <secret-id ...> [arg=value ...]
 
+EXAMPLES:
+  Get a raw json value from a secret version
+    scw secret version access 11111111-1111-1111-111111111111 revision=1 field=key raw=true
+
 ARGS:
   secret-id         ID of the secret
   revision          Version number

cmd/scw/testdata/test-all-usage-secret-version-create-usage.golden

@@ -5,9 +5,13 @@ Create a version of a given secret specified by the `region` and `secret_id` par
 USAGE:
   scw secret version create <secret-id ...> [arg=value ...]
 
+EXAMPLES:
+  Create a json secret version
+    scw secret version create 11111111-1111-1111-111111111111 data={"key":"value"}
+
 ARGS:
   secret-id            ID of the secret
-  data                 Content of the secret version. Base64 is handled by the SDK (Support file loading with @/path/to/file)
+  data                 Content of the secret version. (Support file loading with @/path/to/file)
   [description]        Description of the version
   [disable-previous]   Disable the previous secret version
   [data-crc32]         (Optional.) The CRC32 checksum of the data as a base-10 integer

docs/commands/secret.md

@@ -278,6 +278,16 @@ scw secret version access <secret-id ...> [arg=value ...]
 | 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:**
+
+
+Get a raw json value from a secret version
+```
+scw secret version access 11111111-1111-1111-111111111111 revision=1 field=key raw=true
+```
+
+
+
 
 ### Create a version
 
@@ -295,13 +305,23 @@ scw secret version create <secret-id ...> [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | secret-id | Required | ID of the secret |
-| data | Required | Content of the secret version. Base64 is handled by the SDK |
+| data | Required | Content of the secret version. |
 | description |  | Description of the version |
 | disable-previous |  | Disable the previous secret version |
 | data-crc32 |  | (Optional.) The CRC32 checksum of the data as a base-10 integer |
 | 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:**
+
+
+Create a json secret version
+```
+scw secret version create 11111111-1111-1111-111111111111 data={"key":"value"}
+```
+
+
+
 
 ### Delete a version
 

internal/namespaces/secret/v1beta1/custom.go

@@ -1,11 +1,6 @@
 package secret
 
 import (
-	"context"
-	"encoding/json"
-	"fmt"
-	"reflect"
-
 	"github.com/scaleway/scaleway-cli/v2/internal/core"
 	secret "github.com/scaleway/scaleway-sdk-go/api/secret/v1beta1"
 )
@@ -18,81 +13,9 @@ type customAccessSecretVersionRequest struct {
 
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
-	cmds.MustFind("secret", "version", "create").Override(secretVersionCreateData)
-	cmds.MustFind("secret", "version", "access").Override(secretVersionAccessCommand)
-	return cmds
-}
-
-func secretVersionCreateData(c *core.Command) *core.Command {
-	*c.ArgSpecs.GetByName("data") = core.ArgSpec{
-		Name:        "data",
-		Short:       "Content of the secret version. Base64 is handled by the SDK",
-		Required:    true,
-		CanLoadFile: true,
-	}
-	return c
-}
-
-func secretVersionAccessCommand(c *core.Command) *core.Command {
-	c.ArgsType = reflect.TypeOf(customAccessSecretVersionRequest{})
-
-	c.ArgSpecs.AddBefore("region", &core.ArgSpec{
-		Name:  "field",
-		Short: "Return only the JSON field of the given name",
-	})
-
-	c.ArgSpecs.AddBefore("region", &core.ArgSpec{
-		Name:  "raw",
-		Short: "Return only the raw payload",
-	})
-
-	c.Run = func(ctx context.Context, args interface{}) (i interface{}, e error) {
-		client := core.ExtractClient(ctx)
-		api := secret.NewAPI(client)
 
-		request := args.(*customAccessSecretVersionRequest)
+	cmds.MustFind("secret", "version", "create").Override(secretVersionCreateBuilder)
+	cmds.MustFind("secret", "version", "access").Override(secretVersionAccessBuilder)
 
-		response, err := api.AccessSecretVersion(&secret.AccessSecretVersionRequest{
-			Region:   request.Region,
-			SecretID: request.SecretID,
-			Revision: request.Revision,
-		})
-		if err != nil {
-			return nil, err
-		}
-
-		if request.Field != nil {
-			response.Data, err = getSecretVersionField(response.Data, *request.Field)
-			if err != nil {
-				return nil, err
-			}
-		}
-
-		if request.Raw {
-			return core.RawResult(response.Data), nil
-		}
-
-		return response, nil
-	}
-
-	return c
-}
-
-func getSecretVersionField(data []byte, field string) ([]byte, error) {
-	var rawFields interface{}
-	if err := json.Unmarshal(data, &rawFields); err != nil {
-		return nil, fmt.Errorf("cannot unmarshal JSON data")
-	}
-
-	rawField, ok := rawFields.(map[string]interface{})[field]
-	if !ok {
-		return nil, fmt.Errorf("JSON field is not present")
-	}
-
-	switch field := rawField.(type) {
-	case string:
-		return []byte(field), nil
-	default:
-		return nil, fmt.Errorf("JSON field type is not valid")
-	}
+	return cmds
 }

internal/namespaces/secret/v1beta1/custom_secret_version.go

@@ -0,0 +1,96 @@
+package secret
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"reflect"
+
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+	secret "github.com/scaleway/scaleway-sdk-go/api/secret/v1beta1"
+)
+
+func secretVersionCreateBuilder(c *core.Command) *core.Command {
+	*c.ArgSpecs.GetByName("data") = core.ArgSpec{
+		Name:        "data",
+		Short:       "Content of the secret version.",
+		Required:    true,
+		CanLoadFile: true,
+	}
+
+	c.Examples = append(c.Examples, &core.Example{
+		Short: "Create a json secret version",
+		Raw:   "scw secret version create 11111111-1111-1111-111111111111 data={\"key\":\"value\"}",
+	})
+
+	return c
+}
+
+func secretVersionAccessBuilder(c *core.Command) *core.Command {
+	c.ArgsType = reflect.TypeOf(customAccessSecretVersionRequest{})
+
+	c.ArgSpecs.AddBefore("region", &core.ArgSpec{
+		Name:  "field",
+		Short: "Return only the JSON field of the given name",
+	})
+
+	c.ArgSpecs.AddBefore("region", &core.ArgSpec{
+		Name:  "raw",
+		Short: "Return only the raw payload",
+	})
+
+	c.Examples = append(c.Examples, &core.Example{
+		Short: "Get a raw json value from a secret version",
+		Raw:   "scw secret version access 11111111-1111-1111-111111111111 revision=1 field=key raw=true",
+	})
+
+	c.Run = func(ctx context.Context, args interface{}) (i interface{}, e error) {
+		client := core.ExtractClient(ctx)
+		api := secret.NewAPI(client)
+
+		request := args.(*customAccessSecretVersionRequest)
+
+		response, err := api.AccessSecretVersion(&secret.AccessSecretVersionRequest{
+			Region:   request.Region,
+			SecretID: request.SecretID,
+			Revision: request.Revision,
+		})
+		if err != nil {
+			return nil, err
+		}
+
+		if request.Field != nil {
+			response.Data, err = getSecretVersionField(response.Data, *request.Field)
+			if err != nil {
+				return nil, err
+			}
+		}
+
+		if request.Raw {
+			return core.RawResult(response.Data), nil
+		}
+
+		return response, nil
+	}
+
+	return c
+}
+
+func getSecretVersionField(data []byte, field string) ([]byte, error) {
+	var rawFields interface{}
+	if err := json.Unmarshal(data, &rawFields); err != nil {
+		return nil, fmt.Errorf("cannot unmarshal JSON data")
+	}
+
+	rawField, ok := rawFields.(map[string]interface{})[field]
+	if !ok {
+		return nil, fmt.Errorf("JSON field is not present")
+	}
+
+	switch field := rawField.(type) {
+	case string:
+		return []byte(field), nil
+	default:
+		return nil, fmt.Errorf("JSON field type is not valid")
+	}
+}

internal/namespaces/secret/v1beta1/custom_secret_version_test.go

@@ -0,0 +1,35 @@
+package secret_test
+
+import (
+	"testing"
+
+	"github.com/alecthomas/assert"
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+	secret "github.com/scaleway/scaleway-cli/v2/internal/namespaces/secret/v1beta1"
+)
+
+func Test_AccessSecret(t *testing.T) {
+	cmds := secret.GetCommands()
+
+	t.Run("Simple", core.Test(&core.TestConfig{
+		Commands: cmds,
+		BeforeFunc: core.BeforeFuncCombine(
+			createSecret("cli-test-access-secret"),
+			createSecretVersion("{\"key\":\"value\"}"),
+		),
+		Cmd: "scw secret version access {{ .Secret.ID }} revision={{ .SecretVersion.Revision }} field=key raw=true",
+		Check: core.TestCheckCombine(
+			core.TestCheckGolden(),
+			func(t *testing.T, ctx *core.CheckFuncCtx) {
+				rawResult, isBytes := ctx.Result.(core.RawResult)
+				if !isBytes {
+					t.Fatalf("Expecting result to be bytes")
+				}
+				assert.Equal(t, core.RawResult("value"), rawResult)
+			},
+		),
+		AfterFunc: core.AfterFuncCombine(
+			deleteSecret(),
+		),
+	}))
+}

internal/namespaces/secret/v1beta1/helper_test.go

@@ -0,0 +1,23 @@
+package secret_test
+
+import (
+	"github.com/scaleway/scaleway-cli/v2/internal/core"
+)
+
+func createSecret(name string) core.BeforeFunc {
+	return core.ExecStoreBeforeCmd(
+		"Secret",
+		"scw secret secret create name="+name,
+	)
+}
+
+func createSecretVersion(content string) core.BeforeFunc {
+	return core.ExecStoreBeforeCmd(
+		"SecretVersion",
+		"scw secret version create {{ .Secret.ID }} data="+content,
+	)
+}
+
+func deleteSecret() core.AfterFunc {
+	return core.ExecAfterCmd("scw secret secret delete {{ .Secret.ID }}")
+}