Bump up the API to support getting the API version.

Signed-off-by: Gao Hongtao <[email protected]>

Author: hanahmily

CHANGES.md

@@ -3,12 +3,14 @@ Changes by Version
 Release Notes.
 
 0.8.0
+------------------
 
 ### Features
 
 * Bump up the API to support the index mode of Measure.
 * Bump up the API to support the new property.
 * Bump up the API to adopt the status field which is changed to the string type due to the compatibility issue.
+* Bump up the API to support getting the API version.
 
 0.7.0
 ------------------

src/main/java/org/apache/skywalking/banyandb/v1/client/BanyanDBClient.java

@@ -34,6 +34,7 @@
 import org.apache.skywalking.banyandb.common.v1.BanyandbCommon;
 import org.apache.skywalking.banyandb.common.v1.BanyandbCommon.Group;
 import org.apache.skywalking.banyandb.common.v1.BanyandbCommon.Metadata;
+import org.apache.skywalking.banyandb.common.v1.ServiceGrpc;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.TopNAggregation;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.Measure;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.Stream;
@@ -1069,6 +1070,20 @@ public MetadataCache.EntityMetadata updateMeasureMetadataCacheFromSever(String g
         return this.metadataCache.updateMeasureFromSever(group, name);
     }
 
+    /**
+     * Get the API version of the server
+     *
+     * @return the API version of the server
+     * @throws BanyanDBException if the server is not reachable
+     */
+    public BanyandbCommon.APIVersion getAPIVersion() throws BanyanDBException {
+        ServiceGrpc.ServiceBlockingStub stub = ServiceGrpc.newBlockingStub(this.channel);
+        return HandleExceptionsWith.callAndTranslateApiException(() -> {
+            BanyandbCommon.GetAPIVersionResponse resp = stub.getAPIVersion(BanyandbCommon.GetAPIVersionRequest.getDefaultInstance());
+            return resp.getVersion();
+        });
+    }
+
     @Override
     public void close() throws IOException {
         connectionEstablishLock.lock();

src/main/proto/banyandb/v1/banyandb-common.proto

@@ -115,3 +115,29 @@ message Tag {
   // value is the value of the tag.
   string value = 2;
 }
+
+
+// APIVersion is the version of the API
+message APIVersion {
+  // version is the version of the API
+  string version = 1;
+  // revision is the commit hash of the API
+  string revision = 2;
+}
+
+// GetAPIVersionRequest is the request for GetAPIVersion
+message GetAPIVersionRequest {
+  // empty
+}
+
+// GetAPIVersionResponse is the response for GetAPIVersion
+message GetAPIVersionResponse {
+  // version is the version of the API
+  APIVersion version = 1;
+}
+
+// Service is the service for the API
+service Service {
+  // GetAPIVersion returns the version of the API
+  rpc GetAPIVersion(GetAPIVersionRequest) returns (GetAPIVersionResponse);
+}

src/test/java/org/apache/skywalking/banyandb/v1/client/BanyanDBClientTestCI.java

@@ -29,9 +29,9 @@
 
 @Slf4j
 public class BanyanDBClientTestCI {
-    private static final String REGISTRY = "docker.io";
-    private static final String IMAGE_NAME = "hanahmily/skywalking-banyandb";
-    private static final String TAG = "v0.7.0-42-ga96ffb3-max-disk";
+    private static final String REGISTRY = "ghcr.io";
+    private static final String IMAGE_NAME = "apache/skywalking-banyandb";
+    private static final String TAG = "362d68ed79c532e6d61dd6674cce38090caa0da7";
 
     private static final String IMAGE = REGISTRY + "/" + IMAGE_NAME + ":" + TAG;
 

src/test/java/org/apache/skywalking/banyandb/v1/client/ITBanyanDBCommonTests.java

@@ -0,0 +1,49 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.apache.skywalking.banyandb.v1.client;
+
+import com.google.common.base.Strings;
+import org.apache.skywalking.banyandb.common.v1.BanyandbCommon;
+import org.apache.skywalking.banyandb.v1.client.grpc.exception.BanyanDBException;
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.IOException;
+
+public class ITBanyanDBCommonTests extends BanyanDBClientTestCI {
+    @Before
+    public void setUp() throws IOException, BanyanDBException, InterruptedException {
+        super.setUpConnection();
+    }
+
+    @After
+    public void tearDown() throws IOException {
+        this.closeClient();
+    }
+
+    @Test
+    public void test_GetAPIVersion() throws BanyanDBException {
+        BanyandbCommon.APIVersion version = this.client.getAPIVersion();
+        Assert.assertEquals("0.8", version.getVersion());
+        Assert.assertFalse(Strings.isNullOrEmpty(version.getRevision()));
+    }
+
+}