DATAREDIS-574 - Polishing.

Updated reference Documentation, JavaDoc and add some minor code changes (rename methods, fix return types, diamond  operators,…).

Original Pull Request: #236
This commit is contained in:
Christoph Strobl
2017-06-06 16:17:51 +02:00
parent 3819ded01c
commit 5f9cb22ad5
18 changed files with 294 additions and 315 deletions

View File

@@ -23,6 +23,7 @@ import org.junit.Test;
* Unit tests for {@link RedisPassword}.
*
* @author Mark Paluch
* @author Christoph Strobl
*/
public class RedisPasswordUnitTests {
@@ -48,6 +49,6 @@ public class RedisPasswordUnitTests {
@Test // DATAREDIS-574
public void toStringShouldHideValue() {
assertThat(RedisPassword.of("foo".toCharArray()).toString()).startsWith("RedisPassword[***");
assertThat(RedisPassword.of("foo".toCharArray()).toString()).startsWith("RedisPassword[**").doesNotContain("foo");
}
}

View File

@@ -40,7 +40,7 @@ public class JedisClientConfigurationUnitTests {
@Test // DATAREDIS-574
public void shouldCreateEmptyConfiguration() {
JedisClientConfiguration configuration = JedisClientConfiguration.create();
JedisClientConfiguration configuration = JedisClientConfiguration.defaultConfiguration();
assertThat(configuration.getClientName()).isEmpty();
assertThat(configuration.getConnectTimeout()).isEqualTo(Duration.ofSeconds(2));
@@ -69,7 +69,7 @@ public class JedisClientConfigurationUnitTests {
.usePooling().poolConfig(poolConfig) //
.build();
assertThat(configuration.useSsl()).isTrue();
assertThat(configuration.isUseSsl()).isTrue();
assertThat(configuration.getHostnameVerifier()).contains(MyHostnameVerifier.INSTANCE);
assertThat(configuration.getSslParameters()).contains(sslParameters);
assertThat(configuration.getSslSocketFactory()).contains(socketFactory);
@@ -81,18 +81,6 @@ public class JedisClientConfigurationUnitTests {
assertThat(configuration.getPoolConfig()).contains(poolConfig);
}
@Test // DATAREDIS-574
public void shouldAllowsConfigurationOverrides() {
JedisClientConfiguration configuration = JedisClientConfiguration.builder().useSsl() //
.and().usePlaintext() //
.usePooling().and().useUnpooledConnections() //
.build();
assertThat(configuration.useSsl()).isFalse();
assertThat(configuration.usePooling()).isFalse();
}
enum MyHostnameVerifier implements HostnameVerifier {
INSTANCE;

View File

@@ -60,7 +60,7 @@ public class JedisConnectionFactoryIntegrationTests {
factory = new JedisConnectionFactory(
new RedisStandaloneConfiguration(SettingsUtils.getHost(), SettingsUtils.getPort()),
JedisClientConfiguration.create());
JedisClientConfiguration.defaultConfiguration());
factory.afterPropertiesSet();
assertThat(factory.getConnection().ping(), equalTo("PONG"));

View File

@@ -104,7 +104,7 @@ public class JedisConnectionFactoryUnitTests {
RedisStandaloneConfiguration envConfig = new RedisStandaloneConfiguration();
envConfig.setPassword(RedisPassword.of("foo"));
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getPassword()).isEqualTo("foo");
}
@@ -115,7 +115,7 @@ public class JedisConnectionFactoryUnitTests {
RedisStandaloneConfiguration envConfig = new RedisStandaloneConfiguration();
envConfig.setPassword(RedisPassword.of("foo"));
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
connectionFactory.setPassword("bar");
assertThat(connectionFactory.getPassword()).isEqualTo("bar");
@@ -128,7 +128,7 @@ public class JedisConnectionFactoryUnitTests {
RedisSentinelConfiguration envConfig = new RedisSentinelConfiguration();
envConfig.setPassword(RedisPassword.of("foo"));
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getPassword()).isEqualTo("foo");
}
@@ -139,7 +139,7 @@ public class JedisConnectionFactoryUnitTests {
RedisSentinelConfiguration envConfig = new RedisSentinelConfiguration();
envConfig.setPassword(RedisPassword.of("foo"));
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
connectionFactory.setPassword("bar");
assertThat(connectionFactory.getPassword()).isEqualTo("bar");
@@ -152,7 +152,7 @@ public class JedisConnectionFactoryUnitTests {
RedisClusterConfiguration envConfig = new RedisClusterConfiguration();
envConfig.setPassword(RedisPassword.of("foo"));
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getPassword()).isEqualTo("foo");
}
@@ -163,7 +163,7 @@ public class JedisConnectionFactoryUnitTests {
RedisClusterConfiguration envConfig = new RedisClusterConfiguration();
envConfig.setPassword(RedisPassword.of("foo"));
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
connectionFactory.setPassword("bar");
assertThat(connectionFactory.getPassword()).isEqualTo("bar");
@@ -176,7 +176,7 @@ public class JedisConnectionFactoryUnitTests {
RedisStandaloneConfiguration envConfig = new RedisStandaloneConfiguration();
envConfig.setDatabase(2);
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getDatabase()).isEqualTo(2);
}
@@ -187,7 +187,7 @@ public class JedisConnectionFactoryUnitTests {
RedisStandaloneConfiguration envConfig = new RedisStandaloneConfiguration();
envConfig.setDatabase(2);
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
connectionFactory.setDatabase(3);
assertThat(connectionFactory.getDatabase()).isEqualTo(3);
@@ -200,7 +200,7 @@ public class JedisConnectionFactoryUnitTests {
RedisSentinelConfiguration envConfig = new RedisSentinelConfiguration();
envConfig.setDatabase(2);
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getDatabase()).isEqualTo(2);
}
@@ -211,7 +211,7 @@ public class JedisConnectionFactoryUnitTests {
RedisSentinelConfiguration envConfig = new RedisSentinelConfiguration();
envConfig.setDatabase(2);
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(envConfig, JedisClientConfiguration.defaultConfiguration());
connectionFactory.setDatabase(3);
assertThat(connectionFactory.getDatabase()).isEqualTo(3);
@@ -250,7 +250,7 @@ public class JedisConnectionFactoryUnitTests {
public void shouldReturnStandaloneConfiguration() {
RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration();
connectionFactory = new JedisConnectionFactory(configuration, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(configuration, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getStandaloneConfiguration()).isSameAs(configuration);
assertThat(connectionFactory.getSentinelConfiguration()).isNull();
@@ -261,7 +261,7 @@ public class JedisConnectionFactoryUnitTests {
public void shouldReturnSentinelConfiguration() {
RedisSentinelConfiguration configuration = new RedisSentinelConfiguration();
connectionFactory = new JedisConnectionFactory(configuration, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(configuration, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getStandaloneConfiguration()).isNotNull();
assertThat(connectionFactory.getSentinelConfiguration()).isSameAs(configuration);
@@ -272,7 +272,7 @@ public class JedisConnectionFactoryUnitTests {
public void shouldReturnClusterConfiguration() {
RedisClusterConfiguration configuration = new RedisClusterConfiguration();
connectionFactory = new JedisConnectionFactory(configuration, JedisClientConfiguration.create());
connectionFactory = new JedisConnectionFactory(configuration, JedisClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getStandaloneConfiguration()).isNotNull();
assertThat(connectionFactory.getSentinelConfiguration()).isNull();
@@ -283,7 +283,7 @@ public class JedisConnectionFactoryUnitTests {
public void shouldDenyChangesToImmutableClientConfiguration() throws NoSuchAlgorithmException {
connectionFactory = new JedisConnectionFactory(new RedisStandaloneConfiguration(),
JedisClientConfiguration.create());
JedisClientConfiguration.defaultConfiguration());
connectionFactory.setClientName("foo");
}

View File

@@ -34,14 +34,14 @@ public class LettuceClientConfigurationUnitTests {
@Test // DATAREDIS-574
public void shouldCreateEmptyConfiguration() {
LettuceClientConfiguration configuration = LettuceClientConfiguration.create();
LettuceClientConfiguration configuration = LettuceClientConfiguration.defaultConfiguration();
assertThat(configuration.useSsl()).isFalse();
assertThat(configuration.isUseSsl()).isFalse();
assertThat(configuration.isVerifyPeer()).isTrue();
assertThat(configuration.isStartTls()).isFalse();
assertThat(configuration.getClientOptions()).isEmpty();
assertThat(configuration.getClientResources()).isEmpty();
assertThat(configuration.getTimeout()).isEqualTo(Duration.ofSeconds(60));
assertThat(configuration.getCommandTimeout()).isEqualTo(Duration.ofSeconds(60));
assertThat(configuration.getShutdownTimeout()).isEqualTo(Duration.ofSeconds(2));
}
@@ -53,30 +53,20 @@ public class LettuceClientConfigurationUnitTests {
LettuceClientConfiguration configuration = LettuceClientConfiguration.builder() //
.useSsl() //
.verifyPeer(false) //
.disablePeerVerification() //
.startTls().and() //
.clientOptions(clientOptions) //
.clientResources(sharedClientResources) //
.timeout(Duration.ofMinutes(5)) //
.commandTimeout(Duration.ofMinutes(5)) //
.shutdownTimeout(Duration.ofHours(2)) //
.build();
assertThat(configuration.useSsl()).isTrue();
assertThat(configuration.isUseSsl()).isTrue();
assertThat(configuration.isVerifyPeer()).isFalse();
assertThat(configuration.isStartTls()).isTrue();
assertThat(configuration.getClientOptions()).contains(clientOptions);
assertThat(configuration.getClientResources()).contains(sharedClientResources);
assertThat(configuration.getTimeout()).isEqualTo(Duration.ofMinutes(5));
assertThat(configuration.getCommandTimeout()).isEqualTo(Duration.ofMinutes(5));
assertThat(configuration.getShutdownTimeout()).isEqualTo(Duration.ofHours(2));
}
@Test // DATAREDIS-574
public void shouldAllowsConfigurationOverrides() {
LettuceClientConfiguration configuration = LettuceClientConfiguration.builder() //
.useSsl().and().usePlaintext() //
.build();
assertThat(configuration.useSsl()).isFalse();
}
}

View File

@@ -292,7 +292,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setPassword(RedisPassword.of("foo"));
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getPassword(), is(equalTo("foo")));
}
@@ -304,7 +304,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setPassword(RedisPassword.of("foo"));
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
connectionFactory.setPassword("bar");
assertThat(connectionFactory.getPassword(), is(equalTo("bar")));
@@ -318,7 +318,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setPassword(RedisPassword.of("foo"));
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getPassword(), is(equalTo("foo")));
}
@@ -330,7 +330,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setPassword(RedisPassword.of("foo"));
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
connectionFactory.setPassword("bar");
assertThat(connectionFactory.getPassword(), is(equalTo("bar")));
@@ -344,7 +344,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setPassword(RedisPassword.of("foo"));
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getPassword(), is(equalTo("foo")));
}
@@ -356,7 +356,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setPassword(RedisPassword.of("foo"));
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
connectionFactory.setPassword("bar");
assertThat(connectionFactory.getPassword(), is(equalTo("bar")));
@@ -370,7 +370,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setDatabase(2);
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getDatabase(), is(2));
}
@@ -382,7 +382,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setDatabase(2);
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
connectionFactory.setDatabase(3);
assertThat(connectionFactory.getDatabase(), is(3));
@@ -396,7 +396,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setDatabase(2);
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getDatabase(), is(2));
}
@@ -408,7 +408,7 @@ public class LettuceConnectionFactoryUnitTests {
envConfig.setDatabase(2);
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(envConfig,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
connectionFactory.setDatabase(3);
assertThat(connectionFactory.getDatabase(), is(3));
@@ -423,11 +423,11 @@ public class LettuceConnectionFactoryUnitTests {
LettuceClientConfiguration configuration = LettuceClientConfiguration.builder() //
.useSsl() //
.verifyPeer(false) //
.disablePeerVerification() //
.startTls().and() //
.clientOptions(clientOptions) //
.clientResources(sharedClientResources) //
.timeout(Duration.ofMinutes(5)) //
.commandTimeout(Duration.ofMinutes(5)) //
.shutdownTimeout(Duration.ofHours(2)) //
.build();
@@ -449,7 +449,7 @@ public class LettuceConnectionFactoryUnitTests {
RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration();
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(configuration,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getStandaloneConfiguration(), is(configuration));
assertThat(connectionFactory.getSentinelConfiguration(), is(nullValue()));
@@ -461,7 +461,7 @@ public class LettuceConnectionFactoryUnitTests {
RedisSentinelConfiguration configuration = new RedisSentinelConfiguration();
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(configuration,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getStandaloneConfiguration(), is(notNullValue()));
assertThat(connectionFactory.getSentinelConfiguration(), is(configuration));
@@ -473,7 +473,7 @@ public class LettuceConnectionFactoryUnitTests {
RedisClusterConfiguration configuration = new RedisClusterConfiguration();
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(configuration,
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
assertThat(connectionFactory.getStandaloneConfiguration(), is(notNullValue()));
assertThat(connectionFactory.getSentinelConfiguration(), is(nullValue()));
@@ -484,7 +484,7 @@ public class LettuceConnectionFactoryUnitTests {
public void shouldDenyChangesToImmutableClientConfiguration() throws NoSuchAlgorithmException {
LettuceConnectionFactory connectionFactory = new LettuceConnectionFactory(new RedisStandaloneConfiguration(),
LettuceClientConfiguration.create());
LettuceClientConfiguration.defaultConfiguration());
connectionFactory.setUseSsl(false);
}

View File

@@ -41,6 +41,7 @@ import org.springframework.oxm.xstream.XStreamMarshaller;
* @author Jennifer Hickey
* @author Thomas Darimont
* @author Christoph Strobl
* @author Mark Paluch
*/
abstract public class AbstractOperationsTestParams {
@@ -71,46 +72,46 @@ abstract public class AbstractOperationsTestParams {
stringTemplate.setConnectionFactory(jedisConnectionFactory);
stringTemplate.afterPropertiesSet();
RedisTemplate<String, Long> longTemplate = new RedisTemplate<String, Long>();
RedisTemplate<String, Long> longTemplate = new RedisTemplate<>();
longTemplate.setKeySerializer(new StringRedisSerializer());
longTemplate.setValueSerializer(new GenericToStringSerializer<Long>(Long.class));
longTemplate.setValueSerializer(new GenericToStringSerializer<>(Long.class));
longTemplate.setConnectionFactory(jedisConnectionFactory);
longTemplate.afterPropertiesSet();
RedisTemplate<String, Double> doubleTemplate = new RedisTemplate<String, Double>();
RedisTemplate<String, Double> doubleTemplate = new RedisTemplate<>();
doubleTemplate.setKeySerializer(new StringRedisSerializer());
doubleTemplate.setValueSerializer(new GenericToStringSerializer<Double>(Double.class));
doubleTemplate.setValueSerializer(new GenericToStringSerializer<>(Double.class));
doubleTemplate.setConnectionFactory(jedisConnectionFactory);
doubleTemplate.afterPropertiesSet();
RedisTemplate<byte[], byte[]> rawTemplate = new RedisTemplate<byte[], byte[]>();
RedisTemplate<byte[], byte[]> rawTemplate = new RedisTemplate<>();
rawTemplate.setEnableDefaultSerializer(false);
rawTemplate.setConnectionFactory(jedisConnectionFactory);
rawTemplate.afterPropertiesSet();
RedisTemplate<String, Person> personTemplate = new RedisTemplate<String, Person>();
RedisTemplate<String, Person> personTemplate = new RedisTemplate<>();
personTemplate.setConnectionFactory(jedisConnectionFactory);
personTemplate.afterPropertiesSet();
OxmSerializer serializer = new OxmSerializer(xstream, xstream);
RedisTemplate<String, String> xstreamStringTemplate = new RedisTemplate<String, String>();
RedisTemplate<String, String> xstreamStringTemplate = new RedisTemplate<>();
xstreamStringTemplate.setConnectionFactory(jedisConnectionFactory);
xstreamStringTemplate.setDefaultSerializer(serializer);
xstreamStringTemplate.afterPropertiesSet();
RedisTemplate<String, Person> xstreamPersonTemplate = new RedisTemplate<String, Person>();
RedisTemplate<String, Person> xstreamPersonTemplate = new RedisTemplate<>();
xstreamPersonTemplate.setConnectionFactory(jedisConnectionFactory);
xstreamPersonTemplate.setValueSerializer(serializer);
xstreamPersonTemplate.afterPropertiesSet();
Jackson2JsonRedisSerializer<Person> jackson2JsonSerializer = new Jackson2JsonRedisSerializer<Person>(Person.class);
RedisTemplate<String, Person> jackson2JsonPersonTemplate = new RedisTemplate<String, Person>();
RedisTemplate<String, Person> jackson2JsonPersonTemplate = new RedisTemplate<>();
jackson2JsonPersonTemplate.setConnectionFactory(jedisConnectionFactory);
jackson2JsonPersonTemplate.setValueSerializer(jackson2JsonSerializer);
jackson2JsonPersonTemplate.afterPropertiesSet();
GenericJackson2JsonRedisSerializer genericJackson2JsonSerializer = new GenericJackson2JsonRedisSerializer();
RedisTemplate<String, Person> genericJackson2JsonPersonTemplate = new RedisTemplate<String, Person>();
RedisTemplate<String, Person> genericJackson2JsonPersonTemplate = new RedisTemplate<>();
genericJackson2JsonPersonTemplate.setConnectionFactory(jedisConnectionFactory);
genericJackson2JsonPersonTemplate.setValueSerializer(genericJackson2JsonSerializer);
genericJackson2JsonPersonTemplate.afterPropertiesSet();