Rework structure. Fix help. Add readme.

Author: lexbritvin

Makefile

@@ -25,7 +25,7 @@ LOCAL_BIN:=$(CURDIR)/bin
 
 # Linter config.
 GOLANGCI_BIN:=$(LOCAL_BIN)/golangci-lint
-GOLANGCI_TAG:=1.52.2
+GOLANGCI_TAG:=1.53.3
 
 .PHONY: all
 all: deps test build

README.md

@@ -1,6 +1,9 @@
 # Launchr
 
-`launchr`
+Launchr is a CLI action runner that executes actions inside short-lived local containers.  
+Actions are defined in `action.yaml` files, which are automatically discovered in the filesystem. 
+They can be placed anywhere that makes sense semantically. You can find action examples [here](example) and in the [documentation](docs).  
+Launchr has a plugin system that allows to extend its functionality. See [core plugins](pkg/plugins), [compose](https://github.com/launchrctl/compose) and [documentation](docs).
 
 ## Table of contents
 

app.go

@@ -8,10 +8,17 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/launchrctl/launchr/pkg/action"
 	"github.com/launchrctl/launchr/pkg/cli"
-	"github.com/launchrctl/launchr/pkg/log"
+	"github.com/launchrctl/launchr/pkg/cobraadapter"
 )
 
+// ActionsGroup is a cobra command group definition
+var ActionsGroup = &cobra.Group{
+	ID:    "actions",
+	Title: "Actions:",
+}
+
 // App holds app related global variables.
 type App struct {
 	cmd     *cobra.Command
@@ -20,6 +27,7 @@ type App struct {
 	cfgDir  string
 	version *AppVersion
 	plugins map[PluginInfo]Plugin
+	actions map[string]*action.Command
 }
 
 // NewApp constructs app implementation.
@@ -47,13 +55,23 @@ func (app *App) Plugins() map[PluginInfo]Plugin {
 	return app.plugins
 }
 
+// AddActionCommand adds an action to the app.
+func (app *App) AddActionCommand(cmd *action.Command) {
+	app.actions[cmd.CommandName] = cmd
+}
+
+func (app *App) GetActionCommands() map[string]*action.Command {
+	return app.actions
+}
+
 // Init initializes application and plugins.
 func (app *App) Init() error {
 	var err error
 	app.version = GetVersion()
 	// Global configuration.
 	app.cfgDir = fmt.Sprintf(".%s", app.version.Name)
 	app.workDir, err = filepath.Abs("./")
+	app.actions = make(map[string]*action.Command)
 	if err != nil {
 		return err
 	}
@@ -84,16 +102,25 @@ func (app *App) exec() error {
 		//Short: "", // @todo
 		//Long:  ``, // @todo
 		Version: Version,
-		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-			setCobraLogger()
-			return nil
-		},
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return cmd.Help()
 		},
 	}
 	rootCmd.SetVersionTemplate(app.version.String())
