DATAREDIS-324 - Add Redis Sentinel support.

We’ve added RedisSentinelConfiguration holding required information for connecting to redis sentinels. This can be used to set up ConnectionFeactory for HA environments. **Using Jedis** Providing RedisSentinelConfiguration will force the JedisConnectionFactory to use JedisSentinelPool for managing resources. **Using Lettuce/JRedis/SRP** There’s currently no support for sentinel in those clients. **CI Build** We’ve added makefile to build and set up redis instances for testing sentinel support on travis-ci. There’s already a section for redis cluster. The cluster section is for whatever reason currently not working as the cluster nodes won’t start. This will be fixed when we add redis-cluster support. _side note:_ there’s an alternative fork of lettuce at mp911de/lettuce that already has sentinel support.

Author: christophstrobl

.gitignore

@@ -14,3 +14,5 @@ pom.xml
 .settings
 .idea
 out
+work
+*.rdb

.travis.yml

@@ -3,6 +3,4 @@ jdk:
  - oraclejdk7
  - openjdk6
  - oraclejdk8
-services:
- - redis-server
-script: "gradle clean build -DrunLongTests=true"
+script: make test

Makefile

@@ -0,0 +1,99 @@
+# Copyright 2011-2014 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.
+
+REDIS_VERSION:=2.8.13
+
+#######
+# Redis
+#######
+.PRECIOUS: work/redis-%.conf
+
+work/redis-%.conf:
+@mkdir -p $(@D)
+
+echo port $* >> $@
+echo daemonize yes >> $@
+echo pidfile $(shell pwd)/work/redis-$*.pid >> $@
+echo logfile $(shell pwd)/work/redis-$*.log >> $@
+echo save \"\" >> $@
+echo slaveof 127.0.0.1 6379 >> $@
+
+# Handled separately because it's the master and all others are slaves
+work/redis-6379.conf:
+@mkdir -p $(@D)
+
+echo port 6379 >> $@
+echo daemonize yes >> $@
+echo pidfile $(shell pwd)/work/redis-6379.pid >> $@
+echo logfile $(shell pwd)/work/redis-6379.log >> $@
+echo save \"\" >> $@
+
+work/redis-%.pid: work/redis-%.conf work/redis/bin/redis-server
+work/redis/bin/redis-server $<
+
+redis-start: work/redis-6379.pid work/redis-6380.pid work/redis-6381.pid
+
+redis-stop: stop-6379 stop-6380 stop-6381
+
+##########
+# Sentinel
+##########
+.PRECIOUS: work/sentinel-%.conf
+
+work/sentinel-%.conf:
+@mkdir -p $(@D)
+
+echo port $* >> $@
+echo daemonize yes >> $@
+echo pidfile $(shell pwd)/work/sentinel-$*.pid >> $@
+echo logfile $(shell pwd)/work/sentinel-$*.log >> $@
+echo save \"\" >> $@
+echo sentinel monitor mymaster 127.0.0.1 6379 2 >> $@
+
+work/sentinel-%.pid: work/sentinel-%.conf work/redis-6379.pid work/redis/bin/redis-server
+work/redis/bin/redis-server $< --sentinel
+
+sentinel-start: work/sentinel-26379.pid work/sentinel-26380.pid work/sentinel-26381.pid
+
+sentinel-stop: stop-26379 stop-26380 stop-26381
+
+########
+# Global
+########
+clean:
+rm -rf work/*.conf work/*.log
+
+clobber:
+rm -rf work
+
+work/redis/bin/redis-cli work/redis/bin/redis-server:
+@mkdir -p work/redis
+
+curl -sSL https://github.com/antirez/redis/archive/$(REDIS_VERSION).tar.gz | tar xzf - -C work
+$(MAKE) -C work/redis-$(REDIS_VERSION) -j
+$(MAKE) -C work/redis-$(REDIS_VERSION) PREFIX=$(shell pwd)/work/redis install
+rm -rf work/redis-$(REDIS_VERSION)
+
+start: redis-start sentinel-start
+
+stop-%: work/redis/bin/redis-cli
+-work/redis/bin/redis-cli -p $* shutdown
+
+stop: redis-stop sentinel-stop
+
+test:
+$(MAKE) start
+sleep 2
+$(PWD)/gradlew clean build -DrunLongTests=true
+$(MAKE) stop

docs/src/reference/docbook/reference/redis.xml

@@ -209,6 +209,21 @@
 
  </section>
 
+ <section id="redis:sentinel">
+ <title>Redis Sentinel Support</title>
+ <para>For dealing with high available Redis there is support for <ulink url="http://redis.io/topics/sentinel">Redis Sentinel</ulink> using <classname>RedisSentinelConfiguration</classname>.</para>
+ <note>Please note that currently only <ulink url="http://github.com/xetorthio/jedis">Jedis</ulink> supports Redis Sentinel.</note> 
+ <programlisting language="java"><![CDATA[@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);
+} 
+ ]]></programlisting>
+ </section>
+ 
  <section id="redis:template">
  <title>Working with Objects through <classname>RedisTemplate</classname></title>
 

src/main/java/org/springframework/data/redis/connection/NamedNode.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2014 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.data.redis.connection;
+
+/**
+ * @author Christoph Strobl
+ * @since 1.4
+ */
+public interface NamedNode {
+
+String getName();
+}

src/main/java/org/springframework/data/redis/connection/RedisNode.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2014 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.data.redis.connection;
+
+import org.springframework.util.ObjectUtils;
+
+/**
+ * @author Christoph Strobl
+ * @since 1.4
+ */
+public class RedisNode {
+
+private final String host;
+private final int port;
+
+public RedisNode(String host, int port) {
+this.host = host;
+this.port = port;
+}
+
+public String getHost() {
+return host;
+}
+
+public Integer getPort() {
+return port;
+}
+
+public String asString() {
+return host + ":" + port;
+}
+
+@Override
+public String toString() {
+return asString();
+}
+
+@Override
+public int hashCode() {
+final int prime = 31;
+int result = 1;
+result = prime * result + ObjectUtils.nullSafeHashCode(host);
+result = prime * result + ObjectUtils.nullSafeHashCode(port);
+return result;
+}
+
+@Override
+public boolean equals(Object obj) {
+
+if (this == obj) {
+return true;
+}
+if (obj == null || !(obj instanceof RedisNode)) {
+return false;
+}
+
+RedisNode other = (RedisNode) obj;
+
+if (!ObjectUtils.nullSafeEquals(this.host, other.host)) {
+return false;
+}
+
+if (!ObjectUtils.nullSafeEquals(this.port, other.port)) {
+return false;
+}
+
+return true;
+}
+
+}