Check parameter presence

rumpl · rumpl · commit bd3038cbb119 · 2019-10-04T12:46:52.000+02:00
Older bundles don't have the inspect format parameter, we don't set it
for them, we set it only on bundles that define that parameter.

Signed-off-by: Djordje Lukic &lt;djordje.lukic@docker.com&gt;
diff --git a/e2e/commands_test.go b/e2e/commands_test.go
@@ -170,9 +170,7 @@ func TestInspectApp(t *testing.T) {
 	cmd.Command = dockerCli.Command("app", "inspect", "simple-app:1.0.0")
 	cmd.Dir = dir.Path()
 	output := icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()
-	fmt.Println(output)
 	golden.Assert(t, output, "app-inspect.golden")
-
 }
 
 func TestBundle(t *testing.T) {
diff --git a/e2e/testdata/app-inspect.golden b/e2e/testdata/app-inspect.golden
@@ -18,22 +18,17 @@
         {
             "Name": "api",
             "Image": "python:3.6",
-            "Replicas": 1,
-            "Mode": "",
-            "Ports": ""
+            "Replicas": 1
         },
         {
             "Name": "db",
             "Image": "postgres:9.3",
-            "Replicas": 1,
-            "Mode": "",
-            "Ports": ""
+            "Replicas": 1
         },
         {
             "Name": "web",
             "Image": "nginx:latest",
             "Replicas": 1,
-            "Mode": "",
             "Ports": "8082"
         }
     ],
@@ -44,11 +39,9 @@
     "Volumes": [
         "static"
     ],
-    "Secrets": [],
     "Parameters": {
         "api_host": "example.com",
         "static_subdir": "data/static",
         "web_port": "8082"
-    },
-    "Attachments": []
+    }
 }
