Merge pull request #1165 from docker/global-opts

Make `--file` and `--project-name` global compose options

Author: ndeloof

cli/cmd/compose/build.go

@@ -26,21 +26,21 @@ import (
 )
 
 type buildOptions struct {
+	*projectOptions
 	composeOptions
 }
 
-func buildCommand() *cobra.Command {
-	opts := buildOptions{}
+func buildCommand(p *projectOptions) *cobra.Command {
+	opts := buildOptions{
+		projectOptions: p,
+	}
 	buildCmd := &cobra.Command{
 		Use:   "build [SERVICE...]",
 		Short: "Build or rebuild services",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runBuild(cmd.Context(), opts, args)
 		},
 	}
-	buildCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	buildCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-
 	return buildCmd
 }
 

cli/cmd/compose/compose.go

@@ -27,26 +27,22 @@ import (
 	"github.com/docker/compose-cli/api/context/store"
 )
 
-type composeOptions struct {
+type projectOptions struct {
 	ProjectName string
-	DomainName  string
-	WorkingDir  string
 	ConfigPaths []string
-	Environment []string
+	WorkingDir  string
 	EnvFile     string
-	Format      string
-	Detach      bool
-	Build       bool
-	Quiet       bool
 }
 
-func addComposeCommonFlags(f *pflag.FlagSet, opts *composeOptions) {
-	f.StringVarP(&opts.ProjectName, "project-name", "p", "", "Project name")
-	f.StringVar(&opts.Format, "format", "", "Format the output. Values: [pretty | json]. (Default: pretty)")
-	f.BoolVarP(&opts.Quiet, "quiet", "q", false, "Only display IDs")
+func (o *projectOptions) addProjectFlags(f *pflag.FlagSet) {
+	f.StringVarP(&o.ProjectName, "project-name", "p", "", "Project name")
+	f.StringArrayVarP(&o.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
+	f.StringVar(&o.EnvFile, "env-file", "", "Specify an alternate environment file.")
+	f.StringVar(&o.WorkingDir, "workdir", "", "Specify an alternate working directory")
+	// TODO make --project-directory an alias
 }
 
-func (o *composeOptions) toProjectName() (string, error) {
+func (o *projectOptions) toProjectName() (string, error) {
 	if o.ProjectName != "" {
 		return o.ProjectName, nil
 	}
@@ -58,7 +54,7 @@ func (o *composeOptions) toProjectName() (string, error) {
 	return project.Name, nil
 }
 
-func (o *composeOptions) toProject() (*types.Project, error) {
+func (o *projectOptions) toProject() (*types.Project, error) {
 	options, err := o.toProjectOptions()
 	if err != nil {
 		return nil, err
@@ -71,18 +67,18 @@ func (o *composeOptions) toProject() (*types.Project, error) {
 	return project, nil
 }
 
-func (o *composeOptions) toProjectOptions() (*cli.ProjectOptions, error) {
+func (o *projectOptions) toProjectOptions() (*cli.ProjectOptions, error) {
 	return cli.NewProjectOptions(o.ConfigPaths,
 		cli.WithOsEnv,
 		cli.WithEnvFile(o.EnvFile),
 		cli.WithDotEnv,
-		cli.WithEnv(o.Environment),
 		cli.WithWorkingDirectory(o.WorkingDir),
 		cli.WithName(o.ProjectName))
 }
 
 // Command returns the compose command with its child commands
 func Command(contextType string) *cobra.Command {
+	opts := projectOptions{}
 	command := &cobra.Command{
 		Short: "Docker Compose",
 		Use:   "compose",
@@ -95,23 +91,24 @@ func Command(contextType string) *cobra.Command {
 	}
 
 	command.AddCommand(
-		upCommand(contextType),
-		downCommand(),
-		psCommand(),
+		upCommand(&opts, contextType),
+		downCommand(&opts),
+		psCommand(&opts),
 		listCommand(),
-		logsCommand(),
-		convertCommand(),
-		runCommand(),
+		logsCommand(&opts),
+		convertCommand(&opts),
+		runCommand(&opts),
 	)
 
 	if contextType == store.LocalContextType || contextType == store.DefaultContextType {
 		command.AddCommand(
-			buildCommand(),
-			pushCommand(),
-			pullCommand(),
+			buildCommand(&opts),
+			pushCommand(&opts),
+			pullCommand(&opts),
 		)
 	}
 	command.Flags().SetInterspersed(false)
+	opts.addProjectFlags(command.PersistentFlags())
 	return command
 }
 

cli/cmd/compose/convert.go

@@ -27,26 +27,29 @@ import (
 	"github.com/docker/compose-cli/api/client"
 )
 
-func convertCommand() *cobra.Command {
-	opts := composeOptions{}
+type convertOptions struct {
+	*projectOptions
+	Format string
+}
+
+func convertCommand(p *projectOptions) *cobra.Command {
+	opts := convertOptions{
+		projectOptions: p,
+	}
 	convertCmd := &cobra.Command{
 		Use:   "convert",
 		Short: "Converts the compose file to a cloud format (default: cloudformation)",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runConvert(cmd.Context(), opts)
 		},
 	}
-	convertCmd.Flags().StringVarP(&opts.ProjectName, "project-name", "p", "", "Project name")
-	convertCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	convertCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-	convertCmd.Flags().StringArrayVarP(&opts.Environment, "environment", "e", []string{}, "Environment variables")
-	convertCmd.Flags().StringVar(&opts.EnvFile, "env-file", "", "Specify an alternate environment file.")
-	convertCmd.Flags().StringVar(&opts.Format, "format", "yaml", "Format the output. Values: [yaml | json]")
+	flags := convertCmd.Flags()
+	flags.StringVar(&opts.Format, "format", "yaml", "Format the output. Values: [yaml | json]")
 
 	return convertCmd
 }
 
-func runConvert(ctx context.Context, opts composeOptions) error {
+func runConvert(ctx context.Context, opts convertOptions) error {
 	var json []byte
 	c, err := client.NewWithDefaultLocalBackend(ctx)
 	if err != nil {

cli/cmd/compose/down.go

@@ -29,23 +29,25 @@ import (
 	"github.com/docker/compose-cli/api/progress"
 )
 
-func downCommand() *cobra.Command {
-	opts := composeOptions{}
+type downOptions struct {
+	*projectOptions
+}
+
+func downCommand(p *projectOptions) *cobra.Command {
+	opts := downOptions{
+		projectOptions: p,
+	}
 	downCmd := &cobra.Command{
 		Use:   "down",
 		Short: "Stop and remove containers, networks",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runDown(cmd.Context(), opts)
 		},
 	}
-	downCmd.Flags().StringVarP(&opts.ProjectName, "project-name", "p", "", "Project name")
-	downCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	downCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-
 	return downCmd
 }
 
-func runDown(ctx context.Context, opts composeOptions) error {
+func runDown(ctx context.Context, opts downOptions) error {
 	c, err := client.NewWithDefaultLocalBackend(ctx)
 	if err != nil {
 		return err

cli/cmd/compose/list.go

@@ -30,25 +30,31 @@ import (
 	"github.com/docker/compose-cli/cli/formatter"
 )
 
+type lsOptions struct {
+	Format string
+	Quiet  bool
+}
+
 func listCommand() *cobra.Command {
-	opts := composeOptions{}
+	opts := lsOptions{}
 	lsCmd := &cobra.Command{
 		Use:   "ls",
 		Short: "List running compose projects",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runList(cmd.Context(), opts)
 		},
 	}
-	addComposeCommonFlags(lsCmd.Flags(), &opts)
+	lsCmd.Flags().StringVar(&opts.Format, "format", "pretty", "Format the output. Values: [pretty | json].")
+	lsCmd.Flags().BoolVarP(&opts.Quiet, "quiet", "q", false, "Only display IDs")
 	return lsCmd
 }
 
-func runList(ctx context.Context, opts composeOptions) error {
+func runList(ctx context.Context, opts lsOptions) error {
 	c, err := client.NewWithDefaultLocalBackend(ctx)
 	if err != nil {
 		return err
 	}
-	stackList, err := c.ComposeService().List(ctx, opts.ProjectName)
+	stackList, err := c.ComposeService().List(ctx, "")
 	if err != nil {
 		return err
 	}

cli/cmd/compose/logs.go

@@ -27,23 +27,26 @@ import (
 	"github.com/docker/compose-cli/cli/formatter"
 )
 
-func logsCommand() *cobra.Command {
-	opts := composeOptions{}
+type logsOptions struct {
+	*projectOptions
+	composeOptions
+}
+
+func logsCommand(p *projectOptions) *cobra.Command {
+	opts := logsOptions{
+		projectOptions: p,
+	}
 	logsCmd := &cobra.Command{
 		Use:   "logs [service...]",
 		Short: "View output from containers",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runLogs(cmd.Context(), opts, args)
 		},
 	}
-	logsCmd.Flags().StringVarP(&opts.ProjectName, "project-name", "p", "", "Project name")
-	logsCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	logsCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-
 	return logsCmd
 }
 
-func runLogs(ctx context.Context, opts composeOptions, services []string) error {
+func runLogs(ctx context.Context, opts logsOptions, services []string) error {
 	c, err := client.NewWithDefaultLocalBackend(ctx)
 	if err != nil {
 		return err

cli/cmd/compose/ps.go

@@ -30,22 +30,29 @@ import (
 	"github.com/docker/compose-cli/cli/formatter"
 )
 
-func psCommand() *cobra.Command {
-	opts := composeOptions{}
+type psOptions struct {
+	*projectOptions
+	Format string
+	Quiet  bool
+}
+
+func psCommand(p *projectOptions) *cobra.Command {
+	opts := psOptions{
+		projectOptions: p,
+	}
 	psCmd := &cobra.Command{
 		Use:   "ps",
 		Short: "List containers",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runPs(cmd.Context(), opts)
 		},
 	}
-	psCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	psCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-	addComposeCommonFlags(psCmd.Flags(), &opts)
+	psCmd.Flags().StringVar(&opts.Format, "format", "pretty", "Format the output. Values: [pretty | json].")
+	psCmd.Flags().BoolVarP(&opts.Quiet, "quiet", "q", false, "Only display IDs")
 	return psCmd
 }
 
-func runPs(ctx context.Context, opts composeOptions) error {
+func runPs(ctx context.Context, opts psOptions) error {
 	c, err := client.NewWithDefaultLocalBackend(ctx)
 	if err != nil {
 		return err

cli/cmd/compose/pull.go

@@ -26,22 +26,21 @@ import (
 )
 
 type pullOptions struct {
+	*projectOptions
 	composeOptions
 }
 
-func pullCommand() *cobra.Command {
-	opts := pullOptions{}
+func pullCommand(p *projectOptions) *cobra.Command {
+	opts := pullOptions{
+		projectOptions: p,
+	}
 	pullCmd := &cobra.Command{
 		Use:   "pull [SERVICE...]",
 		Short: "Pull service images",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runPull(cmd.Context(), opts, args)
 		},
 	}
-
-	pullCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	pullCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-
 	return pullCmd
 }
 

cli/cmd/compose/push.go

@@ -26,22 +26,21 @@ import (
 )
 
 type pushOptions struct {
+	*projectOptions
 	composeOptions
 }
 
-func pushCommand() *cobra.Command {
-	opts := pushOptions{}
+func pushCommand(p *projectOptions) *cobra.Command {
+	opts := pushOptions{
+		projectOptions: p,
+	}
 	pushCmd := &cobra.Command{
 		Use:   "push [SERVICE...]",
 		Short: "Push service images",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runPush(cmd.Context(), opts, args)
 		},
 	}
-
-	pushCmd.Flags().StringVar(&opts.WorkingDir, "workdir", "", "Work dir")
-	pushCmd.Flags().StringArrayVarP(&opts.ConfigPaths, "file", "f", []string{}, "Compose configuration files")
-
 	return pushCmd
 }