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
|
import asyncio
import inspect
import random
import sys
from unittest.mock import ANY, create_autospec, patch
import pytest
from aiocache import cached, cached_stampede, multi_cached
from aiocache.backends.memory import SimpleMemoryCache
from aiocache.base import BaseCache, SENTINEL
from aiocache.decorators import _get_args_dict
from aiocache.lock import RedLock
async def stub(*args, value=None, seconds=0, **kwargs):
await asyncio.sleep(seconds)
if value:
return str(value)
return str(random.randint(1, 50))
class TestCached:
@pytest.fixture
def decorator(self, mock_cache):
with patch("aiocache.decorators._get_cache", autospec=True, return_value=mock_cache):
yield cached()
@pytest.fixture
def decorator_call(self, decorator):
d = decorator(stub)
yield d
@pytest.fixture(autouse=True)
def spy_stub(self, mocker):
module = sys.modules[globals()["__name__"]]
mocker.spy(module, "stub")
def test_init(self):
c = cached(
ttl=1,
key="key",
key_builder="fn",
cache=SimpleMemoryCache,
plugins=None,
alias=None,
noself=False,
namespace="test",
unused_kwarg="unused",
)
assert c.ttl == 1
assert c.key == "key"
assert c.key_builder == "fn"
assert c.cache is None
assert c._cache == SimpleMemoryCache
assert c._serializer is None
assert c._namespace == "test"
assert c._kwargs == {"unused_kwarg": "unused"}
def test_fails_at_instantiation(self):
with pytest.raises(TypeError):
@cached(wrong_param=1)
async def fn() -> None:
"""Dummy function."""
def test_alias_takes_precedence(self, mock_cache):
with patch(
"aiocache.decorators.caches.get", autospec=True, return_value=mock_cache
) as mock_get:
c = cached(alias="default", cache=SimpleMemoryCache, namespace="test")
c(stub)
mock_get.assert_called_with("default")
assert c.cache is mock_cache
def test_get_cache_key_with_key(self, decorator):
decorator.key = "key"
decorator.key_builder = "fn"
assert decorator.get_cache_key(stub, (1, 2), {"a": 1, "b": 2}) == "key"
def test_get_cache_key_without_key_and_attr(self, decorator):
assert (
decorator.get_cache_key(stub, (1, 2), {"a": 1, "b": 2})
== "stub(1, 2)[('a', 1), ('b', 2)]"
)
def test_get_cache_key_without_key_and_attr_noself(self, decorator):
decorator.noself = True
assert (
decorator.get_cache_key(stub, ("self", 1, 2), {"a": 1, "b": 2})
== "stub(1, 2)[('a', 1), ('b', 2)]"
)
def test_get_cache_key_with_key_builder(self, decorator):
decorator.key_builder = lambda *args, **kwargs: kwargs["market"].upper()
assert decorator.get_cache_key(stub, (), {"market": "es"}) == "ES"
async def test_calls_get_and_returns(self, decorator, decorator_call):
decorator.cache.get.return_value = 1
await decorator_call()
decorator.cache.get.assert_called_with("stub()[]")
assert decorator.cache.set.call_count == 0
assert stub.call_count == 0
async def test_cache_read_disabled(self, decorator, decorator_call):
await decorator_call(cache_read=False)
assert decorator.cache.get.call_count == 0
assert decorator.cache.set.call_count == 1
assert stub.call_count == 1
async def test_cache_write_disabled(self, decorator, decorator_call):
decorator.cache.get.return_value = None
await decorator_call(cache_write=False)
assert decorator.cache.get.call_count == 1
assert decorator.cache.set.call_count == 0
assert stub.call_count == 1
async def test_disable_params_not_propagated(self, decorator, decorator_call):
decorator.cache.get.return_value = None
await decorator_call(cache_read=False, cache_write=False)
stub.assert_called_once_with()
async def test_get_from_cache_returns(self, decorator, decorator_call):
decorator.cache.get.return_value = 1
assert await decorator.get_from_cache("key") == 1
async def test_get_from_cache_exception(self, decorator, decorator_call):
decorator.cache.get.side_effect = Exception
assert await decorator.get_from_cache("key") is None
async def test_get_from_cache_none(self, decorator, decorator_call):
decorator.cache.get.return_value = None
assert await decorator.get_from_cache("key") is None
async def test_calls_fn_set_when_get_none(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "get_from_cache")
mocker.spy(decorator, "set_in_cache")
decorator.cache.get.return_value = None
await decorator_call(value="value")
assert decorator.get_from_cache.call_count == 1
decorator.set_in_cache.assert_called_with("stub()[('value', 'value')]", "value")
stub.assert_called_once_with(value="value")
async def test_calls_fn_raises_exception(self, decorator, decorator_call):
decorator.cache.get.return_value = None
stub.side_effect = Exception()
with pytest.raises(Exception):
assert await decorator_call()
async def test_cache_write_waits_for_future(self, decorator, decorator_call):
with patch.object(decorator, "get_from_cache", autospec=True, return_value=None) as m:
await decorator_call()
m.assert_awaited()
async def test_cache_write_doesnt_wait_for_future(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "set_in_cache")
with patch.object(decorator, "get_from_cache", autospec=True, return_value=None):
with patch("aiocache.decorators.asyncio.ensure_future", autospec=True):
await decorator_call(aiocache_wait_for_write=False, value="value")
decorator.set_in_cache.assert_not_awaited()
decorator.set_in_cache.assert_called_once_with("stub()[('value', 'value')]", "value")
async def test_set_calls_set(self, decorator, decorator_call):
await decorator.set_in_cache("key", "value")
decorator.cache.set.assert_called_with("key", "value", ttl=SENTINEL)
async def test_set_calls_set_ttl(self, decorator, decorator_call):
decorator.ttl = 10
await decorator.set_in_cache("key", "value")
decorator.cache.set.assert_called_with("key", "value", ttl=decorator.ttl)
async def test_set_catches_exception(self, decorator, decorator_call):
decorator.cache.set.side_effect = Exception
assert await decorator.set_in_cache("key", "value") is None
async def test_decorate(self, mock_cache):
mock_cache.get.return_value = None
with patch("aiocache.decorators._get_cache", autospec=True, return_value=mock_cache):
@cached()
async def fn(n):
return n
assert await fn(1) == 1
assert await fn(2) == 2
assert fn.cache == mock_cache
async def test_keeps_signature(self, mock_cache):
with patch("aiocache.decorators._get_cache", autospec=True, return_value=mock_cache):
@cached()
async def what(self, a, b):
"""Dummy function."""
assert what.__name__ == "what"
assert str(inspect.signature(what)) == "(self, a, b)"
assert inspect.getfullargspec(what.__wrapped__).args == ["self", "a", "b"]
async def test_reuses_cache_instance(self):
with patch("aiocache.decorators._get_cache", autospec=True) as get_c:
cache = create_autospec(BaseCache, instance=True)
get_c.side_effect = [cache, None]
@cached()
async def what():
"""Dummy function."""
await what()
await what()
assert get_c.call_count == 1
assert cache.get.call_count == 2
async def test_cache_per_function(self):
@cached()
async def foo():
"""First function."""
@cached()
async def bar():
"""Second function."""
assert foo.cache != bar.cache
class TestCachedStampede:
@pytest.fixture
def decorator(self, mock_cache):
with patch("aiocache.decorators._get_cache", autospec=True, return_value=mock_cache):
yield cached_stampede()
@pytest.fixture
def decorator_call(self, decorator):
yield decorator(stub)
@pytest.fixture(autouse=True)
def spy_stub(self, mocker):
module = sys.modules[globals()["__name__"]]
mocker.spy(module, "stub")
def test_inheritance(self):
assert isinstance(cached_stampede(), cached)
def test_init(self):
c = cached_stampede(
lease=3,
ttl=1,
key="key",
key_builder="fn",
cache=SimpleMemoryCache,
plugins=None,
alias=None,
noself=False,
namespace="test",
unused_kwarg="unused",
)
assert c.ttl == 1
assert c.key == "key"
assert c.key_builder == "fn"
assert c.cache is None
assert c._cache == SimpleMemoryCache
assert c._serializer is None
assert c.lease == 3
assert c._namespace == "test"
assert c._kwargs == {"unused_kwarg": "unused"}
async def test_calls_get_and_returns(self, decorator, decorator_call):
decorator.cache.get.return_value = 1
await decorator_call()
decorator.cache.get.assert_called_with("stub()[]")
assert decorator.cache.set.call_count == 0
assert stub.call_count == 0
async def test_calls_fn_raises_exception(self, decorator, decorator_call):
decorator.cache.get.return_value = None
stub.side_effect = Exception()
with pytest.raises(Exception):
assert await decorator_call()
async def test_calls_redlock(self, decorator, decorator_call):
decorator.cache.get.return_value = None
lock = create_autospec(RedLock, instance=True)
with patch("aiocache.decorators.RedLock", autospec=True, return_value=lock):
await decorator_call(value="value")
assert decorator.cache.get.call_count == 2
assert lock.__aenter__.call_count == 1
assert lock.__aexit__.call_count == 1
decorator.cache.set.assert_called_with(
"stub()[('value', 'value')]", "value", ttl=SENTINEL
)
stub.assert_called_once_with(value="value")
async def test_calls_locked_client(self, decorator, decorator_call):
decorator.cache.get.side_effect = [None, None, None, "value"]
decorator.cache._add.side_effect = [True, ValueError]
lock1 = create_autospec(RedLock, instance=True)
lock2 = create_autospec(RedLock, instance=True)
with patch("aiocache.decorators.RedLock", autospec=True, side_effect=[lock1, lock2]):
await asyncio.gather(decorator_call(value="value"), decorator_call(value="value"))
assert decorator.cache.get.call_count == 4
assert lock1.__aenter__.call_count == 1
assert lock1.__aexit__.call_count == 1
assert lock2.__aenter__.call_count == 1
assert lock2.__aexit__.call_count == 1
decorator.cache.set.assert_called_with(
"stub()[('value', 'value')]", "value", ttl=SENTINEL
)
assert stub.call_count == 1
async def stub_dict(*args, keys=None, **kwargs):
values = {"a": random.randint(1, 50), "b": random.randint(1, 50), "c": random.randint(1, 50)}
return {k: values.get(k) for k in keys}
class TestMultiCached:
@pytest.fixture
def decorator(self, mock_cache):
with patch("aiocache.decorators._get_cache", autospec=True, return_value=mock_cache):
yield multi_cached(keys_from_attr="keys")
@pytest.fixture
def decorator_call(self, decorator):
d = decorator(stub_dict)
decorator._conn = decorator.cache.get_connection()
yield d
@pytest.fixture(autouse=True)
def spy_stub_dict(self, mocker):
module = sys.modules[globals()["__name__"]]
mocker.spy(module, "stub_dict")
def test_init(self):
mc = multi_cached(
keys_from_attr="keys",
key_builder=None,
ttl=1,
cache=SimpleMemoryCache,
plugins=None,
alias=None,
namespace="test",
unused_kwarg="unused",
)
def f():
"""Dummy function. Not called."""
assert mc.ttl == 1
assert mc.key_builder("key", f) == "key"
assert mc.keys_from_attr == "keys"
assert mc.cache is None
assert mc._cache == SimpleMemoryCache
assert mc._serializer is None
assert mc._namespace == "test"
assert mc._kwargs == {"unused_kwarg": "unused"}
def test_fails_at_instantiation(self):
with pytest.raises(TypeError):
@multi_cached(wrong_param=1)
async def fn() -> None:
"""Dummy function."""
def test_alias_takes_precedence(self, mock_cache):
with patch(
"aiocache.decorators.caches.get", autospec=True, return_value=mock_cache
) as mock_get:
mc = multi_cached(
keys_from_attr="keys", alias="default", cache=SimpleMemoryCache, namespace="test"
)
mc(stub_dict)
mock_get.assert_called_with("default")
assert mc.cache is mock_cache
def test_get_cache_keys(self, decorator):
keys = decorator.get_cache_keys(stub_dict, (), {"keys": ["a", "b"]})
assert keys == (["a", "b"], [], -1)
def test_get_cache_keys_empty_list(self, decorator):
assert decorator.get_cache_keys(stub_dict, (), {"keys": []}) == ([], [], -1)
def test_get_cache_keys_missing_kwarg(self, decorator):
assert decorator.get_cache_keys(stub_dict, (), {}) == ([], [], -1)
def test_get_cache_keys_arg_key_from_attr(self, decorator):
def fake(keys, a=1, b=2):
"""Dummy function."""
assert decorator.get_cache_keys(fake, (["a"]), {}) == (["a"], [["a"]], 0)
def test_get_cache_keys_with_none(self, decorator):
assert decorator.get_cache_keys(stub_dict, (), {"keys": None}) == ([], [], -1)
def test_get_cache_keys_with_key_builder(self, decorator):
decorator.key_builder = lambda key, *args, **kwargs: kwargs["market"] + "_" + key.upper()
assert decorator.get_cache_keys(stub_dict, (), {"keys": ["a", "b"], "market": "ES"}) == (
["ES_A", "ES_B"],
[],
-1,
)
async def test_get_from_cache(self, decorator, decorator_call):
decorator.cache.multi_get.return_value = [1, 2, 3]
assert await decorator.get_from_cache("a", "b", "c") == [1, 2, 3]
decorator.cache.multi_get.assert_called_with(("a", "b", "c"))
async def test_get_from_cache_no_keys(self, decorator, decorator_call):
assert await decorator.get_from_cache() == []
assert decorator.cache.multi_get.call_count == 0
async def test_get_from_cache_exception(self, decorator, decorator_call):
decorator.cache.multi_get.side_effect = Exception
assert await decorator.get_from_cache("a", "b", "c") == [None, None, None]
decorator.cache.multi_get.assert_called_with(("a", "b", "c"))
async def test_get_from_cache_conn(self, decorator, decorator_call):
decorator.cache.multi_get.return_value = [1, 2, 3]
assert await decorator.get_from_cache("a", "b", "c") == [1, 2, 3]
decorator.cache.multi_get.assert_called_with(("a", "b", "c"))
async def test_calls_no_keys(self, decorator, decorator_call):
await decorator_call(keys=[])
assert decorator.cache.multi_get.call_count == 0
assert stub_dict.call_count == 1
async def test_returns_from_multi_set(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "get_from_cache")
mocker.spy(decorator, "set_in_cache")
decorator.cache.multi_get.return_value = [1, 2]
assert await decorator_call(1, keys=["a", "b"]) == {"a": 1, "b": 2}
decorator.get_from_cache.assert_called_once_with("a", "b")
assert decorator.set_in_cache.call_count == 0
assert stub_dict.call_count == 0
async def test_calls_fn_multi_set_when_multi_get_none(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "get_from_cache")
mocker.spy(decorator, "set_in_cache")
decorator.cache.multi_get.return_value = [None, None]
ret = await decorator_call(1, keys=["a", "b"], value="value")
decorator.get_from_cache.assert_called_once_with("a", "b")
decorator.set_in_cache.assert_called_with(ret, stub_dict, ANY, ANY)
stub_dict.assert_called_once_with(1, keys=["a", "b"], value="value")
async def test_cache_write_waits_for_future(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "set_in_cache")
with patch.object(decorator, "get_from_cache", autospec=True, return_value=[None, None]):
await decorator_call(1, keys=["a", "b"], value="value")
decorator.set_in_cache.assert_awaited()
async def test_cache_write_doesnt_wait_for_future(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "set_in_cache")
with patch.object(decorator, "get_from_cache", autospec=True, return_value=[None, None]):
with patch("aiocache.decorators.asyncio.ensure_future", autospec=True):
await decorator_call(1, keys=["a", "b"], value="value",
aiocache_wait_for_write=False)
decorator.set_in_cache.assert_not_awaited()
decorator.set_in_cache.assert_called_once_with({"a": ANY, "b": ANY}, stub_dict, ANY, ANY)
async def test_calls_fn_with_only_missing_keys(self, mocker, decorator, decorator_call):
mocker.spy(decorator, "set_in_cache")
decorator.cache.multi_get.return_value = [1, None]
assert await decorator_call(1, keys=["a", "b"], value="value") == {"a": ANY, "b": ANY}
decorator.set_in_cache.assert_called_once_with({"a": ANY, "b": ANY}, stub_dict, ANY, ANY)
stub_dict.assert_called_once_with(1, keys=["b"], value="value")
async def test_calls_fn_raises_exception(self, decorator, decorator_call):
decorator.cache.multi_get.return_value = [None]
stub_dict.side_effect = Exception()
with pytest.raises(Exception):
assert await decorator_call(keys=[])
async def test_cache_read_disabled(self, decorator, decorator_call):
await decorator_call(1, keys=["a", "b"], cache_read=False)
assert decorator.cache.multi_get.call_count == 0
assert decorator.cache.multi_set.call_count == 1
assert stub_dict.call_count == 1
async def test_cache_write_disabled(self, decorator, decorator_call):
decorator.cache.multi_get.return_value = [None, None]
await decorator_call(1, keys=["a", "b"], cache_write=False)
assert decorator.cache.multi_get.call_count == 1
assert decorator.cache.multi_set.call_count == 0
assert stub_dict.call_count == 1
async def test_disable_params_not_propagated(self, decorator, decorator_call):
decorator.cache.multi_get.return_value = [None, None]
await decorator_call(1, keys=["a", "b"], cache_read=False, cache_write=False)
stub_dict.assert_called_once_with(1, keys=["a", "b"])
async def test_set_in_cache(self, decorator, decorator_call):
await decorator.set_in_cache({"a": 1, "b": 2}, stub_dict, (), {})
call_args = decorator.cache.multi_set.call_args[0][0]
assert ("a", 1) in call_args
assert ("b", 2) in call_args
assert decorator.cache.multi_set.call_args[1]["ttl"] is SENTINEL
async def test_set_in_cache_with_ttl(self, decorator, decorator_call):
decorator.ttl = 10
await decorator.set_in_cache({"a": 1, "b": 2}, stub_dict, (), {})
assert decorator.cache.multi_set.call_args[1]["ttl"] == decorator.ttl
async def test_set_in_cache_exception(self, decorator, decorator_call):
decorator.cache.multi_set.side_effect = Exception
assert await decorator.set_in_cache({"a": 1, "b": 2}, stub_dict, (), {}) is None
async def test_decorate(self, mock_cache):
mock_cache.multi_get.return_value = [None]
with patch("aiocache.decorators._get_cache", autospec=True, return_value=mock_cache):
@multi_cached(keys_from_attr="keys")
async def fn(keys=None):
return {"test": 1}
assert await fn(keys=["test"]) == {"test": 1}
assert await fn(["test"]) == {"test": 1}
assert fn.cache == mock_cache
async def test_keeps_signature(self):
@multi_cached(keys_from_attr="keys")
async def what(self, keys=None, what=1):
"""Dummy function."""
assert what.__name__ == "what"
assert str(inspect.signature(what)) == "(self, keys=None, what=1)"
assert inspect.getfullargspec(what.__wrapped__).args == ["self", "keys", "what"]
async def test_reuses_cache_instance(self):
with patch("aiocache.decorators._get_cache", autospec=True) as get_c:
cache = create_autospec(BaseCache, instance=True)
cache.multi_get.return_value = [None]
get_c.side_effect = [cache, None]
@multi_cached("keys")
async def what(keys=None):
return {}
await what(keys=["a"])
await what(keys=["a"])
assert get_c.call_count == 1
assert cache.multi_get.call_count == 2
async def test_cache_per_function(self):
@multi_cached("keys")
async def foo():
"""First function."""
@multi_cached("keys")
async def bar():
"""Second function."""
assert foo.cache != bar.cache
def test_get_args_dict():
def fn(a, b, *args, keys=None, **kwargs):
"""Dummy function."""
args_dict = _get_args_dict(fn, ("a", "b", "c", "d"), {"what": "what"})
assert args_dict == {"a": "a", "b": "b", "keys": None, "what": "what"}
|