Merge pull request #375 from silvin-lubecki/141-better-inspect

Add compose file summary to the inspect command

Author: chris-crone

README.md

@@ -255,7 +255,7 @@ Commands:
   fork        Create a fork of an existing application to be modified
   helm        Generate a Helm chart
   init        Start building a Docker application
-  inspect     Shows metadata and settings for a given application
+  inspect     Shows metadata, settings and a summary of the compose file for a given application
   merge       Merge a multi-file application into a single file
   push        Push the application to a registry
   render      Render the Compose file for the application

cmd/docker-app/inspect.go

@@ -3,24 +3,37 @@ package main
 import (
 	"github.com/docker/app/internal/inspect"
 	"github.com/docker/app/internal/packager"
+	"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"
 )
 
+var (
+	inspectSettingsFile []string
+	inspectEnv          []string
+)
+
 // inspectCmd represents the inspect command
 func inspectCmd(dockerCli command.Cli) *cobra.Command {
-	return &cobra.Command{
-		Use:   "inspect [<app-name>]",
-		Short: "Shows metadata and settings for a given application",
+	cmd := &cobra.Command{
+		Use:   "inspect [<app-name>] [-s key=value...] [-f settings-file...]",
+		Short: "Shows metadata, settings and a summary of the compose file for a given application",
 		Args:  cli.RequiresMaxArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			app, err := packager.Extract(firstOrEmpty(args))
+			app, err := packager.Extract(firstOrEmpty(args),
+				types.WithSettingsFiles(inspectSettingsFile...),
+			)
 			if err != nil {
 				return err
 			}
 			defer app.Cleanup()
-			return inspect.Inspect(dockerCli.Out(), app)
+			argSettings := cliopts.ConvertKVStringsToMap(inspectEnv)
+			return inspect.Inspect(dockerCli.Out(), app, argSettings)
 		},
 	}
+	cmd.Flags().StringArrayVarP(&inspectSettingsFile, "settings-files", "f", []string{}, "Override settings files")
+	cmd.Flags().StringArrayVarP(&inspectEnv, "set", "s", []string{}, "Override settings values")
+	return cmd
 }

e2e/testdata/envvariables-inspect.golden

@@ -1,8 +1,14 @@
 myapp 0.1.0
+
 Maintained by: bearclaw <bearclaw@bearclaw.bearclaw>
 
-Setting              Default
--------              -------
+Service (1) Replicas Ports Image
+----------- -------- ----- -----
+test        1              alpine:latest
+
+Settings (4)         Value
+------------         -----
 myapp.alpine_version latest
 myapp.command1       cat
 myapp.command2       foo
+myapp.command3       bar

e2e/testdata/helloworld-inspect.golden

@@ -1,9 +1,14 @@
 hello-world 0.1.0
+
 Maintained by: user <user@email.com>
 
 Hello, World!
 
-Setting Default
-------- -------
-port    8080
-text    Hello, World!
+Service (1) Replicas Ports Image
+----------- -------- ----- -----
+hello       1        8080  hashicorp/http-echo
+
+Settings (2) Value
+------------ -----
+port         8080
+text         Hello, World!

e2e/testdata/render/envvariables/my.dockerapp/settings.yml

@@ -2,3 +2,4 @@ myapp:
   alpine_version: latest
   command1: cat
   command2: foo
+  command3: bar

internal/inspect/inspect.go

@@ -4,39 +4,137 @@ import (
 	"fmt"
 	"io"
 	"sort"
+	"strings"
 	"text/tabwriter"
 
+	"github.com/docker/app/render"
 	"github.com/docker/app/types"
+	"github.com/docker/app/types/settings"
+	composetypes "github.com/docker/cli/cli/compose/types"
 )
 
 // Inspect dumps the metadata of an app
