Add App inspect unit tests

Signed-off-by: Jean-Christophe Sirot <[email protected]>

Author: Jean-Christophe Sirot

cmd/cnab-run/status.go

@@ -50,7 +50,7 @@ var (
 			return reference.FamiliarString(ref)
 		}},
 		{"PORTS", func(s *swarmtypes.Service) string {
-			return Ports(s.Endpoint.Ports)
+			return ports(s.Endpoint.Ports)
 		}},
 	}
 )
@@ -84,7 +84,7 @@ func (pr portRange) String() string {
 
 // Ports formats port configuration. This function is copied et adapted from docker CLI
 // see https://github.com/docker/cli/blob/d6edc912ce/cli/command/service/formatter.go#L655
-func Ports(servicePorts []swarmtypes.PortConfig) string {
+func ports(servicePorts []swarmtypes.PortConfig) string {
 	if servicePorts == nil {
 		return ""
 	}

e2e/testdata/plugin-usage.golden

@@ -12,6 +12,7 @@ Management Commands:
 Commands:
   build       Build an App image from an App definition (.dockerapp)
   init        Initialize an App definition
+  inspect     Shows status, metadata, parameters and the list of services of a running App
   ls          List running Apps
   pull        Pull an App image from a registry
   push        Push an App image to a registry

internal/commands/inspect.go

@@ -29,11 +29,10 @@ func inspectCmd(dockerCli command.Cli) *cobra.Command {
 	var opts inspectOptions
 	cmd := &cobra.Command{
 		Use:   "inspect [OPTIONS] RUNNING_APP",
-		Short: "Shows installation and App metadata, parameters and the service list of a running App",
+		Short: "Shows status, metadata, parameters and the list of services of a running App",
 		Example: `$ docker app inspect my-running-app
 $ docker app inspect my-running-app:1.0.0`,
-		Args:   cli.ExactArgs(1),
-		Hidden: true,
+		Args: cli.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return runInspect(dockerCli, firstOrEmpty(args), opts)
 		},
@@ -88,7 +87,7 @@ func runInspect(dockerCli command.Cli, appName string, inspectOptions inspectOpt
 	} else {
 		return fmt.Errorf("inspect failed: status action is not supported by the App")
 	}
-	if err := a.Run(&installation.Claim, creds, nil); err != nil {
+	if err := a.Run(&installation.Claim, creds); err != nil {
 		return fmt.Errorf("inspect failed: %s\n%s", err, errBuf)
 	}
 

internal/inspect/inspect_test.go

@@ -5,8 +5,12 @@ import (
 	"fmt"
 	"os"
 	"testing"
+	"time"
 
+	"github.com/deislabs/cnab-go/bundle"
+	"github.com/deislabs/cnab-go/claim"
 	"github.com/docker/app/internal"
+	"github.com/docker/app/internal/store"
 	"github.com/docker/app/types"
 	"gotest.tools/assert"
 	"gotest.tools/fs"
@@ -22,7 +26,7 @@ type inspectTestCase struct {
 	args map[string]string
 }
 
-func TestInspect(t *testing.T) {
+func TestImageInspect(t *testing.T) {
 	dir := fs.NewDir(t, "inspect",
 		fs.WithDir("no-maintainers",
 			fs.WithFile(internal.ComposeFileName, composeYAML),
@@ -121,14 +125,14 @@ text: hello`),
 			{name: "full"},
 		} {
 			os.Setenv(internal.DockerInspectFormatEnvVar, "pretty")
-			testInspect(t, dir, testcase, "")
+			testImageInspect(t, dir, testcase, "")
 			os.Setenv(internal.DockerInspectFormatEnvVar, "json")
-			testInspect(t, dir, testcase, "-json")
+			testImageInspect(t, dir, testcase, "-json")
 		}
 	})
 }
 
-func testInspect(t *testing.T, dir *fs.Dir, testcase inspectTestCase, suffix string) {
+func testImageInspect(t *testing.T, dir *fs.Dir, testcase inspectTestCase, suffix string) {
 	app, err := types.NewAppFromDefaultFiles(dir.Join(testcase.name))
 	assert.NilError(t, err)
 	// Inspect twice to ensure output is stable (e.g. sorting of maps)
@@ -141,3 +145,66 @@ func testInspect(t *testing.T, dir *fs.Dir, testcase inspectTestCase, suffix str
 		})
 	}
 }
+
+func getInstallation() store.Installation {
+	created := time.Now().Add(time.Hour * -24)
+	modified := time.Now().Add(time.Hour * -17)
+	b := bundle.Bundle{
+		SchemaVersion: "1.0.0",
+		Name:          "hello-world",
+		Version:       "0.1.0",
+		Description:   "Hello, World!",
+	}
+	i := store.Installation{
+		Claim: claim.Claim{
+			Name:     "hello-world",
+			Revision: "01DS2ZW4QKPXHTZXZ8YAP6S9W2",
+			Created:  created,
+			Modified: modified,
+			Bundle:   &b,
+			Result: claim.Result{
+				Action: "upgrade",
+				Status: "success",
+			},
+			Parameters: map[string]interface{}{
+				"com.docker.app.args":                 "{}",
+				"com.docker.app.inspect-format":       "json",
+				"com.docker.app.kubernetes-namespace": "default",
+				"com.docker.app.orchestrator":         "",
+				"com.docker.app.render-format":        "yaml",
+				"com.docker.app.share-registry-creds": false,
+				"port":                                "8080",
+				"text":                                "Hello, World!",
+			},
+		},
+		Reference: "docker.io/sirot/hello-world:0.1.0",
+	}
+	return i
+}
+
+func TestInspect(t *testing.T) {
+	i := getInstallation()
+
+	testCases := []struct {
+		name   string
+		format string
+	}{
+		{
+			name:   "pretty",
+			format: "pretty",
+		},
+		{
+			name:   "json",
+			format: "json",
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			var out bytes.Buffer
+			err := Inspect(&out, &i, testCase.format, "swarm")
+			assert.NilError(t, err)
+			golden.Assert(t, out.String(), fmt.Sprintf("inspect-app-%s.golden", testCase.name))
+		})
+	}
+}

internal/inspect/testdata/inspect-app-json.golden

@@ -0,0 +1,20 @@
+{
+    "Installation": {
+        "Name": "hello-world",
+        "Created": "1 day ago",
+        "Modified": "17 hours ago",
+        "Revision": "01DS2ZW4QKPXHTZXZ8YAP6S9W2",
+        "Last Action": "upgrade",
+        "Result": "success",
+        "Orchestrator": "swarm"
+    },
+    "Application": {
+        "Name": "hello-world",
+        "Version": "0.1.0",
+        "ImageReference": "docker.io/sirot/hello-world:0.1.0"
+    },
+    "Parameters": {
+        "port": "8080",
+        "text": "Hello, World!"
+    }
+}

internal/inspect/testdata/inspect-app-pretty.golden

@@ -0,0 +1,18 @@
+Installation:
+  Name: hello-world
+  Created: 1 day ago
+  Modified: 17 hours ago
+  Revision: 01DS2ZW4QKPXHTZXZ8YAP6S9W2
+  Last Action: upgrade
+  Result: success
+  Ochestrator: swarm
+
+Application:
+  Name: hello-world
+  Version: 0.1.0
+  Image Reference: docker.io/sirot/hello-world:0.1.0
+
+Parameters:
+  port: "8080"
+  text: Hello, World!
+