Fix the JDBC driver version

returned by the methods in the classes CassandraDriver and CassandraDatabaseMetaData
to be consistent with the version defined into the POM file.

Also externalize some driver properties into a jdbc-driver.properties file.

Update JUnit Jupiter dependencies and improve logging in the tests.

Author: maximevw

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to 
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+### Fixed
+- Fix the JDBC driver version returned by the methods of the classes `CassandraDriver` and `CassandraDatabaseMetaData` 
+  to be consistent with the version of the JDBC wrapper artifact (see issue 
+  [#19](https://github.com/ing-bank/cassandra-jdbc-wrapper/issues/19)).
+
 ## 4.8.0 - 2023-01-12
 ### Added
 - Implement the methods `getMetaData()` and `getParameterMetaData()` into the implementation class

pom.xml

@@ -98,9 +98,10 @@
         <!-- Versions for test dependencies -->
         <achilles-embedded.version>6.1.0</achilles-embedded.version>
         <hamcrest.version>2.2</hamcrest.version>
-        <junit5.version>5.9.1</junit5.version>
-        <junit-platform.version>1.9.1</junit-platform.version>
+        <junit5.version>5.9.2</junit5.version>
+        <junit-platform.version>1.9.2</junit-platform.version>
         <mockito.version>3.12.4</mockito.version>
+        <slf4j.version>1.7.36</slf4j.version>
         <!-- Versions for plugins -->
         <maven-checkstyle-plugin.version>3.2.0</maven-checkstyle-plugin.version>
         <maven-clean-plugin.version>3.2.0</maven-clean-plugin.version>
@@ -191,6 +192,12 @@
             <version>${achilles-embedded.version}</version>
             <scope>test</scope>
         </dependency>
+        <!-- Logging for tests -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
 	</dependencies>
 
 	<build>
@@ -215,6 +222,7 @@
                 <version>${maven-resources-plugin.version}</version>
                 <configuration>
                     <encoding>${encoding}</encoding>
+                    <propertiesEncoding>${encoding}</propertiesEncoding>
                 </configuration>
             </plugin>
 

src/main/java/com/ing/data/cassandra/jdbc/CassandraConnection.java

@@ -65,7 +65,6 @@
 import static com.ing.data.cassandra.jdbc.CassandraResultSet.DEFAULT_TYPE;
 import static com.ing.data.cassandra.jdbc.Utils.ALWAYS_AUTOCOMMIT;
 import static com.ing.data.cassandra.jdbc.Utils.BAD_TIMEOUT;
-import static com.ing.data.cassandra.jdbc.Utils.NO_INTERFACE;
 import static com.ing.data.cassandra.jdbc.Utils.NO_TRANSACTIONS;
 import static com.ing.data.cassandra.jdbc.Utils.PROTOCOL;
 import static com.ing.data.cassandra.jdbc.Utils.TAG_ACTIVE_CQL_VERSION;
@@ -77,23 +76,17 @@
 import static com.ing.data.cassandra.jdbc.Utils.TAG_USER;
 import static com.ing.data.cassandra.jdbc.Utils.WAS_CLOSED_CONN;
 import static com.ing.data.cassandra.jdbc.Utils.createSubName;
+import static com.ing.data.cassandra.jdbc.Utils.getDriverProperty;
 
 /**
  * Cassandra connection: implementation class for {@link Connection} to create a JDBC connection to a Cassandra cluster.
  */
 public class CassandraConnection extends AbstractConnection implements Connection {
 
-    /**
-     * The database product name.
-     */
-    public static final String DB_PRODUCT_NAME = "Cassandra";
-    /**
-     * The default CQL language version supported by the driver.
-     */
-    public static final String DEFAULT_CQL_VERSION = "3.0.0";
-
     // Minimal Apache Cassandra version supported by the DataStax Java Driver for Apache Cassandra on top which this
     // wrapper is built.
+    // If available, the effective version run by the node on which the connection is established will override these
+    // values.
     /**
      * Minimal Apache Cassandra major version supported by the DataStax Java Driver for Apache Cassandra.
      */
@@ -153,7 +146,8 @@ public CassandraConnection(final SessionHolder sessionHolder) throws SQLExceptio
         this.optionSet = lookupOptionSet(sessionProperties.getProperty(TAG_COMPLIANCE_MODE));
         this.username = sessionProperties.getProperty(TAG_USER,
             defaultConfigProfile.getString(DefaultDriverOption.AUTH_PROVIDER_USER_NAME, StringUtils.EMPTY));
-        final String cqlVersion = sessionProperties.getProperty(TAG_CQL_VERSION, DEFAULT_CQL_VERSION);
+        final String cqlVersion = sessionProperties.getProperty(TAG_CQL_VERSION,
+            getDriverProperty("database.defaultCqlVersion"));
         this.connectionProperties.setProperty(TAG_ACTIVE_CQL_VERSION, cqlVersion);
         this.defaultConsistencyLevel = DefaultConsistencyLevel.valueOf(
             sessionProperties.getProperty(TAG_CONSISTENCY_LEVEL,

src/main/java/com/ing/data/cassandra/jdbc/CassandraDatabaseMetaData.java

@@ -28,14 +28,14 @@
 import java.sql.SQLSyntaxErrorException;
 
 import static com.ing.data.cassandra.jdbc.Utils.NOT_SUPPORTED;
+import static com.ing.data.cassandra.jdbc.Utils.getDriverProperty;
+import static com.ing.data.cassandra.jdbc.Utils.parseVersion;
 
 /**
  * Cassandra database metadata: implementation class for {@link DatabaseMetaData}.
  */
 public class CassandraDatabaseMetaData implements DatabaseMetaData {
 
-    static final int JDBC_MAJOR_VERSION = 4;
-    static final int JDBC_MINOR_VERSION = 0;
     static final int UNKNOWN_MAX_VALUE = 0;
     static final int KEYSPACE_NAME_MAX_LENGTH = 48;
     static final int TABLE_NAME_MAX_LENGTH = 48;
@@ -223,7 +223,7 @@ public int getDatabaseMinorVersion() {
 
     @Override
     public String getDatabaseProductName() {
-        return CassandraConnection.DB_PRODUCT_NAME;
+        return getDriverProperty("database.productName");
     }
 
     /**
@@ -250,23 +250,22 @@ public int getDefaultTransactionIsolation() {
 
     @Override
     public int getDriverMajorVersion() {
-        return CassandraDriver.DRIVER_MAJOR_VERSION;
+        return parseVersion(getDriverVersion(), 0);
     }
 
     @Override
     public int getDriverMinorVersion() {
-        return CassandraDriver.DRIVER_MINOR_VERSION;
+        return parseVersion(getDriverVersion(), 1);
     }
 
     @Override
     public String getDriverName() {
-        return CassandraDriver.DRIVER_NAME;
+        return getDriverProperty("driver.name");
     }
 
     @Override
     public String getDriverVersion() {
-        return String.format("%d.%d.%d", CassandraDriver.DRIVER_MAJOR_VERSION, CassandraDriver.DRIVER_MINOR_VERSION,
-            CassandraDriver.DRIVER_PATCH_VERSION);
+        return getDriverProperty("driver.version");
     }
 
     /**
@@ -358,12 +357,12 @@ public ResultSet getIndexInfo(final String catalog, final String schema, final S
 
     @Override
     public int getJDBCMajorVersion() {
-        return JDBC_MAJOR_VERSION;
+        return parseVersion(getDriverProperty("driver.jdbcVersion"), 0);
     }
 
     @Override
     public int getJDBCMinorVersion() {
-        return JDBC_MINOR_VERSION;
+        return parseVersion(getDriverProperty("driver.jdbcVersion"), 1);
     }
 
     @Override

src/main/java/com/ing/data/cassandra/jdbc/CassandraDriver.java

@@ -37,30 +37,15 @@
 import static com.ing.data.cassandra.jdbc.Utils.PROTOCOL;
 import static com.ing.data.cassandra.jdbc.Utils.TAG_PASSWORD;
 import static com.ing.data.cassandra.jdbc.Utils.TAG_USER;
+import static com.ing.data.cassandra.jdbc.Utils.getDriverProperty;
+import static com.ing.data.cassandra.jdbc.Utils.parseVersion;
 
 /**
  * The Cassandra driver implementation.
  */
 @SuppressWarnings("UnstableApiUsage")
 public class CassandraDriver implements Driver {
 
-    /**
-     * The JDBC driver major version.
-     */
-    public static final int DRIVER_MAJOR_VERSION = 4;
-    /**
-     * The JDBC driver minor version.
-     */
-    public static final int DRIVER_MINOR_VERSION = 4;
-    /**
-     * The JDBC driver patch version.
-     */
-    public static final int DRIVER_PATCH_VERSION = 0;
-    /**
-     * The JDBC driver name.
-     */
-    public static final String DRIVER_NAME = "Cassandra JDBC Driver";
-
     static {
         // Register the CassandraDriver with DriverManager.
         try {
@@ -124,12 +109,12 @@ public Connection connect(final String url, final Properties properties) throws
 
     @Override
     public int getMajorVersion() {
-        return DRIVER_MAJOR_VERSION;
+        return parseVersion(getDriverProperty("driver.version"), 0);
     }
 
     @Override
     public int getMinorVersion() {
-        return DRIVER_MINOR_VERSION;
+        return parseVersion(getDriverProperty("driver.version"), 1);
     }
 
     @Override

src/main/java/com/ing/data/cassandra/jdbc/Utils.java

@@ -22,6 +22,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.IOException;
+import java.io.InputStream;
 import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -54,6 +56,11 @@ public final class Utils {
      * Default Cassandra cluster port.
      */
     public static final int DEFAULT_PORT = 9042;
+    /**
+     * Properties file name containing some properties relative to this JDBC wrapper (such as JDBC driver version,
+     * name, etc.).
+     */
+    public static final String JDBC_DRIVER_PROPERTIES_FILE = "jdbc-driver.properties";
 
     /**
      * JDBC URL parameter key for the database version.
@@ -197,6 +204,48 @@ private Utils() {
         // Private constructor to hide the public one.
     }
 
+    /**
+     * Gets a property value from the Cassandra JDBC driver properties file.
+     *
+     * @param name The name of the property.
+     * @return The property value or an empty string the value cannot be retrieved.
+     */
+    public static String getDriverProperty(final String name) {
+        try (final InputStream propertiesFile =
+                 Utils.class.getClassLoader().getResourceAsStream(JDBC_DRIVER_PROPERTIES_FILE)) {
+            final Properties driverProperties = new Properties();
+            driverProperties.load(propertiesFile);
+            return driverProperties.getProperty(name, StringUtils.EMPTY);
+        } catch (IOException ex) {
+            LOG.error("Unable to get JDBC driver property: {}.", name, ex);
+            return StringUtils.EMPTY;
+        }
+    }
+
+    /**
+     * Gets a part of a version string.
+     * <p>
+     *     It uses the dot character as separator to parse the different parts of a version (major, minor, patch).
+     * </p>
+     *
+     * @param version The version string (for example X.Y.Z).
+     * @param part The part of the version to extract (for the semantic versioning, use 0 for the major version, 1 for
+     *             the minor and 2 for the patch).
+     * @return The requested part of the version, or 0 if the requested part cannot be parsed correctly.
+     */
+    public static int parseVersion(final String version, final int part) {
+        if (StringUtils.isBlank(version) || StringUtils.countMatches(version, ".") < part || part < 0 ) {
+            return 0;
+        } else {
+            try {
+                return Integer.parseInt(version.split("\\.")[part]);
+            } catch (final NumberFormatException ex) {
+                LOG.error("Unable to parse version: {}", version);
+                return 0;
+            }
+        }
+    }
+
     /**
      * Parses a URL for the Cassandra JDBC Driver.
      * <p>

src/main/resources/jdbc-driver.properties

@@ -0,0 +1,22 @@
+#
+#
+#   Licensed 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.
+#
+
+# The Cassandra JDBC Driver version is retrieved from the version defined in the POM file.
+driver.version=${project.version}
+driver.name=Cassandra JDBC Driver
+driver.jdbcVersion=4.0
+
+database.productName=Cassandra
+database.defaultCqlVersion=3.0.0

src/test/java/com/ing/data/cassandra/jdbc/ConnectionUnitTest.java

@@ -46,10 +46,10 @@
 
 import java.net.InetSocketAddress;
 import java.net.URL;
+import java.sql.DatabaseMetaData;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.SQLNonTransientConnectionException;
-import java.sql.Statement;
 import java.time.Duration;
 import java.util.Collections;
 import java.util.Objects;
@@ -65,6 +65,7 @@
 import static org.hamcrest.Matchers.instanceOf;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
@@ -367,4 +368,32 @@ void givenSessionToConnect_andLiquibaseCompliance() throws SQLException {
         assertNull(jdbcConnection.getCatalog());
     }
 
+    @Test
+    void givenConnection_whenGetMetaData_getExpectedResultSet() throws Exception {
+        initConnection(KEYSPACE);
+        assertNotNull(sqlConnection);
+        assertNotNull(sqlConnection.getMetaData());
+
+        final DatabaseMetaData dbMetadata = sqlConnection.getMetaData();
+        log.debug("====================================================");
+        log.debug("Connection Metadata");
+        log.debug("====================================================");
+        log.debug("Driver name: {}", dbMetadata.getDriverName());
+        log.debug("Driver version: {}", dbMetadata.getDriverVersion());
+        log.debug("DB name: {}", dbMetadata.getDatabaseProductName());
+        log.debug("DB version: {}", dbMetadata.getDatabaseProductVersion());
+        log.debug("JDBC version: {}.{}", dbMetadata.getJDBCMajorVersion(), dbMetadata.getJDBCMinorVersion());
+        log.debug("====================================================");
+
+        assertEquals("Cassandra JDBC Driver", dbMetadata.getDriverName());
+        assertNotEquals(0, dbMetadata.getDriverMajorVersion());
+        assertNotEquals(0, dbMetadata.getDriverMinorVersion());
+        assertEquals(4, dbMetadata.getJDBCMajorVersion());
+        assertEquals(0, dbMetadata.getJDBCMinorVersion());
+        assertEquals("Cassandra", dbMetadata.getDatabaseProductName());
+        assertThat(dbMetadata.getDriverVersion(), Matchers.matchesPattern("\\d.\\d+.\\d+"));
+        assertThat(dbMetadata.getDatabaseProductVersion(), Matchers.matchesPattern("\\d.\\d+.\\d+"));
+        sqlConnection.close();
+    }
+
 }

src/test/java/com/ing/data/cassandra/jdbc/UtilsUnitTest.java

@@ -16,6 +16,7 @@
 
 import com.datastax.oss.driver.api.core.config.DefaultDriverOption;
 import com.datastax.oss.driver.api.core.config.DriverOption;
+import org.apache.commons.lang3.StringUtils;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
@@ -36,10 +37,11 @@
 import static com.ing.data.cassandra.jdbc.Utils.HOST_IN_URL;
 import static com.ing.data.cassandra.jdbc.Utils.HOST_REQUIRED;
 import static com.ing.data.cassandra.jdbc.Utils.SECURECONENCTBUNDLE_REQUIRED;
-import static com.ing.data.cassandra.jdbc.Utils.TAG_DATABASE_NAME;
 import static com.ing.data.cassandra.jdbc.Utils.TAG_PORT_NUMBER;
 import static com.ing.data.cassandra.jdbc.Utils.TAG_SERVER_NAME;
 import static com.ing.data.cassandra.jdbc.Utils.URI_IS_SIMPLE;
+import static com.ing.data.cassandra.jdbc.Utils.getDriverProperty;
+import static com.ing.data.cassandra.jdbc.Utils.parseVersion;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
@@ -242,4 +244,21 @@ void testMissingSecureConnectBundleOnDbaasConenctionString(final String jdbcUrl)
             () -> Utils.parseURL(jdbcUrl));
         assertEquals(SECURECONENCTBUNDLE_REQUIRED, exception.getMessage());
     }
+
+    @Test
+    void testGetDriverProperty() {
+        assertEquals(StringUtils.EMPTY, getDriverProperty("invalidProperty"));
+        assertNotNull(getDriverProperty("driver.name"));
+    }
+
+    @Test
+    void testParseVersion() {
+        assertEquals(0, parseVersion(StringUtils.EMPTY, 0));
+        assertEquals(0, parseVersion("1.0.0", 3));
+        assertEquals(0, parseVersion("1.0.0", -1));
+        assertEquals(1, parseVersion("1.2.3", 0));
+        assertEquals(2, parseVersion("1.2.3", 1));
+        assertEquals(3, parseVersion("1.2.3", 2));
+        assertEquals(0, parseVersion("1.a", 1));
+    }
 }