feat: allow to set local values

In a runx config manifest we can ask the user to fill any input. But
sometimes we want to be able to set it for a specific project.
We can now define it inside the local configuration .docker/runx.yaml.
The value from the local configuration will be used, and the user will
not be prompt for a value.
But if we want to temporaily override it, it's still possible using the
--ask flag.

Signed-off-by: Yves Brissaud <[email protected]>

Author: eunomie

docs/reference/docker_runx.yaml

@@ -13,6 +13,16 @@ clink:
     - docker_runx_help.yaml
     - docker_runx_version.yaml
 options:
+    - option: ask
+      value_type: bool
+      default_value: "false"
+      description: Do not read local configuration option values and always ask them
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
     - option: docs
       shorthand: d
       value_type: bool

docs/reference/runx.md

@@ -14,10 +14,11 @@ Docker Run, better
 
 ### Options
 
-| Name           | Type   | Default | Description                          |
-|:---------------|:-------|:--------|:-------------------------------------|
-| `-d`, `--docs` | `bool` |         | Print the documentation of the image |
-| `-l`, `--list` | `bool` |         | List available actions               |
+| Name           | Type   | Default | Description                                                       |
+|:---------------|:-------|:--------|:------------------------------------------------------------------|
+| `--ask`        | `bool` |         | Do not read local configuration option values and always ask them |
+| `-d`, `--docs` | `bool` |         | Print the documentation of the image                              |
+| `-l`, `--list` | `bool` |         | List available actions                                            |
 
 
 <!---MARKER_GEN_END-->

internal/commands/root/root.go

@@ -27,6 +27,7 @@ import (
 var (
 	docs bool
 	list bool
+	ask  bool
 )
 
 func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
@@ -100,7 +101,7 @@ func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
 					if tui.IsATTY(dockerCli.In().FD()) {
 						action := prompt.SelectAction(rk.Config.Actions)
 						if action != "" {
-							return run(cmd.Context(), dockerCli.Err(), rk, action)
+							return run(cmd.Context(), dockerCli.Err(), src, rk, action)
 						}
 					} else {
 						_, _ = fmt.Fprintln(dockerCli.Out(), tui.Markdown(mdActions(rk)))
@@ -109,7 +110,7 @@ func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
 				}
 
 				if action != "" {
-					return run(cmd.Context(), dockerCli.Err(), rk, action)
+					return run(cmd.Context(), dockerCli.Err(), src, rk, action)
 				}
 
 				return cmd.Help()
@@ -147,17 +148,38 @@ func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
 	f := cmd.Flags()
 	f.BoolVarP(&docs, "docs", "d", false, "Print the documentation of the image")
 	f.BoolVarP(&list, "list", "l", false, "List available actions")
+	f.BoolVar(&ask, "ask", false, "Do not read local configuration option values and always ask them")
 
 	return cmd
 }
 
-func run(ctx context.Context, out io.Writer, rk *runkit.RunKit, action string) error {
+func getValuesLocal(src, action string) map[string]string {
+	opts := make(map[string]string)
+	if ask {
+		return opts
+	}
+
+	lc := runkit.GetLocalConfig()
+	img, ok := lc.Images[src]
+	if !ok {
+		return opts
+	}
+	act, ok := img.Actions[action]
+	if !ok {
+		return opts
+	}
+	return act.Opts
+}
+
+func run(ctx context.Context, out io.Writer, src string, rk *runkit.RunKit, action string) error {
 	runnable, err := rk.GetRunnable(action)
 	if err != nil {
 		return err
 	}
 
-	opts, err := prompt.Ask(runnable.Action)
+	localOpts := getValuesLocal(src, action)
+
+	opts, err := prompt.Ask(runnable.Action, localOpts)
 	if err != nil {
 		return err
 	}

internal/prompt/prompt.go

@@ -47,19 +47,21 @@ func envStr(env []string) string {
 	return " (required env: " + strings.Join(env, ", ") + ")"
 }
 
-func Ask(action runkit.Action) (map[string]string, error) {
+func Ask(action runkit.Action, opts map[string]string) (map[string]string, error) {
 	if len(action.Options) == 0 {
 		return nil, nil
 	}
 
 	var (
 		err    error
-		opts   = map[string]string{}
 		form   *huh.Form
 		fields []huh.Field
 	)
 
 	for _, opt := range action.Options {
+		if _, ok := opts[opt.Name]; ok {
+			continue
+		}
 		opt := opt
 		if len(opt.Values) == 0 {
 			fields = append(fields,
@@ -79,6 +81,10 @@ func Ask(action runkit.Action) (map[string]string, error) {
 		}
 	}
 
+	if len(fields) == 0 {
+		return opts, nil
+	}
+
 	form = huh.NewForm(huh.NewGroup(fields...))
 	if err = form.Run(); err != nil {
 		return nil, err

runkit/types.go

@@ -38,7 +38,12 @@ type (
 	}
 
 	ConfigImage struct {
-		Default string `yaml:"default,omitempty" json:"default,omitempty"`
+		Default string                  `yaml:"default,omitempty" json:"default,omitempty"`
+		Actions map[string]ConfigAction `yaml:"actions,omitempty" json:"actions,omitempty"`
+	}
+
+	ConfigAction struct {
+		Opts map[string]string `yaml:"opts,omitempty" json:"opts,omitempty"`
 	}
 )