Refactor test framework infrastructure classes.

Resolves gh-1115.

Author: jxblum

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/support/CassandraConnectionProperties.java

@@ -24,93 +24,91 @@
 import java.util.Properties;
 
 import org.springframework.core.convert.converter.Converter;
+import org.springframework.lang.NonNull;
 import org.springframework.util.Assert;
 
 /**
  * Cassandra connection properties using {@code config/cassandra-connection.properties}. Properties are generated during
  * the build and can be override using system properties.
  *
  * @author Mark Paluch
+ * @author John Blum
  */
-@SuppressWarnings("serial")
+@SuppressWarnings("unused")
 public class CassandraConnectionProperties extends Properties {
 
 	private final static List<WeakReference<CassandraConnectionProperties>> instances = new ArrayList<>();
 
-	private String resourceName;
+	private final String resourceName;
 
 	/**
-	 * Create a new {@link CassandraConnectionProperties} using properties from
-	 * {@code config/cassandra-connection.properties}.
+	 * Construct a new instance of {@link CassandraConnectionProperties} using properties
+	 * from {@code config/cassandra-connection.properties}.
 	 */
 	public CassandraConnectionProperties() {
 		this("/config/cassandra-connection.properties");
 	}
 
+	private CassandraConnectionProperties(@NonNull String resourceName) {
+
+		this.resourceName = resourceName;
+
+		loadProperties();
+
+		instances.add(new WeakReference<>(this));
+	}
+
 	public void update() {
+
 		try {
 			// Caution: Rewriting properties during initialization.
-			File file = new File(getClass().getResource(resourceName).toURI());
+			File file = new File(getClass().getResource(this.resourceName).toURI());
 
-			try (FileOutputStream fos = new FileOutputStream(file)) {
-				store(fos, "");
+			try (FileOutputStream out = new FileOutputStream(file)) {
+				store(out, "");
 			}
 
 			reload();
-		} catch (Exception e) {
-			e.printStackTrace();
-			throw new IllegalStateException(e);
+		}
+		catch (Exception cause) {
+			cause.printStackTrace();
+			throw new IllegalStateException(cause);
 		}
 	}
 
 	private static void reload() {
+
 		for (WeakReference<CassandraConnectionProperties> ref : instances) {
 
 			CassandraConnectionProperties properties = ref.get();
+
 			if (properties != null) {
 				properties.loadProperties();
 			}
 		}
 	}
 
-	private CassandraConnectionProperties(String resourceName) {
-
-		this.resourceName = resourceName;
-		loadProperties();
-
-		instances.add(new WeakReference<>(this));
-	}
-
 	private void loadProperties() {
-
 		loadProperties(this.resourceName);
 	}
 
 	private void loadProperties(String resourceName) {
 
-		InputStream in = null;
-
-		try {
-			in = getClass().getResourceAsStream(resourceName);
-
+		try (InputStream in = getClass().getResourceAsStream(resourceName)){
 			if (in != null) {
 				load(in);
 			}
-		} catch (Exception cause) {
+		}
+		catch (Exception cause) {
 			throw new RuntimeException(cause);
-		} finally {
-			if (in != null) {
-				try {
-					in.close();
-				} catch (Exception ignore) {}
-			}
 		}
 	}
 
 	@Override
 	public String getProperty(String key) {
 
 		String value = super.getProperty(key);
+
 		if (value == null) {
 			value = System.getProperty(key);
 		}
@@ -154,17 +152,17 @@ public int getCassandraRpcPort() {
 	}
 
 	/**
-	 * @return the Cassandra Storage port
+	 * @return the Cassandra SSL Storage port
 	 */
-	public int getCassandraStoragePort() {
-		return getInt("build.cassandra.storage_port");
+	public int getCassandraSslStoragePort() {
+		return getInt("build.cassandra.ssl_storage_port");
 	}
 
 	/**
-	 * @return the Cassandra SSL Storage port
+	 * @return the Cassandra Storage port
 	 */
-	public int getCassandraSslStoragePort() {
-		return getInt("build.cassandra.ssl_storage_port");
+	public int getCassandraStoragePort() {
+		return getInt("build.cassandra.storage_port");
 	}
 
 	/**
@@ -174,12 +172,9 @@ public CassandraType getCassandraType() {
 
 		String cassandraType = getProperty("build.cassandra.mode");
 
-		if (CassandraType.TESTCONTAINERS.name().equalsIgnoreCase(cassandraType)) {
-			return CassandraType.TESTCONTAINERS;
-		}
-
-		return CassandraType.EXTERNAL.name().equalsIgnoreCase(cassandraType) ? CassandraType.EXTERNAL
-				: CassandraType.EMBEDDED;
+		return CassandraType.TESTCONTAINERS.name().equalsIgnoreCase(cassandraType) ? CassandraType.TESTCONTAINERS
+			: CassandraType.EXTERNAL.name().equalsIgnoreCase(cassandraType) ? CassandraType.EXTERNAL
+			: CassandraType.EMBEDDED;
 	}
 
 	/**
@@ -229,6 +224,6 @@ private <T> T convert(String propertyName, Class<T> type, Converter<String, T> c
 	}
 
 	public enum CassandraType {
-		EMBEDDED, EXTERNAL, TESTCONTAINERS;
+		EMBEDDED, EXTERNAL, TESTCONTAINERS
 	}
 }

spring-data-cassandra/src/test/java/org/springframework/data/cassandra/test/util/CassandraDelegate.java

@@ -22,15 +22,16 @@
 import java.util.Map;
 import java.util.Optional;
 
+import org.testcontainers.containers.CassandraContainer;
+
 import org.springframework.data.cassandra.core.cql.SessionCallback;
 import org.springframework.data.cassandra.support.CassandraConnectionProperties;
 import org.springframework.data.cassandra.support.CqlDataSet;
+import org.springframework.lang.NonNull;
 import org.springframework.util.Assert;
 import org.springframework.util.SocketUtils;
 import org.springframework.util.StringUtils;
 
-import org.testcontainers.containers.CassandraContainer;
-
 import com.datastax.oss.driver.api.core.CqlIdentifier;
 import com.datastax.oss.driver.api.core.CqlSession;
 import com.datastax.oss.driver.api.core.CqlSessionBuilder;
@@ -48,22 +49,25 @@
  * @author Mark Paluch
  * @author John Blum
  * @author Tomasz Lelek
+ * @see org.springframework.data.cassandra.support.CassandraConnectionProperties
+ * @see com.datastax.oss.driver.api.core.CqlSessionBuilder
+ * @see com.datastax.oss.driver.api.core.CqlSession
  * @since 1.5
- * @see CassandraConnectionProperties
  */
 class CassandraDelegate {
 
-	private static ResourceHolder resourceHolder;
-
 	private static CassandraContainer<?> container;
 
+	private static ResourceHolder resourceHolder;
+
 	private final long startupTimeout;
 
-	@SuppressWarnings("all") private final CassandraConnectionProperties properties = new CassandraConnectionProperties();
+	private final CassandraConnectionProperties properties = new CassandraConnectionProperties();
 
+	private CqlSession session;
 	private CqlSession system;
 
-	private CqlSession session;
+	private CqlSessionBuilder sessionBuilder;
 
 	private Integer cassandraPort;
 
@@ -72,16 +76,16 @@ class CassandraDelegate {
 
 	private final Map<SessionCallback<?>, InvocationMode> invocationModeMap = new HashMap<>();
 
-	private CqlSessionBuilder sessionBuilder;
-
 	private final String configurationFilename;
 
 	/**
-	 * Create a new {@link CassandraDelegate} and allows the use of a config file.
+	 * Create a new {@link CassandraDelegate} allowing the use of a config file.
 	 *
-	 * @param yamlConfigurationResource name of the configuration resource, must not be {@literal null} and not empty
+	 * @param yamlConfigurationResource {@link String name} of the configuration resource;
+	 * must not be {@literal null} or {@literal empty}.
+	 * @see #CassandraDelegate(String, long)
 	 */
-	public CassandraDelegate(String yamlConfigurationResource) {
+	public CassandraDelegate(@NonNull String yamlConfigurationResource) {
 		this(yamlConfigurationResource, EmbeddedCassandraServerHelper.DEFAULT_STARTUP_TIMEOUT_MS);
 	}
 
@@ -232,6 +236,7 @@ public void before() throws Exception {
 	private void startCassandraIfNeeded() throws Exception {
 
 		if (isStartNeeded()) {
+
 			configureRemoteJmxPort();
 
 			if (isEmbedded()) {
@@ -263,12 +268,9 @@ private void runEmbeddedCassandra() throws Exception {
 	private void runTestcontainerCassandra() {
 
 		if (container == null) {
-			String cassandra_version = System.getenv("CASSANDRA_VERSION");
-			if (StringUtils.hasText(cassandra_version)) {
-				container = new CassandraContainer<>("cassandra:" + cassandra_version);
-			} else {
-				container = new CassandraContainer<>();
-			}
+
+			container = getCassandraDockerImageName().map(CassandraContainer::new)
+				.orElseGet(CassandraContainer::new);
 
 			container.start();
 
@@ -278,6 +280,13 @@ private void runTestcontainerCassandra() {
 		}
 	}
 
+	private Optional<String> getCassandraDockerImageName() {
+
+		return Optional.ofNullable(System.getenv("CASSANDRA_VERSION"))
+			.filter(StringUtils::hasText)
+			.map(cassandraVersion -> String.format("cassandra:%s", cassandraVersion));
+	}
+
 	private synchronized void initializeConnection() {
 
 		this.cassandraPort = resolvePort();
@@ -420,7 +429,8 @@ private void load(CqlSession session, CqlDataSet cqlDataSet) {
 	/**
 	 * Create a {@link CqlSession} object.
 	 *
-	 * @return
+	 * @return a new {@link CqlSession}.
+	 * @see com.datastax.oss.driver.api.core.CqlSession
 	 */
 	CqlSession createSession() {
 		return sessionBuilder.build();