feat(instance): import file for cloud-init (#1525)

* feat(instance): import file for cloud-init
* fix: add io.Reader support for @file

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

Author: jtherin

cmd/scw/testdata/test-all-usage-instance-server-create-usage.golden

@@ -35,7 +35,7 @@ ARGS:
   [security-group-id]            The security group ID it use for this server
   [placement-group-id]           The placement group ID in witch the server has to be created
   [bootscript-id]                The bootscript ID to use, if empty the local boot will be used
-  [cloud-init]                   The cloud-init script to use
+  [cloud-init]                   The cloud-init script to use (Support file loading with @/path/to/file)
   [boot-type=local]              The boot type to use, if empty the local boot will be used. Will be overwritten to bootscript if bootscript-id is set. (local | bootscript | rescue)
   [project-id]                   Project ID to use. If none is passed the default project ID will be used
   [zone=fr-par-1]                Zone to target. If none is passed will use default zone from the config

cmd/scw/testdata/test-all-usage-instance-server-update-usage.golden

@@ -28,7 +28,7 @@ ARGS:
   server-id                                   UUID of the server
   [name]                                      Name of the server
   [ip]                                        IP that should be attached to the server (use ip=none to detach)
-  [cloud-init]                                The cloud-init script to use
+  [cloud-init]                                The cloud-init script to use (Support file loading with @/path/to/file)
   [boot-type]                                  (local | bootscript | rescue)
   [tags.{index}]                              Tags of the server
   [bootscript]                                

cmd/scw/testdata/test-all-usage-instance-user-data-set-usage.golden

@@ -8,7 +8,7 @@ USAGE:
 ARGS:
   server-id         UUID of the server
   key               Key of the user data to set
-  content           Content of the user data
+  content           Content of the user data (Support file loading with @/path/to/file)
   [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | pl-waw-1)
 
 FLAGS:

internal/core/arg_file_content.go

@@ -0,0 +1,56 @@
+package core
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"reflect"
+	"strings"
+
+	"github.com/scaleway/scaleway-sdk-go/strcase"
+)
+
+// loadArgsFileContent will hydrate args with default values.
+func loadArgsFileContent(cmd *Command, cmdArgs interface{}) error {
+	for _, argSpec := range cmd.ArgSpecs {
+		if !argSpec.CanLoadFile {
+			continue
+		}
+
+		fieldName := strcase.ToPublicGoName(argSpec.Name)
+		fieldValues, err := getValuesForFieldByName(reflect.ValueOf(cmdArgs), strings.Split(fieldName, "."))
+		if err != nil {
+			continue
+		}
+
+		for _, v := range fieldValues {
+			switch i := v.Interface().(type) {
+			case io.Reader:
+				b, err := ioutil.ReadAll(i)
+				if err != nil {
+					return fmt.Errorf("could not read argument: %s", err)
+				}
+
+				if strings.HasPrefix(string(b), "@") {
+					content, err := ioutil.ReadFile(string(b)[1:])
+					if err != nil {
+						return fmt.Errorf("could not open requested file: %s", err)
+					}
+					test := bytes.NewBuffer(content)
+					v.Set(reflect.ValueOf(test))
+				}
+			case *string:
+				if strings.HasPrefix(*i, "@") {
+					content, err := ioutil.ReadFile((*i)[1:])
+					if err != nil {
+						return fmt.Errorf("could not open requested file: %s", err)
+					}
+					v.SetString(string(content))
+				}
+			}
+		}
+	}
+
+	return nil
+}

internal/core/arg_specs.go

@@ -99,6 +99,9 @@ type ArgSpec struct {
 	// Deprecated is used to flag an argument as deprecated.
 	// Use the short field to indicate migration tips for users.
 	Deprecated bool
+
+	// CanLoadFile allow to use @ prefix to load a file as content
+	CanLoadFile bool
 }
 
 func (a *ArgSpec) Prefix() string {

internal/core/cobra_usage_builder.go

@@ -45,15 +45,19 @@ func buildUsageArgs(ctx context.Context, cmd *Command, deprecated bool) string {
 func _buildUsageArgs(ctx context.Context, w io.Writer, argSpecs ArgSpecs) error {
 	for _, argSpec := range argSpecs {
 		argSpecUsageLeftPart := argSpec.Name
+		argSpecUsageRightPart := _buildArgShort(argSpec)
 		if argSpec.Default != nil {
 			_, doc := argSpec.Default(ctx)
 			argSpecUsageLeftPart = fmt.Sprintf("%s=%s", argSpecUsageLeftPart, doc)
 		}
 		if !argSpec.Required && !argSpec.Positional {
 			argSpecUsageLeftPart = fmt.Sprintf("[%s]", argSpecUsageLeftPart)
 		}
+		if argSpec.CanLoadFile {
+			argSpecUsageRightPart += " (Support file loading with @/path/to/file)"
+		}
 
-		_, err := fmt.Fprintf(w, "  %s\t%s\n", argSpecUsageLeftPart, _buildArgShort(argSpec))
+		_, err := fmt.Fprintf(w, "  %s\t%s\n", argSpecUsageLeftPart, argSpecUsageRightPart)
 		if err != nil {
 			return err
 		}

internal/core/cobra_utils.go

@@ -115,6 +115,12 @@ func run(ctx context.Context, cobraCmd *cobra.Command, cmd *Command, rawArgs []s
 		return nil, err
 	}
 
+	// Load args file imports.
+	err = loadArgsFileContent(cmd, cmdArgs)
+	if err != nil {
+		return nil, err
+	}
+
 	// PreValidate hook.
 	if cmd.PreValidateFunc != nil {
 		err = cmd.PreValidateFunc(ctx, cmdArgs)

internal/namespaces/instance/v1/custom_server.go

@@ -202,8 +202,9 @@ func serverUpdateBuilder(c *core.Command) *core.Command {
 		Short: `IP that should be attached to the server (use ip=none to detach)`,
 	})
 	c.ArgSpecs.AddBefore("boot-type", &core.ArgSpec{
-		Name:  "cloud-init",
-		Short: "The cloud-init script to use",
+		Name:        "cloud-init",
+		Short:       "The cloud-init script to use",
+		CanLoadFile: true,
 	})
 
 	c.Run = func(ctx context.Context, argsI interface{}) (i interface{}, e error) {

internal/namespaces/instance/v1/custom_server_create.go

@@ -121,8 +121,9 @@ func serverCreateCommand() *core.Command {
 				Short: "The bootscript ID to use, if empty the local boot will be used",
 			},
 			{
-				Name:  "cloud-init",
-				Short: "The cloud-init script to use",
+				Name:        "cloud-init",
+				Short:       "The cloud-init script to use",
+				CanLoadFile: true,
 			},
 			{
 				Name:       "boot-type",

internal/namespaces/instance/v1/custom_user_data.go

@@ -23,9 +23,10 @@ func userDataDeleteBuilder(c *core.Command) *core.Command {
 
 func userDataSetBuilder(c *core.Command) *core.Command {
 	*c.ArgSpecs.GetByName("content.name") = core.ArgSpec{
-		Name:     "content",
-		Short:    "Content of the user data",
-		Required: true,
+		Name:        "content",
+		Short:       "Content of the user data",
+		Required:    true,
+		CanLoadFile: true,
 	}
 
 	c.ArgSpecs.DeleteByName("content.content-type")