Show Server Version in Yorkie CLI (#938)

This commit adds the functionality to display the version of connected
Yorkie server in the version command.

The version information can be viewed by converting it into yaml or
json format using the --output, -o flag. This flag accepts json and
yaml strings and converts them to the appropriate format for display.
In order to solely check the version of the client CLI without
considering the server's version, the --client flag has been included.
The development of this feature was inspired by examining the kubectl.

Author: hyun98

admin/client.go

@@ -354,6 +354,20 @@ func (c *Client) ListChangeSummaries(
 	return summaries, nil
 }
 
+// GetServerVersion gets the server version.
+func (c *Client) GetServerVersion(ctx context.Context) (*types.VersionDetail, error) {
+	response, err := c.client.GetServerVersion(ctx, connect.NewRequest(&api.GetServerVersionRequest{}))
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.VersionDetail{
+		YorkieVersion: response.Msg.YorkieVersion,
+		GoVersion:     response.Msg.GoVersion,
+		BuildDate:     response.Msg.BuildDate,
+	}, nil
+}
+
 /**
  * withShardKey returns a context with the given shard key in metadata.
  */

api/docs/yorkie/v1/admin.openapi.yaml

@@ -82,6 +82,18 @@ paths:
           $ref: '#/components/responses/connect.error'
       tags:
       - yorkie.v1.AdminService
+  /yorkie.v1.AdminService/GetServerVersion:
+    post:
+      description: ""
+      requestBody:
+        $ref: '#/components/requestBodies/yorkie.v1.AdminService.GetServerVersion.yorkie.v1.GetServerVersionRequest'
+      responses:
+        "200":
+          $ref: '#/components/responses/yorkie.v1.AdminService.GetServerVersion.yorkie.v1.GetServerVersionResponse'
+        default:
+          $ref: '#/components/responses/connect.error'
+      tags:
+      - yorkie.v1.AdminService
   /yorkie.v1.AdminService/GetSnapshotMeta:
     post:
       description: ""
@@ -246,6 +258,15 @@ components:
           schema:
             $ref: '#/components/schemas/yorkie.v1.GetProjectRequest'
       required: true
+    yorkie.v1.AdminService.GetServerVersion.yorkie.v1.GetServerVersionRequest:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/yorkie.v1.GetServerVersionRequest'
+        application/proto:
+          schema:
+            $ref: '#/components/schemas/yorkie.v1.GetServerVersionRequest'
+      required: true
     yorkie.v1.AdminService.GetSnapshotMeta.yorkie.v1.GetSnapshotMetaRequest:
       content:
         application/json:
@@ -391,6 +412,15 @@ components:
           schema:
             $ref: '#/components/schemas/yorkie.v1.GetProjectResponse'
       description: ""
+    yorkie.v1.AdminService.GetServerVersion.yorkie.v1.GetServerVersionResponse:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/yorkie.v1.GetServerVersionResponse'
+        application/proto:
+          schema:
+            $ref: '#/components/schemas/yorkie.v1.GetServerVersionResponse'
+      description: ""
     yorkie.v1.AdminService.GetSnapshotMeta.yorkie.v1.GetSnapshotMetaResponse:
       content:
         application/json:
@@ -868,6 +898,32 @@ components:
           type: object
       title: GetProjectResponse
       type: object
+    yorkie.v1.GetServerVersionRequest:
+      additionalProperties: false
+      description: ""
+      title: GetServerVersionRequest
+      type: object
+    yorkie.v1.GetServerVersionResponse:
+      additionalProperties: false
+      description: ""
+      properties:
+        buildDate:
+          additionalProperties: false
+          description: ""
+          title: build_date
+          type: string
+        goVersion:
+          additionalProperties: false
+          description: ""
+          title: go_version
+          type: string
+        yorkieVersion:
+          additionalProperties: false
+          description: ""
+          title: yorkie_version
+          type: string
+      title: GetServerVersionResponse
+      type: object
     yorkie.v1.GetSnapshotMetaRequest:
       additionalProperties: false
       description: ""

api/types/version_info.go

@@ -0,0 +1,22 @@
+package types
+
+// VersionInfo represents information of version.
+type VersionInfo struct {
+	// ClientVersion is the yorkie cli version.
+	ClientVersion *VersionDetail `json:"clientVersion,omitempty" yaml:"clientVersion,omitempty"`
+
+	// ServerVersion is the yorkie server version.
+	ServerVersion *VersionDetail `json:"serverVersion,omitempty" yaml:"serverVersion,omitempty"`
+}
+
+// VersionDetail represents detail information of version.
+type VersionDetail struct {
+	// YorkieVersion
+	YorkieVersion string `json:"yorkieVersion" yaml:"yorkieVersion"`
+
+	// GoVersion
+	GoVersion string `json:"goVersion" yaml:"goVersion"`
+
+	// BuildDate
+	BuildDate string `json:"buildDate" yaml:"buildDate"`
+}

api/yorkie/v1/admin.pb.go

@@ -44,6 +44,8 @@ service AdminService {
   rpc SearchDocuments (SearchDocumentsRequest) returns (SearchDocumentsResponse) {}
 
   rpc ListChanges (ListChangesRequest) returns (ListChangesResponse) {}
+
+  rpc GetServerVersion (GetServerVersionRequest) returns (GetServerVersionResponse) {}
 }
 
 message SignUpRequest {
@@ -184,3 +186,11 @@ message ListChangesRequest {
 message ListChangesResponse {
   repeated Change changes = 1;
 }
+
+message GetServerVersionRequest {}
+
+message GetServerVersionResponse {
+  string yorkie_version = 1;
+  string go_version = 2;
+  string build_date = 3;
+}

api/yorkie/v1/admin.proto

@@ -79,7 +79,7 @@ func LoadAuth(addr string) (Auth, error) {
 
 	auth, ok := config.Auths[addr]
 	if !ok {
-		return Auth{}, fmt.Errorf("auth for %s does not exist", addr)
+		return Auth{}, fmt.Errorf("auth for '%s' does not exist", addr)
 	}
 
 	return auth, nil