Cluster mode draft PR #2

ClusterRedisExample.py

@@ -0,0 +1,34 @@
+from redis import RedisCluster as Redis
+from redis.cluster import ClusterNode
+
+host = 'localhost'
+startup_nodes = [ClusterNode(host, 6378), ClusterNode(host, 6379)]
+
+# from_url examples
+rc_url = Redis.from_url("redis://localhost:6379/0")
+print(rc_url.client_list())
+print(rc_url.set('foo', 'bar1'))
+print(rc_url.set('zzzsdfsdf', 'bar2'))
+print(rc_url.keyslot('bar'))
+print(rc_url.set('{000}', 'bar3'))
+print(f"get_all_nodes: {rc_url.get_all_nodes()}")
+print(rc_url.get('foo'))
+print(rc_url.keys())
+# rc = Redis(host=host, port=6379)
+rc = Redis(startup_nodes=startup_nodes, decode_responses=True)
+print(rc.get('{000}'))
+print(rc.keys())
+print(rc.cluster_save_config(rc.get_all_primaries()))
+print(rc.cluster_save_config(rc.get_node(host=host, port=6378)))
+
+# READONLY examples
+rc_readonly = Redis(startup_nodes=startup_nodes, read_from_replicas=True)
+for i in range(0, 4):
+    # Assigning the read command to the slot's servers in a Round-Robin manner
+    print(rc_readonly.get('zzz'))
+# set command would be directed only to the slot's primary node
+rc_readonly.set('bar', 'foo2')
+# reset READONLY flag
+print(rc_readonly.readwrite())
+# now the get command would be directed only to the slot's primary node
+print(rc_readonly.get('bar'))

Makefile

@@ -9,6 +9,9 @@ dev:	base
 test:	dev
 		docker-compose run --rm test /redis-py/docker-entry.sh
 
+test-cluster:	dev
+		docker-compose run --rm test_cluster /redis-py/docker-entry.sh
+
 clean:
 		docker-compose stop
 		docker-compose rm -f

docker-compose.yml

@@ -34,13 +34,45 @@ services:
     ports:
       - "26381:26381"
 
+  cluster_master_1:
+    build: docker/cluster/master_1
+    ports:
+      - "7000:7000"
+
+  cluster_master_2:
+    build: docker/cluster/master_2
+    ports:
+      - "7001:7001"
+
+  cluster_slave_1:
+    build: docker/cluster/slave_1
+    depends_on:
+      - "cluster_master_1"
+    ports:
+      - "7002:7002"
+    environment:
+      CLUSTER_MASTER_HOST: cluster_master_1
+
+  cluster_slave_2:
+    build: docker/cluster/slave_2
+    depends_on:
+      - "cluster_master_2"
+    ports:
+      - "7003:7003"
+    environment:
+      CLUSTER_MASTER_HOST: cluster_master_2
+
   test:
     build: .
     depends_on:
-      - "sentinel_3"
+      - "cluster_slave_2"
     environment:
       REDIS_MASTER_HOST: master
       REDIS_MASTER_PORT: 6379
+      DB: 9
+      CLUSTER_MASTER_HOST: cluster_master_1
+      CLUSTER_MASTER_PORT: 7000
+      CLUSTER_DB: 0
       CI:
       CI_BUILD_ID:
       CI_BUILD_URL:

docker-entry.sh

@@ -15,5 +15,15 @@ if [ "${GITHUB_ACTIONS}" = true ] ; then
 fi
 
 # use the wait-for-it util to ensure the server is running before invoking Tox
-util/wait-for-it.sh ${REDIS_MASTER} -- tox -- --redis-url=redis://"${REDIS_MASTER}"/9
+util/wait-for-it.sh ${REDIS_MASTER} -- tox -- --redis-url=redis://"${REDIS_MASTER}"/${DB}
+
+if [[ -v CLUSTER_MASTER_HOST ]] ; then
+  # Test Cluster Redis
+  CLUSTER_MASTER="${CLUSTER_MASTER_HOST}":"${CLUSTER_MASTER_PORT}"
+  echo "Testing against Cluster-Redis Server: ${CLUSTER_MASTER}"
+  # We can skip these environments since they were already tested in the strict Redis tests
+  export TOX_SKIP_ENV='.*?(flake8|covreport|codecov)'
+  tox -- --redis-url=redis://"${CLUSTER_MASTER}"/${CLUSTER_DB}
+fi
+
 

