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 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
|
import asyncio
import re
from unittest import mock
import pytest
import pytest_asyncio
import redis.asyncio as redis
from redis.asyncio.connection import Connection, to_bool
from redis.auth.token import TokenInterface
from tests.conftest import skip_if_redis_enterprise, skip_if_server_version_lt
from .compat import aclosing
from .conftest import asynccontextmanager
from .test_pubsub import wait_for_message
@pytest.mark.onlynoncluster
class TestRedisAutoReleaseConnectionPool:
@pytest_asyncio.fixture
async def r(self, create_redis) -> redis.Redis:
"""This is necessary since r and r2 create ConnectionPools behind the scenes"""
r = await create_redis()
r.auto_close_connection_pool = True
yield r
@staticmethod
def get_total_connected_connections(pool):
return len(pool._available_connections) + len(pool._in_use_connections)
@staticmethod
async def create_two_conn(r: redis.Redis):
if not r.single_connection_client: # Single already initialized connection
r.connection = await r.connection_pool.get_connection()
return await r.connection_pool.get_connection()
@staticmethod
def has_no_connected_connections(pool: redis.ConnectionPool):
return not any(
x.is_connected
for x in pool._available_connections + list(pool._in_use_connections)
)
async def test_auto_disconnect_redis_created_pool(self, r: redis.Redis):
new_conn = await self.create_two_conn(r)
assert new_conn != r.connection
assert self.get_total_connected_connections(r.connection_pool) == 2
await r.aclose()
assert self.has_no_connected_connections(r.connection_pool)
async def test_do_not_auto_disconnect_redis_created_pool(self, r2: redis.Redis):
assert r2.auto_close_connection_pool is False, (
"The connection pool should not be disconnected as a manually created "
"connection pool was passed in in conftest.py"
)
new_conn = await self.create_two_conn(r2)
assert self.get_total_connected_connections(r2.connection_pool) == 2
await r2.aclose()
assert r2.connection_pool._in_use_connections == {new_conn}
assert new_conn.is_connected
assert len(r2.connection_pool._available_connections) == 1
assert r2.connection_pool._available_connections[0].is_connected
async def test_auto_release_override_true_manual_created_pool(self, r: redis.Redis):
assert r.auto_close_connection_pool is True, "This is from the class fixture"
await self.create_two_conn(r)
await r.aclose()
assert self.get_total_connected_connections(r.connection_pool) == 2, (
"The connection pool should not be disconnected as a manually created "
"connection pool was passed in in conftest.py"
)
assert self.has_no_connected_connections(r.connection_pool)
@pytest.mark.parametrize("auto_close_conn_pool", [True, False])
async def test_close_override(self, r: redis.Redis, auto_close_conn_pool):
r.auto_close_connection_pool = auto_close_conn_pool
await self.create_two_conn(r)
await r.aclose(close_connection_pool=True)
assert self.has_no_connected_connections(r.connection_pool)
@pytest.mark.parametrize("auto_close_conn_pool", [True, False])
async def test_negate_auto_close_client_pool(
self, r: redis.Redis, auto_close_conn_pool
):
r.auto_close_connection_pool = auto_close_conn_pool
new_conn = await self.create_two_conn(r)
await r.aclose(close_connection_pool=False)
assert not self.has_no_connected_connections(r.connection_pool)
assert r.connection_pool._in_use_connections == {new_conn}
assert r.connection_pool._available_connections[0].is_connected
assert self.get_total_connected_connections(r.connection_pool) == 2
class DummyConnection(Connection):
description_format = "DummyConnection<>"
def __init__(self, **kwargs):
self.kwargs = kwargs
def repr_pieces(self):
return [("id", id(self)), ("kwargs", self.kwargs)]
async def connect(self):
pass
async def disconnect(self):
pass
async def can_read_destructive(self, timeout: float = 0):
return False
def set_re_auth_token(self, token: TokenInterface):
pass
async def re_auth(self):
pass
class TestConnectionPool:
@asynccontextmanager
async def get_pool(
self,
connection_kwargs=None,
max_connections=None,
connection_class=redis.Connection,
):
connection_kwargs = connection_kwargs or {}
pool = redis.ConnectionPool(
connection_class=connection_class,
max_connections=max_connections,
**connection_kwargs,
)
try:
yield pool
finally:
await pool.disconnect(inuse_connections=True)
async def test_connection_creation(self):
connection_kwargs = {"foo": "bar", "biz": "baz"}
async with self.get_pool(
connection_kwargs=connection_kwargs, connection_class=DummyConnection
) as pool:
connection = await pool.get_connection()
assert isinstance(connection, DummyConnection)
assert connection.kwargs == connection_kwargs
async def test_aclosing(self):
connection_kwargs = {"foo": "bar", "biz": "baz"}
pool = redis.ConnectionPool(
connection_class=DummyConnection,
max_connections=None,
**connection_kwargs,
)
async with aclosing(pool):
pass
async def test_multiple_connections(self, master_host):
connection_kwargs = {"host": master_host[0]}
async with self.get_pool(connection_kwargs=connection_kwargs) as pool:
c1 = await pool.get_connection()
c2 = await pool.get_connection()
assert c1 != c2
async def test_max_connections(self, master_host):
connection_kwargs = {"host": master_host[0]}
async with self.get_pool(
max_connections=2, connection_kwargs=connection_kwargs
) as pool:
await pool.get_connection()
await pool.get_connection()
with pytest.raises(redis.ConnectionError):
await pool.get_connection()
async def test_reuse_previously_released_connection(self, master_host):
connection_kwargs = {"host": master_host[0]}
async with self.get_pool(connection_kwargs=connection_kwargs) as pool:
c1 = await pool.get_connection()
await pool.release(c1)
c2 = await pool.get_connection()
assert c1 == c2
async def test_repr_contains_db_info_tcp(self):
connection_kwargs = {
"host": "localhost",
"port": 6379,
"db": 1,
"client_name": "test-client",
}
async with self.get_pool(
connection_kwargs=connection_kwargs, connection_class=redis.Connection
) as pool:
expected = "host=localhost,port=6379,db=1,client_name=test-client"
assert expected in repr(pool)
async def test_repr_contains_db_info_unix(self):
connection_kwargs = {"path": "/abc", "db": 1, "client_name": "test-client"}
async with self.get_pool(
connection_kwargs=connection_kwargs,
connection_class=redis.UnixDomainSocketConnection,
) as pool:
expected = "path=/abc,db=1,client_name=test-client"
assert expected in repr(pool)
class TestBlockingConnectionPool:
@asynccontextmanager
async def get_pool(self, connection_kwargs=None, max_connections=10, timeout=20):
connection_kwargs = connection_kwargs or {}
pool = redis.BlockingConnectionPool(
connection_class=DummyConnection,
max_connections=max_connections,
timeout=timeout,
**connection_kwargs,
)
try:
yield pool
finally:
await pool.disconnect(inuse_connections=True)
async def test_connection_creation(self, master_host):
connection_kwargs = {
"foo": "bar",
"biz": "baz",
"host": master_host[0],
"port": master_host[1],
}
async with self.get_pool(connection_kwargs=connection_kwargs) as pool:
connection = await pool.get_connection()
assert isinstance(connection, DummyConnection)
assert connection.kwargs == connection_kwargs
async def test_disconnect(self, master_host):
"""A regression test for #1047"""
connection_kwargs = {
"foo": "bar",
"biz": "baz",
"host": master_host[0],
"port": master_host[1],
}
async with self.get_pool(connection_kwargs=connection_kwargs) as pool:
await pool.get_connection()
await pool.disconnect()
async def test_multiple_connections(self, master_host):
connection_kwargs = {"host": master_host[0], "port": master_host[1]}
async with self.get_pool(connection_kwargs=connection_kwargs) as pool:
c1 = await pool.get_connection()
c2 = await pool.get_connection()
assert c1 != c2
async def test_connection_pool_blocks_until_timeout(self, master_host):
"""When out of connections, block for timeout seconds, then raise"""
connection_kwargs = {"host": master_host[0]}
async with self.get_pool(
max_connections=1, timeout=0.1, connection_kwargs=connection_kwargs
) as pool:
c1 = await pool.get_connection()
start = asyncio.get_running_loop().time()
with pytest.raises(redis.ConnectionError):
await pool.get_connection()
# we should have waited at least some period of time
assert asyncio.get_running_loop().time() - start >= 0.05
await c1.disconnect()
async def test_connection_pool_blocks_until_conn_available(self, master_host):
"""
When out of connections, block until another connection is released
to the pool
"""
connection_kwargs = {"host": master_host[0], "port": master_host[1]}
async with self.get_pool(
max_connections=1, timeout=2, connection_kwargs=connection_kwargs
) as pool:
c1 = await pool.get_connection()
async def target():
await asyncio.sleep(0.1)
await pool.release(c1)
start = asyncio.get_running_loop().time()
await asyncio.gather(target(), pool.get_connection())
stop = asyncio.get_running_loop().time()
assert (stop - start) <= 0.2
async def test_reuse_previously_released_connection(self, master_host):
connection_kwargs = {"host": master_host[0]}
async with self.get_pool(connection_kwargs=connection_kwargs) as pool:
c1 = await pool.get_connection()
await pool.release(c1)
c2 = await pool.get_connection()
assert c1 == c2
def test_repr_contains_db_info_tcp(self):
pool = redis.ConnectionPool(
host="localhost", port=6379, client_name="test-client"
)
expected = "host=localhost,port=6379,client_name=test-client"
assert expected in repr(pool)
def test_repr_contains_db_info_unix(self):
pool = redis.ConnectionPool(
connection_class=redis.UnixDomainSocketConnection,
path="abc",
db=0,
client_name="test-client",
)
expected = "path=abc,db=0,client_name=test-client"
assert expected in repr(pool)
class TestConnectionPoolURLParsing:
def test_hostname(self):
pool = redis.ConnectionPool.from_url("redis://my.host")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "my.host"}
def test_quoted_hostname(self):
pool = redis.ConnectionPool.from_url("redis://my %2F host %2B%3D+")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "my / host +=+"}
def test_port(self):
pool = redis.ConnectionPool.from_url("redis://localhost:6380")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "port": 6380}
@skip_if_server_version_lt("6.0.0")
def test_username(self):
pool = redis.ConnectionPool.from_url("redis://myuser:@localhost")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "username": "myuser"}
@skip_if_server_version_lt("6.0.0")
def test_quoted_username(self):
pool = redis.ConnectionPool.from_url(
"redis://%2Fmyuser%2F%2B name%3D%24+:@localhost"
)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {
"host": "localhost",
"username": "/myuser/+ name=$+",
}
def test_password(self):
pool = redis.ConnectionPool.from_url("redis://:mypassword@localhost")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "password": "mypassword"}
def test_quoted_password(self):
pool = redis.ConnectionPool.from_url(
"redis://:%2Fmypass%2F%2B word%3D%24+@localhost"
)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {
"host": "localhost",
"password": "/mypass/+ word=$+",
}
@skip_if_server_version_lt("6.0.0")
def test_username_and_password(self):
pool = redis.ConnectionPool.from_url("redis://myuser:mypass@localhost")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {
"host": "localhost",
"username": "myuser",
"password": "mypass",
}
def test_db_as_argument(self):
pool = redis.ConnectionPool.from_url("redis://localhost", db=1)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "db": 1}
def test_db_in_path(self):
pool = redis.ConnectionPool.from_url("redis://localhost/2", db=1)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "db": 2}
def test_db_in_querystring(self):
pool = redis.ConnectionPool.from_url("redis://localhost/2?db=3", db=1)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "db": 3}
def test_extra_typed_querystring_options(self):
pool = redis.ConnectionPool.from_url(
"redis://localhost/2?socket_timeout=20&socket_connect_timeout=10"
"&socket_keepalive=&retry_on_timeout=Yes&max_connections=10"
)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {
"host": "localhost",
"db": 2,
"socket_timeout": 20.0,
"socket_connect_timeout": 10.0,
"retry_on_timeout": True,
}
assert pool.max_connections == 10
def test_boolean_parsing(self):
for expected, value in (
(None, None),
(None, ""),
(False, 0),
(False, "0"),
(False, "f"),
(False, "F"),
(False, "False"),
(False, "n"),
(False, "N"),
(False, "No"),
(True, 1),
(True, "1"),
(True, "y"),
(True, "Y"),
(True, "Yes"),
):
assert expected is to_bool(value)
def test_client_name_in_querystring(self):
pool = redis.ConnectionPool.from_url("redis://location?client_name=test-client")
assert pool.connection_kwargs["client_name"] == "test-client"
def test_invalid_extra_typed_querystring_options(self):
with pytest.raises(ValueError):
redis.ConnectionPool.from_url(
"redis://localhost/2?socket_timeout=_&socket_connect_timeout=abc"
)
def test_extra_querystring_options(self):
pool = redis.ConnectionPool.from_url("redis://localhost?a=1&b=2")
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {"host": "localhost", "a": "1", "b": "2"}
def test_calling_from_subclass_returns_correct_instance(self):
pool = redis.BlockingConnectionPool.from_url("redis://localhost")
assert isinstance(pool, redis.BlockingConnectionPool)
def test_client_creates_connection_pool(self):
r = redis.Redis.from_url("redis://myhost")
assert r.connection_pool.connection_class == redis.Connection
assert r.connection_pool.connection_kwargs == {"host": "myhost"}
def test_invalid_scheme_raises_error(self):
with pytest.raises(ValueError) as cm:
redis.ConnectionPool.from_url("localhost")
assert str(cm.value) == (
"Redis URL must specify one of the following schemes "
"(redis://, rediss://, unix://)"
)
class TestBlockingConnectionPoolURLParsing:
def test_extra_typed_querystring_options(self):
pool = redis.BlockingConnectionPool.from_url(
"redis://localhost/2?socket_timeout=20&socket_connect_timeout=10"
"&socket_keepalive=&retry_on_timeout=Yes&max_connections=10&timeout=13.37"
)
assert pool.connection_class == redis.Connection
assert pool.connection_kwargs == {
"host": "localhost",
"db": 2,
"socket_timeout": 20.0,
"socket_connect_timeout": 10.0,
"retry_on_timeout": True,
}
assert pool.max_connections == 10
assert pool.timeout == 13.37
def test_invalid_extra_typed_querystring_options(self):
with pytest.raises(ValueError):
redis.BlockingConnectionPool.from_url(
"redis://localhost/2?timeout=_not_a_float_"
)
class TestConnectionPoolUnixSocketURLParsing:
def test_defaults(self):
pool = redis.ConnectionPool.from_url("unix:///socket")
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {"path": "/socket"}
@skip_if_server_version_lt("6.0.0")
def test_username(self):
pool = redis.ConnectionPool.from_url("unix://myuser:@/socket")
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {"path": "/socket", "username": "myuser"}
@skip_if_server_version_lt("6.0.0")
def test_quoted_username(self):
pool = redis.ConnectionPool.from_url(
"unix://%2Fmyuser%2F%2B name%3D%24+:@/socket"
)
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {
"path": "/socket",
"username": "/myuser/+ name=$+",
}
def test_password(self):
pool = redis.ConnectionPool.from_url("unix://:mypassword@/socket")
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {"path": "/socket", "password": "mypassword"}
def test_quoted_password(self):
pool = redis.ConnectionPool.from_url(
"unix://:%2Fmypass%2F%2B word%3D%24+@/socket"
)
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {
"path": "/socket",
"password": "/mypass/+ word=$+",
}
def test_quoted_path(self):
pool = redis.ConnectionPool.from_url(
"unix://:mypassword@/my%2Fpath%2Fto%2F..%2F+_%2B%3D%24ocket"
)
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {
"path": "/my/path/to/../+_+=$ocket",
"password": "mypassword",
}
def test_db_as_argument(self):
pool = redis.ConnectionPool.from_url("unix:///socket", db=1)
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {"path": "/socket", "db": 1}
def test_db_in_querystring(self):
pool = redis.ConnectionPool.from_url("unix:///socket?db=2", db=1)
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {"path": "/socket", "db": 2}
def test_client_name_in_querystring(self):
pool = redis.ConnectionPool.from_url("redis://location?client_name=test-client")
assert pool.connection_kwargs["client_name"] == "test-client"
def test_extra_querystring_options(self):
pool = redis.ConnectionPool.from_url("unix:///socket?a=1&b=2")
assert pool.connection_class == redis.UnixDomainSocketConnection
assert pool.connection_kwargs == {"path": "/socket", "a": "1", "b": "2"}
class TestSSLConnectionURLParsing:
def test_host(self):
pool = redis.ConnectionPool.from_url("rediss://my.host")
assert pool.connection_class == redis.SSLConnection
assert pool.connection_kwargs == {"host": "my.host"}
def test_cert_reqs_options(self):
import ssl
class DummyConnectionPool(redis.ConnectionPool):
def get_connection(self):
return self.make_connection()
pool = DummyConnectionPool.from_url("rediss://?ssl_cert_reqs=none")
assert pool.get_connection().cert_reqs == ssl.CERT_NONE
pool = DummyConnectionPool.from_url("rediss://?ssl_cert_reqs=optional")
assert pool.get_connection().cert_reqs == ssl.CERT_OPTIONAL
pool = DummyConnectionPool.from_url("rediss://?ssl_cert_reqs=required")
assert pool.get_connection().cert_reqs == ssl.CERT_REQUIRED
pool = DummyConnectionPool.from_url("rediss://?ssl_check_hostname=False")
assert pool.get_connection().check_hostname is False
pool = DummyConnectionPool.from_url("rediss://?ssl_check_hostname=True")
assert pool.get_connection().check_hostname is True
class TestConnection:
async def test_on_connect_error(self):
"""
An error in Connection.on_connect should disconnect from the server
see for details: https://github.com/andymccurdy/redis-py/issues/368
"""
# this assumes the Redis server being tested against doesn't have
# 9999 databases ;)
bad_connection = redis.Redis(db=9999)
# an error should be raised on connect
with pytest.raises(redis.RedisError):
await bad_connection.info()
pool = bad_connection.connection_pool
assert len(pool._available_connections) == 1
assert not pool._available_connections[0]._reader
@pytest.mark.onlynoncluster
@skip_if_server_version_lt("2.8.8")
@skip_if_redis_enterprise()
async def test_busy_loading_disconnects_socket(self, r):
"""
If Redis raises a LOADING error, the connection should be
disconnected and a BusyLoadingError raised
"""
with pytest.raises(redis.BusyLoadingError):
await r.execute_command("DEBUG", "ERROR", "LOADING fake message")
if r.connection:
assert not r.connection._reader
@pytest.mark.onlynoncluster
@skip_if_server_version_lt("2.8.8")
@skip_if_redis_enterprise()
async def test_busy_loading_from_pipeline_immediate_command(self, r):
"""
BusyLoadingErrors should raise from Pipelines that execute a
command immediately, like WATCH does.
"""
pipe = r.pipeline()
with pytest.raises(redis.BusyLoadingError):
await pipe.immediate_execute_command(
"DEBUG", "ERROR", "LOADING fake message"
)
pool = r.connection_pool
assert pipe.connection
assert pipe.connection in pool._in_use_connections
assert not pipe.connection._reader
@pytest.mark.onlynoncluster
@skip_if_server_version_lt("2.8.8")
@skip_if_redis_enterprise()
async def test_busy_loading_from_pipeline(self, r):
"""
BusyLoadingErrors should be raised from a pipeline execution
regardless of the raise_on_error flag.
"""
pipe = r.pipeline()
pipe.execute_command("DEBUG", "ERROR", "LOADING fake message")
with pytest.raises(redis.BusyLoadingError):
await pipe.execute()
pool = r.connection_pool
assert not pipe.connection
assert len(pool._available_connections) == 1
assert not pool._available_connections[0]._reader
@skip_if_server_version_lt("2.8.8")
@skip_if_redis_enterprise()
async def test_read_only_error(self, r):
"""READONLY errors get turned into ReadOnlyError exceptions"""
with pytest.raises(redis.ReadOnlyError):
await r.execute_command("DEBUG", "ERROR", "READONLY blah blah")
@skip_if_redis_enterprise()
async def test_oom_error(self, r):
"""OOM errors get turned into OutOfMemoryError exceptions"""
with pytest.raises(redis.OutOfMemoryError):
# note: don't use the DEBUG OOM command since it's not the same
# as the db being full
await r.execute_command("DEBUG", "ERROR", "OOM blah blah")
def test_connect_from_url_tcp(self):
connection = redis.Redis.from_url("redis://localhost:6379?db=0")
pool = connection.connection_pool
assert re.match(
r"< .*?([^\.]+) \( < .*?([^\.]+) \( (.+) \) > \) >", repr(pool), re.VERBOSE
).groups() == (
"ConnectionPool",
"Connection",
"db=0,host=localhost,port=6379",
)
def test_connect_from_url_unix(self):
connection = redis.Redis.from_url("unix:///path/to/socket")
pool = connection.connection_pool
assert re.match(
r"< .*?([^\.]+) \( < .*?([^\.]+) \( (.+) \) > \) >", repr(pool), re.VERBOSE
).groups() == (
"ConnectionPool",
"UnixDomainSocketConnection",
"path=/path/to/socket",
)
@skip_if_redis_enterprise()
async def test_connect_no_auth_supplied_when_required(self, r):
"""
AuthenticationError should be raised when the server requires a
password but one isn't supplied.
"""
with pytest.raises(redis.AuthenticationError):
await r.execute_command(
"DEBUG", "ERROR", "ERR Client sent AUTH, but no password is set"
)
@skip_if_redis_enterprise()
async def test_connect_invalid_password_supplied(self, r):
"""AuthenticationError should be raised when sending the wrong password"""
with pytest.raises(redis.AuthenticationError):
await r.execute_command("DEBUG", "ERROR", "ERR invalid password")
@pytest.mark.onlynoncluster
class TestMultiConnectionClient:
@pytest_asyncio.fixture()
async def r(self, create_redis, server):
redis = await create_redis(single_connection_client=False)
yield redis
await redis.flushall()
@pytest.mark.onlynoncluster
@pytest.mark.xfail(strict=False)
class TestHealthCheck:
interval = 60
@pytest_asyncio.fixture()
async def r(self, create_redis):
redis = await create_redis(health_check_interval=self.interval)
yield redis
await redis.flushall()
def assert_interval_advanced(self, connection):
diff = connection.next_health_check - asyncio.get_running_loop().time()
assert self.interval >= diff > (self.interval - 1)
async def test_health_check_runs(self, r):
if r.connection:
r.connection.next_health_check = asyncio.get_running_loop().time() - 1
await r.connection.check_health()
self.assert_interval_advanced(r.connection)
async def test_arbitrary_command_invokes_health_check(self, r):
# invoke a command to make sure the connection is entirely setup
if r.connection:
await r.get("foo")
r.connection.next_health_check = asyncio.get_running_loop().time()
with mock.patch.object(
r.connection, "send_command", wraps=r.connection.send_command
) as m:
await r.get("foo")
m.assert_called_with("PING", check_health=False)
self.assert_interval_advanced(r.connection)
async def test_arbitrary_command_advances_next_health_check(self, r):
if r.connection:
await r.get("foo")
next_health_check = r.connection.next_health_check
# ensure that the event loop's `time()` advances a bit
await asyncio.sleep(0.001)
await r.get("foo")
assert next_health_check < r.connection.next_health_check
async def test_health_check_not_invoked_within_interval(self, r):
if r.connection:
await r.get("foo")
with mock.patch.object(
r.connection, "send_command", wraps=r.connection.send_command
) as m:
await r.get("foo")
ping_call_spec = (("PING",), {"check_health": False})
assert ping_call_spec not in m.call_args_list
async def test_health_check_in_pipeline(self, r):
async with r.pipeline(transaction=False) as pipe:
pipe.connection = await pipe.connection_pool.get_connection()
pipe.connection.next_health_check = 0
with mock.patch.object(
pipe.connection, "send_command", wraps=pipe.connection.send_command
) as m:
responses = await pipe.set("foo", "bar").get("foo").execute()
m.assert_any_call("PING", check_health=False)
assert responses == [True, b"bar"]
async def test_health_check_in_transaction(self, r):
async with r.pipeline(transaction=True) as pipe:
pipe.connection = await pipe.connection_pool.get_connection()
pipe.connection.next_health_check = 0
with mock.patch.object(
pipe.connection, "send_command", wraps=pipe.connection.send_command
) as m:
responses = await pipe.set("foo", "bar").get("foo").execute()
m.assert_any_call("PING", check_health=False)
assert responses == [True, b"bar"]
async def test_health_check_in_watched_pipeline(self, r):
await r.set("foo", "bar")
async with r.pipeline(transaction=False) as pipe:
pipe.connection = await pipe.connection_pool.get_connection()
pipe.connection.next_health_check = 0
with mock.patch.object(
pipe.connection, "send_command", wraps=pipe.connection.send_command
) as m:
await pipe.watch("foo")
# the health check should be called when watching
m.assert_called_with("PING", check_health=False)
self.assert_interval_advanced(pipe.connection)
assert await pipe.get("foo") == b"bar"
# reset the mock to clear the call list and schedule another
# health check
m.reset_mock()
pipe.connection.next_health_check = 0
pipe.multi()
responses = await pipe.set("foo", "not-bar").get("foo").execute()
assert responses == [True, b"not-bar"]
m.assert_any_call("PING", check_health=False)
async def test_health_check_in_pubsub_before_subscribe(self, r):
"""A health check happens before the first [p]subscribe"""
p = r.pubsub()
p.connection = await p.connection_pool.get_connection()
p.connection.next_health_check = 0
with mock.patch.object(
p.connection, "send_command", wraps=p.connection.send_command
) as m:
assert not p.subscribed
await p.subscribe("foo")
# the connection is not yet in pubsub mode, so the normal
# ping/pong within connection.send_command should check
# the health of the connection
m.assert_any_call("PING", check_health=False)
self.assert_interval_advanced(p.connection)
subscribe_message = await wait_for_message(p)
assert subscribe_message["type"] == "subscribe"
async def test_health_check_in_pubsub_after_subscribed(self, r):
"""
Pubsub can handle a new subscribe when it's time to check the
connection health
"""
p = r.pubsub()
p.connection = await p.connection_pool.get_connection()
p.connection.next_health_check = 0
with mock.patch.object(
p.connection, "send_command", wraps=p.connection.send_command
) as m:
await p.subscribe("foo")
subscribe_message = await wait_for_message(p)
assert subscribe_message["type"] == "subscribe"
self.assert_interval_advanced(p.connection)
# because we weren't subscribed when sending the subscribe
# message to 'foo', the connection's standard check_health ran
# prior to subscribing.
m.assert_any_call("PING", check_health=False)
p.connection.next_health_check = 0
m.reset_mock()
await p.subscribe("bar")
# the second subscribe issues exactly only command (the subscribe)
# and the health check is not invoked
m.assert_called_once_with("SUBSCRIBE", "bar", check_health=False)
# since no message has been read since the health check was
# reset, it should still be 0
assert p.connection.next_health_check == 0
subscribe_message = await wait_for_message(p)
assert subscribe_message["type"] == "subscribe"
assert await wait_for_message(p) is None
# now that the connection is subscribed, the pubsub health
# check should have taken over and include the HEALTH_CHECK_MESSAGE
m.assert_any_call("PING", p.HEALTH_CHECK_MESSAGE, check_health=False)
self.assert_interval_advanced(p.connection)
async def test_health_check_in_pubsub_poll(self, r):
"""
Polling a pubsub connection that's subscribed will regularly
check the connection's health.
"""
p = r.pubsub()
p.connection = await p.connection_pool.get_connection()
with mock.patch.object(
p.connection, "send_command", wraps=p.connection.send_command
) as m:
await p.subscribe("foo")
subscribe_message = await wait_for_message(p)
assert subscribe_message["type"] == "subscribe"
self.assert_interval_advanced(p.connection)
# polling the connection before the health check interval
# doesn't result in another health check
m.reset_mock()
next_health_check = p.connection.next_health_check
assert await wait_for_message(p) is None
assert p.connection.next_health_check == next_health_check
m.assert_not_called()
# reset the health check and poll again
# we should not receive a pong message, but the next_health_check
# should be advanced
p.connection.next_health_check = 0
assert await wait_for_message(p) is None
m.assert_called_with("PING", p.HEALTH_CHECK_MESSAGE, check_health=False)
self.assert_interval_advanced(p.connection)
|