Merge pull request #515 from chris-crone/init-validate-name

Output on successful init and validate

Author: chris-crone

e2e/commands_test.go

@@ -131,7 +131,8 @@ maintainers:
 		"--description", "my cool app",
 		"--maintainer", "dev1",
 		"--maintainer", "dev2:[email protected]")
-	icmd.RunCmd(cmd).Assert(t, icmd.Success)
+	stdOut := icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()
+	golden.Assert(t, stdOut, "init-output.golden")
 
 	manifest := fs.Expected(
 		t,
@@ -144,7 +145,8 @@ maintainers:
 
 	// validate metadata with JSON Schema
 	cmd.Command = dockerCli.Command("app", "validate", testAppName)
-	icmd.RunCmd(cmd).Assert(t, icmd.Success)
+	stdOut = icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()
+	golden.Assert(t, stdOut, "validate-output.golden")
 
 	// test single-file init
 	cmd.Command = dockerCli.Command("app",

e2e/testdata/init-output.golden

@@ -0,0 +1,2 @@
+You will need to edit parameters.yml to fill in default values.
+Created "app-test.dockerapp"

e2e/testdata/validate-output.golden

@@ -0,0 +1 @@
+Validated "app-test.dockerapp"

internal/commands/init.go

@@ -1,8 +1,11 @@
 package commands
 
 import (
+	"fmt"
+
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/cli/cli"
+	"github.com/docker/cli/cli/command"
 	"github.com/spf13/cobra"
 )
 
@@ -13,15 +16,20 @@ var (
 	initSingleFile  bool
 )
 
-func initCmd() *cobra.Command {
+func initCmd(dockerCli command.Cli) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "init APP_NAME [--compose-file COMPOSE_FILE] [--description DESCRIPTION] [--maintainer NAME:EMAIL ...] [OPTIONS]",
 		Short:   "Initialize Docker Application definition",
 		Long:    `Start building a Docker Application package. If there is a docker-compose.yml file in the current directory it will be copied and used.`,
 		Example: `$ docker app init myapp --description "a useful description"`,
 		Args:    cli.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			return packager.Init(args[0], initComposeFile, initDescription, initMaintainers, initSingleFile)
+			created, err := packager.Init(args[0], initComposeFile, initDescription, initMaintainers, initSingleFile)
+			if err != nil {
+				return err
+			}
+			fmt.Fprintf(dockerCli.Out(), "Created %q\n", created)
+			return nil
 		},
 	}
 	cmd.Flags().StringVar(&initComposeFile, "compose-file", "", "Compose file to use as application base (optional)")

internal/commands/root.go

@@ -27,12 +27,12 @@ func addCommands(cmd *cobra.Command, dockerCli command.Cli) {
 		upgradeCmd(dockerCli),
 		uninstallCmd(dockerCli),
 		statusCmd(dockerCli),
-		initCmd(),
+		initCmd(dockerCli),
 		inspectCmd(dockerCli),
 		mergeCmd(dockerCli),
 		renderCmd(dockerCli),
 		splitCmd(),
-		validateCmd(),
+		validateCmd(dockerCli),
 		versionCmd(dockerCli),
 		completionCmd(dockerCli, cmd),
 		bundleCmd(dockerCli),

internal/commands/validate.go

@@ -1,10 +1,13 @@
 package commands
 
 import (
+	"fmt"
+
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/render"
 	"github.com/docker/app/types"
 	"github.com/docker/cli/cli"
+	"github.com/docker/cli/cli/command"
 	cliopts "github.com/docker/cli/opts"
 	"github.com/spf13/cobra"
 )
@@ -13,7 +16,7 @@ type validateOptions struct {
 	parametersOptions
 }
 
-func validateCmd() *cobra.Command {
+func validateCmd(dockerCli command.Cli) *cobra.Command {
 	var opts validateOptions
 	cmd := &cobra.Command{
 		Use:   "validate [APP_NAME] [--set KEY=VALUE ...] [--parameters-file PARAMETERS_FILE]",
@@ -29,7 +32,11 @@ func validateCmd() *cobra.Command {
 			defer app.Cleanup()
 			argParameters := cliopts.ConvertKVStringsToMap(opts.overrides)
 			_, err = render.Render(app, argParameters, nil)
-			return err
+			if err != nil {
+				return err
+			}
+			fmt.Fprintf(dockerCli.Out(), "Validated %q\n", app.Path)
+			return nil
 		},
 	}
 	opts.parametersOptions.addFlags(cmd.Flags())

internal/packager/init.go

@@ -32,14 +32,15 @@ func prependToFile(filename, text string) error {
 }
 
 // Init is the entrypoint initialization function.
-// It generates a new application package based on the provided parameters.
-func Init(name string, composeFile string, description string, maintainers []string, singleFile bool) error {
+// It generates a new application definition based on the provided parameters
+// and returns the path to the created application definition.
+func Init(name string, composeFile string, description string, maintainers []string, singleFile bool) (string, error) {
 	if err := internal.ValidateAppName(name); err != nil {
-		return err
+		return "", err
 	}
 	dirName := internal.DirNameFromAppName(name)
 	if err := os.Mkdir(dirName, 0755); err != nil {
-		return errors.Wrap(err, "failed to create application directory")
+		return "", errors.Wrap(err, "failed to create application directory")
 	}
 	var err error
 	defer func() {
@@ -48,7 +49,7 @@ func Init(name string, composeFile string, description string, maintainers []str
 		}
 	}()
 	if err = writeMetadataFile(name, dirName, description, maintainers); err != nil {
-		return err
+		return "", err
 	}
 
 	if composeFile == "" {
@@ -62,40 +63,40 @@ func Init(name string, composeFile string, description string, maintainers []str
 		err = initFromComposeFile(name, composeFile)
 	}
 	if err != nil {
-		return err
+		return "", err
 	}
 	if !singleFile {
-		return nil
+		return dirName, nil
 	}
 	// Merge as a single file
 	// Add some helfpful comments to distinguish the sections
 	if err := prependToFile(filepath.Join(dirName, internal.ComposeFileName), "# This section contains the Compose file that describes your application services.\n"); err != nil {
-		return err
+		return "", err
 	}
 	if err := prependToFile(filepath.Join(dirName, internal.ParametersFileName), "# This section contains the default values for your application parameters.\n"); err != nil {
-		return err
+		return "", err
 	}
 	if err := prependToFile(filepath.Join(dirName, internal.MetadataFileName), "# This section contains your application metadata.\n"); err != nil {
-		return err
+		return "", err
 	}
 
 	temp := "_temp_dockerapp__.dockerapp"
 	err = os.Rename(dirName, temp)
 	if err != nil {
-		return err
+		return "", err
 	}
 	defer os.RemoveAll(temp)
 	var target io.Writer
 	target, err = os.Create(dirName)
 	if err != nil {
-		return err
+		return "", err
 	}
 	defer target.(io.WriteCloser).Close()
 	app, err := loader.LoadFromDirectory(temp)
 	if err != nil {
-		return err
+		return "", err
 	}
-	return Merge(app, target)
+	return dirName, Merge(app, target)
 }
 
 func initFromScratch(name string) error {