Convert docker-app to a docker cli plugin

* Use the docker/cli/cli-plugins/plugin.Run helper to create and execute the commands as a plugin
* Refactor e2e tests to use “docker app” (docker cli invoking docker-app plugin)
* Add CLI plugin invocation e2e tests
* Bump docker-cli to include the plugin work
* Bump gotest.tools to 2.3.0

Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>

Author: silvin-lubecki

Gopkg.lock

@@ -38,7 +38,7 @@ required = ["github.com/wadey/gocovmerge"]
 
 [[override]]
   name = "github.com/docker/cli"
-  revision = "06b837a7d7e1115f3d2aa65c47765e25d4bf845b"
+  revision = "3ddb3133f5b5a74dd4e3f721ced21f4d0b9651b6"
 
 [[override]]
   name = "github.com/deislabs/duffle"

Gopkg.toml

@@ -33,7 +33,7 @@ func inspectCmd(dockerCli command.Cli) *cobra.Command {
 }
 
 func runInspect(dockerCli command.Cli, appname string, opts inspectOptions) error {
-	muteDockerCli(dockerCli)
+	defer muteDockerCli(dockerCli)()
 
 	c, err := claim.New("inspect")
 	if err != nil {

cmd/docker-app/inspect.go

@@ -68,7 +68,7 @@ func installCmd(dockerCli command.Cli) *cobra.Command {
 }
 
 func runInstall(dockerCli command.Cli, appname string, opts installOptions) error {
-	muteDockerCli(dockerCli)
+	defer muteDockerCli(dockerCli)()
 	if opts.sendRegistryAuth {
 		return errors.New("with-registry-auth is not supported at the moment")
 	}

cmd/docker-app/install.go

@@ -1,22 +1,19 @@
 package main
 
 import (
-	"fmt"
-	"os"
-
+	"github.com/docker/app/internal"
+	"github.com/docker/cli/cli-plugins/manager"
+	"github.com/docker/cli/cli-plugins/plugin"
 	"github.com/docker/cli/cli/command"
-	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
 )
 
 func main() {
-	dockerCli, err := command.NewDockerCli()
-	if err != nil {
-		fmt.Fprintln(os.Stderr, err)
-		os.Exit(1)
-	}
-	logrus.SetOutput(dockerCli.Err())
-	cmd := newRootCmd(dockerCli)
-	if err := cmd.Execute(); err != nil {
-		os.Exit(1)
-	}
+	plugin.Run(func(dockerCli command.Cli) *cobra.Command {
+		return newRootCmd(dockerCli)
+	}, manager.Metadata{
+		SchemaVersion: "0.1.0",
+		Vendor:        "Docker Inc.",
+		Version:       internal.Version,
+	})
 }

cmd/docker-app/main.go

@@ -1,39 +1,21 @@
 package main
 
 import (
-	"fmt"
 	"io/ioutil"
 
-	"github.com/docker/app/internal"
-	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
-	cliflags "github.com/docker/cli/cli/flags"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
 
 // rootCmd represents the base command when called without any subcommands
-func newRootCmd(dockerCli *command.DockerCli) *cobra.Command {
-	var (
-		opts  *cliflags.ClientOptions
-		flags *pflag.FlagSet
-	)
-
+// FIXME(vdemeester) use command.Cli interface
+func newRootCmd(dockerCli command.Cli) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:              "docker-app",
-		Short:            "Docker Application Packages",
-		Long:             `Build and deploy Docker Application Packages.`,
-		SilenceUsage:     true,
-		TraverseChildren: true,
-		PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
-			opts.Common.SetDefaultOptions(flags)
-			return dockerCli.Initialize(opts)
-		},
-		Version: fmt.Sprintf("%s, build %s", internal.Version, internal.GitCommit),
+		Use:   "app",
+		Short: "Docker Application Packages",
+		Long:  `Build and deploy Docker Application Packages.`,
 	}
-	opts, flags, _ = cli.SetupRootCommand(cmd)
-	flags.BoolP("version", "v", false, "Print version information")
-	cmd.SetVersionTemplate("docker-app version {{.Version}}\n")
 	addCommands(cmd, dockerCli)
 	return cmd
 }
@@ -66,8 +48,13 @@ func firstOrEmpty(list []string) string {
 	return ""
 }
 
-func muteDockerCli(dockerCli command.Cli) {
+func muteDockerCli(dockerCli command.Cli) func() {
+	stdout := dockerCli.Out()
+	stderr := dockerCli.Err()
 	dockerCli.Apply(command.WithCombinedStreams(ioutil.Discard))
+	return func() {
+		dockerCli.Apply(command.WithOutputStream(stdout), command.WithErrorStream(stderr))
+	}
 }
 
 type parametersOptions struct {

cmd/docker-app/root.go

@@ -29,7 +29,7 @@ func statusCmd(dockerCli command.Cli) *cobra.Command {
 }
 
 func runStatus(dockerCli command.Cli, claimName string, opts credentialOptions) error {
-	muteDockerCli(dockerCli)
+	defer muteDockerCli(dockerCli)()
 	h := duffleHome()
 
 	claimStore := claim.NewClaimStore(crud.NewFileSystemStore(h.Claims(), "json"))

cmd/docker-app/status.go

@@ -29,7 +29,7 @@ func uninstallCmd(dockerCli command.Cli) *cobra.Command {
 }
 
 func runUninstall(dockerCli command.Cli, claimName string, opts credentialOptions) error {
-	muteDockerCli(dockerCli)
+	defer muteDockerCli(dockerCli)()
 	h := duffleHome()
 
 	claimStore := claim.NewClaimStore(crud.NewFileSystemStore(h.Claims(), "json"))

cmd/docker-app/uninstall.go

@@ -39,7 +39,7 @@ func upgradeCmd(dockerCli command.Cli) *cobra.Command {
 }
 
 func runUpgrade(dockerCli command.Cli, installationName string, opts upgradeOptions) error {
-	muteDockerCli(dockerCli)
+	defer muteDockerCli(dockerCli)()
 	targetContext := getTargetContext(opts.targetContext, dockerCli.CurrentContext())
 	h := duffleHome()
 	claimStore := claim.NewClaimStore(crud.NewFileSystemStore(h.Claims(), "json"))

cmd/docker-app/upgrade.go

@@ -2,6 +2,7 @@ package e2e
 
 import (
 	"fmt"
+	"os"
 	"path"
 	"runtime"
 	"testing"
@@ -28,7 +29,7 @@ func TestCallCustomStatusAction(t *testing.T) {
 		{
 			name:           "missingCustomStatusAction",
 			exitCode:       1,
-			expectedOutput: "Error: Status failed: action not defined for bundle",
+			expectedOutput: "Status failed: action not defined for bundle",
 			cnab:           "cnab-without-status",
 		},
 	}
@@ -38,9 +39,7 @@ func TestCallCustomStatusAction(t *testing.T) {
 			tmpDir := fs.NewDir(t, t.Name())
 			defer tmpDir.Remove()
 			testDir := path.Join("testdata", testCase.cnab)
-			cmd := icmd.Cmd{
-				Env: []string{fmt.Sprintf("DUFFLE_HOME=%s", tmpDir.Path())},
-			}
+			cmd := icmd.Cmd{Env: append(os.Environ(), fmt.Sprintf("DUFFLE_HOME=%s", tmpDir.Path()))}
 
 			// We need to explicitly set the SYSTEMROOT on windows
 			// otherwise we get the error:
@@ -50,21 +49,21 @@ func TestCallCustomStatusAction(t *testing.T) {
 				cmd.Env = append(cmd.Env, `SYSTEMROOT=C:\WINDOWS`)
 			}
 			// Build CNAB invocation image
-			cmd.Command = []string{"docker", "build", "-f", path.Join(testDir, "cnab", "build", "Dockerfile"), "-t", fmt.Sprintf("e2e/%s:v0.1.0", testCase.cnab), testDir}
+			cmd.Command = dockerCli.Command("build", "--file", path.Join(testDir, "cnab", "build", "Dockerfile"), "--tag", fmt.Sprintf("e2e/%s:v0.1.0", testCase.cnab), testDir)
 			icmd.RunCmd(cmd).Assert(t, icmd.Success)
 
-			// docker-app install
-			cmd.Command = []string{dockerApp, "install", path.Join(testDir, "bundle.json"), "--name", testCase.name}
+			// docker app install
+			cmd.Command = dockerCli.Command("app", "install", path.Join(testDir, "bundle.json"), "--name", testCase.name)
 			icmd.RunCmd(cmd).Assert(t, icmd.Success)
 
-			// docker-app uninstall
+			// docker app uninstall
 			defer func() {
-				cmd.Command = []string{dockerApp, "uninstall", testCase.name}
+				cmd.Command = dockerCli.Command("app", "uninstall", testCase.name)
 				icmd.RunCmd(cmd).Assert(t, icmd.Success)
 			}()
 
-			// docker-app status
-			cmd.Command = []string{dockerApp, "status", testCase.name}
+			// docker app status
+			cmd.Command = dockerCli.Command("app", "status", testCase.name)
 			result := icmd.RunCmd(cmd)
 			result.Assert(t, icmd.Expected{ExitCode: testCase.exitCode})
 			assert.Assert(t, is.Contains(result.Combined(), testCase.expectedOutput))