1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
import socket
from unittest import mock
import pytest
import redis.sentinel
from redis import exceptions
from redis.sentinel import (
MasterNotFoundError,
Sentinel,
SentinelConnectionPool,
SlaveNotFoundError,
)
@pytest.fixture(scope="module")
def master_ip(master_host):
yield socket.gethostbyname(master_host[0])
class SentinelTestClient:
def __init__(self, cluster, id):
self.cluster = cluster
self.id = id
def sentinel_masters(self):
self.cluster.connection_error_if_down(self)
self.cluster.timeout_if_down(self)
return {self.cluster.service_name: self.cluster.master}
def sentinel_slaves(self, master_name):
self.cluster.connection_error_if_down(self)
self.cluster.timeout_if_down(self)
if master_name != self.cluster.service_name:
return []
return self.cluster.slaves
def execute_command(self, *args, **kwargs):
# wrapper purely to validate the calls don't explode
from redis.client import bool_ok
return bool_ok
class SentinelTestCluster:
def __init__(self, servisentinel_ce_name="mymaster", ip="127.0.0.1", port=6379):
self.clients = {}
self.master = {
"ip": ip,
"port": port,
"is_master": True,
"is_sdown": False,
"is_odown": False,
"num-other-sentinels": 0,
}
self.service_name = servisentinel_ce_name
self.slaves = []
self.nodes_down = set()
self.nodes_timeout = set()
def connection_error_if_down(self, node):
if node.id in self.nodes_down:
raise exceptions.ConnectionError
def timeout_if_down(self, node):
if node.id in self.nodes_timeout:
raise exceptions.TimeoutError
def client(self, host, port, **kwargs):
return SentinelTestClient(self, (host, port))
@pytest.fixture()
def cluster(request, master_ip):
def teardown():
redis.sentinel.Redis = saved_Redis
cluster = SentinelTestCluster(ip=master_ip)
saved_Redis = redis.sentinel.Redis
redis.sentinel.Redis = cluster.client
request.addfinalizer(teardown)
return cluster
@pytest.fixture()
def sentinel(request, cluster):
return Sentinel([("foo", 26379), ("bar", 26379)])
@pytest.fixture()
def deployed_sentinel(request):
sentinel_ips = request.config.getoption("--sentinels")
sentinel_endpoints = [
(ip.strip(), int(port.strip()))
for ip, port in (endpoint.split(":") for endpoint in sentinel_ips.split(","))
]
kwargs = {}
decode_responses = True
sentinel_kwargs = {"decode_responses": decode_responses}
force_master_ip = "localhost"
protocol = request.config.getoption("--protocol", 2)
sentinel = Sentinel(
sentinel_endpoints,
force_master_ip=force_master_ip,
sentinel_kwargs=sentinel_kwargs,
socket_timeout=0.1,
protocol=protocol,
decode_responses=decode_responses,
**kwargs,
)
yield sentinel
for s in sentinel.sentinels:
s.close()
@pytest.mark.onlynoncluster
def test_discover_master(sentinel, master_ip):
address = sentinel.discover_master("mymaster")
assert address == (master_ip, 6379)
@pytest.mark.onlynoncluster
def test_discover_master_error(sentinel):
with pytest.raises(MasterNotFoundError):
sentinel.discover_master("xxx")
@pytest.mark.onlynoncluster
def test_dead_pool(sentinel):
master = sentinel.master_for("mymaster", db=9)
conn = master.connection_pool.get_connection()
conn.disconnect()
del master
conn.connect()
@pytest.mark.onlynoncluster
def test_discover_master_sentinel_down(cluster, sentinel, master_ip):
# Put first sentinel 'foo' down
cluster.nodes_down.add(("foo", 26379))
address = sentinel.discover_master("mymaster")
assert address == (master_ip, 6379)
# 'bar' is now first sentinel
assert sentinel.sentinels[0].id == ("bar", 26379)
@pytest.mark.onlynoncluster
def test_discover_master_sentinel_timeout(cluster, sentinel, master_ip):
# Put first sentinel 'foo' down
cluster.nodes_timeout.add(("foo", 26379))
address = sentinel.discover_master("mymaster")
assert address == (master_ip, 6379)
# 'bar' is now first sentinel
assert sentinel.sentinels[0].id == ("bar", 26379)
@pytest.mark.onlynoncluster
def test_master_min_other_sentinels(cluster, master_ip):
sentinel = Sentinel([("foo", 26379)], min_other_sentinels=1)
# min_other_sentinels
with pytest.raises(MasterNotFoundError):
sentinel.discover_master("mymaster")
cluster.master["num-other-sentinels"] = 2
address = sentinel.discover_master("mymaster")
assert address == (master_ip, 6379)
@pytest.mark.onlynoncluster
def test_master_odown(cluster, sentinel):
cluster.master["is_odown"] = True
with pytest.raises(MasterNotFoundError):
sentinel.discover_master("mymaster")
@pytest.mark.onlynoncluster
def test_master_sdown(cluster, sentinel):
cluster.master["is_sdown"] = True
with pytest.raises(MasterNotFoundError):
sentinel.discover_master("mymaster")
@pytest.mark.onlynoncluster
def test_discover_slaves(cluster, sentinel):
assert sentinel.discover_slaves("mymaster") == []
cluster.slaves = [
{"ip": "slave0", "port": 1234, "is_odown": False, "is_sdown": False},
{"ip": "slave1", "port": 1234, "is_odown": False, "is_sdown": False},
]
assert sentinel.discover_slaves("mymaster") == [("slave0", 1234), ("slave1", 1234)]
# slave0 -> ODOWN
cluster.slaves[0]["is_odown"] = True
assert sentinel.discover_slaves("mymaster") == [("slave1", 1234)]
# slave1 -> SDOWN
cluster.slaves[1]["is_sdown"] = True
assert sentinel.discover_slaves("mymaster") == []
cluster.slaves[0]["is_odown"] = False
cluster.slaves[1]["is_sdown"] = False
# node0 -> DOWN
cluster.nodes_down.add(("foo", 26379))
assert sentinel.discover_slaves("mymaster") == [("slave0", 1234), ("slave1", 1234)]
cluster.nodes_down.clear()
# node0 -> TIMEOUT
cluster.nodes_timeout.add(("foo", 26379))
assert sentinel.discover_slaves("mymaster") == [("slave0", 1234), ("slave1", 1234)]
@pytest.mark.onlynoncluster
def test_master_for(sentinel, master_ip):
master = sentinel.master_for("mymaster", db=9)
assert master.ping()
assert master.connection_pool.master_address == (master_ip, 6379)
# Use internal connection check
master = sentinel.master_for("mymaster", db=9, check_connection=True)
assert master.ping()
@pytest.mark.onlynoncluster
def test_slave_for(cluster, sentinel):
cluster.slaves = [
{"ip": "127.0.0.1", "port": 6379, "is_odown": False, "is_sdown": False}
]
slave = sentinel.slave_for("mymaster", db=9)
assert slave.ping()
@pytest.mark.onlynoncluster
def test_slave_for_slave_not_found_error(cluster, sentinel):
cluster.master["is_odown"] = True
slave = sentinel.slave_for("mymaster", db=9)
with pytest.raises(SlaveNotFoundError):
slave.ping()
@pytest.mark.onlynoncluster
def test_slave_round_robin(cluster, sentinel, master_ip):
cluster.slaves = [
{"ip": "slave0", "port": 6379, "is_odown": False, "is_sdown": False},
{"ip": "slave1", "port": 6379, "is_odown": False, "is_sdown": False},
]
pool = SentinelConnectionPool("mymaster", sentinel)
rotator = pool.rotate_slaves()
assert next(rotator) in (("slave0", 6379), ("slave1", 6379))
assert next(rotator) in (("slave0", 6379), ("slave1", 6379))
# Fallback to master
assert next(rotator) == (master_ip, 6379)
with pytest.raises(SlaveNotFoundError):
next(rotator)
@pytest.mark.onlynoncluster
def test_ckquorum(sentinel):
resp = sentinel.sentinel_ckquorum("mymaster")
assert resp is True
@pytest.mark.onlynoncluster
def test_flushconfig(sentinel):
resp = sentinel.sentinel_flushconfig()
assert resp is True
@pytest.mark.onlynoncluster
def test_reset(cluster, sentinel):
cluster.master["is_odown"] = True
resp = sentinel.sentinel_reset("mymaster")
assert resp is True
@pytest.mark.onlynoncluster
@pytest.mark.parametrize("method_name", ["master_for", "slave_for"])
def test_auto_close_pool(cluster, sentinel, method_name):
"""
Check that the connection pool created by the sentinel client is
automatically closed
"""
method = getattr(sentinel, method_name)
client = method("mymaster", db=9)
pool = client.connection_pool
assert client.auto_close_connection_pool is True
calls = 0
def mock_disconnect():
nonlocal calls
calls += 1
with mock.patch.object(pool, "disconnect", mock_disconnect):
client.close()
assert calls == 1
pool.disconnect()
# Tests against real sentinel instances
@pytest.mark.onlynoncluster
def test_get_sentinels(deployed_sentinel):
resps = deployed_sentinel.sentinel_sentinels("redis-py-test", return_responses=True)
# validate that the original command response is returned
assert isinstance(resps, list)
# validate that the command has been executed against all sentinels
# each response from each sentinel is returned
assert len(resps) > 1
# validate default behavior
resps = deployed_sentinel.sentinel_sentinels("redis-py-test")
assert isinstance(resps, bool)
@pytest.mark.onlynoncluster
def test_get_master_addr_by_name(deployed_sentinel):
resps = deployed_sentinel.sentinel_get_master_addr_by_name(
"redis-py-test", return_responses=True
)
# validate that the original command response is returned
assert isinstance(resps, list)
# validate that the command has been executed just once
# when executed once, only one response element is returned
assert len(resps) == 1
assert isinstance(resps[0], tuple)
# validate default behavior
resps = deployed_sentinel.sentinel_get_master_addr_by_name("redis-py-test")
assert isinstance(resps, bool)
@pytest.mark.onlynoncluster
def test_redis_master_usage(deployed_sentinel):
r = deployed_sentinel.master_for("redis-py-test", db=0)
r.set("foo", "bar")
assert r.get("foo") == "bar"
|