Refactor actions, global config, structure.

Author: lexbritvin

app.go

@@ -8,8 +8,9 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/launchrctl/launchr/internal/launchr/config"
+	"github.com/launchrctl/launchr/pkg/action"
 	"github.com/launchrctl/launchr/pkg/cli"
-	"github.com/launchrctl/launchr/pkg/cobraadapter"
 )
 
 // ActionsGroup is a cobra command group definition
@@ -20,14 +21,15 @@ var ActionsGroup = &cobra.Group{
 
 // App holds app related global variables.
 type App struct {
-	rootCmd     *cobra.Command
-	cli         cli.Cli
-	workDir     string
-	cfgDir      string
-	version     *AppVersion
-	actionMngr  ActionManager
-	serviceMngr ServiceManager
-	pluginMngr  PluginManager
+	rootCmd    *cobra.Command
+	streams    cli.Streams
+	workDir    string
+	cfgDir     string
+	version    *AppVersion
+	services   map[ServiceInfo]Service
+	actionMngr action.Manager
+	pluginMngr PluginManager
+	globalCfg  GlobalConfig
 }
 
 // NewApp constructs app implementation.
@@ -40,24 +42,18 @@ func (app *App) GetWD() string {
 	return app.workDir
 }
 
-// GetCfgDir returns config directory path.
-func (app *App) GetCfgDir() string {
-	return app.cfgDir
+// Streams returns application cli.
+func (app *App) Streams() cli.Streams {
+	return app.streams
 }
 
-// GetCli returns application cli.
-func (app *App) GetCli() cli.Cli {
-	return app.cli
-}
-
-// SetCli sets application cli.
-func (app *App) SetCli(c cli.Cli) {
-	app.cli = c
-}
-
-// ServiceManager returns application service manager.
-func (app *App) ServiceManager() ServiceManager {
-	return app.serviceMngr
+// AddService registers a service in the app.
+func (app *App) AddService(s Service) {
+	info := s.ServiceInfo()
+	if _, ok := app.services[info]; ok {
+		panic(fmt.Errorf("service %s already exists, review your code", info.ID))
+	}
+	app.services[info] = s
 }
 
 // init initializes application and plugins.
@@ -70,20 +66,14 @@ func (app *App) init() error {
 	if err != nil {
 		return err
 	}
-	appCli, err := cli.NewAppCli(
-		cli.WithStandardStreams(),
-		cli.WithGlobalConfigFromDir(os.DirFS(app.cfgDir)),
-	)
-	if err != nil {
-		return err
-	}
-	app.SetCli(appCli)
-	app.serviceMngr = newServiceManager()
-	app.actionMngr = newActionManager()
+	app.streams = cli.StandardStreams()
+	app.services = make(map[ServiceInfo]Service)
+	app.actionMngr = action.NewManager()
 	app.pluginMngr = pluginManagerMap(registeredPlugins)
-	app.serviceMngr.Add(ServiceManagerID, app.serviceMngr)
-	app.serviceMngr.Add(ActionManagerID, app.actionMngr)
-	app.serviceMngr.Add(PluginManagerID, app.pluginMngr)
+	app.globalCfg = config.GlobalConfigFromFS(os.DirFS(app.cfgDir))
+	app.AddService(app.actionMngr)
+	app.AddService(app.pluginMngr)
+	app.AddService(app.globalCfg)
 
 	// Initialize the plugins.
 	for _, p := range app.pluginMngr.All() {
@@ -115,7 +105,7 @@ func (app *App) exec() error {
 		rootCmd.AddGroup(ActionsGroup)
 	}
 	for _, cmdDef := range actions {
-		cobraCmd, err := cobraadapter.GetActionImpl(app.GetCli(), cmdDef, ActionsGroup)
+		cobraCmd, err := action.CobraImpl(cmdDef, app.Streams(), app.globalCfg, ActionsGroup)
 		if err != nil {
 			return err
 		}
@@ -131,9 +121,9 @@ func (app *App) exec() error {
 
 	// Set io streams.
 	app.rootCmd = rootCmd
-	rootCmd.SetIn(app.cli.In())
-	rootCmd.SetOut(app.cli.Out())
-	rootCmd.SetErr(app.cli.Err())
+	rootCmd.SetIn(app.streams.In())
+	rootCmd.SetOut(app.streams.Out())
+	rootCmd.SetErr(app.streams.Err())
 	return app.rootCmd.Execute()
 }
 

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/spf13/cobra v1.7.0
 	github.com/stretchr/testify v1.8.4
 	golang.org/x/mod v0.12.0
-	golang.org/x/sys v0.10.0
+	golang.org/x/sys v0.11.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
@@ -33,15 +33,15 @@ require (
 	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/opencontainers/image-spec v1.1.0-rc4 // indirect
-	github.com/opencontainers/runc v1.1.8 // indirect
+	github.com/opencontainers/runc v1.1.9 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rogpeppe/go-internal v1.10.0 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	golang.org/x/net v0.13.0 // indirect
+	golang.org/x/net v0.14.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
-	golang.org/x/tools v0.11.1 // indirect
+	golang.org/x/tools v0.12.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gotest.tools/v3 v3.4.0 // indirect
 )

go.sum

@@ -80,6 +80,8 @@ github.com/opencontainers/runc v1.1.7 h1:y2EZDS8sNng4Ksf0GUYNhKbTShZJPJg1FiXJNH/
 github.com/opencontainers/runc v1.1.7/go.mod h1:CbUumNnWCuTGFukNXahoo/RFBZvDAgRh/smNYNOhA50=
 github.com/opencontainers/runc v1.1.8 h1:zICRlc+C1XzivLc3nzE+cbJV4LIi8tib6YG0MqC6OqA=
 github.com/opencontainers/runc v1.1.8/go.mod h1:CbUumNnWCuTGFukNXahoo/RFBZvDAgRh/smNYNOhA50=
+github.com/opencontainers/runc v1.1.9 h1:XR0VIHTGce5eWPkaPesqTBrhW2yAcaraWfsEalNwQLM=
+github.com/opencontainers/runc v1.1.9/go.mod h1:CbUumNnWCuTGFukNXahoo/RFBZvDAgRh/smNYNOhA50=
 github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
@@ -127,6 +129,8 @@ golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50=
 golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
 golang.org/x/net v0.13.0 h1:Nvo8UFsZ8X3BhAC9699Z1j7XQ3rsZnUUm7jfBEk1ueY=
 golang.org/x/net v0.13.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
+golang.org/x/net v0.14.0 h1:BONx9s002vGdD9umnlX1Po8vOZmrgH34qlHcD1MfK14=
+golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -146,6 +150,8 @@ golang.org/x/sys v0.9.0 h1:KS/R3tvhPqvJvwcKfnBHJwwthS11LRhmM5D59eEXa0s=
 golang.org/x/sys v0.9.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
 golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
+golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
@@ -163,6 +169,8 @@ golang.org/x/tools v0.11.0 h1:EMCa6U9S2LtZXLAMoWiR/R8dAQFRqbAitmbJ2UKhoi8=
 golang.org/x/tools v0.11.0/go.mod h1:anzJrxPjNtfgiYQYirP2CPGzGLxrH2u2QBhn6Bf3qY8=
 golang.org/x/tools v0.11.1 h1:ojD5zOW8+7dOGzdnNgersm8aPfcDjhMp12UfG93NIMc=
 golang.org/x/tools v0.11.1/go.mod h1:anzJrxPjNtfgiYQYirP2CPGzGLxrH2u2QBhn6Bf3qY8=
+golang.org/x/tools v0.12.0 h1:YW6HUoUmYBpwSgyaGaZq1fHjrBjX1rlpZ54T6mu2kss=
+golang.org/x/tools v0.12.0/go.mod h1:Sc0INKfu04TlqNoRA1hgpFZbhYXHPr4V5DzpSBTPqQM=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

internal/launchr/config/config.go

@@ -0,0 +1,148 @@
+// Package config provides global app config object.
+package config
+
+import (
+	"errors"
+	"io"
+	"io/fs"
+	"path/filepath"
+	"reflect"
+	"regexp"
+
+	"gopkg.in/yaml.v3"
+
+	"github.com/launchrctl/launchr/internal/launchr"
+)
+
+var configRegex = regexp.MustCompile(`^config\.(yaml|yml)$`)
+
+var (
+	errNoFile = errors.New("config file is not found")
+)
+
+// GlobalConfig is a config interface.
+type GlobalConfig interface {
+	launchr.Service
+	// DirPath returns an absolute path to config directory.
+	DirPath() string
+	// Path provides an absolute path to global config.
+	Path(parts ...string) string
+	// EnsurePath creates all directories in the path.
+	EnsurePath(parts ...string) error
+	// Get returns a value by name to a parameter v. Parameter v must be a pointer to a value.
+	// Error may be returned on decode.
+	Get(name string, v interface{}) error
+}
+
+// GlobalConfigAware provides an interface for structs to support global configuration setting.
+type GlobalConfigAware interface {
+	// SetGlobalConfig sets a global config to the struct.
+	SetGlobalConfig(GlobalConfig)
+}
+
+type cachedProps map[string]reflect.Value
+type globalConfig struct {
+	root     fs.FS
+	fname    fs.DirEntry
+	rootPath string
+	cached   cachedProps
+	yaml     map[string]yaml.Node
+}
+
+func findConfig(root fs.FS) fs.DirEntry {
+	dir, err := fs.ReadDir(root, ".")
+	if err != nil {
+		return nil
+	}
+	for _, f := range dir {
+		if !f.IsDir() && configRegex.MatchString(f.Name()) {
+			return f
+		}
+	}
+	return nil
+}
+
+// GlobalConfigFromFS parses global app config.
+func GlobalConfigFromFS(root fs.FS) GlobalConfig {
+	return &globalConfig{
+		root:     root,
+		rootPath: launchr.GetFsAbsPath(root),
+		cached:   make(cachedProps),
+		fname:    findConfig(root),
+	}
+}
+
+func (cfg *globalConfig) ServiceInfo() launchr.ServiceInfo {
+	return launchr.ServiceInfo{
+		ID: "global_config",
+	}
+}
+
+func (cfg *globalConfig) DirPath() string {
+	return cfg.rootPath
+}
+
+func (cfg *globalConfig) Get(name string, v interface{}) error {
+	var err error
+	cached, ok := cfg.cached[name]
+	if ok {
+		err, ok = cached.Interface().(error)
+		if ok {
+			return err
+		}
+		reflect.ValueOf(v).Elem().Set(cached)
+		return nil
+	}
+
+	if cfg.fname != nil && cfg.yaml == nil {
+		if err = cfg.parse(); err != nil {
+			return err
+		}
+	}
+	y, ok := cfg.yaml[name]
+	if !ok {
+		// Return default value.
+		return nil
+	}
+	defer func() {
+		// Save error result to prevent parsing twice.
+		if err != nil {
+			cfg.cached[name] = reflect.ValueOf(err)
+		}
+	}()
+	vcopy := reflect.New(reflect.TypeOf(v).Elem()).Elem()
+	if err = y.Decode(v); err != nil {
+		// Set value to empty struct not to leak partial parsing to ensure consistent results.
+		reflect.ValueOf(v).Elem().Set(vcopy)
+		return err
+	}
+	cfg.cached[name] = reflect.ValueOf(v).Elem()
+	return nil
+}
+
+func (cfg *globalConfig) parse() error {
+	if cfg.fname == nil {
+		return errNoFile
+	}
+	r, err := cfg.root.Open(cfg.fname.Name())
+	if err != nil {
+		return err
+	}
+	defer r.Close()
+
+	d := yaml.NewDecoder(r)
+	err = d.Decode(&cfg.yaml)
+	if err != nil && err != io.EOF {
+		return err
+	}
+	return nil
+}
+
+func (cfg *globalConfig) Path(parts ...string) string {
+	parts = append([]string{cfg.rootPath}, parts...)
+	return filepath.Clean(filepath.Join(parts...))
+}
+
+func (cfg *globalConfig) EnsurePath(parts ...string) error {
+	return launchr.EnsurePath(cfg.Path(parts...))
+}