feat: merge all the .docker/runx.yaml files

Merge all the .docker/runx.yaml files we found from the current
directory up to the root.

Allow to define options for all the actions.

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

Author: eunomie

README.md

@@ -159,6 +159,7 @@ actions:
       - name: OPTION_NAME # Name of the option. Also used in the local override or with `--opt` flag.
         desc: DESCRIPTION # Description, rendered in the documentation of the action.
         prompt: PROMPT # A specific prompt to ask the user for the value.
+        no-prompt: true|false # If set to true, the option will not be prompted to the user.
         required: true|false # If required, an empty value will not be accepted.
         values: # A list of possible values for the option. If set, a select will be displayed to the user.
           - VALUE
@@ -183,6 +184,8 @@ actions:
 A local file `.docker/runx.yaml` can be used to override the actions defined in the image manifest.
 This is useful to configure some actions for a specific project for instance.
 
+`docker runx` will look for this file in the current directory and in all the parent directories. The different files will be merged together, the closer to the current directory will have the priority.
+
 ```yaml
 # Optional.
 # It allows to define a default reference to an image if none is provided by the user.
@@ -198,6 +201,12 @@ images:
     # This overrides the `default` action in the image `runx.yaml` configuration.
     default: ACTION_ID
     # Optional.
+    # Allow to define common options for all the actions of the image.
+    all-actions:
+      opts:
+        # Override the value of an option.
+        OPTION_NAME: OPTION_VALUE
+    # Optional.
     actions:
       # Specify the action to override.
       ACTION_ID:

docs/index.markdown

@@ -163,6 +163,7 @@ actions:
       - name: OPTION_NAME # Name of the option. Also used in the local override or with `--opt` flag.
         desc: DESCRIPTION # Description, rendered in the documentation of the action.
         prompt: PROMPT # A specific prompt to ask the user for the value.
+        no-prompt: true|false # If set to true, the option will not be prompted to the user.
         required: true|false # If required, an empty value will not be accepted.
         values: # A list of possible values for the option. If set, a select will be displayed to the user.
           - VALUE
@@ -187,6 +188,8 @@ actions:
 A local file `.docker/runx.yaml` can be used to override the actions defined in the image manifest.
 This is useful to configure some actions for a specific project for instance.
 
+`docker runx` will look for this file in the current directory and in all the parent directories. The different files will be merged together, the closer to the current directory will have the priority.
+
 ```yaml
 # Optional.
 # It allows to define a default reference to an image if none is provided by the user.
@@ -202,6 +205,12 @@ images:
     # This overrides the `default` action in the image `runx.yaml` configuration.
     default: ACTION_ID
     # Optional.
+    # Allow to define common options for all the actions of the image.
+    all-actions:
+      opts:
+        # Override the value of an option.
+        OPTION_NAME: OPTION_VALUE
+    # Optional.
     actions:
       # Specify the action to override.
       ACTION_ID:

internal/commands/root/root.go

@@ -173,11 +173,18 @@ func getValuesLocal(src, action string) map[string]string {
 	if !ok {
 		return localOpts
 	}
+
+	if img.AllActions.Opts != nil {
+		localOpts = img.AllActions.Opts
+	}
+
 	act, ok := img.Actions[action]
-	if !ok {
-		return localOpts
+	if ok {
+		for k, v := range act.Opts {
+			localOpts[k] = v
+		}
 	}
-	return act.Opts
+	return localOpts
 }
 
 func run(ctx context.Context, out io.Writer, src string, rk *runkit.RunKit, action string) error {

runkit/config.go

@@ -1,9 +1,11 @@
 package runkit
 
 import (
+	"cmp"
 	"errors"
 	"fmt"
 	"os"
+	"path/filepath"
 	"sync"
 
 	"gopkg.in/yaml.v2"
@@ -31,7 +33,76 @@ func GetLocalConfig() LocalConfig {
 }
 
 func getLocalConfig() (LocalConfig, error) {
-	data, err := os.ReadFile(DefaultLocalConfigFile)
+	lc := LocalConfig{}
+
+	wd, err := os.Getwd()
+	if err != nil {
+		return lc, err
+	}
+
+	p := wd
+
+	for {
+		c, err := read(filepath.Join(p, DefaultLocalConfigFile))
+		if err != nil {
+			return lc, err
+		}
+
+		lc = merge(c, lc)
+
+		if p == "/" {
+			break
+		}
+
+		p = filepath.Clean(filepath.Join(p, ".."))
+	}
+
+	return lc, nil
+}
+
+func merge(a, b LocalConfig) LocalConfig {
+	a.Ref = cmp.Or(b.Ref, a.Ref)
+	if a.Images == nil {
+		a.Images = b.Images
+		return a
+	}
+	for imgName, img := range b.Images {
+		i, ok := a.Images[imgName]
+		if !ok {
+			a.Images[imgName] = img
+			continue
+		}
+		i.Default = cmp.Or(img.Default, i.Default)
+		i.AllActions.Opts = mergeOpts(i.AllActions.Opts, img.AllActions.Opts)
+		i.Actions = mergeActions(i.Actions, img.Actions)
+		a.Images[imgName] = i
+	}
+
+	return a
+}
+
+func mergeOpts(a, b map[string]string) map[string]string {
+	for k, v := range b {
+		a[k] = v
+	}
+	return a
+}
+
+func mergeActions(a, b map[string]ConfigAction) map[string]ConfigAction {
+	for k, v := range b {
+		actA, ok := a[k]
+		if !ok {
+			a[k] = v
+			continue
+		}
+		actA.Opts = mergeOpts(actA.Opts, v.Opts)
+		a[k] = actA
+	}
+	return a
+}
+
+func read(filePath string) (LocalConfig, error) {
+	data, err := os.ReadFile(filePath)
 	if err != nil {
 		if errors.Is(err, os.ErrNotExist) {
 			// in this case we just don't have a config file, so use everything as default

runkit/types.go

@@ -30,7 +30,7 @@ type (
 	Opt struct {
 		Name        string   `yaml:"name" json:"name"`
 		Description string   `yaml:"desc" json:"desc,omitempty"`
-		NoPrompt    bool     `yaml:"no-prompt,omitempty" json:"no_prompt,omitempty"`
+		NoPrompt    bool     `yaml:"no-prompt,omitempty" json:"no-prompt,omitempty"`
 		Prompt      string   `yaml:"prompt,omitempty" json:"prompt,omitempty"`
 		Required    bool     `yaml:"required,omitempty" json:"required,omitempty"`
 		Values      []string `yaml:"values,omitempty" json:"values,omitempty"`
@@ -44,8 +44,9 @@ type (
 	}
 
 	ConfigImage struct {
-		Default string                  `yaml:"default,omitempty" json:"default,omitempty"`
-		Actions map[string]ConfigAction `yaml:"actions,omitempty" json:"actions,omitempty"`
+		Default    string                  `yaml:"default,omitempty" json:"default,omitempty"`
+		AllActions ConfigAction            `yaml:"all-actions,omitempty" json:"all-actions,omitempty"`
+		Actions    map[string]ConfigAction `yaml:"actions,omitempty" json:"actions,omitempty"`
 	}
 
 	ConfigAction struct {