docker/cluster/master_1/Dockerfile

@@ -0,0 +1,9 @@
+FROM redis-py-base:latest
+
+COPY redis.conf /usr/local/etc/redis/redis.conf
+COPY nodes.conf /usr/local/etc/redis/nodes.conf
+
+EXPOSE 7000
+
+RUN chmod 666 /usr/local/etc/redis/nodes.conf
+CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]

docker/cluster/master_1/nodes.conf

@@ -0,0 +1,4 @@
+18883b616f3f42c441cdb7d1de6106852e766156 cluster_master_1:7000@17000 myself,master - 0 1630232956498 2 connected 0-8191
+01eca22229cf3c652b6fca0d09ff694183e0d2e3 cluster_master_2:7001@17001 master - 0 1630232956000 1 connected 8192-16383
+52611e796814b78e90ad94be9d769a9f4f668f9a cluster_slave_1:7002@17002 slave 18883b616f3f42c441cdb7d1de6106852e766156 0 1630232954000 1 connected
+22221e7y5814b78e90ad94k8lh969a9ff4665h7a cluster_slave_2:7003@17003 slave 01eca22229cf3c652b6fca0d09ff694183e0d2e3 0 1630232954000 1 connected

docker/cluster/master_1/redis.conf

@@ -0,0 +1,4 @@
+bind cluster_master_1 127.0.0.1
+port 7000
+cluster-enabled yes
+cluster-config-file /usr/local/etc/redis/nodes.conf

docker/cluster/master_2/Dockerfile

@@ -0,0 +1,9 @@
+FROM redis-py-base:latest
+
+COPY redis.conf /usr/local/etc/redis/redis.conf
+COPY nodes.conf /usr/local/etc/redis/nodes.conf
+
+EXPOSE 7001
+
+RUN chmod 666 /usr/local/etc/redis/nodes.conf
+CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]

docker/cluster/master_2/nodes.conf

@@ -0,0 +1,4 @@
+18883b616f3f42c441cdb7d1de6106852e766156 cluster_master_1:7000@17000 master - 0 1630232956498 2 connected 0-8191
+01eca22229cf3c652b6fca0d09ff694183e0d2e3 cluster_master_2:7001@17001 myself,master - 0 1630232956000 1 connected 8192-16383
+52611e796814b78e90ad94be9d769a9f4f668f9a cluster_slave_1:7002@17002 slave 18883b616f3f42c441cdb7d1de6106852e766156 0 1630232954000 1 connected
+22221e7y5814b78e90ad94k8lh969a9ff4665h7a cluster_slave_2:7003@17003 slave 01eca22229cf3c652b6fca0d09ff694183e0d2e3 0 1630232954000 1 connected

docker/cluster/master_2/redis.conf

@@ -0,0 +1,4 @@
+bind cluster_master_2 127.0.0.1
+port 7001
+cluster-enabled yes
+cluster-config-file /usr/local/etc/redis/nodes.conf

docker/cluster/slave_1/Dockerfile

@@ -0,0 +1,9 @@
+FROM redis-py-base:latest
+
+COPY redis.conf /usr/local/etc/redis/redis.conf
+COPY nodes.conf /usr/local/etc/redis/nodes.conf
+
+EXPOSE 7002
+
+RUN chmod 666 /usr/local/etc/redis/nodes.conf
+CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]

docker/cluster/slave_1/nodes.conf

@@ -0,0 +1,4 @@
+18883b616f3f42c441cdb7d1de6106852e766156 cluster_master_1:7000@17000 master - 0 1630232956498 2 connected 0-8191
+01eca22229cf3c652b6fca0d09ff694183e0d2e3 cluster_master_2:7001@17001 master - 0 1630232956000 1 connected 8192-16383
+52611e796814b78e90ad94be9d769a9f4f668f9a cluster_slave_1:7002@17002 myself,slave 18883b616f3f42c441cdb7d1de6106852e766156 0 1630232954000 1 connected
+22221e7y5814b78e90ad94k8lh969a9ff4665h7a cluster_slave_2:7003@17003 slave 01eca22229cf3c652b6fca0d09ff694183e0d2e3 0 1630232954000 1 connected

