feature: add pouch history functionality

Signed-off-by: xiechengsheng <[email protected]>

Author: xiechengsheng

apis/server/image_bridge.go

@@ -172,3 +172,15 @@ func (s *Server) saveImage(ctx context.Context, rw http.ResponseWriter, req *htt
 
 	return nil
 }
+
+// imageHistory gets image history.
+func (s *Server) imageHistory(ctx context.Context, rw http.ResponseWriter, req *http.Request) error {
+	imageName := mux.Vars(req)["name"]
+
+	history, err := s.ImageMgr.ImageHistory(ctx, imageName)
+	if err != nil {
+		return err
+	}
+
+	return EncodeResponse(rw, http.StatusOK, history)
+}

apis/server/router.go

@@ -64,6 +64,7 @@ func initRoute(s *Server) http.Handler {
 	s.addRoute(r, http.MethodPost, "/images/{name:.*}/tag", s.postImageTag)
 	s.addRoute(r, http.MethodPost, "/images/load", withCancelHandler(s.loadImage))
 	s.addRoute(r, http.MethodGet, "/images/save", withCancelHandler(s.saveImage))
+	s.addRoute(r, http.MethodGet, "/images/{name:.*}/history", s.imageHistory)
 
 	// volume
 	s.addRoute(r, http.MethodGet, "/volumes", s.listVolume)

apis/swagger.yml

@@ -197,7 +197,7 @@ paths:
 
   /images/{imageid}/json:
     get:
-      summary: "Inspect a image"
+      summary: "Inspect an image"
       description: "Return the information about image"
       operationId: "ImageInspect"
       produces:
@@ -227,6 +227,53 @@ paths:
       parameters:
         - $ref: "#/parameters/imageid"
 
+  /images/{imageid}/history:
+    get:
+      summary: "Get an image's history"
+      description: "Return the parent layers about image"
+      operationId: "ImageHistory"
+      produces:
+        - "application/json"
+      responses:
+        200:
+          description: "no error"
+          schema:
+            type: "array"
+            items:
+              type: "object"
+              x-go-name: HistoryResultItem
+              required: [ID, Created, CreatedBy, Author, Comment, EmptyLayer, Size]
+              properties:
+                ID:
+                  type: "string"
+                  x-nullable: false
+                Created:
+                  type: "integer"
+                  format: "int64"
+                  x-nullable: false
+                CreatedBy:
+                  type: "string"
+                  x-nullable: false
+                Author:
+                  type: "string"
+                  x-nullable: false
+                Comment:
+                  type: "string"
+                  x-nullable: false
+                EmptyLayer:
+                  type: "boolean"
+                  x-nullable: false
+                Size:
+                  type: "integer"
+                  format: "int64"
+                  x-nullable: false
+        404:
+          $ref: "#/responses/404ErrorResponse"
+        500:
+          $ref: "#/responses/500ErrorResponse"
+      parameters:
+        - $ref: "#/parameters/imageid"
+
   /images/json:
     get:
       summary: "List Images"

apis/types/history_result_item.go

@@ -0,0 +1,130 @@
+package main
+
+import (
+	"context"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/alibaba/pouch/pkg/utils"
+
+	"github.com/docker/docker/pkg/stringid"
+	"github.com/spf13/cobra"
+)
+
+// historyDescription is used to describe history command in detail and auto generate command doc.
+var historyDescription = "Return the history information on Pouch image"
+
+// HistoryCommand is used to implement 'image history' command.
+type HistoryCommand struct {
+	baseCommand
+
+	// flags for history command
+	flagHuman   bool
+	flagQuiet   bool
+	flagNoTrunc bool
+}
+
+// Init initialize "image history" command.
+func (h *HistoryCommand) Init(c *Cli) {
+	h.cli = c
+	h.cmd = &cobra.Command{
+		Use:   "history [OPTIONS] IMAGE",
+		Short: "Display history information on image",
+		Long:  historyDescription,
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return h.runHistory(args)
+		},
+		Example: h.example(),
+	}
+	h.addFlags()
+}
+
+// addFlags adds flags for specific command.
+func (h *HistoryCommand) addFlags() {
+	flagSet := h.cmd.Flags()
+	flagSet.BoolVar(&h.flagHuman, "human", true, "Print information in human readable format")
+	flagSet.BoolVarP(&h.flagQuiet, "quiet", "q", false, "Only show image numeric ID")
+	flagSet.BoolVar(&h.flagNoTrunc, "no-trunc", false, "Do not truncate output")
+}
+
+// runHistory is used to get history of an image.
+func (h *HistoryCommand) runHistory(args []string) error {
+	name := args[0]
+
+	ctx := context.Background()
+	apiClient := h.cli.Client()
+
+	history, err := apiClient.ImageHistory(ctx, name)
+	if err != nil {
+		return err
+	}
+
+	display := h.cli.NewTableDisplay()
+	if h.flagQuiet {
+		for _, entry := range history {
+			if h.flagNoTrunc {
+				display.AddRow([]string{entry.ID})
+			} else {
+				display.AddRow([]string{stringid.TruncateID(entry.ID)})
+			}
+		}
+		display.Flush()
+		return nil
+	}
+
+	var (
+		imageID   string
+		createdBy string
+		created   string
+		size      string
+	)
+
+	display.AddRow([]string{"IMAGE", "CREATED", "CREATED BY", "SIZE", "COMMENT"})
+	for _, entry := range history {
+		imageID = entry.ID
+		createdBy = strings.Replace(entry.CreatedBy, "\t", " ", -1)
+		if !h.flagNoTrunc {
+			createdBy = ellipsis(createdBy, 45)
+			imageID = stringid.TruncateID(entry.ID)
+		}
+
+		if h.flagHuman {
+			created, err = utils.FormatTimeInterval(entry.Created)
+			if err != nil {
+				return err
+			}
+			created = created + " ago"
+			size = utils.FormatSize(entry.Size)
+		} else {
+			created = time.Unix(0, entry.Created).Format(time.RFC3339)
+			size = strconv.FormatInt(entry.Size, 10)
+		}
+
+		display.AddRow([]string{imageID, created, createdBy, size, entry.Comment})
+	}
+	display.Flush()
+	return nil
+}
+
+// example shows examples in history command, and is used in auto-generated cli docs.
+func (h *HistoryCommand) example() string {
+	return `pouch history busybox:1.28
+IMAGE          CREATED        CREATED BY                                      SIZE        COMMENT
+8c811b4aec35   2 months ago   /bin/sh -c #(nop)  CMD ["sh"]                   710.81 KB
+<missing>      2 months ago   /bin/sh -c #(nop) ADD file:5f0439d8328ab58...   0.00 B      `
+}
+
+// ellipsis truncates a string to fit within maxlen, and appends ellipsis (...).
+// For maxlen of 3 and lower, no ellipsis is appended.
+func ellipsis(s string, maxlen int) string {
+	r := []rune(s)
+	if len(r) <= maxlen {
+		return s
+	}
+	if maxlen <= 3 {
+		return string(r[:maxlen])
+	}
+	return string(r[:maxlen-3]) + "..."
+}

cli/history.go

@@ -32,6 +32,7 @@ func main() {
 	cli.AddCommand(base, &TagCommand{})
 	cli.AddCommand(base, &LoadCommand{})
 	cli.AddCommand(base, &SaveCommand{})
+	cli.AddCommand(base, &HistoryCommand{})
 
 	cli.AddCommand(base, &InspectCommand{})
 	cli.AddCommand(base, &RenameCommand{})