feature: add inspect format for image network and volume

Signed-off-by: letty <letty.ll@alibaba-inc.com>

cli/image_inspect.go

@@ -2,10 +2,10 @@ package main
 
 import (
 	"context"
-	"encoding/json"
-	"fmt"
 	"os"
 
+	"github.com/alibaba/pouch/cli/inspect"
+
 	"github.com/spf13/cobra"
 )
 
@@ -15,6 +15,7 @@ var imageInspectDescription = "Return detailed information on Pouch image"
 // ImageInspectCommand use to implement 'image inspect' command.
 type ImageInspectCommand struct {
 	baseCommand
+	format string
 }
 
 // Init initialize "image inspect" command.
@@ -30,20 +31,25 @@ func (i *ImageInspectCommand) Init(c *Cli) {
 		},
 		Example: i.example(),
 	}
+	i.addFlags()
+}
+
+// addFlags adds flags for specific command.
+func (i *ImageInspectCommand) addFlags() {
+	i.cmd.Flags().StringVarP(&i.format, "format", "f", "", "Format the output using the given go template")
 }
 
 // runInpsect is used to inspect image.
 func (i *ImageInspectCommand) runInspect(args []string) error {
 	ctx := context.Background()
 	apiClient := i.cli.Client()
-	image, err := apiClient.ImageInspect(ctx, args[0])
-	if err != nil {
-		return fmt.Errorf("failed to inspect image: %v", err)
+	name := args[0]
+
+	getRefFunc := func(ref string) (interface{}, error) {
+		return apiClient.ImageInspect(ctx, ref)
 	}
 
-	enc := json.NewEncoder(os.Stdout)
-	enc.SetIndent("", "  ")
-	return enc.Encode(image)
+	return inspect.Inspect(os.Stdout, name, i.format, getRefFunc)
 }
 
 // example shows examples in inspect command, and is used in auto-generated cli docs.

cli/network.go

@@ -3,9 +3,11 @@ package main
 import (
 	"context"
 	"fmt"
+	"os"
 	"strings"
 
 	"github.com/alibaba/pouch/apis/types"
+	"github.com/alibaba/pouch/cli/inspect"
 
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -252,6 +254,7 @@ var networkInspectDescription = "Inspect a network in pouchd. " +
 // NetworkInspectCommand is used to implement 'network inspect' command.
 type NetworkInspectCommand struct {
 	baseCommand
+	format string
 }
 
 // Init initializes NetworkInspectCommand command.
@@ -275,6 +278,7 @@ func (n *NetworkInspectCommand) Init(c *Cli) {
 // addFlags adds flags for specific command.
 func (n *NetworkInspectCommand) addFlags() {
 	//TODO add flags
+	n.cmd.Flags().StringVarP(&n.format, "format", "f", "", "Format the output using the given go template")
 }
 
 // runNetworkInspect is the entry of NetworkInspectCommand command.
@@ -283,13 +287,12 @@ func (n *NetworkInspectCommand) runNetworkInspect(args []string) error {
 
 	ctx := context.Background()
 	apiClient := n.cli.Client()
-	resp, err := apiClient.NetworkInspect(ctx, name)
-	if err != nil {
-		return err
+
+	getRefFunc := func(ref string) (interface{}, error) {
+		return apiClient.NetworkInspect(ctx, ref)
 	}
 
-	n.cli.Print(resp)
-	return nil
+	return inspect.Inspect(os.Stdout, name, n.format, getRefFunc)
 }
 
 // networkInspectExample shows examples in network inspect command, and is used in auto-generated cli docs.

cli/volume.go

@@ -3,9 +3,11 @@ package main
 import (
 	"context"
 	"fmt"
+	"os"
 	"strings"
 
 	"github.com/alibaba/pouch/apis/types"
+	"github.com/alibaba/pouch/cli/inspect"
 
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -214,6 +216,7 @@ var volumeInspectDescription = "Inspect a volume in pouchd. " +
 // VolumeInspectCommand is used to implement 'volume inspect' command.
 type VolumeInspectCommand struct {
 	baseCommand
+	format string
 }
 
 // Init initializes VolumeInspectCommand command.
@@ -233,7 +236,9 @@ func (v *VolumeInspectCommand) Init(c *Cli) {
 }
 
 // addFlags adds flags for specific command.
-func (v *VolumeInspectCommand) addFlags() {}
+func (v *VolumeInspectCommand) addFlags() {
+	v.cmd.Flags().StringVarP(&v.format, "format", "f", "", "Format the output using the given go template")
+}
 
 // runVolumeInspect is the entry of VolumeInspectCommand command.
 func (v *VolumeInspectCommand) runVolumeInspect(args []string) error {
@@ -244,13 +249,11 @@ func (v *VolumeInspectCommand) runVolumeInspect(args []string) error {
 	ctx := context.Background()
 	apiClient := v.cli.Client()
 
-	resp, err := apiClient.VolumeInspect(ctx, name)
-	if err != nil {
-		return err
+	getRefFunc := func(ref string) (interface{}, error) {
+		return apiClient.VolumeInspect(ctx, ref)
 	}
 
-	v.cli.Print(resp)
-	return nil
+	return inspect.Inspect(os.Stdout, name, v.format, getRefFunc)
 }
 
 // volumeInspectExample shows examples in volume inspect command, and is used in auto-generated cli docs.

test/cli_images_test.go

@@ -2,13 +2,16 @@ package main
 
 import (
 	"context"
+	"encoding/json"
+	"fmt"
 	"strings"
 
 	"github.com/alibaba/pouch/apis/types"
 	"github.com/alibaba/pouch/client"
 	"github.com/alibaba/pouch/pkg/utils"
 	"github.com/alibaba/pouch/test/command"
 	"github.com/alibaba/pouch/test/environment"
+
 	"github.com/go-check/check"
 	"github.com/gotestyourself/gotestyourself/icmd"
 	"github.com/pkg/errors"
@@ -92,3 +95,16 @@ func getImageInfo(apiClient client.ImageAPIClient, name string) (types.ImageInfo
 	}
 	return types.ImageInfo{}, errors.Errorf("image %s not found", name)
 }
+
+// TestInspectImage is to verify the format flag of image inspect command.
+func (suite *PouchImagesSuite) TestInspectImage(c *check.C) {
+	output := command.PouchRun("image", "inspect", busyboxImage).Stdout()
+	result := &types.ContainerJSON{}
+	if err := json.Unmarshal([]byte(output), result); err != nil {
+		c.Errorf("failed to decode inspect output: %v", err)
+	}
+
+	// inspect image name
+	output = command.PouchRun("image", "inspect", "-f", "{{.Name}}", busyboxImage).Stdout()
+	c.Assert(output, check.Equals, fmt.Sprintf("%s\n", busyboxImage))
+}

test/cli_network_test.go

@@ -1,11 +1,14 @@
 package main
 
 import (
+	"encoding/json"
 	"runtime"
 	"strings"
 
+	"github.com/alibaba/pouch/apis/types"
 	"github.com/alibaba/pouch/test/command"
 	"github.com/alibaba/pouch/test/environment"
+
 	"github.com/go-check/check"
 	"github.com/gotestyourself/gotestyourself/icmd"
 )
@@ -26,6 +29,19 @@ func (suite *PouchNetworkSuite) SetUpSuite(c *check.C) {
 	environment.PruneAllContainers(apiClient)
 }
 
+// TestNetworkInspectFormat tests the inspect format of network works.
+func (suite *PouchNetworkSuite) TestNetworkInspectFormat(c *check.C) {
+	output := command.PouchRun("network", "inspect", "bridge").Stdout()
+	result := &types.ContainerJSON{}
+	if err := json.Unmarshal([]byte(output), result); err != nil {
+		c.Errorf("failed to decode inspect output: %v", err)
+	}
+
+	// inspect network name
+	output = command.PouchRun("network", "inspect", "-f", "{{.Name}}", "bridge").Stdout()
+	c.Assert(output, check.Equals, "bridge\n")
+}
+
 // TestNetworkDefault tests the creation of default bridge/none/host network.
 func (suite *PouchNetworkSuite) TestNetworkDefault(c *check.C) {
 	pc, _, _, _ := runtime.Caller(0)

test/cli_volume_test.go

@@ -1,11 +1,15 @@
 package main
 
 import (
+	"encoding/json"
+	"fmt"
 	"runtime"
 	"strings"
 
+	"github.com/alibaba/pouch/apis/types"
 	"github.com/alibaba/pouch/test/command"
 	"github.com/alibaba/pouch/test/environment"
+
 	"github.com/go-check/check"
 	"github.com/gotestyourself/gotestyourself/icmd"
 )
@@ -156,3 +160,27 @@ func (suite *PouchVolumeSuite) TestVolumeCreateWithSelector(c *check.C) {
 	command.PouchRun("volume", "create", "--name", funcname, "--selector", "test=foo").Assert(c, icmd.Success)
 	command.PouchRun("volume", "remove", funcname)
 }
+
+// TestVolumeInspectFormat tests the inspect format of volume works.
+func (suite *PouchNetworkSuite) TestVolumeInspectFormat(c *check.C) {
+	pc, _, _, _ := runtime.Caller(0)
+	tmpname := strings.Split(runtime.FuncForPC(pc).Name(), ".")
+	var funcname string
+	for i := range tmpname {
+		funcname = tmpname[i]
+	}
+
+	command.PouchRun("volume", "create", "--name", funcname).Assert(c, icmd.Success)
+
+	output := command.PouchRun("volume", "inspect", funcname).Stdout()
+	result := &types.ContainerJSON{}
+	if err := json.Unmarshal([]byte(output), result); err != nil {
+		c.Errorf("failed to decode inspect output: %v", err)
+	}
+
+	// inspect network name
+	output = command.PouchRun("volume", "inspect", "-f", "{{.Name}}", funcname).Stdout()
+	c.Assert(output, check.Equals, fmt.Sprintf("%s\n", funcname))
+
+	defer command.PouchRun("volume", "remove", funcname)
+}