You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2024/09/27 08:24:43 UTC
(hbase) branch branch-3 updated: HBASE-28645 Add build information to the REST server version endpoint (#6262)
This is an automated email from the ASF dual-hosted git repository.
stoty pushed a commit to branch branch-3
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-3 by this push:
new 9df0a1a8931 HBASE-28645 Add build information to the REST server version endpoint (#6262)
9df0a1a8931 is described below
commit 9df0a1a8931b80976d7d71ce8d5ff5bd39e1822a
Author: Dávid Paksy <PD...@users.noreply.github.com>
AuthorDate: Fri Sep 27 10:23:07 2024 +0200
HBASE-28645 Add build information to the REST server version endpoint (#6262)
Signed-off-by: Nihal Jain <ni...@apache.org>
Signed-off-by: Istvan Toth <st...@apache.org>
(cherry picked from commit 64a49a267c2aeb6136c980e05f1edd8b9274f90b)
---
.../src/main/protobuf/rest/VersionMessage.proto | 2 +
.../hadoop/hbase/rest/model/VersionModel.java | 44 ++++++++++++++++++++++
.../hadoop/hbase/rest/TestVersionResource.java | 13 ++++++-
.../hadoop/hbase/rest/model/TestVersionModel.java | 18 +++++++--
4 files changed, 71 insertions(+), 6 deletions(-)
diff --git a/hbase-protocol-shaded/src/main/protobuf/rest/VersionMessage.proto b/hbase-protocol-shaded/src/main/protobuf/rest/VersionMessage.proto
index 742d8828d4f..4ce5afe7141 100644
--- a/hbase-protocol-shaded/src/main/protobuf/rest/VersionMessage.proto
+++ b/hbase-protocol-shaded/src/main/protobuf/rest/VersionMessage.proto
@@ -24,4 +24,6 @@ message Version {
optional string osVersion = 3;
optional string serverVersion = 4;
optional string jerseyVersion = 5;
+ optional string version = 6;
+ optional string revision = 7;
}
diff --git a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/model/VersionModel.java b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/model/VersionModel.java
index 359211ef5e2..3ab5e4db6b5 100644
--- a/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/model/VersionModel.java
+++ b/hbase-rest/src/main/java/org/apache/hadoop/hbase/rest/model/VersionModel.java
@@ -25,6 +25,7 @@ import javax.xml.bind.annotation.XmlRootElement;
import org.apache.hadoop.hbase.rest.ProtobufMessageHandler;
import org.apache.hadoop.hbase.rest.RESTServlet;
import org.apache.hadoop.hbase.rest.RestUtil;
+import org.apache.hadoop.hbase.util.VersionInfo;
import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream;
@@ -54,6 +55,8 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
private String osVersion;
private String serverVersion;
private String jerseyVersion;
+ private String version;
+ private String revision;
/**
* Default constructor. Do not use.
@@ -75,6 +78,9 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
jerseyVersion = ServletContainer.class.getPackage().getImplementationVersion();
// Currently, this will always be null because the manifest doesn't have any useful information
if (jerseyVersion == null) jerseyVersion = "";
+
+ version = VersionInfo.getVersion();
+ revision = VersionInfo.getRevision();
}
/** Returns the REST gateway version */
@@ -107,6 +113,18 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
return jerseyVersion;
}
+ /** Returns the build version of the REST server component */
+ @XmlAttribute(name = "Version")
+ public String getVersion() {
+ return version;
+ }
+
+ /** Returns the source control revision of the REST server component */
+ @XmlAttribute(name = "Revision")
+ public String getRevision() {
+ return revision;
+ }
+
/**
* @param version the REST gateway version string
*/
@@ -142,6 +160,20 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
this.jerseyVersion = version;
}
+ /**
+ * @param version the REST server component build version string
+ */
+ public void setVersion(String version) {
+ this.version = version;
+ }
+
+ /**
+ * @param revision the REST server component source control revision string
+ */
+ public void setRevision(String revision) {
+ this.revision = revision;
+ }
+
/*
* (non-Javadoc)
* @see java.lang.Object#toString()
@@ -159,6 +191,10 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
sb.append(serverVersion);
sb.append("] [Jersey: ");
sb.append(jerseyVersion);
+ sb.append("] [Version: ");
+ sb.append(version);
+ sb.append("] [Revision: ");
+ sb.append(revision);
sb.append("]\n");
return sb.toString();
}
@@ -171,6 +207,8 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
builder.setOsVersion(osVersion);
builder.setServerVersion(serverVersion);
builder.setJerseyVersion(jerseyVersion);
+ builder.setVersion(version);
+ builder.setRevision(revision);
return builder.build();
}
@@ -193,6 +231,12 @@ public class VersionModel implements Serializable, ProtobufMessageHandler {
if (builder.hasJerseyVersion()) {
jerseyVersion = builder.getJerseyVersion();
}
+ if (builder.hasVersion()) {
+ version = builder.getVersion();
+ }
+ if (builder.hasRevision()) {
+ revision = builder.getRevision();
+ }
return this;
}
}
diff --git a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestVersionResource.java b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestVersionResource.java
index 39593d566aa..158d412971b 100644
--- a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestVersionResource.java
+++ b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/TestVersionResource.java
@@ -36,6 +36,7 @@ import org.apache.hadoop.hbase.rest.model.VersionModel;
import org.apache.hadoop.hbase.testclassification.MediumTests;
import org.apache.hadoop.hbase.testclassification.RestTests;
import org.apache.hadoop.hbase.util.Bytes;
+import org.apache.hadoop.hbase.util.VersionInfo;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.ClassRule;
@@ -77,8 +78,9 @@ public class TestVersionResource {
private static void validate(VersionModel model) {
assertNotNull(model);
- assertNotNull(model.getRESTVersion());
- assertEquals(RESTServlet.VERSION_STRING, model.getRESTVersion());
+ String restVersion = model.getRESTVersion();
+ assertNotNull(restVersion);
+ assertEquals(RESTServlet.VERSION_STRING, restVersion);
String osVersion = model.getOSVersion();
assertNotNull(osVersion);
assertTrue(osVersion.contains(System.getProperty("os.name")));
@@ -94,6 +96,13 @@ public class TestVersionResource {
assertNotNull(jerseyVersion);
// TODO: fix when we actually get a jersey version
// assertEquals(jerseyVersion, ServletContainer.class.getPackage().getImplementationVersion());
+
+ String version = model.getVersion();
+ assertNotNull(version);
+ assertEquals(VersionInfo.getVersion(), version);
+ String revision = model.getRevision();
+ assertNotNull(revision);
+ assertEquals(VersionInfo.getRevision(), revision);
}
@Test
diff --git a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/model/TestVersionModel.java b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/model/TestVersionModel.java
index 166a68c5228..8062e97e8e0 100644
--- a/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/model/TestVersionModel.java
+++ b/hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/model/TestVersionModel.java
@@ -37,19 +37,25 @@ public class TestVersionModel extends TestModelBase<VersionModel> {
private static final String JVM_VERSION = "Sun Microsystems Inc. 1.6.0_13-11.3-b02";
private static final String JETTY_VERSION = "6.1.14";
private static final String JERSEY_VERSION = "1.1.0-ea";
+ private static final String VERSION = "4.0.0-alpha-1-SNAPSHOT";
+ private static final String REVISION = "5085d27ab17d857118a96ae3f37c00b60c925471";
public TestVersionModel() throws Exception {
super(VersionModel.class);
AS_XML = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Version JVM=\"Sun "
+ "Microsystems Inc. 1.6.0_13-11.3-b02\" Jersey=\"1.1.0-ea\" "
- + "OS=\"Linux 2.6.18-128.1.6.el5.centos.plusxen amd64\" REST=\"0.0.1\" Server=\"6.1.14\"/>";
+ + "OS=\"Linux 2.6.18-128.1.6.el5.centos.plusxen amd64\" REST=\"0.0.1\" Server=\"6.1.14\" "
+ + "Version=\"4.0.0-alpha-1-SNAPSHOT\" "
+ + "Revision=\"5085d27ab17d857118a96ae3f37c00b60c925471\"/>";
- AS_PB = "CgUwLjAuMRInU3VuIE1pY3Jvc3lzdGVtcyBJbmMuIDEuNi4wXzEzLTExLjMtYjAyGi1MaW51eCAy"
- + "LjYuMTgtMTI4LjEuNi5lbDUuY2VudG9zLnBsdXN4ZW4gYW1kNjQiBjYuMS4xNCoIMS4xLjAtZWE=";
+ AS_PB = "CgUwLjAuMRInU3VuIE1pY3Jvc3lzdGVtcyBJbmMuIDEuNi4wXzEzLTExLjMtYjAyGi1MaW51eCAyLjYuMTg"
+ + "tMTI4LjEuNi5lbDUuY2VudG9zLnBsdXN4ZW4gYW1kNjQiBjYuMS4xNCoIMS4xLjAtZWEyFjQuMC4wLWFscGhhLT"
+ + "EtU05BUFNIT1Q6KDUwODVkMjdhYjE3ZDg1NzExOGE5NmFlM2YzN2MwMGI2MGM5MjU0NzE=";
AS_JSON = "{\"JVM\":\"Sun Microsystems Inc. 1.6.0_13-11.3-b02\",\"Jersey\":\"1.1.0-ea\","
+ "\"OS\":\"Linux 2.6.18-128.1.6.el5.centos.plusxen amd64\",\""
- + "REST\":\"0.0.1\",\"Server\":\"6.1.14\"}";
+ + "REST\":\"0.0.1\",\"Server\":\"6.1.14\", \"Version\":\"4.0.0-alpha-1-SNAPSHOT\","
+ + "\"Revision\":\"5085d27ab17d857118a96ae3f37c00b60c925471\"}";
}
@Override
@@ -60,6 +66,8 @@ public class TestVersionModel extends TestModelBase<VersionModel> {
model.setJVMVersion(JVM_VERSION);
model.setServerVersion(JETTY_VERSION);
model.setJerseyVersion(JERSEY_VERSION);
+ model.setVersion(VERSION);
+ model.setRevision(REVISION);
return model;
}
@@ -70,5 +78,7 @@ public class TestVersionModel extends TestModelBase<VersionModel> {
assertEquals(JVM_VERSION, model.getJVMVersion());
assertEquals(JETTY_VERSION, model.getServerVersion());
assertEquals(JERSEY_VERSION, model.getJerseyVersion());
+ assertEquals(VERSION, model.getVersion());
+ assertEquals(REVISION, model.getRevision());
}
}