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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
|
import platform
import threading
import time
from unittest import mock
from unittest.mock import patch
import pytest
import redis
from redis.exceptions import ConnectionError
from .conftest import _get_client, skip_if_redis_enterprise, skip_if_server_version_lt
def wait_for_message(pubsub, timeout=0.5, ignore_subscribe_messages=False):
now = time.time()
timeout = now + timeout
while now < timeout:
message = pubsub.get_message(
ignore_subscribe_messages=ignore_subscribe_messages
)
if message is not None:
return message
time.sleep(0.01)
now = time.time()
return None
def make_message(type, channel, data, pattern=None):
return {
"type": type,
"pattern": pattern and pattern.encode("utf-8") or None,
"channel": channel and channel.encode("utf-8") or None,
"data": data.encode("utf-8") if isinstance(data, str) else data,
}
def make_subscribe_test_data(pubsub, type):
if type == "channel":
return {
"p": pubsub,
"sub_type": "subscribe",
"unsub_type": "unsubscribe",
"sub_func": pubsub.subscribe,
"unsub_func": pubsub.unsubscribe,
"keys": ["foo", "bar", "uni" + chr(4456) + "code"],
}
elif type == "pattern":
return {
"p": pubsub,
"sub_type": "psubscribe",
"unsub_type": "punsubscribe",
"sub_func": pubsub.psubscribe,
"unsub_func": pubsub.punsubscribe,
"keys": ["f*", "b*", "uni" + chr(4456) + "*"],
}
assert False, f"invalid subscribe type: {type}"
class TestPubSubSubscribeUnsubscribe:
def _test_subscribe_unsubscribe(
self, p, sub_type, unsub_type, sub_func, unsub_func, keys
):
for key in keys:
assert sub_func(key) is None
# should be a message for each channel/pattern we just subscribed to
for i, key in enumerate(keys):
assert wait_for_message(p) == make_message(sub_type, key, i + 1)
for key in keys:
assert unsub_func(key) is None
# should be a message for each channel/pattern we just unsubscribed
# from
for i, key in enumerate(keys):
i = len(keys) - 1 - i
assert wait_for_message(p) == make_message(unsub_type, key, i)
def test_channel_subscribe_unsubscribe(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "channel")
self._test_subscribe_unsubscribe(**kwargs)
def test_pattern_subscribe_unsubscribe(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "pattern")
self._test_subscribe_unsubscribe(**kwargs)
def _test_resubscribe_on_reconnection(
self, p, sub_type, unsub_type, sub_func, unsub_func, keys
):
for key in keys:
assert sub_func(key) is None
# should be a message for each channel/pattern we just subscribed to
for i, key in enumerate(keys):
assert wait_for_message(p) == make_message(sub_type, key, i + 1)
# manually disconnect
p.connection.disconnect()
# calling get_message again reconnects and resubscribes
# note, we may not re-subscribe to channels in exactly the same order
# so we have to do some extra checks to make sure we got them all
messages = []
for i in range(len(keys)):
messages.append(wait_for_message(p))
unique_channels = set()
assert len(messages) == len(keys)
for i, message in enumerate(messages):
assert message["type"] == sub_type
assert message["data"] == i + 1
assert isinstance(message["channel"], bytes)
channel = message["channel"].decode("utf-8")
unique_channels.add(channel)
assert len(unique_channels) == len(keys)
for channel in unique_channels:
assert channel in keys
def test_resubscribe_to_channels_on_reconnection(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "channel")
self._test_resubscribe_on_reconnection(**kwargs)
@pytest.mark.onlynoncluster
def test_resubscribe_to_patterns_on_reconnection(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "pattern")
self._test_resubscribe_on_reconnection(**kwargs)
def _test_subscribed_property(
self, p, sub_type, unsub_type, sub_func, unsub_func, keys
):
assert p.subscribed is False
sub_func(keys[0])
# we're now subscribed even though we haven't processed the
# reply from the server just yet
assert p.subscribed is True
assert wait_for_message(p) == make_message(sub_type, keys[0], 1)
# we're still subscribed
assert p.subscribed is True
# unsubscribe from all channels
unsub_func()
# we're still technically subscribed until we process the
# response messages from the server
assert p.subscribed is True
assert wait_for_message(p) == make_message(unsub_type, keys[0], 0)
# now we're no longer subscribed as no more messages can be delivered
# to any channels we were listening to
assert p.subscribed is False
# subscribing again flips the flag back
sub_func(keys[0])
assert p.subscribed is True
assert wait_for_message(p) == make_message(sub_type, keys[0], 1)
# unsubscribe again
unsub_func()
assert p.subscribed is True
# subscribe to another channel before reading the unsubscribe response
sub_func(keys[1])
assert p.subscribed is True
# read the unsubscribe for key1
assert wait_for_message(p) == make_message(unsub_type, keys[0], 0)
# we're still subscribed to key2, so subscribed should still be True
assert p.subscribed is True
# read the key2 subscribe message
assert wait_for_message(p) == make_message(sub_type, keys[1], 1)
unsub_func()
# haven't read the message yet, so we're still subscribed
assert p.subscribed is True
assert wait_for_message(p) == make_message(unsub_type, keys[1], 0)
# now we're finally unsubscribed
assert p.subscribed is False
def test_subscribe_property_with_channels(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "channel")
self._test_subscribed_property(**kwargs)
@pytest.mark.onlynoncluster
def test_subscribe_property_with_patterns(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "pattern")
self._test_subscribed_property(**kwargs)
def test_ignore_all_subscribe_messages(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
checks = (
(p.subscribe, "foo"),
(p.unsubscribe, "foo"),
(p.psubscribe, "f*"),
(p.punsubscribe, "f*"),
)
assert p.subscribed is False
for func, channel in checks:
assert func(channel) is None
assert p.subscribed is True
assert wait_for_message(p) is None
assert p.subscribed is False
def test_ignore_individual_subscribe_messages(self, r):
p = r.pubsub()
checks = (
(p.subscribe, "foo"),
(p.unsubscribe, "foo"),
(p.psubscribe, "f*"),
(p.punsubscribe, "f*"),
)
assert p.subscribed is False
for func, channel in checks:
assert func(channel) is None
assert p.subscribed is True
message = wait_for_message(p, ignore_subscribe_messages=True)
assert message is None
assert p.subscribed is False
def test_sub_unsub_resub_channels(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "channel")
self._test_sub_unsub_resub(**kwargs)
@pytest.mark.onlynoncluster
def test_sub_unsub_resub_patterns(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "pattern")
self._test_sub_unsub_resub(**kwargs)
def _test_sub_unsub_resub(
self, p, sub_type, unsub_type, sub_func, unsub_func, keys
):
# https://github.com/andymccurdy/redis-py/issues/764
key = keys[0]
sub_func(key)
unsub_func(key)
sub_func(key)
assert p.subscribed is True
assert wait_for_message(p) == make_message(sub_type, key, 1)
assert wait_for_message(p) == make_message(unsub_type, key, 0)
assert wait_for_message(p) == make_message(sub_type, key, 1)
assert p.subscribed is True
def test_sub_unsub_all_resub_channels(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "channel")
self._test_sub_unsub_all_resub(**kwargs)
def test_sub_unsub_all_resub_patterns(self, r):
kwargs = make_subscribe_test_data(r.pubsub(), "pattern")
self._test_sub_unsub_all_resub(**kwargs)
def _test_sub_unsub_all_resub(
self, p, sub_type, unsub_type, sub_func, unsub_func, keys
):
# https://github.com/andymccurdy/redis-py/issues/764
key = keys[0]
sub_func(key)
unsub_func()
sub_func(key)
assert p.subscribed is True
assert wait_for_message(p) == make_message(sub_type, key, 1)
assert wait_for_message(p) == make_message(unsub_type, key, 0)
assert wait_for_message(p) == make_message(sub_type, key, 1)
assert p.subscribed is True
class TestPubSubMessages:
def setup_method(self, method):
self.message = None
def message_handler(self, message):
self.message = message
def test_published_message_to_channel(self, r):
p = r.pubsub()
p.subscribe("foo")
assert wait_for_message(p) == make_message("subscribe", "foo", 1)
assert r.publish("foo", "test message") == 1
message = wait_for_message(p)
assert isinstance(message, dict)
assert message == make_message("message", "foo", "test message")
def test_published_message_to_pattern(self, r):
p = r.pubsub()
p.subscribe("foo")
p.psubscribe("f*")
assert wait_for_message(p) == make_message("subscribe", "foo", 1)
assert wait_for_message(p) == make_message("psubscribe", "f*", 2)
# 1 to pattern, 1 to channel
assert r.publish("foo", "test message") == 2
message1 = wait_for_message(p)
message2 = wait_for_message(p)
assert isinstance(message1, dict)
assert isinstance(message2, dict)
expected = [
make_message("message", "foo", "test message"),
make_message("pmessage", "foo", "test message", pattern="f*"),
]
assert message1 in expected
assert message2 in expected
assert message1 != message2
def test_channel_message_handler(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
p.subscribe(foo=self.message_handler)
assert wait_for_message(p) is None
assert r.publish("foo", "test message") == 1
assert wait_for_message(p) is None
assert self.message == make_message("message", "foo", "test message")
@pytest.mark.onlynoncluster
def test_pattern_message_handler(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
p.psubscribe(**{"f*": self.message_handler})
assert wait_for_message(p) is None
assert r.publish("foo", "test message") == 1
assert wait_for_message(p) is None
assert self.message == make_message(
"pmessage", "foo", "test message", pattern="f*"
)
def test_unicode_channel_message_handler(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
channel = "uni" + chr(4456) + "code"
channels = {channel: self.message_handler}
p.subscribe(**channels)
assert wait_for_message(p) is None
assert r.publish(channel, "test message") == 1
assert wait_for_message(p) is None
assert self.message == make_message("message", channel, "test message")
@pytest.mark.onlynoncluster
# see: https://redis-py-cluster.readthedocs.io/en/stable/pubsub.html
# #known-limitations-with-pubsub
def test_unicode_pattern_message_handler(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
pattern = "uni" + chr(4456) + "*"
channel = "uni" + chr(4456) + "code"
p.psubscribe(**{pattern: self.message_handler})
assert wait_for_message(p) is None
assert r.publish(channel, "test message") == 1
assert wait_for_message(p) is None
assert self.message == make_message(
"pmessage", channel, "test message", pattern=pattern
)
class TestPubSubAutoDecoding:
"These tests only validate that we get unicode values back"
channel = "uni" + chr(4456) + "code"
pattern = "uni" + chr(4456) + "*"
data = "abc" + chr(4458) + "123"
def make_message(self, type, channel, data, pattern=None):
return {"type": type, "channel": channel, "pattern": pattern, "data": data}
def setup_method(self, method):
self.message = None
def message_handler(self, message):
self.message = message
@pytest.fixture()
def r(self, request):
return _get_client(redis.Redis, request=request, decode_responses=True)
def test_channel_subscribe_unsubscribe(self, r):
p = r.pubsub()
p.subscribe(self.channel)
assert wait_for_message(p) == self.make_message("subscribe", self.channel, 1)
p.unsubscribe(self.channel)
assert wait_for_message(p) == self.make_message("unsubscribe", self.channel, 0)
def test_pattern_subscribe_unsubscribe(self, r):
p = r.pubsub()
p.psubscribe(self.pattern)
assert wait_for_message(p) == self.make_message("psubscribe", self.pattern, 1)
p.punsubscribe(self.pattern)
assert wait_for_message(p) == self.make_message("punsubscribe", self.pattern, 0)
def test_channel_publish(self, r):
p = r.pubsub()
p.subscribe(self.channel)
assert wait_for_message(p) == self.make_message("subscribe", self.channel, 1)
r.publish(self.channel, self.data)
assert wait_for_message(p) == self.make_message(
"message", self.channel, self.data
)
@pytest.mark.onlynoncluster
def test_pattern_publish(self, r):
p = r.pubsub()
p.psubscribe(self.pattern)
assert wait_for_message(p) == self.make_message("psubscribe", self.pattern, 1)
r.publish(self.channel, self.data)
assert wait_for_message(p) == self.make_message(
"pmessage", self.channel, self.data, pattern=self.pattern
)
def test_channel_message_handler(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
p.subscribe(**{self.channel: self.message_handler})
assert wait_for_message(p) is None
r.publish(self.channel, self.data)
assert wait_for_message(p) is None
assert self.message == self.make_message("message", self.channel, self.data)
# test that we reconnected to the correct channel
self.message = None
p.connection.disconnect()
assert wait_for_message(p) is None # should reconnect
new_data = self.data + "new data"
r.publish(self.channel, new_data)
assert wait_for_message(p) is None
assert self.message == self.make_message("message", self.channel, new_data)
def test_pattern_message_handler(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
p.psubscribe(**{self.pattern: self.message_handler})
assert wait_for_message(p) is None
r.publish(self.channel, self.data)
assert wait_for_message(p) is None
assert self.message == self.make_message(
"pmessage", self.channel, self.data, pattern=self.pattern
)
# test that we reconnected to the correct pattern
self.message = None
p.connection.disconnect()
assert wait_for_message(p) is None # should reconnect
new_data = self.data + "new data"
r.publish(self.channel, new_data)
assert wait_for_message(p) is None
assert self.message == self.make_message(
"pmessage", self.channel, new_data, pattern=self.pattern
)
def test_context_manager(self, r):
with r.pubsub() as pubsub:
pubsub.subscribe("foo")
assert pubsub.connection is not None
assert pubsub.connection is None
assert pubsub.channels == {}
assert pubsub.patterns == {}
class TestPubSubRedisDown:
def test_channel_subscribe(self, r):
r = redis.Redis(host="localhost", port=6390)
p = r.pubsub()
with pytest.raises(ConnectionError):
p.subscribe("foo")
class TestPubSubSubcommands:
@pytest.mark.onlynoncluster
@skip_if_server_version_lt("2.8.0")
def test_pubsub_channels(self, r):
p = r.pubsub()
p.subscribe("foo", "bar", "baz", "quux")
for i in range(4):
assert wait_for_message(p)["type"] == "subscribe"
expected = [b"bar", b"baz", b"foo", b"quux"]
assert all([channel in r.pubsub_channels() for channel in expected])
@pytest.mark.onlynoncluster
@skip_if_server_version_lt("2.8.0")
def test_pubsub_numsub(self, r):
p1 = r.pubsub()
p1.subscribe("foo", "bar", "baz")
for i in range(3):
assert wait_for_message(p1)["type"] == "subscribe"
p2 = r.pubsub()
p2.subscribe("bar", "baz")
for i in range(2):
assert wait_for_message(p2)["type"] == "subscribe"
p3 = r.pubsub()
p3.subscribe("baz")
assert wait_for_message(p3)["type"] == "subscribe"
channels = [(b"foo", 1), (b"bar", 2), (b"baz", 3)]
assert r.pubsub_numsub("foo", "bar", "baz") == channels
@skip_if_server_version_lt("2.8.0")
def test_pubsub_numpat(self, r):
p = r.pubsub()
p.psubscribe("*oo", "*ar", "b*z")
for i in range(3):
assert wait_for_message(p)["type"] == "psubscribe"
assert r.pubsub_numpat() == 3
class TestPubSubPings:
@skip_if_server_version_lt("3.0.0")
def test_send_pubsub_ping(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
p.subscribe("foo")
p.ping()
assert wait_for_message(p) == make_message(
type="pong", channel=None, data="", pattern=None
)
@skip_if_server_version_lt("3.0.0")
def test_send_pubsub_ping_message(self, r):
p = r.pubsub(ignore_subscribe_messages=True)
p.subscribe("foo")
p.ping(message="hello world")
assert wait_for_message(p) == make_message(
type="pong", channel=None, data="hello world", pattern=None
)
@pytest.mark.onlynoncluster
class TestPubSubConnectionKilled:
@skip_if_server_version_lt("3.0.0")
@skip_if_redis_enterprise()
def test_connection_error_raised_when_connection_dies(self, r):
p = r.pubsub()
p.subscribe("foo")
assert wait_for_message(p) == make_message("subscribe", "foo", 1)
for client in r.client_list():
if client["cmd"] == "subscribe":
r.client_kill_filter(_id=client["id"])
with pytest.raises(ConnectionError):
wait_for_message(p)
class TestPubSubTimeouts:
def test_get_message_with_timeout_returns_none(self, r):
p = r.pubsub()
p.subscribe("foo")
assert wait_for_message(p) == make_message("subscribe", "foo", 1)
assert p.get_message(timeout=0.01) is None
def test_get_message_not_subscribed_return_none(self, r):
p = r.pubsub()
assert p.subscribed is False
assert p.get_message() is None
assert p.get_message(timeout=0.1) is None
with patch.object(threading.Event, "wait") as mock:
mock.return_value = False
assert p.get_message(timeout=0.01) is None
assert mock.called
def test_get_message_subscribe_during_waiting(self, r):
p = r.pubsub()
def poll(ps, expected_res):
assert ps.get_message() is None
message = ps.get_message(timeout=1)
assert message == expected_res
subscribe_response = make_message("subscribe", "foo", 1)
poller = threading.Thread(target=poll, args=(p, subscribe_response))
poller.start()
time.sleep(0.2)
p.subscribe("foo")
poller.join()
def test_get_message_wait_for_subscription_not_being_called(self, r):
p = r.pubsub()
p.subscribe("foo")
with patch.object(threading.Event, "wait") as mock:
assert p.subscribed is True
assert wait_for_message(p) == make_message("subscribe", "foo", 1)
assert mock.called is False
class TestPubSubWorkerThread:
@pytest.mark.skipif(
platform.python_implementation() == "PyPy", reason="Pypy threading issue"
)
def test_pubsub_worker_thread_exception_handler(self, r):
event = threading.Event()
def exception_handler(ex, pubsub, thread):
thread.stop()
event.set()
p = r.pubsub()
p.subscribe(**{"foo": lambda m: m})
with mock.patch.object(p, "get_message", side_effect=Exception("error")):
pubsub_thread = p.run_in_thread(
daemon=True, exception_handler=exception_handler
)
assert event.wait(timeout=1.0)
pubsub_thread.join(timeout=1.0)
assert not pubsub_thread.is_alive()
class TestPubSubDeadlock:
@pytest.mark.timeout(30, method="thread")
def test_pubsub_deadlock(self, master_host):
pool = redis.ConnectionPool(host=master_host[0], port=master_host[1])
r = redis.Redis(connection_pool=pool)
for i in range(60):
p = r.pubsub()
p.subscribe("my-channel-1", "my-channel-2")
pool.reset()
|