diff --git a/internal/commands/inspect.go b/internal/commands/inspect.go
@@ -19,10 +19,11 @@ type inspectOptions struct {
 func inspectCmd(dockerCli command.Cli) *cobra.Command {
 	var opts inspectOptions
 	cmd := &cobra.Command{
-		Use:     "inspect [APP_NAME] [OPTIONS]",
-		Short:   "Shows metadata, parameters and a summary of the Compose file for a given application",
-		Example: `$ docker app inspect my-app`,
-		Args:    cli.RequiresMaxArgs(1),
+		Use:   "inspect [APP_NAME] [OPTIONS]",
+		Short: "Shows metadata, parameters and a summary of the Compose file for a given application",
+		Example: `$ docker app inspect my-installed-app
+$docker app inspect my-app:1.0.0`,
+		Args: cli.RequiresMaxArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runInspect(dockerCli, firstOrEmpty(args), opts)
 		},
@@ -42,15 +43,16 @@ func runInspect(dockerCli command.Cli, appname string, opts inspectOptions) erro
 	if err != nil {
 		return err
 	}
-	bundle, ref, err := getLocalBundle(dockerCli, bundleStore, appname, false)
+	bndl, ref, err := getLocalBundle(dockerCli, bundleStore, appname, false)
+
 	if err != nil {
 		return err
 	}
 	installation, err := appstore.NewInstallation("custom-action", ref.String())
 	if err != nil {
 		return err
 	}
-	installation.Bundle = bundle
+	installation.Bundle = bndl
 
 	driverImpl, errBuf := prepareDriver(dockerCli, bindMount{}, nil)
 	a := &action.RunCustom{
@@ -62,7 +64,9 @@ func runInspect(dockerCli command.Cli, appname string, opts inspectOptions) erro
 	if opts.pretty {
 		format = "pretty"
 	}
-	installation.Parameters[internal.ParameterInspectFormatName] = format
+
+	installation.SetParameter(internal.ParameterInspectFormatName, format)
+
 	if err := a.Run(&installation.Claim, nil, nil); err != nil {
 		return fmt.Errorf("inspect failed: %s\n%s", err, errBuf)
 	}
diff --git a/internal/inspect/inspect.go b/internal/inspect/inspect.go
@@ -20,72 +20,87 @@ import (
 )
 
 type service struct {
-	Name     string
-	Image    string
-	Replicas int
-	Mode     string
-	Ports    string
+	Name     string `json:",omitempty"`
+	Image    string `json:",omitempty"`
+	Replicas int    `json:",omitempty"`
+	Mode     string `json:",omitempty"`
+	Ports    string `json:",omitempty"`
 }
 
 type attachment struct {
-	Path string
-	Size int64
+	Path string `json:",omitempty"`
+	Size int64  `json:",omitempty"`
 }
 
 type appInfo struct {
-	Metadata       metadata.AppMetadata
-	Services       []service
-	Networks       []string
-	Volumes        []string
-	Secrets        []string
+	Metadata       metadata.AppMetadata `json:",omitempty"`
+	Services       []service            `json:",omitempty"`
+	Networks       []string             `json:",omitempty"`
+	Volumes        []string             `json:",omitempty"`
+	Secrets        []string             `json:",omitempty"`
 	parametersKeys []string
-	Parameters     map[string]string
-	Attachments    []attachment
+	Parameters     map[string]string `json:",omitempty"`
+	Attachments    []attachment      `json:",omitempty"`
 }
 
 // Inspect dumps the metadata of an app
 func Inspect(out io.Writer, app *types.App, argParameters map[string]string, imageMap map[string]bundle.Image) error {
-	outputFormat := os.Getenv(internal.DockerInspectFormatEnvVar)
-
 	// Render the compose file
 	config, err := render.Render(app, argParameters, imageMap)
 	if err != nil {
 		return err
 	}
 
+	// Collect all the relevant information about the application
 	appInfo, err := getAppInfo(app, config, argParameters)
 	if err != nil {
 		return err
 	}
 
-	if outputFormat == "json" {
-		js, err := json.MarshalIndent(appInfo, "", "    ")
-		if err != nil {
-			return err
-		}
-		fmt.Fprintln(out, string(js))
-		return nil
+	outputFormat := os.Getenv(internal.DockerInspectFormatEnvVar)
+	return printAppInfo(out, appInfo, outputFormat)
+}
+
+func printAppInfo(out io.Writer, app appInfo, format string) error {
+	switch format {
+	case "pretty":
+		return printTable(out, app)
+	case "json":
+		return printJSON(out, app)
+	default:
+		return fmt.Errorf("unknown format %q", format)
+	}
+}
+
+func printJSON(out io.Writer, appInfo appInfo) error {
+	js, err := json.MarshalIndent(appInfo, "", "    ")
+	if err != nil {
+		return err
 	}
+	fmt.Fprintln(out, string(js))
+	return nil
+}
 
+func printTable(out io.Writer, appInfo appInfo) error {
 	// Add Meta data
 	printMetadata(out, appInfo)
 
 	// Add Service section
-	printSection(out, len(config.Services), func(w io.Writer) {
+	printSection(out, len(appInfo.Services), func(w io.Writer) {
 		for _, service := range appInfo.Services {
 			fmt.Fprintf(w, "%s\t%d\t%s\t%s\n", service.Name, service.Replicas, service.Ports, service.Image)
 		}
 	}, "Service", "Replicas", "Ports", "Image")
 
 	// Add Network section
-	printSection(out, len(config.Networks), func(w io.Writer) {
+	printSection(out, len(appInfo.Networks), func(w io.Writer) {
 		for _, name := range appInfo.Networks {
 			fmt.Fprintln(w, name)
 		}
 	}, "Network")
 
 	// Add Volume section
-	printSection(out, len(config.Volumes), func(w io.Writer) {
+	printSection(out, len(appInfo.Volumes), func(w io.Writer) {
 		for _, name := range appInfo.Volumes {
 			fmt.Fprintln(w, name)
 		}
@@ -105,14 +120,13 @@ func Inspect(out io.Writer, app *types.App, argParameters map[string]string, ima
 		}
 	}, "Parameter", "Value")
 
-	// // Add Attachments section
+	// Add Attachments section
 	printSection(out, len(appInfo.Attachments), func(w io.Writer) {
 		for _, attachment := range appInfo.Attachments {
 			sizeString := units.HumanSize(float64(attachment.Size))
 			fmt.Fprintf(w, "%s\t%s\n", attachment.Path, sizeString)
 		}
 	}, "Attachment", "Size")
-
 	return nil
 }
 
diff --git a/internal/inspect/testdata/inspect-full-json.golden b/internal/inspect/testdata/inspect-full-json.golden
@@ -15,14 +15,12 @@
             "Name": "web1",
             "Image": "nginx:latest",
             "Replicas": 2,
-            "Mode": "",
             "Ports": "8080-8100"
         },
         {
             "Name": "web2",
             "Image": "nginx:latest",
             "Replicas": 2,
-            "Mode": "",
             "Ports": "9080-9100"
         }
     ],
diff --git a/internal/inspect/testdata/inspect-no-description-json.golden b/internal/inspect/testdata/inspect-no-description-json.golden
@@ -8,11 +8,5 @@
                 "email": "dev@example.com"
             }
         ]
-    },
-    "Services": [],
-    "Networks": [],
-    "Volumes": [],
-    "Secrets": [],
-    "Parameters": {},
-    "Attachments": []
+    }
 }
diff --git a/internal/inspect/testdata/inspect-no-maintainers-json.golden b/internal/inspect/testdata/inspect-no-maintainers-json.golden
@@ -2,11 +2,5 @@
     "Metadata": {
         "version": "0.1.0",
         "name": "myapp"
-    },
-    "Services": [],
-    "Networks": [],
-    "Volumes": [],
-    "Secrets": [],
-    "Parameters": {},
-    "Attachments": []
+    }
 }
diff --git a/internal/inspect/testdata/inspect-no-parameters-json.golden b/internal/inspect/testdata/inspect-no-parameters-json.golden
@@ -9,11 +9,5 @@
                 "email": "dev@example.com"
             }
         ]
