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
|
from __future__ import annotations
import time
import pytest
from pytest_lazy_fixtures import lf
from limits import RateLimitItemPerMinute, RateLimitItemPerSecond
from limits.errors import ConfigurationError, StorageError
from limits.storage import (
EtcdStorage,
MemcachedStorage,
MemoryStorage,
MongoDBStorage,
MovingWindowSupport,
RedisClusterStorage,
RedisSentinelStorage,
RedisStorage,
SlidingWindowCounterSupport,
Storage,
storage_from_string,
)
from limits.strategies import MovingWindowRateLimiter, SlidingWindowCounterRateLimiter
from tests.utils import fixed_start
class TestBaseStorage:
@pytest.mark.parametrize(
"uri, args", [("blah://", {}), ("redis+sentinel://localhost:26379", {})]
)
def test_invalid_storage_string(self, uri, args):
with pytest.raises(ConfigurationError):
storage_from_string(uri, **args)
def test_pluggable_storage_fixed_only(self):
class MyStorage(Storage):
STORAGE_SCHEME = ["mystorage+fixed"]
@property
def base_exceptions(self):
return ValueError
def incr(self, key, expiry, elastic_expiry=False):
return
def get(self, key):
return 0
def get_expiry(self, key):
return time.time()
def reset(self):
return
def check(self):
return
def clear(self):
return
storage = storage_from_string("mystorage+fixed://")
assert isinstance(storage, MyStorage)
with pytest.raises(NotImplementedError):
MovingWindowRateLimiter(storage)
with pytest.raises(NotImplementedError):
SlidingWindowCounterRateLimiter(storage)
def test_pluggable_storage_moving_window(self):
class MyStorage(Storage, MovingWindowSupport):
STORAGE_SCHEME = ["mystorage+moving"]
@property
def base_exceptions(self):
return ValueError
def incr(self, key, expiry, elastic_expiry=False):
return
def get(self, key):
return 0
def get_expiry(self, key):
return time.time()
def reset(self):
return
def check(self):
return
def clear(self):
return
def acquire_entry(self, *a, **k):
return True
def get_moving_window(self, *a, **k):
return (time.time(), 1)
storage = storage_from_string("mystorage+moving://")
assert isinstance(storage, MyStorage)
MovingWindowRateLimiter(storage)
def test_pluggable_storage_sliding_window_counter(self):
class MyStorage(Storage, SlidingWindowCounterSupport):
STORAGE_SCHEME = ["mystorage+sliding"]
@property
def base_exceptions(self):
return ValueError
def incr(self, key, expiry, elastic_expiry=False):
return
def get(self, key):
return 0
def get_expiry(self, key):
return time.time()
def reset(self):
return
def check(self):
return
def clear(self):
return
def acquire_sliding_window_entry(
self, key: str, limit: int, expiry: int, amount: int = 1
) -> bool:
pass
def get_sliding_window(
self, key: str, expiry: int
) -> tuple[int, float, int, float]:
pass
storage = storage_from_string("mystorage+sliding://")
assert isinstance(storage, MyStorage)
SlidingWindowCounterRateLimiter(storage)
@pytest.mark.parametrize(
"uri, args, expected_instance, fixture",
[
pytest.param("memory://", {}, MemoryStorage, None, id="in-memory"),
pytest.param(
"redis://localhost:7379",
{},
RedisStorage,
lf("redis_basic"),
marks=pytest.mark.redis,
id="redis",
),
pytest.param(
"redis+unix:///tmp/limits.redis.sock",
{},
RedisStorage,
lf("redis_uds"),
marks=pytest.mark.redis,
id="redis-uds",
),
pytest.param(
"redis+unix://:password/tmp/limits.redis.sock",
{},
RedisStorage,
lf("redis_uds"),
marks=pytest.mark.redis,
id="redis-uds-auth",
),
pytest.param(
"memcached://localhost:22122",
{},
MemcachedStorage,
lf("memcached"),
marks=pytest.mark.memcached,
id="memcached",
),
pytest.param(
"memcached://localhost:22122,localhost:22123",
{},
MemcachedStorage,
lf("memcached_cluster"),
marks=pytest.mark.memcached,
id="memcached-cluster",
),
pytest.param(
"memcached:///tmp/limits.memcached.sock",
{},
MemcachedStorage,
lf("memcached_uds"),
marks=pytest.mark.memcached,
id="memcached-uds",
),
pytest.param(
"redis+sentinel://localhost:26379",
{"service_name": "mymaster"},
RedisSentinelStorage,
lf("redis_sentinel"),
marks=pytest.mark.redis_sentinel,
id="redis-sentinel",
),
pytest.param(
"redis+sentinel://localhost:26379/mymaster",
{},
RedisSentinelStorage,
lf("redis_sentinel"),
marks=pytest.mark.redis_sentinel,
id="redis-sentinel-service-name-url",
),
pytest.param(
"redis+sentinel://:sekret@localhost:36379/mymaster",
{"password": "sekret"},
RedisSentinelStorage,
lf("redis_sentinel_auth"),
marks=pytest.mark.redis_sentinel,
id="redis-sentinel-auth",
),
pytest.param(
"redis+cluster://localhost:7001/",
{},
RedisClusterStorage,
lf("redis_cluster"),
marks=pytest.mark.redis_cluster,
id="redis-cluster",
),
pytest.param(
"redis+cluster://:sekret@localhost:8400/",
{},
RedisClusterStorage,
lf("redis_auth_cluster"),
marks=pytest.mark.redis_cluster,
id="redis-cluster-auth",
),
pytest.param(
"mongodb://localhost:37017/",
{},
MongoDBStorage,
lf("mongodb"),
marks=pytest.mark.mongodb,
id="mongodb",
),
pytest.param(
"etcd://localhost:2379",
{},
EtcdStorage,
lf("etcd"),
marks=pytest.mark.etcd,
id="etcd",
),
],
)
class TestConcreteStorages:
def test_storage_string(self, uri, args, expected_instance, fixture):
assert isinstance(storage_from_string(uri, **args), expected_instance)
@fixed_start
def test_expiry_incr(self, uri, args, expected_instance, fixture):
storage = storage_from_string(uri, **args)
limit = RateLimitItemPerSecond(1)
storage.incr(limit.key_for(), limit.get_expiry())
time.sleep(1.1)
assert storage.get(limit.key_for()) == 0
@fixed_start
def test_expiry_acquire_entry(self, uri, args, expected_instance, fixture):
if not issubclass(expected_instance, MovingWindowSupport):
pytest.skip(f"{expected_instance} does not support acquire entry")
storage = storage_from_string(uri, **args)
limit = RateLimitItemPerSecond(1)
assert storage.acquire_entry(limit.key_for(), limit.amount, limit.get_expiry())
time.sleep(1.1)
assert storage.get(limit.key_for()) == 0
@fixed_start
def test_expiry_acquire_sliding_window_entry(
self, uri, args, expected_instance, fixture
):
if not issubclass(expected_instance, SlidingWindowCounterSupport):
pytest.skip(f"{expected_instance} does not support acquire entry")
storage = storage_from_string(uri, **args)
limit = RateLimitItemPerSecond(1)
assert storage.acquire_sliding_window_entry(
limit.key_for(), limit.amount, limit.get_expiry()
)
assert storage.get_sliding_window(limit.key_for(), limit.get_expiry())[
-1
] == pytest.approx(2, abs=1e2)
def test_incr_custom_amount(self, uri, args, expected_instance, fixture):
storage = storage_from_string(uri, **args)
limit = RateLimitItemPerMinute(1)
assert 1 == storage.incr(limit.key_for(), limit.get_expiry(), amount=1)
assert 11 == storage.incr(limit.key_for(), limit.get_expiry(), amount=10)
def test_acquire_entry_custom_amount(self, uri, args, expected_instance, fixture):
if not issubclass(expected_instance, MovingWindowSupport):
pytest.skip(f"{expected_instance} does not support acquire entry")
storage = storage_from_string(uri, **args)
limit = RateLimitItemPerMinute(10)
assert not storage.acquire_entry(
limit.key_for(), limit.amount, limit.get_expiry(), amount=11
)
assert storage.acquire_entry(
limit.key_for(), limit.amount, limit.get_expiry(), amount=1
)
assert not storage.acquire_entry(
limit.key_for(), limit.amount, limit.get_expiry(), amount=10
)
def test_storage_check(self, uri, args, expected_instance, fixture):
assert storage_from_string(uri, **args).check()
def test_storage_reset(self, uri, args, expected_instance, fixture):
if expected_instance == MemcachedStorage:
pytest.skip("Reset not supported for memcached")
limit1 = RateLimitItemPerMinute(10) # default namespace, LIMITER
limit2 = RateLimitItemPerMinute(10, namespace="OTHER")
storage = storage_from_string(uri, **args)
for i in range(10):
storage.incr(limit1.key_for(str(i)), limit1.get_expiry())
storage.incr(limit2.key_for(str(i)), limit2.get_expiry())
assert storage.reset() == 20
def test_storage_clear(self, uri, args, expected_instance, fixture):
limit = RateLimitItemPerMinute(10)
storage = storage_from_string(uri, **args)
storage.incr(limit.key_for(), limit.get_expiry())
assert 1 == storage.get(limit.key_for())
storage.clear(limit.key_for())
assert 0 == storage.get(limit.key_for())
@pytest.mark.parametrize("wrap_exceptions", (True, False))
class TestStorageErrors:
class MyStorage(Storage, MovingWindowSupport, SlidingWindowCounterSupport):
STORAGE_SCHEME = ["mystorage"]
class MyError(Exception):
pass
@property
def base_exceptions(self):
return self.MyError
def incr(self, key, expiry, elastic_expiry=False, amount=1):
raise self.MyError()
def get(self, key):
raise self.MyError()
def get_expiry(self, key):
raise self.MyError()
def reset(self):
raise self.MyError()
def check(self):
raise self.MyError()
def clear(self, key):
raise self.MyError()
def acquire_entry(self, key, limit, expiry, amount=1):
raise self.MyError()
def get_moving_window(self, key, limit, expiry):
raise self.MyError()
def acquire_sliding_window_entry(
self, key: str, limit: int, expiry: int, amount: int = 1
) -> bool:
raise self.MyError()
def get_sliding_window(
self, key: str, expiry: int
) -> tuple[int, float, int, float]:
raise self.MyError()
def assert_exception(self, exc, wrap_exceptions):
if wrap_exceptions:
assert isinstance(exc, StorageError)
assert isinstance(exc.storage_error, self.MyStorage.MyError)
else:
assert isinstance(exc, self.MyStorage.MyError)
def test_incr_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).incr("", 1)
self.assert_exception(exc.value, wrap_exceptions)
def test_get_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).get("")
self.assert_exception(exc.value, wrap_exceptions)
def test_get_expiry_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).get_expiry("")
self.assert_exception(exc.value, wrap_exceptions)
def test_reset_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).reset()
self.assert_exception(exc.value, wrap_exceptions)
def test_check_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).check()
self.assert_exception(exc.value, wrap_exceptions)
def test_clear_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).clear("")
self.assert_exception(exc.value, wrap_exceptions)
def test_acquire_entry_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).acquire_entry("", 1, 1)
self.assert_exception(exc.value, wrap_exceptions)
def test_get_moving_window_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).get_moving_window("", 1, 1)
self.assert_exception(exc.value, wrap_exceptions)
def test_acquire_sliding_entry_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(
wrap_exceptions=wrap_exceptions
).acquire_sliding_window_entry("", 1, 1)
self.assert_exception(exc.value, wrap_exceptions)
def test_get_sliding_window_exception(self, wrap_exceptions):
with pytest.raises(Exception) as exc:
self.MyStorage(wrap_exceptions=wrap_exceptions).get_sliding_window("", 1)
self.assert_exception(exc.value, wrap_exceptions)
|
