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
|
"""Common tests to run for all backends (BaseStorage subclasses)"""
from concurrent.futures import ThreadPoolExecutor
from datetime import datetime
from typing import Dict, Type
import pytest
from attrs import define, field
from requests_cache.backends import BaseStorage
from requests_cache.models import CachedResponse
from tests.conftest import CACHE_NAME, N_ITERATIONS, N_REQUESTS_PER_ITERATION, N_WORKERS
class BaseStorageTest:
"""Base class for testing cache storage dict-like interfaces"""
storage_class: Type[BaseStorage] = None
init_kwargs: Dict = {}
num_instances: int = 10 # Max number of cache instances to test
def init_cache(self, cache_name=CACHE_NAME, index=0, clear=True, **kwargs):
kwargs = {**self.init_kwargs, **kwargs}
cache = self.storage_class(cache_name, f'table_{index}', **kwargs)
if clear:
cache.clear()
return cache
def teardown_class(cls):
for i in range(cls.num_instances):
cls().init_cache(index=i, clear=True)
def test_basic_methods(self):
"""Test basic dict methods with multiple cache instances:
``getitem, setitem, delitem, len, contains``
"""
caches = [self.init_cache(index=i) for i in range(10)]
for i in range(self.num_instances):
caches[i][f'key_{i}'] = f'value_{i}'
caches[i][f'key_{i+1}'] = f'value_{i+1}'
for i in range(self.num_instances):
cache = caches[i]
assert cache[f'key_{i}'] == f'value_{i}'
assert len(cache) == 2
assert f'key_{i}' in cache and f'key_{i+1}' in cache
del cache[f'key_{i}']
assert f'key_{i}' not in cache
def test_iterable_methods(self):
"""Test iterable dict methods with multiple cache instances:
``iter, keys, values, items``
"""
caches = [self.init_cache(index=i) for i in range(self.num_instances)]
for i in range(self.num_instances):
caches[i][f'key_{i}'] = f'value_{i}'
for i in range(self.num_instances):
cache = caches[i]
assert list(cache) == [f'key_{i}']
assert list(cache.keys()) == [f'key_{i}']
assert list(cache.values()) == [f'value_{i}']
assert list(cache.items()) == [(f'key_{i}', f'value_{i}')]
assert dict(cache) == {f'key_{i}': f'value_{i}'}
def test_cache_key(self):
"""The cache_key attribute should be available on responses returned from all
mapping/collection methods
"""
cache = self.init_cache()
cache['key'] = CachedResponse()
assert cache['key'].cache_key == 'key'
assert list(cache.values())[0].cache_key == 'key'
assert list(cache.items())[0][1].cache_key == 'key'
def test_del(self):
"""Some more tests to ensure ``delitem`` deletes only the expected items"""
cache = self.init_cache()
for i in range(20):
cache[f'key_{i}'] = f'value_{i}'
for i in range(5):
del cache[f'key_{i}']
assert len(cache) == 15
assert set(cache.keys()) == {f'key_{i}' for i in range(5, 20)}
assert set(cache.values()) == {f'value_{i}' for i in range(5, 20)}
def test_bulk_delete(self):
cache = self.init_cache()
for i in range(20):
cache[f'key_{i}'] = f'value_{i}'
cache.bulk_delete([f'key_{i}' for i in range(5)])
cache.bulk_delete(['nonexistent_key'])
assert len(cache) == 15
assert set(cache.keys()) == {f'key_{i}' for i in range(5, 20)}
assert set(cache.values()) == {f'value_{i}' for i in range(5, 20)}
def test_bulk_delete__noop(self):
"""Just make sure bulk_delete doesn't do anything unexpected if no keys are provided"""
cache = self.init_cache()
for i in range(20):
cache[f'key_{i}'] = f'value_{i}'
cache.bulk_delete([])
assert len(cache) == 20
def test_keyerrors(self):
"""Accessing or deleting a deleted item should raise a KeyError"""
cache = self.init_cache()
cache['key'] = 'value'
del cache['key']
with pytest.raises(KeyError):
del cache['key']
with pytest.raises(KeyError):
cache['key']
def test_picklable_dict(self):
cache = self.init_cache(serializer='pickle')
original_obj = BasicDataclass(
bool_attr=True,
datetime_attr=datetime(2022, 2, 2),
int_attr=2,
str_attr='value',
)
cache['key_1'] = original_obj
obj = cache['key_1']
assert obj.bool_attr == original_obj.bool_attr
assert obj.datetime_attr == original_obj.datetime_attr
assert obj.int_attr == original_obj.int_attr
assert obj.str_attr == original_obj.str_attr
def test_clear_and_work_again(self):
cache_1 = self.init_cache()
cache_2 = self.init_cache(connection=getattr(cache_1, 'connection', None))
for i in range(5):
cache_1[f'key_{i}'] = f'value_{i}'
cache_2[f'key_{i}'] = f'value_{i}'
assert len(cache_1) == len(cache_2) == 5
cache_1.clear()
cache_2.clear()
assert len(cache_1) == len(cache_2) == 0
def test_same_settings(self):
cache_1 = self.init_cache()
cache_2 = self.init_cache(connection=getattr(cache_1, 'connection', None))
cache_1['key_1'] = 'value_1'
cache_2['key_2'] = 'value_2'
assert cache_1 == cache_2
def test_str(self):
"""Not much to test for __str__ methods, just make sure they return keys in some format"""
cache = self.init_cache()
for i in range(10):
cache[f'key_{i}'] = f'value_{i}'
for i in range(10):
assert f'key_{i}' in str(cache)
def test_concurrency(self):
"""Test a large number of concurrent write operations for each backend"""
cache = self.init_cache()
def write(i):
cache[f'key_{i}'] = f'value_{i}'
n_iterations = N_ITERATIONS * N_REQUESTS_PER_ITERATION * 10
with ThreadPoolExecutor(max_workers=N_WORKERS * 2) as executor:
_ = list(executor.map(write, range(n_iterations)))
@define
class BasicDataclass:
bool_attr: bool = field(default=None)
datetime_attr: datetime = field(default=None)
int_attr: int = field(default=None)
str_attr: str = field(default=None)
|