-    },
-    "Services": [],
-    "Networks": [],
-    "Volumes": [],
-    "Secrets": [],
-    "Parameters": {},
-    "Attachments": []
+    }
 }
diff --git a/internal/inspect/testdata/inspect-overridden-json.golden b/internal/inspect/testdata/inspect-overridden-json.golden
@@ -8,15 +8,10 @@
             "Name": "web",
             "Image": "nginx",
             "Replicas": 1,
-            "Mode": "",
             "Ports": "80"
         }
     ],
-    "Networks": [],
-    "Volumes": [],
-    "Secrets": [],
     "Parameters": {
         "web.port": "80"
-    },
-    "Attachments": []
+    }
 }
diff --git a/internal/names.go b/internal/names.go
@@ -50,9 +50,9 @@ const (
 	ParameterOrchestratorName = Namespace + "orchestrator"
 	// ParameterKubernetesNamespaceName is the name of the parameter containing the kubernetes namespace
 	ParameterKubernetesNamespaceName = Namespace + "kubernetes-namespace"
-	// ParameterRenderFormatName is the name of the parameter containing the kubernetes namespace
+	// ParameterRenderFormatName is the name of the parameter containing the render format
 	ParameterRenderFormatName = Namespace + "render-format"
-	// ParameterRenderFormatName is the name of the parameter containing the kubernetes namespace
+	// ParameterInspectFormatName is the name of the parameter containing the inspect format
 	ParameterInspectFormatName = Namespace + "inspect-format"
 	// ParameterShareRegistryCredsName is the name of the parameter which indicates if credentials should be shared
 	ParameterShareRegistryCredsName = Namespace + "share-registry-creds"
@@ -66,7 +66,8 @@ const (
 	// DockerRenderFormatEnvVar is the environment variable set by the CNAB runtime to select
 	// the render output format.
 	DockerRenderFormatEnvVar = "DOCKER_RENDER_FORMAT"
-	// DockerInspectFormatEnvVar ...
+	// DockerInspectFormatEnvVar is the environment variable set by the CNAB runtime to select
+	// the inspect output format.
 	DockerInspectFormatEnvVar = "DOCKER_INSPECT_FORMAT"
 )
 
diff --git a/internal/store/installation.go b/internal/store/installation.go
@@ -34,6 +34,14 @@ func NewInstallation(name string, reference string) (*Installation, error) {
 	}, nil
 }
 
+// SetParameters sets the parameter value if the installation bundle has
+// a defined parameter with that name.
+func (i Installation) SetParameter(name string, value string) {
+	if _, ok := i.Bundle.Parameters[name]; ok {
+		i.Parameters[name] = value
+	}
+}
+
 var _ InstallationStore = &installationStore{}
 
 type installationStore struct {

Original file line number	Diff line number	Diff line change
`@@ -170,9 +170,7 @@ func TestInspectApp(t *testing.T) {`
`170`	`170`	`cmd.Command = dockerCli.Command("app", "inspect", "simple-app:1.0.0")`
`171`	`171`	`cmd.Dir = dir.Path()`
`172`	`172`	`output := icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()`
`173`		`- fmt.Println(output)`
`174`	`173`	`golden.Assert(t, output, "app-inspect.golden")`
`175`		`-`
`176`	`174`	`}`
`177`	`175`
`178`	`176`	`func TestBundle(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,5 @@`
`8`	`8`	`"email": "dev@example.com"`
`9`	`9`	`}`
`10`	`10`	`]`
`11`		`- },`
`12`		`- "Services": [],`
`13`		`- "Networks": [],`
`14`		`- "Volumes": [],`
`15`		`- "Secrets": [],`
`16`		`- "Parameters": {},`
`17`		`- "Attachments": []`
	`11`	`+ }`
`18`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,5 @@`
`9`	`9`	`"email": "dev@example.com"`
`10`	`10`	`}`
`11`	`11`	`]`
`12`		`- },`
`13`		`- "Services": [],`
`14`		`- "Networks": [],`
`15`		`- "Volumes": [],`
`16`		`- "Secrets": [],`
`17`		`- "Parameters": {},`
`18`		`- "Attachments": []`
	`12`	`+ }`
`19`	`13`	`}`