Move ParametersOptions in order to make it accessible from different command packages

Signed-off-by: Jean-Christophe Sirot <[email protected]>

Author: Jean-Christophe Sirot

internal/cliopts/parameters.go

@@ -0,0 +1,17 @@
+package cliopts
+
+import (
+	"github.com/spf13/pflag"
+)
+
+// ParametersOptions are shared CLI options about docker app parameters
+type ParametersOptions struct {
+	ParametersFiles []string
+	Overrides       []string
+}
+
+// AddFlags adds the shared CLI flags to the given flag set
+func (o *ParametersOptions) AddFlags(flags *pflag.FlagSet) {
+	flags.StringArrayVar(&o.ParametersFiles, "parameters-file", []string{}, "Override parameters file")
+	flags.StringArrayVarP(&o.Overrides, "set", "s", []string{}, "Override parameter value")
+}

internal/commands/image/render.go

@@ -6,7 +6,7 @@ import (
 	"io"
 	"os"
 
-	"github.com/spf13/pflag"
+	"github.com/docker/app/internal/cliopts"
 
 	"github.com/deislabs/cnab-go/action"
 	"github.com/docker/app/internal"
@@ -20,18 +20,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
-type parametersOptions struct {
-	ParametersFiles []string
-	Overrides       []string
-}
-
-func (o *parametersOptions) addFlags(flags *pflag.FlagSet) {
-	flags.StringArrayVar(&o.ParametersFiles, "parameters-file", []string{}, "Override parameters file")
-	flags.StringArrayVarP(&o.Overrides, "set", "s", []string{}, "Override parameter value")
-}
-
 type renderOptions struct {
-	parametersOptions
+	cliopts.ParametersOptions
 	formatDriver string
 	renderOutput string
 }
@@ -48,7 +38,7 @@ func renderCmd(dockerCli command.Cli) *cobra.Command {
 			return runRender(dockerCli, args[0], opts)
 		},
 	}
-	opts.parametersOptions.addFlags(cmd.Flags())
+	opts.ParametersOptions.AddFlags(cmd.Flags())
 	cmd.Flags().StringVarP(&opts.renderOutput, "output", "o", "-", "Output file")
 	cmd.Flags().StringVar(&opts.formatDriver, "formatter", "yaml", "Configure the output format (yaml|json)")
 
@@ -68,7 +58,7 @@ func runRender(dockerCli command.Cli, appname string, opts renderOptions) error
 		w = f
 	}
 
-	action, installation, errBuf, err := prepareCustomAction(internal.ActionRenderName, dockerCli, appname, w, opts.parametersOptions)
+	action, installation, errBuf, err := prepareCustomAction(internal.ActionRenderName, dockerCli, appname, w, opts.ParametersOptions)
 	if err != nil {
 		return err
 	}
@@ -80,7 +70,8 @@ func runRender(dockerCli command.Cli, appname string, opts renderOptions) error
 	return nil
 }
 
