DATACASS-226 - Polishing.

Add tests for CassandraCqlClusterFactoryBean and AbstractClusterConfiguration. Update license headers. Extend JavaDoc. Rearrange fields in CassandraCqlClusterFactoryBean to reflect grouping similar to the client. Original pull request: #31.
2016-05-10 17:23:58 +02:00
parent 1a3a9d9c56
commit ac321512bb
4 changed files with 867 additions and 101 deletions
--- a/spring-cql/src/test/java/org/springframework/cassandra/config/CassandraCqlClusterFactoryBeanUnitTests.java
+++ b/spring-cql/src/test/java/org/springframework/cassandra/config/CassandraCqlClusterFactoryBeanUnitTests.java
@@ -0,0 +1,301 @@
+/*
+ * Copyright 2016 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.cassandra.config;
+
+import static org.hamcrest.MatcherAssert.*;
+import static org.hamcrest.Matchers.*;
+
+import org.junit.Test;
+import org.springframework.test.util.ReflectionTestUtils;
+
+import com.datastax.driver.core.AuthProvider;
+import com.datastax.driver.core.Configuration;
+import com.datastax.driver.core.PlainTextAuthProvider;
+import com.datastax.driver.core.PoolingOptions;
+import com.datastax.driver.core.ProtocolOptions.Compression;
+import com.datastax.driver.core.ProtocolVersion;
+import com.datastax.driver.core.QueryOptions;
+import com.datastax.driver.core.SSLOptions;
+import com.datastax.driver.core.SocketOptions;
+import com.datastax.driver.core.policies.ExponentialReconnectionPolicy;
+import com.datastax.driver.core.policies.LoadBalancingPolicy;
+import com.datastax.driver.core.policies.ReconnectionPolicy;
+import com.datastax.driver.core.policies.RoundRobinPolicy;
+
+/**
+ * Unit tests for {@link CassandraCqlClusterFactoryBean}.
+ *
+ * @see DATACASS-226
+ * @author Mark Paluch
+ */
+public class CassandraCqlClusterFactoryBeanUnitTests {
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldInitializeWithoutAnyOptions() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.afterPropertiesSet();
+
+		assertThat(bean.getObject(), is(not(nullValue())));
+		assertThat(bean.getObject().isClosed(), is(false));
+		assertThat(getConfiguration(bean).getMetricsOptions(), is(not(nullValue())));
+		assertThat(getConfiguration(bean).getMetricsOptions().isJMXReportingEnabled(), is(true));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldShutdownClusterInstance() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.afterPropertiesSet();
+		bean.destroy();
+
+		assertThat(bean.getObject().isClosed(), is(true));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetCompressionType() throws Exception {
+
+		CompressionType compressionType = CompressionType.SNAPPY;
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setCompressionType(compressionType);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getProtocolOptions().getCompression(), is(Compression.SNAPPY));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetPoolingOptions() throws Exception {
+
+		PoolingOptions poolingOptions = new PoolingOptions();
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setPoolingOptions(poolingOptions);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getPoolingOptions(), is(poolingOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetSocketOptions() throws Exception {
+
+		SocketOptions socketOptions = new SocketOptions();
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setSocketOptions(socketOptions);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getSocketOptions(), is(socketOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetQueryOptions() throws Exception {
+
+		QueryOptions queryOptions = new QueryOptions();
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setQueryOptions(queryOptions);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getQueryOptions(), is(queryOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void defaultQueryOptionsShouldHaveOwnObjectIdentity() throws Exception {
+
+		QueryOptions queryOptions = new QueryOptions();
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getQueryOptions(), is(not(nullValue())));
+		assertThat(getConfiguration(bean).getQueryOptions(), is(not(queryOptions)));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetAuthProvider() throws Exception {
+
+		AuthProvider authProvider = new PlainTextAuthProvider("x", "y");
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setAuthProvider(authProvider);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getProtocolOptions().getAuthProvider(), is(authProvider));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void doesNotSetPlainTextAuthenticationUnlessAuthProviderIsSet() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setUsername("user");
+		bean.setPassword("password");
+		bean.afterPropertiesSet();
+
+		AuthProvider result = getConfiguration(bean).getProtocolOptions().getAuthProvider();
+		assertThat(result, is(AuthProvider.NONE));
+	}
+
+	@Test
+	public void shouldSetAuthentication() throws Exception {
+
+		PlainTextAuthProvider authProvider = new PlainTextAuthProvider("x", "y");
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setAuthProvider(authProvider);
+		bean.setUsername("user");
+		bean.setPassword("password");
+		bean.afterPropertiesSet();
+
+		AuthProvider result = getConfiguration(bean).getProtocolOptions().getAuthProvider();
+		assertThat(result, is(not(nullValue())));
+		assertThat(ReflectionTestUtils.getField(result, "username"), is(equalTo((Object) "user")));
+		assertThat(ReflectionTestUtils.getField(result, "password"), is(equalTo((Object) "password")));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetLoadBalancingPolicy() throws Exception {
+
+		LoadBalancingPolicy loadBalancingPolicy = new RoundRobinPolicy();
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setLoadBalancingPolicy(loadBalancingPolicy);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getPolicies().getLoadBalancingPolicy(), is(loadBalancingPolicy));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetReconnectionPolicy() throws Exception {
+
+		ReconnectionPolicy reconnectionPolicy = new ExponentialReconnectionPolicy(1, 2);
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setReconnectionPolicy(reconnectionPolicy);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getPolicies().getReconnectionPolicy(), is(reconnectionPolicy));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetProtocolVersion() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setProtocolVersion(ProtocolVersion.V2);
+		bean.afterPropertiesSet();
+
+		assertThat(ReflectionTestUtils.getField(getConfiguration(bean).getProtocolOptions(), "initialProtocolVersion"),
+				is((Object) ProtocolVersion.V2));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetSslOptions() throws Exception {
+
+		SSLOptions sslOptions = new SSLOptions();
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setSslEnabled(true);
+		bean.setSslOptions(sslOptions);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getProtocolOptions().getSSLOptions(), is(sslOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldDisableMetrics() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setMetricsEnabled(false);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getMetricsOptions(), is(nullValue()));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldDisableJmxReporting() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.setJmxReportingEnabled(false);
+		bean.afterPropertiesSet();
+
+		assertThat(getConfiguration(bean).getMetricsOptions().isJMXReportingEnabled(), is(false));
+	}
+
+	private Configuration getConfiguration(CassandraCqlClusterFactoryBean bean) throws Exception {
+		return bean.getObject().getConfiguration();
+	}
+}
--- a/spring-cql/src/test/java/org/springframework/cassandra/config/java/AbstractClusterConfigurationUnitTests.java
+++ b/spring-cql/src/test/java/org/springframework/cassandra/config/java/AbstractClusterConfigurationUnitTests.java
@@ -0,0 +1,335 @@
+/*
+ * Copyright 2016 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.cassandra.config.java;
+
+import static org.hamcrest.MatcherAssert.*;
+import static org.hamcrest.Matchers.*;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.junit.Test;
+import org.springframework.cassandra.config.CassandraCqlClusterFactoryBean;
+import org.springframework.cassandra.config.CompressionType;
+import org.springframework.cassandra.core.keyspace.CreateKeyspaceSpecification;
+import org.springframework.cassandra.core.keyspace.DropKeyspaceSpecification;
+import org.springframework.test.util.ReflectionTestUtils;
+
+import com.datastax.driver.core.AuthProvider;
+import com.datastax.driver.core.Cluster;
+import com.datastax.driver.core.Configuration;
+import com.datastax.driver.core.PlainTextAuthProvider;
+import com.datastax.driver.core.PoolingOptions;
+import com.datastax.driver.core.ProtocolOptions.Compression;
+import com.datastax.driver.core.ProtocolVersion;
+import com.datastax.driver.core.QueryOptions;
+import com.datastax.driver.core.SocketOptions;
+import com.datastax.driver.core.policies.ExponentialReconnectionPolicy;
+import com.datastax.driver.core.policies.LoadBalancingPolicy;
+import com.datastax.driver.core.policies.ReconnectionPolicy;
+import com.datastax.driver.core.policies.RoundRobinPolicy;
+
+/**
+ * Unit tests for {@link AbstractClusterConfiguration}.
+ *
+ * @author Mark Paluch
+ * @soundtrack Max Graham Feat Neev Kennedy - So Caught Up (Dns Project Remix)
+ * @see DATACASS-226
+ */
+public class AbstractClusterConfigurationUnitTests {
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldInitializeWithoutAnyOptions() throws Exception {
+
+		CassandraCqlClusterFactoryBean bean = new CassandraCqlClusterFactoryBean();
+		bean.afterPropertiesSet();
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(cluster, is(not(nullValue())));
+		assertThat(cluster.isClosed(), is(false));
+		assertThat(getConfiguration(cluster).getMetricsOptions(), is(not(nullValue())));
+		assertThat(getConfiguration(cluster).getMetricsOptions().isJMXReportingEnabled(), is(true));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetCompressionType() throws Exception {
+
+		final CompressionType compressionType = CompressionType.SNAPPY;
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected CompressionType getCompressionType() {
+				return compressionType;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getProtocolOptions().getCompression(), is(Compression.SNAPPY));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetPoolingOptions() throws Exception {
+
+		final PoolingOptions poolingOptions = new PoolingOptions();
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected PoolingOptions getPoolingOptions() {
+				return poolingOptions;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getPoolingOptions(), is(poolingOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetSocketOptions() throws Exception {
+
+		final SocketOptions socketOptions = new SocketOptions();
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected SocketOptions getSocketOptions() {
+				return socketOptions;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getSocketOptions(), is(socketOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetQueryOptions() throws Exception {
+
+		final QueryOptions queryOptions = new QueryOptions();
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected QueryOptions getQueryOptions() {
+				return queryOptions;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getQueryOptions(), is(queryOptions));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetAuthProvider() throws Exception {
+
+		final AuthProvider authProvider = new PlainTextAuthProvider("x", "y");
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected AuthProvider getAuthProvider() {
+				return authProvider;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getProtocolOptions().getAuthProvider(), is(authProvider));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetLoadBalancingPolicy() throws Exception {
+
+		final LoadBalancingPolicy loadBalancingPolicy = new RoundRobinPolicy();
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected LoadBalancingPolicy getLoadBalancingPolicy() {
+				return loadBalancingPolicy;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getPolicies().getLoadBalancingPolicy(), is(loadBalancingPolicy));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetReconnectionPolicy() throws Exception {
+
+		final ReconnectionPolicy reconnectionPolicy = new ExponentialReconnectionPolicy(1, 2);
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected ReconnectionPolicy getReconnectionPolicy() {
+				return reconnectionPolicy;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getPolicies().getReconnectionPolicy(), is(reconnectionPolicy));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetProtocolVersion() throws Exception {
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected ProtocolVersion getProtocolVersion() {
+				return ProtocolVersion.V2;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(ReflectionTestUtils.getField(getConfiguration(cluster).getProtocolOptions(), "initialProtocolVersion"),
+				is((Object) ProtocolVersion.V2));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldDisableMetrics() throws Exception {
+
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected boolean getMetricsEnabled() {
+				return false;
+			}
+		};
+
+		Cluster cluster = getCluster(clusterConfiguration);
+		assertThat(getConfiguration(cluster).getMetricsOptions(), is(nullValue()));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetKeyspaceCreations() throws Exception {
+
+		final List<CreateKeyspaceSpecification> specification = Collections
+				.singletonList(CreateKeyspaceSpecification.createKeyspace());
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected List<CreateKeyspaceSpecification> getKeyspaceCreations() {
+				return specification;
+			}
+		};
+
+		assertThat(clusterConfiguration.cluster().getKeyspaceCreations(), is(equalTo(specification)));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetKeyspaceDrops() throws Exception {
+
+		final List<DropKeyspaceSpecification> specification = Collections
+				.singletonList(DropKeyspaceSpecification.dropKeyspace());
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected List<DropKeyspaceSpecification> getKeyspaceDrops() {
+				return specification;
+			}
+		};
+
+		assertThat(clusterConfiguration.cluster().getKeyspaceDrops(), is(equalTo(specification)));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetStartupScripts() throws Exception {
+
+		final List<String> scripts = Collections.singletonList("USE BLUE_METH; CREATE TABLE...");
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected List<String> getStartupScripts() {
+				return scripts;
+			}
+		};
+
+		assertThat(clusterConfiguration.cluster().getStartupScripts(), is(equalTo(scripts)));
+	}
+
+	/**
+	 * @see DATACASS-226
+	 * @throws Exception
+	 */
+	@Test
+	public void shouldSetShutdownScripts() throws Exception {
+
+		final List<String> scripts = Collections.singletonList("USE BLUE_METH; DROP TABLE...");
+		AbstractClusterConfiguration clusterConfiguration = new AbstractClusterConfiguration() {
+			@Override
+			protected List<String> getShutdownScripts() {
+				return scripts;
+			}
+		};
+
+		assertThat(clusterConfiguration.cluster().getShutdownScripts(), is(equalTo(scripts)));
+	}
+
+	private Configuration getConfiguration(Cluster cluster) throws Exception {
+		return cluster.getConfiguration();
+	}
+
+	private Cluster getCluster(AbstractClusterConfiguration clusterConfiguration) throws Exception {
+
+		CassandraCqlClusterFactoryBean cluster = clusterConfiguration.cluster();
+		cluster.afterPropertiesSet();
+		return cluster.getObject();
+	}
+}