DATAREDIS-348 - Polishing.

Fixed connection problems leaving sockets open. Added missing JUnit rules for Sentinels. Added missing author information update, license header and Javadoc.

Upgraded test script to use Redis 3.0.2. Upgrade test script to shut down Redis in case of test errors. Added Redis 3.0 to TestProfileValueSource. Enabled ZRANGEBYLEX tests for lettuce.

Original pull request: #144.
Related pull request: #104.

Author: christophstrobl

Makefile

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-REDIS_VERSION:=2.8.19
+REDIS_VERSION:=3.0.2
 
 #######
 # Redis
@@ -95,5 +95,5 @@ stop: redis-stop sentinel-stop
 test:
 	$(MAKE) start
 	sleep 2
-	$(PWD)/gradlew clean build -DrunLongTests=true -S
+	-$(PWD)/gradlew clean build -DrunLongTests=true -S
 	$(MAKE) stop

src/asciidoc/reference/redis.adoc

@@ -169,12 +169,25 @@ NOTE: Please note that currently only http://github.com/xetorthio/jedis[Jedis] a
 
 [source,java]
 ----
+/**
+ * jedis
+ */
 @Bean 
 public RedisConnectionFactory jedisConnectionFactory() {
   RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration() .master("mymaster")
   .sentinel("127.0.0.1", 26379) .sentinel("127.0.0.1", 26380);
   return new JedisConnectionFactory(sentinelConfig);
 } 
+
+/**
+ * lettuce
+ */
+@Bean
+public RedisConnectionFactory lettuceConnectionFactory() {
+  RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration().master("mymaster")
+  .sentinel("127.0.0.1", 26379) .sentinel("127.0.0.1", 26380);
+  return new LettuceConnectionFactory(sentinelConfig);
+}
 ----
 
 [TIP]
