feat: allow to specify a default reference

Use the .docker/runx.yaml file and set the ref key

If some arguments are still passed, we are trying to see if that's an
image or not. If that's an image, use runx against it. But if we can't
access the image, use it as if it was an action

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

Author: eunomie

.gitignore

@@ -1,2 +1,3 @@
 /dist
-/.coverage
+/.coverage
+/.docker

internal/commands/root/root.go

@@ -19,6 +19,7 @@ import (
 	"github.com/eunomie/docker-runx/internal/commands/version"
 	"github.com/eunomie/docker-runx/internal/constants"
 	"github.com/eunomie/docker-runx/internal/prompt"
+	"github.com/eunomie/docker-runx/internal/registry"
 	"github.com/eunomie/docker-runx/internal/tui"
 	"github.com/eunomie/docker-runx/runkit"
 )
@@ -35,12 +36,41 @@ func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
 			Use:   fmt.Sprintf("%s [IMAGE] [ACTION]", name),
 			Short: "Docker Run, better",
 			RunE: func(cmd *cobra.Command, args []string) error {
-				if len(args) == 0 || len(args) > 2 {
+				var (
+					src    string
+					action string
+					lc     = runkit.GetLocalConfig()
+				)
+
+				switch len(args) {
+				case 0:
+					src = lc.Ref
+					if src == "" {
+						return cmd.Help()
+					}
+				case 1:
+					if lc.Ref == "" {
+						src = args[0]
+					} else {
+						// here we need to know if the argument is an image or an action
+						// there's no easy way, so what we'll do is to check if the argument is a reachable image
+						if registry.ImageExist(cmd.Context(), args[0]) {
+							// the image exist, let's say we override the default reference
+							src = args[0]
+						} else {
+							// we can't access the image, let's say it's an action
+							src = lc.Ref
+							action = args[0]
+						}
+					}
+				case 2:
+					src = args[0]
+					action = args[1]
+				default:
 					return cmd.Help()
 				}
 
 				var (
-					src = args[0]
 					err error
 					rk  *runkit.RunKit
 				)
@@ -64,7 +94,7 @@ func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
 					return nil
 				}
 
-				if list || len(args) == 1 {
+				if list || action == "" {
 					if tui.IsATTY(dockerCli.In().FD()) {
 						action := prompt.SelectAction(rk.Config.Actions)
 						if action != "" {
@@ -76,9 +106,7 @@ func NewCmd(dockerCli command.Cli, isPlugin bool) *cobra.Command {
 					return nil
 				}
 
-				if len(args) == 2 {
-					action := args[1]
-
+				if action != "" {
 					return run(cmd.Context(), dockerCli.Err(), rk, action)
 				}
 

internal/registry/check.go

@@ -0,0 +1,19 @@
+package registry
+
+import (
+	"context"
+
+	"github.com/google/go-containerregistry/pkg/name"
+	"github.com/google/go-containerregistry/pkg/v1/remote"
+)
+
+func ImageExist(ctx context.Context, src string) bool {
+	var (
+		err        error
+		remoteOpts = WithOptions(ctx, nil)
+		ref, _     = name.ParseReference(src)
+	)
+
+	_, err = remote.Head(ref, remoteOpts...)
+	return err == nil
+}

runkit/config.go

@@ -0,0 +1,49 @@
+package runkit
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"sync"
+
+	"gopkg.in/yaml.v2"
+)
+
+const (
+	DefaultLocalConfigFile = ".docker/runx.yaml"
+)
+
+var (
+	localConfig LocalConfig
+	readOnce    = sync.Once{}
+)
+
+func GetLocalConfig() LocalConfig {
+	readOnce.Do(func() {
+		lc, err := getLocalConfig()
+		if err != nil {
+			_, _ = fmt.Fprintf(os.Stderr, "error reading local config: %v\n", err)
+			os.Exit(1)
+		}
+		localConfig = lc
+	})
+	return localConfig
+}
+
+func getLocalConfig() (LocalConfig, error) {
+	data, err := os.ReadFile(DefaultLocalConfigFile)
+	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
+			return LocalConfig{}, nil
+		}
+		return LocalConfig{}, err
+	}
+
+	var config LocalConfig
+	if err = yaml.Unmarshal(data, &config); err != nil {
+		return LocalConfig{}, err
+	}
+
+	return config, nil
+}

runkit/types.go

@@ -30,6 +30,10 @@ type (
 	}
 
 	ActionType string
+
+	LocalConfig struct {
+		Ref string `yaml:"ref,omitempty" json:"ref,omitempty"`
+	}
 )
 
 const (