-func Inspect(out io.Writer, app *types.App) error {
+func Inspect(out io.Writer, app *types.App, argSettings map[string]string) error {
+	// Render the compose file
+	config, err := render.Render(app, argSettings)
+	if err != nil {
+		return err
+	}
+
+	// Extract all the settings
+	settingsKeys, allSettings, err := extractSettings(app, argSettings)
+	if err != nil {
+		return err
+	}
+
+	// Add Meta data
+	printMetadata(out, app)
+
+	// Add Service section
+	printSection(out, len(config.Services), func(w io.Writer) {
+		for _, service := range config.Services {
+			fmt.Fprintf(w, "%s\t%d\t%s\t%s\n", service.Name, getReplicas(service), getPorts(service.Ports), service.Image)
+		}
+	}, "Service", "Replicas", "Ports", "Image")
+
+	// Add Network section
+	printSection(out, len(config.Networks), func(w io.Writer) {
+		for name := range config.Networks {
+			fmt.Fprintln(w, name)
+		}
+	}, "Network")
+
+	// Add Volume section
+	printSection(out, len(config.Volumes), func(w io.Writer) {
+		for name := range config.Volumes {
+			fmt.Fprintln(w, name)
+		}
+	}, "Volume")
+
+	// Add Secret section
+	printSection(out, len(config.Secrets), func(w io.Writer) {
+		for name := range config.Secrets {
+			fmt.Fprintln(w, name)
+		}
+	}, "Secret")
+
+	// Add Setting section
+	printSection(out, len(settingsKeys), func(w io.Writer) {
+		for _, k := range settingsKeys {
+			fmt.Fprintf(w, "%s\t%s\n", k, allSettings[k])
+		}
+	}, "Setting", "Value")
+
+	return nil
+}
+
+func printMetadata(out io.Writer, app *types.App) {
 	meta := app.Metadata()
-	// extract settings
-	settings := app.Settings().Flatten()
+	fmt.Fprintln(out, meta.Name, meta.Version)
+	if maintainers := meta.Maintainers.String(); maintainers != "" {
+		fmt.Fprintln(out)
+		fmt.Fprintln(out, "Maintained by:", maintainers)
+	}
+	if meta.Description != "" {
+		fmt.Fprintln(out)
+		fmt.Fprintln(out, meta.Description)
+	}
+}
+
+func printSection(out io.Writer, len int, printer func(io.Writer), headers ...string) {
+	if len == 0 {
+		return
+	}
+	fmt.Fprintln(out)
+	w := tabwriter.NewWriter(out, 0, 0, 1, ' ', 0)
+	var plural string
+	if len > 1 {
+		plural = "s"
+	}
+	headers[0] = fmt.Sprintf("%s%s (%d)", headers[0], plural, len)
+	printHeaders(w, headers...)
+	printer(w)
+	w.Flush()
+}
+
+func printHeaders(w io.Writer, headers ...string) {
+	fmt.Fprintln(w, strings.Join(headers, "\t"))
+	dashes := make([]string, len(headers))
+	for i, h := range headers {
+		dashes[i] = strings.Repeat("-", len(h))
+	}
+	fmt.Fprintln(w, strings.Join(dashes, "\t"))
+}
+
+func getReplicas(service composetypes.ServiceConfig) int {
+	if service.Deploy.Replicas != nil {
+		return int(*service.Deploy.Replicas)
+	}
+	return 1
+}
+
+func extractSettings(app *types.App, argSettings map[string]string) ([]string, map[string]string, error) {
+	allSettings, err := mergeAndFlattenSettings(app, argSettings)
+	if err != nil {
+		return nil, nil, err
+	}
 	// sort the keys to get consistent output
 	var settingsKeys []string
-	for k := range settings {
+	for k := range allSettings {
 		settingsKeys = append(settingsKeys, k)
 	}
 	sort.Slice(settingsKeys, func(i, j int) bool { return settingsKeys[i] < settingsKeys[j] })
-	// build maintainers string
-	maintainers := meta.Maintainers.String()
-	fmt.Fprintf(out, "%s %s\n", meta.Name, meta.Version)
-	if maintainers != "" {
-		fmt.Fprintf(out, "Maintained by: %s\n", maintainers)
-		fmt.Fprintln(out, "")
-	}
-	if meta.Description != "" {
-		fmt.Fprintf(out, "%s\n", meta.Description)
-		fmt.Fprintln(out, "")
+	return settingsKeys, allSettings, nil
+}
+
+func mergeAndFlattenSettings(app *types.App, argSettings map[string]string) (map[string]string, error) {
+	sArgs, err := settings.FromFlatten(argSettings)
+	if err != nil {
+		return nil, err
 	}
-	w := tabwriter.NewWriter(out, 0, 0, 1, ' ', 0)
-	fmt.Fprintln(w, "Setting\tDefault")
-	fmt.Fprintln(w, "-------\t-------")
-	for _, k := range settingsKeys {
-		fmt.Fprintf(w, "%s\t%s\n", k, settings[k])
+	s, err := settings.Merge(app.Settings(), sArgs)
+	if err != nil {
+		return nil, err
 	}
-	w.Flush()
-	return nil
+	return s.Flatten(), nil
 }

internal/inspect/inspect_test.go

@@ -13,11 +13,7 @@ import (
 )
 
 const (
-	composeYAML = `version: "3.1"
-
-services:
-  web:
-    image: nginx`
+	composeYAML = `version: "3.1"`
 )
 
 func TestInspect(t *testing.T) {
@@ -50,8 +46,41 @@ maintainers:
 description: "this is sparta !"`),
 			fs.WithFile(internal.SettingsFileName, ""),
 		),
+		fs.WithDir("overridden",
+			fs.WithFile(internal.ComposeFileName, `
+version: "3.1"
+
+services:
+  web:
+    image: nginx
+    ports:
+      - ${web.port}:80
+`),
+			fs.WithFile(internal.MetadataFileName, `
+version: 0.1.0
+name: foo
+`),
+			fs.WithFile(internal.SettingsFileName, ""),
+		),
 		fs.WithDir("full",
-			fs.WithFile(internal.ComposeFileName, composeYAML),
+			fs.WithFile(internal.ComposeFileName, `
+version: "3.1"
+
+services:
+  web:
+    image: nginx:latest
+    ports:
+      - 8080-8100:12300-12320
+    deploy:
+      replicas: 2
+networks:
+  my-network:
+volumes:
+  my-volume:
+secrets:
+  my-secret:
+    file: ./my_secret.txt
+`),
 			fs.WithFile(internal.MetadataFileName, `
 version: 0.1.0
 name: foo
@@ -66,14 +95,23 @@ text: hello`),
 	)
 	defer dir.Remove()
 
-	for _, appname := range []string{
-		"no-maintainers", "no-description", "no-settings", "full",
+	for _, testcase := range []struct {
+		name string
+		args map[string]string
+	}{
+		{name: "no-maintainers"},
+		{name: "no-description"},
+		{name: "no-settings"},
+		{name: "overridden", args: map[string]string{"web.port": "80"}},
+		{name: "full"},
 	} {
-		outBuffer := new(bytes.Buffer)
-		app, err := types.NewAppFromDefaultFiles(dir.Join(appname))
-		assert.NilError(t, err)
-		err = Inspect(outBuffer, app)
-		assert.NilError(t, err)
-		golden.Assert(t, outBuffer.String(), fmt.Sprintf("inspect-%s.golden", appname), appname)
+		t.Run(testcase.name, func(t *testing.T) {
+			outBuffer := new(bytes.Buffer)
+			app, err := types.NewAppFromDefaultFiles(dir.Join(testcase.name))
+			assert.NilError(t, err)
+			err = Inspect(outBuffer, app, testcase.args)
+			assert.NilError(t, err)
+			golden.Assert(t, outBuffer.String(), fmt.Sprintf("inspect-%s.golden", testcase.name), testcase.name)
+		})
 	}
 }