@@ -185,16 +198,6 @@ public RedisConnectionFactory jedisConnectionFactory() {
 - `spring.redis.sentinel.master`: name of the master node.
 - `spring.redis.sentinel.nodes`: Comma delimited list of host:port pairs.
 ====
-=======
-[source,java]
-----
-@Bean
-public RedisConnectionFactory lettuceConnectionFactory() {
-  RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration() .master("mymaster")
-  .sentinel("127.0.0.1", 26379) .sentinel("127.0.0.1", 26380);
-  return new LettuceConnectionFactory(sentinelConfig);
-}
-----
 
 Sometimes direct interaction with the one of the Sentinels is required. Using `RedisConnectionFactory.getSentinelConnection()` or `RedisConnection.getSentinelCommands()` gives you access to the first active Sentinel configured.
 

src/main/java/org/springframework/data/redis/connection/lettuce/AuthenticatingRedisClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013 the original author or authors.
+ * Copyright 2013-2015 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.
@@ -18,14 +18,17 @@
 import com.lambdaworks.redis.RedisAsyncConnection;
 import com.lambdaworks.redis.RedisClient;
 import com.lambdaworks.redis.RedisConnection;
+import com.lambdaworks.redis.RedisURI;
 import com.lambdaworks.redis.codec.RedisCodec;
 import com.lambdaworks.redis.pubsub.RedisPubSubConnection;
 
 /**
  * Extension of {@link RedisClient} that calls auth on all new connections using the supplied credentials
  * 
  * @author Jennifer Hickey
- * @deprecated Use password in RedisURI
+ * @author Mar Paluch
+ * @author Christoph Strobl
+ * @deprecated since 1.6 - Please use {@link RedisURI#setPassword(String)}
  */
 @Deprecated
 public class AuthenticatingRedisClient extends RedisClient {

src/main/java/org/springframework/data/redis/connection/lettuce/DefaultLettucePool.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2014 the original author or authors.
+ * Copyright 2013-2015 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.
@@ -17,7 +17,6 @@
 
 import java.util.concurrent.TimeUnit;
 
-import com.lambdaworks.redis.RedisURI;
 import org.apache.commons.pool2.BasePooledObjectFactory;
 import org.apache.commons.pool2.PooledObject;
 import org.apache.commons.pool2.impl.DefaultPooledObject;
@@ -30,6 +29,7 @@
 
 import com.lambdaworks.redis.RedisAsyncConnection;
 import com.lambdaworks.redis.RedisClient;
+import com.lambdaworks.redis.RedisURI;
 
 /**
  * Default implementation of {@link LettucePool}.
@@ -72,6 +72,7 @@ public DefaultLettucePool(String hostName, int port) {
 	 * based on sentinels.
 	 *
 	 * @param sentinelConfiguration The Sentinel configuration
+	 * @since 1.6
 	 */
 	public DefaultLettucePool(RedisSentinelConfiguration sentinelConfiguration) {
 		this.sentinelConfiguration = sentinelConfiguration;
@@ -92,7 +93,7 @@ public DefaultLettucePool(String hostName, int port, GenericObjectPoolConfig poo
 
 	/**
 	 * @return true when {@link RedisSentinelConfiguration} is present.
-	 * @since 1.5
+	 * @since 1.6
 	 */
 	public boolean isRedisSentinelAware() {
 		return sentinelConfiguration != null;
@@ -106,12 +107,11 @@ public void afterPropertiesSet() {
 	}
 
 	/**
-	 *
 	 * @return a RedisURI pointing either to a single Redis host or containing a set of sentinels.
 	 */
 	private RedisURI getRedisURI() {
 
-		if(isRedisSentinelAware()) {
+		if (isRedisSentinelAware()) {
 			return LettuceConverters.sentinelConfigurationToRedisURI(sentinelConfiguration);
 		}
 
@@ -120,7 +120,7 @@ private RedisURI getRedisURI() {
 
 	private RedisURI createSimpleHostRedisURI() {
 		RedisURI.Builder builder = RedisURI.Builder.redis(hostName, port);
-		if(password != null) {
+		if (password != null) {
 			builder.withPassword(password);
 		}
 		builder.withTimeout(timeout, TimeUnit.MILLISECONDS);
@@ -162,7 +162,6 @@ public void destroy() {
 	}
 
 	/**
-	 *
 	 * @return The Redis client
 	 */
 	public RedisClient getClient() {

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnection.java

@@ -3568,6 +3568,10 @@ private RedisURI getRedisURI(RedisNode node) {
 		return RedisURI.Builder.redis(node.getHost(), node.getPort()).build();
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.redis.connection.AbstractRedisConnection#getSentinelConnection(org.springframework.data.redis.connection.RedisNode)
+	 */
 	@Override
 	protected RedisSentinelConnection getSentinelConnection(RedisNode sentinel) {
 		RedisSentinelAsyncConnection<String, String> connection = client.connectSentinelAsync(getRedisURI(sentinel));

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConnectionFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011-2015 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.
@@ -18,9 +18,6 @@
 
 import java.util.concurrent.TimeUnit;
 
-import com.lambdaworks.redis.LettuceFutures;
-import com.lambdaworks.redis.RedisFuture;
-import com.lambdaworks.redis.RedisURI;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.springframework.beans.factory.DisposableBean;
@@ -36,9 +33,12 @@
 import org.springframework.data.redis.connection.RedisSentinelConnection;
 import org.springframework.util.Assert;
 
+import com.lambdaworks.redis.LettuceFutures;
 import com.lambdaworks.redis.RedisAsyncConnection;
 import com.lambdaworks.redis.RedisClient;
 import com.lambdaworks.redis.RedisException;
+import com.lambdaworks.redis.RedisFuture;
+import com.lambdaworks.redis.RedisURI;
 
 /**
  * Connection factory creating <a href="http://github.com/mp911de/lettuce">Lettuce</a>-based connections.
@@ -55,6 +55,7 @@
  * @author Costin Leau
  * @author Jennifer Hickey
  * @author Thomas Darimont
+ * @author Mark Paluch
  */
 public class LettuceConnectionFactory implements InitializingBean, DisposableBean, RedisConnectionFactory {
 
@@ -98,7 +99,7 @@ public LettuceConnectionFactory(String host, int port) {
 	 * Constructs a new {@link LettuceConnectionFactory} instance using the given {@link RedisSentinelConfiguration}
 	 *
 	 * @param sentinelConfiguration
-	 * @since 1.5
+	 * @since 1.6
 	 */
 	public LettuceConnectionFactory(RedisSentinelConfiguration sentinelConfiguration) {
 		this.sentinelConfiguration = sentinelConfiguration;
@@ -156,11 +157,11 @@ public void validateConnection() {
 				try {
 					RedisFuture<String> ping = connection.ping();
 					LettuceFutures.awaitAll(timeout, TimeUnit.MILLISECONDS, ping);
-					if(PING_REPLY.equalsIgnoreCase(ping.get())) {
+					if (PING_REPLY.equalsIgnoreCase(ping.get())) {
 						valid = true;
 					}
 				} catch (Exception e) {
-				   log.debug("Validation failed", e);
+					log.debug("Validation failed", e);
 				}
 			}
 
@@ -313,15 +314,19 @@ public void setPassword(String password) {
 
 	/**
 	 * Returns the shutdown timeout for shutting down the RedisClient (in milliseconds).
+	 * 
 	 * @return shutdown timeout
+	 * @since 1.6
 	 */
 	public long getShutdownTimeout() {
 		return shutdownTimeout;
 	}
 
 	/**
 	 * Sets the shutdown timeout for shutting down the RedisClient (in milliseconds).
+	 * 
 	 * @param shutdownTimeout the shutdown timeout
+	 * @since 1.6
 	 */
 	public void setShutdownTimeout(long shutdownTimeout) {
 		this.shutdownTimeout = shutdownTimeout;
@@ -379,7 +384,7 @@ protected RedisAsyncConnection<byte[], byte[]> createLettuceConnector() {
 
 	private RedisClient createRedisClient() {
 
-		if(isRedisSentinelAware()) {
+		if (isRedisSentinelAware()) {
 			RedisURI redisURI = getSentinelRedisURI();
 			return new RedisClient(redisURI);
 		}
@@ -389,7 +394,7 @@ private RedisClient createRedisClient() {
 		}
 
 		RedisURI.Builder builder = RedisURI.Builder.redis(hostName, port);
-		if(password != null) {
+		if (password != null) {
 			builder.withPassword(password);
 		}
 		builder.withTimeout(timeout, TimeUnit.MILLISECONDS);

src/main/java/org/springframework/data/redis/connection/lettuce/LettuceConverters.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2014 the original author or authors.
+ * Copyright 2013-2015 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.

src/test/java/org/springframework/data/redis/RedisTestProfileValueSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011-2015 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.
@@ -15,10 +15,13 @@
  */
 package org.springframework.data.redis;
 
-import org.springframework.data.redis.connection.RedisConnection;
-import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
+import java.io.IOException;
+
+import org.springframework.data.redis.connection.jedis.JedisConverters;
 import org.springframework.test.annotation.ProfileValueSource;
 
+import redis.clients.jedis.Jedis;
+
 /**
  * Implementation of {@link ProfileValueSource} that handles profile value name "redisVersion" by checking the current
  * version of Redis. 2.4.x will be returned as "2.4" and 2.6.x will be returned as "2.6". Any other version found will
@@ -34,6 +37,7 @@ public class RedisTestProfileValueSource implements ProfileValueSource {
 	private static final String REDIS_24 = "2.4";
 	private static final String REDIS_26 = "2.6";
 	private static final String REDIS_28 = "2.8";
+	private static final String REDIS_30 = "3.0";
 	private static final String REDIS_VERSION_KEY = "redisVersion";
 
 	private static RedisTestProfileValueSource INSTANCE;
@@ -46,22 +50,35 @@ public class RedisTestProfileValueSource implements ProfileValueSource {
 
 	private static Version tryDetectRedisVersionOrReturn(Version fallbackVersion) {
 
-		try {
-			JedisConnectionFactory factory = new JedisConnectionFactory();
-			factory.afterPropertiesSet();
+		Version version = fallbackVersion;
 
-			RedisConnection connection = factory.getConnection();
-			Version redisVersion = RedisVersionUtils.getRedisVersion(connection);
+		Jedis jedis = new Jedis(SettingsUtils.getHost(), SettingsUtils.getPort(), 100);
+		try {
 
-			connection.close();
-			factory.destroy();
+			jedis.connect();
+			String info = jedis.info();
+			String versionString = (String) JedisConverters.stringToProps().convert(info).get("redis_version");
+
+			version = RedisVersionUtils.parseVersion(versionString);
+		} finally {
+
+			try {
+				// force socket to be closed
+				jedis.getClient().quit();
+				jedis.getClient().getSocket().close();
+				try {
+					// need to wait a bit
+					Thread.sleep(100);
+				} catch (InterruptedException e) {
+					// just ignore it
+				}
+			} catch (IOException e1) {
+				// ignore as well
+			}
+			jedis.close();
 
-			return redisVersion;
-		} catch (Exception ex) {
-			System.err.println("Couldn't detect redis version!");
 		}
-
-		return fallbackVersion;
+		return version;
 	}
 
 	public RedisTestProfileValueSource() {
@@ -74,6 +91,10 @@ public String get(String key) {
 			return System.getProperty(key);
 		}
 
+		if (redisVersion.compareTo(RedisVersionUtils.parseVersion(REDIS_30)) >= 0) {
+			return REDIS_30;
+		}
+
 		if (redisVersion.compareTo(RedisVersionUtils.parseVersion(REDIS_28)) >= 0) {
 			return REDIS_28;
 		}

src/test/java/org/springframework/data/redis/SettingsUtils.java

@@ -25,7 +25,7 @@ public abstract class SettingsUtils {
 	private static final Properties SETTINGS;
 
 	static {
-		DEFAULTS.put("host", "localhost");
+		DEFAULTS.put("host", "127.0.0.1");
 		DEFAULTS.put("port", "6379");
 
 		SETTINGS = new Properties(DEFAULTS);