Add cp command

Signed-off-by: Julien Tant <[email protected]>

Author: JulienTant

aci/compose.go

@@ -80,6 +80,10 @@ func (cs *aciComposeService) UnPause(ctx context.Context, project string, option
 	return errdefs.ErrNotImplemented
 }
 
+func (cs *aciComposeService) Copy(ctx context.Context, project *types.Project, options compose.CopyOptions) error {
+	return errdefs.ErrNotImplemented
+}
+
 func (cs *aciComposeService) Up(ctx context.Context, project *types.Project, options compose.UpOptions) error {
 	logrus.Debugf("Up on project with name %q", project.Name)
 

api/client/compose.go

@@ -96,6 +96,10 @@ func (c *composeService) Exec(ctx context.Context, project *types.Project, opts
 	return 0, errdefs.ErrNotImplemented
 }
 
+func (c *composeService) Copy(ctx context.Context, project *types.Project, opts compose.CopyOptions) error {
+	return errdefs.ErrNotImplemented
+}
+
 func (c *composeService) Pause(ctx context.Context, project string, options compose.PauseOptions) error {
 	return errdefs.ErrNotImplemented
 }

api/compose/api.go

@@ -62,6 +62,8 @@ type Service interface {
 	Remove(ctx context.Context, project *types.Project, options RemoveOptions) ([]string, error)
 	// Exec executes a command in a running service container
 	Exec(ctx context.Context, project *types.Project, opts RunOptions) (int, error)
+	// Copy copies a file/folder between a service container and the local filesystem
+	Copy(ctx context.Context, project *types.Project, opts CopyOptions) error
 	// Pause executes the equivalent to a `compose pause`
 	Pause(ctx context.Context, project string, options PauseOptions) error
 	// UnPause executes the equivalent to a `compose unpause`
@@ -271,6 +273,15 @@ type PsOptions struct {
 	All bool
 }
 
+// CopyOptions group options of the cp API
+type CopyOptions struct {
+	Source      string
+	Destination string
+	Index       int
+	FollowLink  bool
+	CopyUIDGID  bool
+}
+
 // PortPublisher hold status about published port
 type PortPublisher struct {
 	URL           string

api/compose/delegator.go

@@ -112,6 +112,11 @@ func (s *ServiceDelegator) Exec(ctx context.Context, project *types.Project, opt
 	return s.Delegate.Exec(ctx, project, options)
 }
 
+//Copy implements Service interface
+func (s *ServiceDelegator) Copy(ctx context.Context, project *types.Project, options CopyOptions) error {
+	return s.Delegate.Copy(ctx, project, options)
+}
+
 //Pause implements Service interface
 func (s *ServiceDelegator) Pause(ctx context.Context, project string, options PauseOptions) error {
 	return s.Delegate.Pause(ctx, project, options)

api/compose/noimpl.go

@@ -112,6 +112,11 @@ func (s NoImpl) Exec(ctx context.Context, project *types.Project, opts RunOption
 	return 0, errdefs.ErrNotImplemented
 }
 
+//Copy implements Service interface
+func (s NoImpl) Copy(ctx context.Context, project *types.Project, opts CopyOptions) error {
+	return errdefs.ErrNotImplemented
+}
+
 //Pause implements Service interface
 func (s NoImpl) Pause(ctx context.Context, project string, options PauseOptions) error {
 	return errdefs.ErrNotImplemented

cli/cmd/compose/compose.go

@@ -228,6 +228,7 @@ func RootCommand(contextType string, backend compose.Service) *cobra.Command {
 			pushCommand(&opts, backend),
 			pullCommand(&opts, backend),
 			createCommand(&opts, backend),
+			copyCommand(&opts, backend),
 		)
 	}
 	command.Flags().SetInterspersed(false)

cli/cmd/compose/cp.go

@@ -0,0 +1,83 @@
+/*
+   Copyright 2020 Docker Compose CLI authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package compose
+
+import (
+	"context"
+	"errors"
+
+	"github.com/docker/cli/cli"
+	"github.com/spf13/cobra"
+
+	"github.com/docker/compose-cli/api/compose"
+)
+
+type copyOptions struct {
+	*projectOptions
+
+	source      string
+	destination string
+	index       int
+	followLink  bool
+	copyUIDGID  bool
+}
+
+func copyCommand(p *projectOptions, backend compose.Service) *cobra.Command {
+	opts := copyOptions{
+		projectOptions: p,
+	}
+	copyCmd := &cobra.Command{
+		Use: `cp [OPTIONS] SERVICE:SRC_PATH DEST_PATH|-
+	docker compose cp [OPTIONS] SRC_PATH|- SERVICE:DEST_PATH`,
+		Short: "Copy files/folders between a service container and the local filesystem",
+		Args:  cli.ExactArgs(2),
+		RunE: Adapt(func(ctx context.Context, args []string) error {
+			if args[0] == "" {
+				return errors.New("source can not be empty")
+			}
+			if args[1] == "" {
+				return errors.New("destination can not be empty")
+			}
+
+			opts.source = args[0]
+			opts.destination = args[1]
+			return runCopy(ctx, backend, opts)
+		}),
+	}
+
+	flags := copyCmd.Flags()
+	flags.IntVar(&opts.index, "index", 1, "index of the container if there are multiple instances of a service [default: 1].")
+	flags.BoolVarP(&opts.followLink, "follow-link", "L", false, "Always follow symbol link in SRC_PATH")
+	flags.BoolVarP(&opts.copyUIDGID, "archive", "a", false, "Archive mode (copy all uid/gid information)")
+
+	return copyCmd
+}
+
+func runCopy(ctx context.Context, backend compose.Service, opts copyOptions) error {
+	projects, err := opts.toProject(nil)
+	if err != nil {
+		return err
+	}
+
+	return backend.Copy(ctx, projects, compose.CopyOptions{
+		Source:      opts.source,
+		Destination: opts.destination,
+		Index:       opts.index,
+		FollowLink:  opts.followLink,
+		CopyUIDGID:  opts.copyUIDGID,
+	})
+}

cli/metrics/commands.go

@@ -63,6 +63,7 @@ var commands = []string{
 	"deploy",
 	"list",
 	"ls",
+	"cp",
 	"merge",
 	"pull",
 	"push",

ecs/local/compose.go

@@ -188,6 +188,10 @@ func (e ecsLocalSimulation) Exec(ctx context.Context, project *types.Project, op
 	return 0, errdefs.ErrNotImplemented
 }
 
+func (e ecsLocalSimulation) Copy(ctx context.Context, project *types.Project, opts compose.CopyOptions) error {
+	return e.compose.Copy(ctx, project, opts)
+}
+
 func (e ecsLocalSimulation) Pause(ctx context.Context, project string, options compose.PauseOptions) error {
 	return e.compose.Pause(ctx, project, options)
 }

ecs/up.go

@@ -75,6 +75,10 @@ func (b *ecsAPIService) Port(ctx context.Context, project string, service string
 	return "", 0, errdefs.ErrNotImplemented
 }
 
+func (b *ecsAPIService) Copy(ctx context.Context, project *types.Project, options compose.CopyOptions) error {
+	return errdefs.ErrNotImplemented
+}
+
 func (b *ecsAPIService) Up(ctx context.Context, project *types.Project, options compose.UpOptions) error {
 	logrus.Debugf("deploying on AWS with region=%q", b.Region)
 	err := b.aws.CheckRequirements(ctx, b.Region)