-	verbosityFlags(rootCmd)
+
+	// Convert actions to cobra commands.
+	if len(app.actions) > 0 {
+		rootCmd.AddGroup(ActionsGroup)
+	}
+	for _, cmdDef := range app.actions {
+		cobraCmd, err := cobraadapter.GetActionImpl(app.GetCli(), cmdDef, ActionsGroup)
+		if err != nil {
+			return err
+		}
+		rootCmd.AddCommand(cobraCmd)
+	}
+
+	// Add cobra commands from plugins.
 	for _, p := range app.Plugins() {
 		p, ok := p.(CobraPlugin)
 		if ok {
@@ -103,7 +130,7 @@ func (app *App) exec() error {
 		}
 	}
 
-	// Set streams.
+	// Set io streams.
 	app.cmd = rootCmd
 	rootCmd.SetIn(app.cli.In())
 	rootCmd.SetOut(app.cli.Out())
@@ -120,27 +147,6 @@ func (app *App) Execute() int {
 	return 0
 }
 
-var verbosity = 0
-var quiet = false
-
-func setCobraLogger() {
-	if quiet {
-		// @todo it doesn't really work for cli and docker output, only for logging.
-		return
-	}
-	log.SetGlobalLogger(log.NewPlainLogger(os.Stdout, os.Stderr, nil))
-	if verbosity > int(log.ErrLvl) {
-		verbosity = int(log.ErrLvl)
-	}
-	log.SetLevel(log.Level(int(log.ErrLvl) - verbosity))
-}
-
-func verbosityFlags(cmd *cobra.Command) {
-	// @todo rework to plugins somehow
-	cmd.PersistentFlags().CountVarP(&verbosity, "verbose", "v", "log verbosity level, use -vvv DEBUG, -vv WARN, -v INFO")
-	cmd.PersistentFlags().BoolVarP(&quiet, "quiet", "q", false, "disable stdOut")
-}
-
 // Run executes launchr application and returns os exit code.
 func Run() int {
 	app := NewApp()

go.mod

@@ -10,7 +10,8 @@ require (
 	github.com/moby/sys/signal v0.7.0
 	github.com/moby/term v0.5.0
 	github.com/spf13/cobra v1.7.0
-	github.com/stretchr/testify v1.8.2
+	github.com/stretchr/testify v1.8.4
+	golang.org/x/mod v0.11.0
 	golang.org/x/sys v0.9.0
 	gopkg.in/yaml.v3 v3.0.1
 )
@@ -26,6 +27,7 @@ require (
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/klauspost/compress v1.16.6 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
 	github.com/moby/patternmatcher v0.5.0 // indirect
 	github.com/moby/sys/sequential v0.5.0 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
@@ -34,9 +36,9 @@ require (
 	github.com/opencontainers/runc v1.1.7 // 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/mod v0.11.0 // indirect
 	golang.org/x/net v0.11.0 // indirect
 	golang.org/x/time v0.3.0 // indirect
 	golang.org/x/tools v0.10.0 // indirect

go.sum

@@ -9,6 +9,7 @@ github.com/a8m/envsubst v1.4.2/go.mod h1:MVUTQNGQ3tsjOOtKCNd+fl8RzhsXcDvvAEzkhGt
 github.com/containerd/containerd v1.7.2 h1:UF2gdONnxO8I6byZXDi5sXWiWvlW3D/sci7dTQimEJo=
 github.com/containerd/containerd v1.7.2/go.mod h1:afcz74+K10M/+cjGHIVQrCt3RAQhUSCAjJ9iMYhhkuI=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY=
 github.com/cyphar/filepath-securejoin v0.2.3 h1:YX6ebbZCZP7VkM3scTTokDgBL2TY741X51MTk3ycuNI=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -34,11 +35,13 @@ github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/klauspost/compress v1.16.6 h1:91SKEy4K37vkp255cJ8QesJhjyRO0hn9i9G0GoUwLsk=
 github.com/klauspost/compress v1.16.6/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=
-github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/moby/moby v24.0.2+incompatible h1:yH+5dRHH1x3XRKzl1THA2aGTy6CHYnkt5N924ADMax8=
 github.com/moby/moby v24.0.2+incompatible/go.mod h1:fDXVQ6+S340veQPv35CzDahGBmHsiclFwfEygB/TWMc=
 github.com/moby/patternmatcher v0.5.0 h1:YCZgJOeULcxLw1Q+sVR636pmS7sPEn1Qo2iAN6M7DBo=
@@ -57,10 +60,14 @@ github.com/opencontainers/image-spec v1.1.0-rc3 h1:fzg1mXZFj8YdPeNkRXMg+zb88BFV0
 github.com/opencontainers/image-spec v1.1.0-rc3/go.mod h1:X4pATf0uXsnn3g5aiGIsVnJBR4mxhKzfwmvK/B2NTm8=
 github.com/opencontainers/runc v1.1.7 h1:y2EZDS8sNng4Ksf0GUYNhKbTShZJPJg1FiXJNH/uoCk=
 github.com/opencontainers/runc v1.1.7/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=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
+github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
+github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
@@ -69,13 +76,9 @@ github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRM
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
-github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=

pkg/cobraadapter/action.go

@@ -0,0 +1,78 @@
+// Package cobraadapter provides an adapter from launchr actions to cobra commands.
+package cobraadapter
+
+import (
+	"context"
+	"strings"
+
+	"github.com/spf13/cobra"
+
+	"github.com/launchrctl/launchr/pkg/action"
+	"github.com/launchrctl/launchr/pkg/cli"
+)
+
+// GetActionImpl returns cobra command implementation for an action.
+func GetActionImpl(appCli cli.Cli, cmd *action.Command, group *cobra.Group) (*cobra.Command, error) {
+	if err := cmd.Compile(); err != nil {
+		return nil, err
+	}
+	a := cmd.Action()
+	args := a.Arguments
+	use := cmd.CommandName
+	for _, p := range args {
+		use += " " + p.Name
+	}
+	options := make(map[string]interface{})
+	cobraCmd := &cobra.Command{
+		Use:  use,
+		Args: cobra.ExactArgs(len(args)),
+		// @todo: maybe we need a long template for arguments description
+		Short: getDesc(a.Title, a.Description),
+		RunE: func(ccmd *cobra.Command, args []string) error {
+			// Don't show usage help on a runtime error.
+			ccmd.SilenceUsage = true
+			return runCmd(ccmd.Context(), appCli, cmd, args, options)
+		},
+	}
+	if group != nil {
+		cobraCmd.GroupID = group.ID
+	}
+
+	for _, opt := range a.Options {
+		options[opt.Name] = setFlag(cobraCmd, opt)
+	}
+
+	return cobraCmd, nil
+}
+
+func runCmd(ctx context.Context, appCli cli.Cli, cmd *action.Command, args []string, opts map[string]interface{}) error {
+	// Save and validate input.
+	cmd.SetArgsInput(args)
+	cmd.SetOptsInput(derefOpts(opts))
+	if err := cmd.Compile(); err != nil {
+		return err
+	}
+	if err := cmd.ValidateInput(); err != nil {
+		return err
+	}
+
+	r, err := action.NewDockerExecutor()
+	if err != nil {
+		return err
+	}
+	defer r.Close()
+
+	// Run the command.
+	return r.Exec(ctx, appCli, cmd)
+}
+
+func getDesc(title string, desc string) string {
+	parts := make([]string, 0, 2)
+	if title != "" {
+		parts = append(parts, title)
+	}
+	if desc != "" {
+		parts = append(parts, desc)
+	}
+	return strings.Join(parts, ": ")
+}

pkg/plugins/yamldiscovery/flag.go renamed to pkg/cobraadapter/flag.go

@@ -1,4 +1,4 @@
-package yamldiscovery
+package cobraadapter
 
 import (
 	"reflect"
@@ -10,9 +10,9 @@ import (
 	"github.com/launchrctl/launchr/pkg/log"
 )
 
-func setCobraFlag(ccmd *cobra.Command, opt *action.Option) interface{} {
+func setFlag(ccmd *cobra.Command, opt *action.Option) interface{} {
 	var val interface{}
-	desc := getCobraCmdDesc(opt.Title, opt.Description)
+	desc := getDesc(opt.Title, opt.Description)
 	switch opt.Type {
 	case jsonschema.String:
 		val = ccmd.Flags().String(opt.Name, opt.Default.(string), desc)
@@ -56,7 +56,7 @@ func derefOpt(v interface{}) interface{} {
 		return *v
 	default:
 		if reflect.ValueOf(v).Kind() == reflect.Ptr {
-			log.Panic("error on dereferencing value: unsupported %T", v)
+			log.Panic("error on a value dereferencing: unsupported %T", v)
 		}
 		return v
 	}

pkg/plugins/builder/plugin.go

@@ -50,7 +50,8 @@ func (p *Plugin) CobraAddCommands(rootCmd *cobra.Command) error {
 	flags := builderInput{}
 
 	var buildCmd = &cobra.Command{
-		Use: "build",
+		Use:   "build",
+		Short: "Rebuilds application with specified configuration",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			// Don't show usage help on a runtime error.
 			cmd.SilenceUsage = true

pkg/plugins/default.go

@@ -4,5 +4,6 @@ package plugins
 import (
 	// Default launchr plugins to include for launchr functionality.
 	_ "github.com/launchrctl/launchr/pkg/plugins/builder"
+	_ "github.com/launchrctl/launchr/pkg/plugins/verbosity"
 	_ "github.com/launchrctl/launchr/pkg/plugins/yamldiscovery"
 )