docker/cluster/slave_1/redis.conf

@@ -0,0 +1,4 @@
+bind cluster_slave_1 127.0.0.1
+port 7002
+cluster-enabled yes
+cluster-config-file /usr/local/etc/redis/nodes.conf

docker/cluster/slave_2/Dockerfile

@@ -0,0 +1,9 @@
+FROM redis-py-base:latest
+
+COPY redis.conf /usr/local/etc/redis/redis.conf
+COPY nodes.conf /usr/local/etc/redis/nodes.conf
+
+EXPOSE 7003
+
+RUN chmod 666 /usr/local/etc/redis/nodes.conf
+CMD [ "redis-server", "/usr/local/etc/redis/redis.conf" ]

docker/cluster/slave_2/nodes.conf

@@ -0,0 +1,4 @@
+18883b616f3f42c441cdb7d1de6106852e766156 cluster_master_1:7000@17000 master - 0 1630232956498 2 connected 0-8191
+01eca22229cf3c652b6fca0d09ff694183e0d2e3 cluster_master_2:7001@17001 master - 0 1630232956000 1 connected 8192-16383
+52611e796814b78e90ad94be9d769a9f4f668f9a cluster_slave_1:7002@17002 slave 18883b616f3f42c441cdb7d1de6106852e766156 0 1630232954000 1 connected
+22221e7y5814b78e90ad94k8lh969a9ff4665h7a cluster_slave_2:7003@17003 myself,slave 01eca22229cf3c652b6fca0d09ff694183e0d2e3 0 1630232954000 1 connected

docker/cluster/slave_2/redis.conf

@@ -0,0 +1,4 @@
+bind cluster_slave_2 127.0.0.1
+port 7003
+cluster-enabled yes
+cluster-config-file /usr/local/etc/redis/nodes.conf

redis/__init__.py

@@ -1,4 +1,5 @@
 from redis.client import Redis, StrictRedis
+from redis.cluster import RedisCluster
 from redis.connection import (
     BlockingConnectionPool,
     ConnectionPool,
@@ -49,6 +50,7 @@ def int_or_str(value):
     'PubSubError',
     'ReadOnlyError',
     'Redis',
+    'RedisCluster',
     'RedisError',
     'ResponseError',
     'SSLConnection',

redis/client.py

@@ -816,7 +816,7 @@ def __init__(self, host='localhost', port=6379,
                  ssl_check_hostname=False,
                  max_connections=None, single_connection_client=False,
                  health_check_interval=0, client_name=None, username=None,
-                 retry=None):
+                 retry=None, redis_connect_func=None):
         """
         Initialize a new Redis client.
         To specify a retry policy, first set `retry_on_timeout` to `True`
@@ -844,7 +844,8 @@ def __init__(self, host='localhost', port=6379,
                 'retry': copy.deepcopy(retry),
                 'max_connections': max_connections,
                 'health_check_interval': health_check_interval,
-                'client_name': client_name
+                'client_name': client_name,
+                'redis_connect_func': redis_connect_func
             }
             # based on input, setup appropriate connection args
             if unix_socket_path is not None:
@@ -1138,14 +1139,16 @@ class PubSub:
     HEALTH_CHECK_MESSAGE = 'redis-py-health-check'
 
     def __init__(self, connection_pool, shard_hint=None,
-                 ignore_subscribe_messages=False):
+                 ignore_subscribe_messages=False, encoder=None):
         self.connection_pool = connection_pool
         self.shard_hint = shard_hint
         self.ignore_subscribe_messages = ignore_subscribe_messages
         self.connection = None
         # we need to know the encoding options for this connection in order
         # to lookup channel and pattern names for callback handlers.
-        self.encoder = self.connection_pool.get_encoder()
+        self.encoder = encoder
+        if self.encoder is None:
+            self.encoder = self.connection_pool.get_encoder()
         if self.encoder.decode_responses:
             self.health_check_response = ['pong', self.HEALTH_CHECK_MESSAGE]
         else: