Merge pull request #674 from yeya24/feature/add-version

feature: add more version information to both cmd and router
dragonflyoss · Jul 17, 2019 · 21d2390 · 21d2390
2 parents a3862fb + 9ee5566
commit 21d2390
Show file tree

Hide file tree

Showing 30 changed files with 357 additions and 57 deletions.
diff --git a/apis/swagger.yml b/apis/swagger.yml
@@ -44,6 +44,20 @@ paths:
         500:
           $ref: "#/responses/500ErrorResponse"
 
+  /version:
+    get:
+      summary: "Get version and build information"
+      description: |
+        Get version and build information, including GoVersion, OS,
+        Arch, Version, BuildDate, and GitCommit.
+      responses:
+        200:
+          description: "no error"
+          schema:
+            $ref: "#/definitions/DragonflyVersion"
+        500:
+          $ref: "#/responses/500ErrorResponse"
+
   /peer/registry:
     post:
       summary: "registry a task"
@@ -567,6 +581,30 @@ definitions:
       message:
         type: string
 
+  DragonflyVersion:
+    type: "object"
+    description: |
+      Version and build information of Dragonfly components.
+    properties:
+      Version:
+        type: "string"
+        description: "Version of Dragonfly components"
+      Revision:
+        type: "string"
+        description: "Git commit when building Dragonfly components"
+      BuildDate:
+        type: "string"
+        description: "Build Date of Dragonfly components"
+      GoVersion:
+        type: "string"
+        description: "Golang runtime version"
+      OS:
+        type: "string"
+        description: "Dragonfly components's operating system"
+      Arch:
+        type: "string"
+        description: "Dragonfly components's architecture target"
+
   ResultInfo: 
     type: "object"
     description: |

diff --git a/apis/types/df_get_task.go b/apis/types/df_get_task.go
diff --git a/apis/types/dragonfly_version.go b/apis/types/dragonfly_version.go
diff --git a/apis/types/error.go b/apis/types/error.go
diff --git a/apis/types/error_response.go b/apis/types/error_response.go
diff --git a/apis/types/peer_create_request.go b/apis/types/peer_create_request.go
diff --git a/apis/types/peer_create_response.go b/apis/types/peer_create_response.go
diff --git a/apis/types/peer_info.go b/apis/types/peer_info.go
diff --git a/apis/types/piece_info.go b/apis/types/piece_info.go
diff --git a/apis/types/piece_pull_request.go b/apis/types/piece_pull_request.go
diff --git a/apis/types/piece_update_request.go b/apis/types/piece_update_request.go
diff --git a/apis/types/preheat_create_request.go b/apis/types/preheat_create_request.go
diff --git a/apis/types/preheat_create_response.go b/apis/types/preheat_create_response.go
diff --git a/apis/types/preheat_info.go b/apis/types/preheat_info.go
diff --git a/apis/types/result_info.go b/apis/types/result_info.go
diff --git a/apis/types/task_create_request.go b/apis/types/task_create_request.go
diff --git a/apis/types/task_create_response.go b/apis/types/task_create_response.go
diff --git a/apis/types/task_info.go b/apis/types/task_info.go
diff --git a/apis/types/task_register_request.go b/apis/types/task_register_request.go
diff --git a/apis/types/task_update_request.go b/apis/types/task_update_request.go
diff --git a/cmd/dfdaemon/app/root.go b/cmd/dfdaemon/app/root.go
@@ -18,7 +18,6 @@ package app
 
 import (
 	"encoding/json"
-	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -29,14 +28,13 @@ import (
 	"github.com/dragonflyoss/Dragonfly/dfdaemon"
 	"github.com/dragonflyoss/Dragonfly/dfdaemon/config"
 	"github.com/dragonflyoss/Dragonfly/dfdaemon/constant"
-	"github.com/dragonflyoss/Dragonfly/version"
+
 	"github.com/mitchellh/mapstructure"
 	"github.com/pkg/errors"
-	"gopkg.in/yaml.v2"
-
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	"gopkg.in/yaml.v2"
 )
 
 var rootCmd = &cobra.Command{
@@ -45,11 +43,6 @@ var rootCmd = &cobra.Command{
 	Long:              "The dfdaemon is a proxy between container engine and registry used for pulling images.",
 	DisableAutoGenTag: true, // disable displaying auto generation tag in cli docs
 	RunE: func(cmd *cobra.Command, args []string) error {
-		if viper.GetBool("version") {
-			fmt.Println("dfdaemon version:", version.DFDaemonVersion)
-			return nil
-		}
-
 		if err := readConfigFile(viper.GetViper(), cmd); err != nil {
 			return errors.Wrap(err, "read config file")
 		}
@@ -83,7 +76,6 @@ func init() {
 
 	rf := rootCmd.Flags()
 
-	rf.BoolP("version", "v", false, "version")
 	rf.String("config", constant.DefaultConfigPath, "the path of dfdaemon's configuration file")
 
 	rf.Bool("verbose", false, "verbose")

diff --git a/cmd/dfdaemon/app/version.go b/cmd/dfdaemon/app/version.go
@@ -0,0 +1,40 @@
+package app
+
+import (
+	"fmt"
+
+	"github.com/dragonflyoss/Dragonfly/version"
+
+	"github.com/spf13/cobra"
+)
+
+// versionDescription is used to describe version command in detail and auto generate command doc.
+var versionDescription = "Display the version and build information of Dragonfly dfdaemon, " +
+	"including GoVersion, OS, Arch, Version, BuildDate and GitCommit."
+
+var versionCmd = &cobra.Command{
+	Use:           "version",
+	Short:         "Show the current version of dfdaemon",
+	Long:          versionDescription,
+	SilenceErrors: true,
+	SilenceUsage:  true,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		fmt.Println(version.Print("dfdaemon"))
+		return nil
+	},
+	Example: versionExample(),
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}
+
+// versionExample shows examples in version command, and is used in auto-generated cli docs.
+func versionExample() string {
+	return `dfdaemon, version  0.4.1
+  Git commit:     6fd5c8f
+  Build date:     20190717-15:57:52
+  Go version:     go1.12.6
+  OS/Arch:        linux/amd64
+`
+}