-func prepareCustomAction(actionName string, dockerCli command.Cli, appname string, stdout io.Writer, paramsOpts parametersOptions) (*action.RunCustom, *appstore.Installation, *bytes.Buffer, error) {
+func prepareCustomAction(actionName string, dockerCli command.Cli, appname string, stdout io.Writer,
+	paramsOpts cliopts.ParametersOptions) (*action.RunCustom, *appstore.Installation, *bytes.Buffer, error) {
 	s, err := appstore.NewApplicationStore(config.Dir())
 	if err != nil {
 		return nil, nil, nil, err

internal/commands/root.go

@@ -110,16 +110,6 @@ func prepareBundleStore() (store.BundleStore, error) {
 	return bundleStore, nil
 }
 
-type parametersOptions struct {
-	parametersFiles []string
-	overrides       []string
-}
-
-func (o *parametersOptions) addFlags(flags *pflag.FlagSet) {
-	flags.StringArrayVar(&o.parametersFiles, "parameters-file", []string{}, "Override parameters file")
-	flags.StringArrayVarP(&o.overrides, "set", "s", []string{}, "Override parameter value")
-}
-
 type targetContextOptions struct {
 	targetContext string
 }

internal/commands/run.go

@@ -4,14 +4,15 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/docker/cli/cli"
+	"github.com/docker/app/internal/cliopts"
 
 	"github.com/deislabs/cnab-go/action"
 	"github.com/deislabs/cnab-go/bundle"
 	"github.com/deislabs/cnab-go/credentials"
 	bdl "github.com/docker/app/internal/bundle"
 	"github.com/docker/app/internal/cnab"
 	"github.com/docker/app/internal/store"
+	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/docker/pkg/namesgenerator"
 	"github.com/pkg/errors"
@@ -20,7 +21,7 @@ import (
 )
 
 type runOptions struct {
-	parametersOptions
+	cliopts.ParametersOptions
 	credentialOptions
 	orchestrator  string
 	kubeNamespace string
@@ -59,7 +60,7 @@ func runCmd(dockerCli command.Cli) *cobra.Command {
 			return runCnab(dockerCli, opts)
 		},
 	}
-	opts.parametersOptions.addFlags(cmd.Flags())
+	opts.ParametersOptions.AddFlags(cmd.Flags())
 	opts.credentialOptions.addFlags(cmd.Flags())
 	cmd.Flags().StringVar(&opts.orchestrator, "orchestrator", "", "Orchestrator to install on (swarm, kubernetes)")
 	cmd.Flags().StringVar(&opts.kubeNamespace, "namespace", "default", "Kubernetes namespace to install into")
@@ -131,8 +132,8 @@ func runBundle(dockerCli command.Cli, bndl *bundle.Bundle, opts runOptions, ref
 	installation.Bundle = bndl
 
 	if err := bdl.MergeBundleParameters(installation,
-		bdl.WithFileParameters(opts.parametersFiles),
-		bdl.WithCommandLineParameters(opts.overrides),
+		bdl.WithFileParameters(opts.ParametersFiles),
+		bdl.WithCommandLineParameters(opts.Overrides),
 		bdl.WithLabels(opts.labels),
 		bdl.WithOrchestratorParameters(opts.orchestrator, opts.kubeNamespace),
 		bdl.WithSendRegistryAuth(opts.sendRegistryAuth),

internal/commands/update.go

@@ -7,13 +7,14 @@ import (
 	"github.com/deislabs/cnab-go/action"
 	"github.com/deislabs/cnab-go/credentials"
 	"github.com/docker/app/internal/bundle"
+	"github.com/docker/app/internal/cliopts"
 	"github.com/docker/app/internal/cnab"
 	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
 )
 
 type updateOptions struct {
-	parametersOptions
+	cliopts.ParametersOptions
 	credentialOptions
 	bundleOrDockerApp string
 }
@@ -29,7 +30,7 @@ func updateCmd(dockerCli command.Cli) *cobra.Command {
 			return runUpdate(dockerCli, args[0], opts)
 		},
 	}
-	opts.parametersOptions.addFlags(cmd.Flags())
+	opts.ParametersOptions.AddFlags(cmd.Flags())
 	opts.credentialOptions.addFlags(cmd.Flags())
 	cmd.Flags().StringVar(&opts.bundleOrDockerApp, "image", "", "Override the running App with another App image")
 
@@ -62,8 +63,8 @@ func runUpdate(dockerCli command.Cli, installationName string, opts updateOption
 		installation.Bundle = b
 	}
 	if err := bundle.MergeBundleParameters(installation,
-		bundle.WithFileParameters(opts.parametersFiles),
-		bundle.WithCommandLineParameters(opts.overrides),
+		bundle.WithFileParameters(opts.ParametersFiles),
+		bundle.WithCommandLineParameters(opts.Overrides),
 		bundle.WithSendRegistryAuth(opts.sendRegistryAuth),
 	); err != nil {
 		return err

internal/commands/validate.go

@@ -4,18 +4,19 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/docker/app/internal/cliopts"
 	"github.com/docker/app/internal/compose"
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/render"
 	"github.com/docker/app/types"
 	"github.com/docker/cli/cli"
-	cliopts "github.com/docker/cli/opts"
+	dockercliopts "github.com/docker/cli/opts"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 )
 
 type validateOptions struct {
-	parametersOptions
+	cliopts.ParametersOptions
 }
 
 func validateCmd() *cobra.Command {
@@ -29,19 +30,19 @@ func validateCmd() *cobra.Command {
 			return runValidate(args, opts)
 		},
 	}
-	opts.parametersOptions.addFlags(cmd.Flags())
+	opts.ParametersOptions.AddFlags(cmd.Flags())
 	return cmd
 }
 
 func runValidate(args []string, opts validateOptions) error {
 	app, err := packager.Extract(firstOrEmpty(args),
-		types.WithParametersFiles(opts.parametersFiles...),
+		types.WithParametersFiles(opts.ParametersFiles...),
 	)
 	if err != nil {
 		return err
 	}
 	defer app.Cleanup()
-	argParameters := cliopts.ConvertKVStringsToMap(opts.overrides)
+	argParameters := dockercliopts.ConvertKVStringsToMap(opts.Overrides)
 	_, err = render.Render(app, argParameters, nil)
 	if err != nil {
 		return err