bugfix, initializing SentinelPool with password to work with sentinel authentication available starting with Redis 5.0.1

Tarcisio Nunes · Tarcisio Nunes · commit a29cb0a34103 · 2019-08-28T18:28:21.000-03:00
diff --git a/pyredis/client.py b/pyredis/client.py
@@ -572,13 +572,14 @@ class SentinelClient(object):
         Accepts a list of sentinels in this form: [('sentinel1', 26379), ('sentinel2', 26379), ('sentinel3', 26379)]
     :type sentinels: list
     """
-    def __init__(self, sentinels):
+    def __init__(self, sentinels, password=None):
         self._conn = None
         self._sentinels = deque(sentinels)
+        self._password = password
 
     def _sentinel_connect(self, sentinel):
         host, port = sentinel
-        self._conn = Connection(host=host, port=port, conn_timeout=0.1, sentinel=True)
+        self._conn = Connection(host=host, port=port, conn_timeout=0.1, sentinel=True, password=self._password)
         try:
             self.execute('PING')
             return True
diff --git a/pyredis/connection.py b/pyredis/connection.py
@@ -88,8 +88,6 @@ def __init__(
         self.database = database
 
     def _authenticate(self):
-        if self._sentinel:
-            return
         if self.password:
             self.write('AUTH', self.password)
             try:
@@ -110,8 +108,8 @@ def _connect(self):
             self._reader = Reader(encoding=self._encoding)
         else:
             self._reader = Reader()
+        self._authenticate()
         if not self._sentinel:
-            self._authenticate()
             self._setdb()
             self._set_read_only()
         self._sock.settimeout(self._read_timeout)
diff --git a/pyredis/pool.py b/pyredis/pool.py
@@ -452,9 +452,9 @@ class SentinelHashPool(
         In case a sentinel delivers stale data, how many other sentinels should be tried.
     :type retries: int
     """
-    def __init__(self, sentinels, buckets, slave_ok=False, retries=3, **kwargs):
+    def __init__(self, sentinels, buckets, slave_ok=False, retries=3, sentinel_password=None, **kwargs):
         super().__init__(**kwargs)
-        self._sentinel = SentinelClient(sentinels=sentinels)
+        self._sentinel = SentinelClient(sentinels=sentinels, password=sentinel_password)
         self._buckets = buckets
         self._slave_ok = slave_ok
         self._retries = retries
@@ -613,9 +613,9 @@ class SentinelPool(
         In case a sentinel delivers stale data, how many other sentinels should be tried.
     :type retries: int
     """
-    def __init__(self, sentinels, name, slave_ok=False, retries=3, **kwargs):
+    def __init__(self, sentinels, name, slave_ok=False, retries=3, sentinel_password=None, **kwargs):
         super().__init__(**kwargs)
-        self._sentinel = SentinelClient(sentinels=sentinels)
+        self._sentinel = SentinelClient(sentinels=sentinels, password=sentinel_password)
         self._name = name
         self._slave_ok = slave_ok
         self._retries = retries
diff --git a/tests/unit/test_client.py b/tests/unit/test_client.py
@@ -470,12 +470,12 @@ def test__sentinel_connect(self):
         conn_mock = Mock()
         self.connection_mock.return_value = conn_mock
         sentinels = [('host1', 12345), ('host2', 12345), ('host3', 12345)]
-        client = pyredis.client.SentinelClient(sentinels=sentinels)
+        client = pyredis.client.SentinelClient(sentinels=sentinels, password='blubber')
         client.execute = Mock()
 
         self.assertTrue(client._sentinel_connect(sentinel=('host1', 12345)))
         self.connection_mock.assert_called_with(
-            host='host1', port=12345, conn_timeout=0.1, sentinel=True)
+            host='host1', port=12345, conn_timeout=0.1, sentinel=True, password='blubber')
         client.execute.assert_called_with('PING')
         self.assertEqual(client._conn, conn_mock)
 
@@ -490,7 +490,7 @@ def test__sentinel_connect_conn_exception(self):
 
         self.assertFalse(client._sentinel_connect(sentinel=('host1', 12345)))
         self.connection_mock.assert_called_with(
-            host='host1', port=12345, conn_timeout=0.1, sentinel=True)
+            host='host1', port=12345, conn_timeout=0.1, sentinel=True, password=None)
         client.execute.assert_called_with('PING')
         client.close.assert_called_with()
 
diff --git a/tests/unit/test_connection.py b/tests/unit/test_connection.py
@@ -517,11 +517,18 @@ def test_read_exception_result_raise(self):
         connection._reader = reader_mock
         self.assertRaises(ReplyError, connection.read)
 
-    def test_read_exception_result_no_raise(self):
-        connection = pyredis.connection.Connection(host='127.0.0.1', encoding='utf-8')
-        connection._sock = True
+    def test_authenticate_sentinel(self):
+        connection = pyredis.connection.Connection(host='127.0.0.1', encoding='utf-8', sentinel=True)
+        authenticate_mock = Mock()
+        setdb_mock = Mock()
+        set_read_only_mock = Mock()
 
-        reader_mock = Mock()
-        reader_mock.gets.return_value = ReplyError('blub')
-        connection._reader = reader_mock
-        connection.read(raise_on_result_err=False)
+        connection._authenticate = authenticate_mock
+        connection._setdb = setdb_mock
+        connection._set_read_only = set_read_only_mock
+
+        connection._connect()
+
+        authenticate_mock.assert_called()
+        setdb_mock.assert_not_called()
+        set_read_only_mock.assert_not_called()
diff --git a/tests/unit/test_pool.py b/tests/unit/test_pool.py
@@ -315,7 +315,7 @@ def setUp(self):
     def test___init__default_args(self):
         pool = pyredis.pool.SentinelPool(sentinels=[('host1', 12345)], name='mymaster')
         pool._sentinel.sentinels = [('host1', 12345)]
-        self.sentinelclient_mock.assert_called_with(sentinels=[('host1', 12345)])
+        self.sentinelclient_mock.assert_called_with(sentinels=[('host1', 12345)], password=None)
         self.assertEqual(pool.name, 'mymaster')
         self.assertEqual(pool.retries, 3)
         self.assertFalse(pool.slave_ok)
@@ -327,10 +327,11 @@ def test___init__default_cust_args(self):
             sentinels=[('host1', 12345)],
             name='mymaster',
             slave_ok=True,
-            retries=5
+            retries=5,
+            sentinel_password='blubber'
         )
         pool._sentinel.sentinels = [('host1', 12345)]
-        self.sentinelclient_mock.assert_called_with(sentinels=[('host1', 12345)])
+        self.sentinelclient_mock.assert_called_with(sentinels=[('host1', 12345)], password='blubber')
         self.assertEqual(pool.name, 'mymaster')
         self.assertEqual(pool.retries, 5)
         self.assertTrue(pool.slave_ok)
