Added support for connection sentinel_kwargs. (#318)

Author: andriilahuta

.github/workflows/tests.yml

@@ -41,6 +41,7 @@ jobs:
           REDIS_MASTER_HOST: redis
           REDIS_MASTER_SET: sentinel
           REDIS_SENTINEL_QUORUM: "1"
+          REDIS_SENTINEL_PASSWORD: channels_redis
 
     steps:
       - uses: actions/checkout@v2

channels_redis/core.py

@@ -134,8 +134,11 @@ def create_pool(self, index):
         elif "master_name" in host:
             sentinels = host.pop("sentinels")
             master_name = host.pop("master_name")
+            sentinel_kwargs = host.pop("sentinel_kwargs", None)
             return aioredis.sentinel.SentinelConnectionPool(
-                master_name, aioredis.sentinel.Sentinel(sentinels), **host
+                master_name,
+                aioredis.sentinel.Sentinel(sentinels, sentinel_kwargs=sentinel_kwargs),
+                **host
             )
         else:
             return aioredis.ConnectionPool(**host)

channels_redis/pubsub.py

@@ -263,6 +263,7 @@ class RedisSingleShardConnection:
     def __init__(self, host, channel_layer):
         self.host = host.copy() if type(host) is dict else {"address": host}
         self.master_name = self.host.pop("master_name", None)
+        self.sentinel_kwargs = self.host.pop("sentinel_kwargs", None)
         self.channel_layer = channel_layer
         self._subscribed_to = set()
         self._lock = asyncio.Lock()
@@ -348,7 +349,9 @@ def _ensure_redis(self):
                 pool = aioredis.sentinel.SentinelConnectionPool(
                     self.master_name,
                     aioredis.sentinel.Sentinel(
-                        self.host["sentinels"], socket_timeout=2
+                        self.host["sentinels"],
+                        socket_timeout=2,
+                        sentinel_kwargs=self.sentinel_kwargs,
                     ),
                 )
             self._redis = aioredis.Redis(connection_pool=pool)

tests/test_pubsub_sentinel.py

@@ -8,7 +8,14 @@
 from channels_redis.pubsub import RedisPubSubChannelLayer
 
 SENTINEL_MASTER = "sentinel"
-TEST_HOSTS = [{"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER}]
+SENTINEL_KWARGS = {"password": "channels_redis"}
+TEST_HOSTS = [
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+    }
+]
 
 
 @pytest.fixture()

tests/test_sentinel.py

@@ -8,19 +8,76 @@
 from channels_redis.core import ChannelFull, RedisChannelLayer
 
 SENTINEL_MASTER = "sentinel"
-TEST_HOSTS = [{"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER}]
-
+SENTINEL_KWARGS = {"password": "channels_redis"}
+
+TEST_HOSTS = [
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+    }
+]
 MULTIPLE_TEST_HOSTS = [
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 0},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 1},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 2},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 3},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 4},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 5},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 6},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 7},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 8},
-    {"sentinels": [("localhost", 26379)], "master_name": SENTINEL_MASTER, "db": 9},
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 0,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 1,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 2,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 3,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 4,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 5,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 6,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 7,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 8,
+    },
+    {
+        "sentinels": [("localhost", 26379)],
+        "master_name": SENTINEL_MASTER,
+        "sentinel_kwargs": SENTINEL_KWARGS,
+        "db": 9,
+    },
 ]