implemented version file

chernser · chernser · commit b0a89340ce5d · 2024-12-26T21:42:56.000-08:00
diff --git a/clickhouse-client/pom.xml b/clickhouse-client/pom.xml
@@ -69,6 +69,12 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
diff --git a/clickhouse-client/src/main/java/com/clickhouse/client/config/ClickHouseClientOption.java b/clickhouse-client/src/main/java/com/clickhouse/client/config/ClickHouseClientOption.java
@@ -1,11 +1,13 @@
 package com.clickhouse.client.config;
 
+import java.io.InputStream;
 import java.io.Serializable;
 import java.net.InetAddress;
 import java.net.UnknownHostException;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Properties;
 
 import com.clickhouse.config.ClickHouseOption;
 import com.clickhouse.data.ClickHouseChecker;
@@ -492,18 +494,21 @@ public enum ClickHouseClientOption implements ClickHouseOption {
         options = Collections.unmodifiableMap(map);
 
         // <artifact-id> <version> (revision: <revision>)
-        String ver = ClickHouseClientOption.class.getPackage().getImplementationVersion();
-        String[] parts = ver == null || ver.isEmpty() ? null : ver.split("\\s");
-        if (parts != null && parts.length == 4 && parts[1].length() > 0 && parts[3].length() > 1
-                && ver.charAt(ver.length() - 1) == ')') {
-            PRODUCT_VERSION = parts[1];
-            ver = parts[3];
-            PRODUCT_REVISION = ver.substring(0, ver.length() - 1);
-        } else { // perhaps try harder by checking version from pom.xml?
-            PRODUCT_VERSION = LATEST_KNOWN_VERSION;
-            PRODUCT_REVISION = UNKNOWN;
+        String tmpVersion = "unknown";
+        try (InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream("clickhouse-client-version.properties")) {
+            Properties p = new Properties();
+            p.load(in);
+
+            String tmp = p.getProperty("version");
+            if (tmp != null && !tmp.isEmpty() && !tmp.equals("${revision}")) {
+                tmpVersion = tmp;
+            }
+        } catch (Exception e) {
+           // ignore
         }
 
+        PRODUCT_VERSION = tmpVersion;
+        PRODUCT_REVISION = UNKNOWN;
 
         CLIENT_OS_INFO = new StringBuilder().append(getSystemConfig("os.name", "O/S")).append('/')
                 .append(getSystemConfig("os.version", UNKNOWN)).toString();
@@ -514,12 +519,14 @@ public enum ClickHouseClientOption implements ClickHouseOption {
         CLIENT_JVM_INFO = new StringBuilder().append(getSystemConfig("java.vm.name", "Java")).append('/')
                 .append(javaVersion).toString();
         CLIENT_USER = getSystemConfig("user.name", UNKNOWN);
+
+        String host = null;
         try {
-            ver = InetAddress.getLocalHost().getHostName();
+            host = InetAddress.getLocalHost().getHostName();
         } catch (UnknownHostException e1) {
             // ignore
         }
-        CLIENT_HOST = ver == null || ver.isEmpty() ? UNKNOWN : ver;
+        CLIENT_HOST = host == null || host.isEmpty() ? UNKNOWN : host;
     }
 
     /**
diff --git a/clickhouse-client/src/main/resources/clickhouse-client-version.properties b/clickhouse-client/src/main/resources/clickhouse-client-version.properties
@@ -0,0 +1,2 @@
+version=${revision}
+build.date=${build_timestamp}
diff --git a/clickhouse-client/src/test/java/com/clickhouse/client/ClickHouseConfigTest.java b/clickhouse-client/src/test/java/com/clickhouse/client/ClickHouseConfigTest.java
@@ -12,6 +12,8 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 public class ClickHouseConfigTest {
     @Test(groups = { "unit" })
@@ -74,7 +76,8 @@ public void testCustomValues() {
     @Test(groups = { "unit" })
     public void testClientInfo() throws UnknownHostException {
         ClickHouseConfig config = new ClickHouseConfig();
-        Assert.assertEquals(config.getProductVersion(), ClickHouseClientOption.LATEST_KNOWN_VERSION);
+        Matcher versioMatcher = Pattern.compile("(^|\\\\.[\\\\d]+)+.*").matcher(config.getProductVersion());
+        Assert.assertTrue(versioMatcher.matches());
         Assert.assertEquals(config.getProductRevision(), "unknown");
         Assert.assertEquals(config.getClientOsInfo(),
                 System.getProperty("os.name") + "/" + System.getProperty("os.version"));
diff --git a/clickhouse-http-client/src/test/java/com/clickhouse/client/http/ClickHouseHttpClientTest.java b/clickhouse-http-client/src/test/java/com/clickhouse/client/http/ClickHouseHttpClientTest.java
@@ -174,6 +174,7 @@ private void testUserAgent(ClickHouseOption option, String optionValue) throws E
                          .executeAndWait()) {
                 if (response.records().iterator().hasNext()) {
                     String result = response.firstRecord().getValue(0).asString();
+                    System.out.println(result);
                     Assert.assertTrue(result.startsWith(optionValue + " ClickHouse-JavaClient/"));
                     Assert.assertTrue(result.indexOf("Http") > 0);
                     break;
diff --git a/clickhouse-jdbc/src/main/resources/clickhouse-jdbc-version.properties b/clickhouse-jdbc/src/main/resources/clickhouse-jdbc-version.properties
@@ -0,0 +1,2 @@
+version=${revision}
+build.date=${build_timestamp}
diff --git a/client-v2/pom.xml b/client-v2/pom.xml
@@ -138,6 +138,12 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
diff --git a/client-v2/src/main/java/com/clickhouse/client/api/Client.java b/client-v2/src/main/java/com/clickhouse/client/api/Client.java
@@ -75,6 +75,7 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Properties;
 import java.util.Set;
 import java.util.StringJoiner;
 import java.util.TimeZone;
@@ -2139,6 +2140,10 @@ public String getServerVersion() {
         return this.serverVersion;
     }
 
+    public String getClientVersion() {
+        return clientVersion;
+    }
+
     /**
      * Sets list of DB roles that should be applied to each query.
      *
@@ -2155,11 +2160,28 @@ public void updateClientName(String name) {
         this.configuration.put(ClientConfigProperties.CLIENT_NAME.getKey(), name);
     }
 
-    public static final String LATEST_ARTIFACT_VERSION = "~0.7.2";
+    public static final String clientVersion = getPackageVersion();
     public static final String CLIENT_USER_AGENT = "clickhouse-java-v2/";
 
     private Collection<String> unmodifiableDbRolesView = Collections.emptyList();
 
+    private static String getPackageVersion() {
+        String version = "unknown";
+        try (InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream("client-v2-version.properties")) {
+            Properties p = new Properties();
+            p.load(in);
+
+            String tmp = p.getProperty("version");
+            if (tmp != null && !tmp.isEmpty() && !tmp.equals("${revision}")) {
+                version = tmp;
+            }
+        } catch (Exception e) {
+            LOG.error("Failed to load version file", e);
+        }
+
+        return version;
+    }
+
     /**
      * Returns list of DB roles that should be applied to each query.
      *
diff --git a/client-v2/src/main/java/com/clickhouse/client/api/internal/HttpAPIClientHelper.java b/client-v2/src/main/java/com/clickhouse/client/api/internal/HttpAPIClientHelper.java
@@ -672,8 +672,9 @@ private  String buildDefaultUserAgent() {
 
         String clientVersion = Client.class.getPackage().getImplementationVersion();
         if (clientVersion == null) {
-            clientVersion = Client.LATEST_ARTIFACT_VERSION;
+            clientVersion = Client.clientVersion;
         }
+
         userAgent.append(clientVersion);
 
         userAgent.append(" (");
diff --git a/client-v2/src/main/resources/client-v2-version.properties b/client-v2/src/main/resources/client-v2-version.properties
@@ -0,0 +1,2 @@
+version=${revision}
+build.date=${build_timestamp}
diff --git a/client-v2/src/test/java/com/clickhouse/client/HttpTransportTests.java b/client-v2/src/test/java/com/clickhouse/client/HttpTransportTests.java
@@ -819,7 +819,7 @@ public void testUserAgentHasCompleteProductName(String clientName, Pattern userA
             Assert.assertFalse(logRecords.isEmpty(), "No records found in query log");
 
             for (GenericRecord record : logRecords) {
-
+                System.out.println(record.getString("http_user_agent"));
                 Assert.assertTrue(userAgentPattern.matcher(record.getString("http_user_agent")).matches(),
                         record.getString("http_user_agent") + " doesn't match \"" +
                                   userAgentPattern.pattern() + "\"");
diff --git a/jdbc-v2/pom.xml b/jdbc-v2/pom.xml
@@ -96,6 +96,12 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
diff --git a/jdbc-v2/src/main/java/com/clickhouse/jdbc/Driver.java b/jdbc-v2/src/main/java/com/clickhouse/jdbc/Driver.java
@@ -7,6 +7,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.InputStream;
 import java.sql.Connection;
 import java.sql.DriverManager;
 import java.sql.DriverPropertyInfo;
@@ -56,18 +57,23 @@ public static String getFrameworksDetected() {
 
     public static final String DRIVER_CLIENT_NAME = "jdbc-v2/";
 
-    private static final String LAST_KNOWN_VERSION = "~0.7.2";
-
     static {
         log.debug("Initializing ClickHouse JDBC driver V2");
-        String tempDriverVersion = Driver.class.getPackage().getImplementationVersion();
-        //If the version is not available, set it to 1.0
-        if (tempDriverVersion == null || tempDriverVersion.isEmpty()) {
-            log.warn("ClickHouse JDBC driver version is not available");
-            tempDriverVersion = LAST_KNOWN_VERSION;
+
+        String tmpDriverVersion = "unknown";
+        try (InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream("jdbc-v2-version.properties")) {
+            Properties p = new Properties();
+            p.load(in);
+
+            String tmp = p.getProperty("version");
+            if (tmp != null && !tmp.isEmpty() && !tmp.equals("${revision}")) {
+                tmpDriverVersion = tmp;
+            }
+        } catch (Exception e) {
+            log.error("Failed to load version file", e);
         }
 
-        driverVersion = tempDriverVersion;
+        driverVersion = tmpDriverVersion;
         log.info("ClickHouse JDBC driver version: {}", driverVersion);
 
         int tmpMajorVersion;
diff --git a/jdbc-v2/src/main/java/com/clickhouse/jdbc/StatementImpl.java b/jdbc-v2/src/main/java/com/clickhouse/jdbc/StatementImpl.java
@@ -162,7 +162,7 @@ public ResultSetImpl executeQuery(String sql, QuerySettings settings) throws SQL
         // Closing before trying to do next request. Otherwise, deadlock because previous connection will not be
         // release before this one completes.
         closePreviousResultSet();
-        
+
         QuerySettings mergedSettings = QuerySettings.merge(connection.getDefaultQuerySettings(), settings);
 
 
diff --git a/jdbc-v2/src/main/resources/jdbc-v2-version.properties b/jdbc-v2/src/main/resources/jdbc-v2-version.properties
@@ -0,0 +1,2 @@
+version=${revision}
+build.date=${build_timestamp}
diff --git a/jdbc-v2/src/test/java/com/clickhouse/jdbc/DriverTest.java b/jdbc-v2/src/test/java/com/clickhouse/jdbc/DriverTest.java
@@ -1,14 +1,13 @@
 package com.clickhouse.jdbc;
 
-import java.sql.DriverManager;
-import java.sql.SQLException;
-import java.util.Properties;
-
 import com.clickhouse.client.api.ClientConfigProperties;
-import org.testcontainers.shaded.com.fasterxml.jackson.databind.annotation.JsonAppend;
 import org.testng.Assert;
 import org.testng.annotations.Test;
 
+import java.sql.DriverManager;
+import java.sql.SQLException;
+import java.util.Properties;
+
 
 public class DriverTest extends JdbcIntegrationTest {
     @Test(groups = { "integration" })
diff --git a/pom.xml b/pom.xml
@@ -143,6 +143,7 @@
         <surefire-plugin.version>3.2.5</surefire-plugin.version>
         <toolchains-plugin.version>3.1.0</toolchains-plugin.version>
         <versions-plugin.version>2.16.0</versions-plugin.version>
+        <resource-plugin.version>3.3.1</resource-plugin.version>
         <jmh.version>1.37</jmh.version>
 
         <minJdk>1.8</minJdk>
@@ -156,6 +157,9 @@
         <sonar.host.url>https://sonarcloud.io</sonar.host.url>
         <sonar.projectVersion>0.6.2</sonar.projectVersion>
         <sonar.cpd.exclusions>**/*0*.java,**/data/*Value.java,**/data/array/*Value.java,**/stream/*Stream.java</sonar.cpd.exclusions>
+
+        <build_timestamp>${maven.build.timestamp}</build_timestamp>
+        <maven.build.timestamp.format>MM-dd-yyyy HH:mm</maven.build.timestamp.format>
     </properties>
 
     <dependencyManagement>
@@ -560,6 +564,11 @@
                         <offline>true</offline>
                     </configuration>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-resources-plugin</artifactId>
+                    <version>${resource-plugin.version}</version>
+                </plugin>
             </plugins>
         </pluginManagement>
         <plugins>
@@ -641,6 +650,11 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-failsafe-plugin</artifactId>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-resources-plugin</artifactId>
+            </plugin>
         </plugins>
     </build>
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+version=${revision}`
	`2`	`+build.date=${build_timestamp}`
Original file line number	Diff line number	Diff line change
`@@ -672,8 +672,9 @@ private String buildDefaultUserAgent() {`
`672`	`672`
`673`	`673`	`String clientVersion = Client.class.getPackage().getImplementationVersion();`
`674`	`674`	`if (clientVersion == null) {`
`675`		`- clientVersion = Client.LATEST_ARTIFACT_VERSION;`
	`675`	`+ clientVersion = Client.clientVersion;`
`676`	`676`	`}`
	`677`	`+`
`677`	`678`	`userAgent.append(clientVersion);`
`678`	`679`
`679`	`680`	`userAgent.append(" (");`