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
|
import asyncio
from datetime import datetime, timezone
from time import sleep
from unittest.mock import Mock
import pytest
from redis.auth.err import RequestTokenErr, TokenRenewalErr
from redis.auth.idp import IdentityProviderInterface
from redis.auth.token import SimpleToken
from redis.auth.token_manager import (
CredentialsListener,
RetryPolicy,
TokenManager,
TokenManagerConfig,
)
class TestTokenManager:
@pytest.mark.parametrize(
"exp_refresh_ratio",
[
0.9,
0.28,
],
ids=[
"Refresh ratio = 0.9",
"Refresh ratio = 0.28",
],
)
def test_success_token_renewal(self, exp_refresh_ratio):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 150,
(datetime.now(timezone.utc).timestamp() * 1000) + 50,
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 170,
(datetime.now(timezone.utc).timestamp() * 1000) + 70,
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 190,
(datetime.now(timezone.utc).timestamp() * 1000) + 90,
{"oid": "test"},
),
]
def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(exp_refresh_ratio, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener)
sleep(0.1)
assert len(tokens) > 0
@pytest.mark.parametrize(
"exp_refresh_ratio",
[
(0.9),
(0.28),
],
ids=[
"Refresh ratio = 0.9",
"Refresh ratio = 0.28",
],
)
@pytest.mark.asyncio
async def test_async_success_token_renewal(self, exp_refresh_ratio):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 130,
(datetime.now(timezone.utc).timestamp() * 1000) + 30,
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 160,
(datetime.now(timezone.utc).timestamp() * 1000) + 60,
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 190,
(datetime.now(timezone.utc).timestamp() * 1000) + 90,
{"oid": "test"},
),
]
async def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(exp_refresh_ratio, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=True)
await asyncio.sleep(0.1)
assert len(tokens) > 0
@pytest.mark.parametrize(
"block_for_initial,tokens_acquired",
[
(True, 1),
(False, 0),
],
ids=[
"Block for initial, callback will triggered once",
"Non blocked, callback wont be triggered",
],
)
@pytest.mark.asyncio
async def test_async_request_token_blocking_behaviour(
self, block_for_initial, tokens_acquired
):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
)
async def on_next(token):
nonlocal tokens
sleep(0.1)
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=block_for_initial)
assert len(tokens) == tokens_acquired
def test_token_renewal_with_skip_initial(self):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 50,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 150,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
]
def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(3, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener, skip_initial=True)
# Should be less than a 0.1, or it will be flacky due to
# additional token renewal.
sleep(0.1)
assert len(tokens) > 0
@pytest.mark.asyncio
async def test_async_token_renewal_with_skip_initial(self):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 120,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 140,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
]
async def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(3, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, skip_initial=True)
# Should be less than a 0.1, or it will be flacky
# due to additional token renewal.
await asyncio.sleep(0.2)
assert len(tokens) > 0
def test_success_token_renewal_with_retry(self):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
RequestTokenErr,
RequestTokenErr,
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
]
def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(3, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener)
# Should be less than a 0.1, or it will be flacky
# due to additional token renewal.
sleep(0.08)
assert mock_provider.request_token.call_count > 0
assert len(tokens) > 0
@pytest.mark.asyncio
async def test_async_success_token_renewal_with_retry(self):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
RequestTokenErr,
RequestTokenErr,
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 100,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
),
]
async def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
mock_listener.on_error = None
retry_policy = RetryPolicy(3, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=True)
# Should be less than a 0.1, or it will be flacky
# due to additional token renewal.
await asyncio.sleep(0.08)
assert mock_provider.request_token.call_count > 0
assert len(tokens) > 0
def test_no_token_renewal_on_process_complete(self):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 1000,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
)
def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(0.9, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener)
sleep(0.2)
assert len(tokens) == 1
@pytest.mark.asyncio
async def test_async_no_token_renewal_on_process_complete(self):
tokens = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 1000,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
)
async def on_next(token):
nonlocal tokens
tokens.append(token)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(0.9, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=True)
await asyncio.sleep(0.2)
assert len(tokens) == 1
def test_failed_token_renewal_with_retry(self):
tokens = []
exceptions = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
RequestTokenErr,
RequestTokenErr,
RequestTokenErr,
RequestTokenErr,
]
def on_next(token):
nonlocal tokens
tokens.append(token)
def on_error(exception):
nonlocal exceptions
exceptions.append(exception)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
mock_listener.on_error = on_error
retry_policy = RetryPolicy(3, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener)
sleep(0.1)
assert mock_provider.request_token.call_count == 4
assert len(tokens) == 0
assert len(exceptions) == 1
@pytest.mark.asyncio
async def test_async_failed_token_renewal_with_retry(self):
tokens = []
exceptions = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.side_effect = [
RequestTokenErr,
RequestTokenErr,
RequestTokenErr,
RequestTokenErr,
]
async def on_next(token):
nonlocal tokens
tokens.append(token)
async def on_error(exception):
nonlocal exceptions
exceptions.append(exception)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
mock_listener.on_error = on_error
retry_policy = RetryPolicy(3, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=True)
sleep(0.1)
assert mock_provider.request_token.call_count == 4
assert len(tokens) == 0
assert len(exceptions) == 1
def test_failed_renewal_on_expired_token(self):
errors = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) - 100,
(datetime.now(timezone.utc).timestamp() * 1000) - 1000,
{"oid": "test"},
)
def on_error(error: TokenRenewalErr):
nonlocal errors
errors.append(error)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_error = on_error
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener)
assert len(errors) == 1
assert isinstance(errors[0], TokenRenewalErr)
assert str(errors[0]) == "Requested token is expired"
@pytest.mark.asyncio
async def test_async_failed_renewal_on_expired_token(self):
errors = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) - 100,
(datetime.now(timezone.utc).timestamp() * 1000) - 1000,
{"oid": "test"},
)
async def on_error(error: TokenRenewalErr):
nonlocal errors
errors.append(error)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_error = on_error
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=True)
assert len(errors) == 1
assert isinstance(errors[0], TokenRenewalErr)
assert str(errors[0]) == "Requested token is expired"
def test_failed_renewal_on_callback_error(self):
errors = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 1000,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
)
def on_next(token):
raise Exception("Some exception")
def on_error(error):
nonlocal errors
errors.append(error)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
mock_listener.on_error = on_error
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
mgr.start(mock_listener)
assert len(errors) == 1
assert isinstance(errors[0], TokenRenewalErr)
assert str(errors[0]) == "Some exception"
@pytest.mark.asyncio
async def test_async_failed_renewal_on_callback_error(self):
errors = []
mock_provider = Mock(spec=IdentityProviderInterface)
mock_provider.request_token.return_value = SimpleToken(
"value",
(datetime.now(timezone.utc).timestamp() * 1000) + 1000,
(datetime.now(timezone.utc).timestamp() * 1000),
{"oid": "test"},
)
async def on_next(token):
raise Exception("Some exception")
async def on_error(error):
nonlocal errors
errors.append(error)
mock_listener = Mock(spec=CredentialsListener)
mock_listener.on_next = on_next
mock_listener.on_error = on_error
retry_policy = RetryPolicy(1, 10)
config = TokenManagerConfig(1, 0, 1000, retry_policy)
mgr = TokenManager(mock_provider, config)
await mgr.start_async(mock_listener, block_for_initial=True)
assert len(errors) == 1
assert isinstance(errors[0], TokenRenewalErr)
assert str(errors[0]) == "Some exception"
|
