Repository navigation
Expand file tree
/
Copy pathtest_manager.py
More file actions
798 lines (684 loc) · 37.6 KB
/
Copy pathtest_manager.py
File metadata and controls
798 lines (684 loc) · 37.6 KB
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
"""Push notification manager tests."""
#pylint:disable=no-self-use,protected-access
from threading import Thread
from queue import Queue
import pytest
from splitio.api import APIException
from splitio.models.token import Token
from splitio.push.sse import SSEEvent
from splitio.push.parser import parse_incoming_event, EventType, ControlType, ControlMessage, \
OccupancyMessage, SplitChangeUpdate, SplitKillUpdate, SegmentChangeUpdate
from splitio.push.processor import MessageProcessor, MessageProcessorAsync
from splitio.push.status_tracker import PushStatusTracker
from splitio.push.manager import PushManager, PushManagerAsync, _TOKEN_REFRESH_GRACE_PERIOD
from splitio.push.splitsse import SplitSSEClient, SplitSSEClientAsync
from splitio.push.status_tracker import Status
from splitio.engine.telemetry import TelemetryStorageProducer, TelemetryStorageProducerAsync
from splitio.storage.inmemmory import InMemoryTelemetryStorage, InMemoryTelemetryStorageAsync
from splitio.models.telemetry import StreamingEventTypes
from splitio.optional.loaders import asyncio
from tests.helpers import Any
class PushManagerTests(object):
"""Parser tests."""
def test_connection_success(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(True, 'abc', {}, 2000000, 1000000)
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_constructor_mock = mocker.Mock()
sse_constructor_mock.return_value = sse_mock
timer_mock = mocker.Mock()
mocker.patch('splitio.push.manager.Timer', new=timer_mock)
mocker.patch('splitio.push.manager.SplitSSEClient', new=sse_constructor_mock)
feedback_loop = Queue()
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManager(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
def new_start(*args, **kwargs): # pylint: disable=unused-argument
"""splitsse.start mock."""
thread = Thread(target=manager._handle_connection_ready, daemon=True)
thread.start()
return True
sse_mock.start.side_effect = new_start
manager.start()
assert feedback_loop.get() == Status.PUSH_SUBSYSTEM_UP
assert timer_mock.mock_calls == [
mocker.call(0, Any()),
mocker.call().cancel(),
mocker.call(1000000 - _TOKEN_REFRESH_GRACE_PERIOD, manager._token_refresh),
mocker.call().setName('TokenRefresh'),
mocker.call().start()
]
assert(telemetry_storage._streaming_events._streaming_events[0]._type == StreamingEventTypes.TOKEN_REFRESH.value)
assert(telemetry_storage._streaming_events._streaming_events[1]._type == StreamingEventTypes.CONNECTION_ESTABLISHED.value)
def test_connection_failure(self, mocker):
"""Test the connection fails to be established."""
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(True, 'abc', {}, 2000000, 1000000)
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_constructor_mock = mocker.Mock()
sse_constructor_mock.return_value = sse_mock
timer_mock = mocker.Mock()
mocker.patch('splitio.push.manager.Timer', new=timer_mock)
mocker.patch('splitio.push.manager.SplitSSEClient', new=sse_constructor_mock)
feedback_loop = Queue()
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManager(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
def new_start(*args, **kwargs): # pylint: disable=unused-argument
"""splitsse.start mock."""
thread = Thread(target=manager._handle_connection_end, daemon=True)
thread.start()
return False
sse_mock.start.side_effect = new_start
manager.start()
assert feedback_loop.get() == Status.PUSH_RETRYABLE_ERROR
assert timer_mock.mock_calls == [mocker.call(0, Any())]
def test_empty_auth_respnse(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(False, None, None, None, None)
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_constructor_mock = mocker.Mock()
sse_constructor_mock.return_value = sse_mock
timer_mock = mocker.Mock()
mocker.patch('splitio.push.manager.Timer', new=timer_mock)
mocker.patch('splitio.push.manager.SplitSSEClient', new=sse_constructor_mock)
feedback_loop = Queue()
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManager(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager.start()
assert feedback_loop.get() == Status.PUSH_NONRETRYABLE_ERROR
assert timer_mock.mock_calls == [mocker.call(0, Any())]
assert sse_mock.mock_calls == []
def test_push_disabled(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(False, 'abc', {}, 1, 2)
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_constructor_mock = mocker.Mock()
sse_constructor_mock.return_value = sse_mock
timer_mock = mocker.Mock()
mocker.patch('splitio.push.manager.Timer', new=timer_mock)
mocker.patch('splitio.push.manager.SplitSSEClient', new=sse_constructor_mock)
feedback_loop = Queue()
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManager(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager.start()
assert feedback_loop.get() == Status.PUSH_NONRETRYABLE_ERROR
assert timer_mock.mock_calls == [mocker.call(0, Any())]
assert sse_mock.mock_calls == []
def test_auth_apiexception(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
api_mock.authenticate.side_effect = APIException('something')
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_constructor_mock = mocker.Mock()
sse_constructor_mock.return_value = sse_mock
timer_mock = mocker.Mock()
mocker.patch('splitio.push.manager.Timer', new=timer_mock)
mocker.patch('splitio.push.manager.SplitSSEClient', new=sse_constructor_mock)
feedback_loop = Queue()
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManager(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager.start()
assert feedback_loop.get() == Status.PUSH_RETRYABLE_ERROR
assert timer_mock.mock_calls == [mocker.call(0, Any())]
assert sse_mock.mock_calls == []
def _build_manager(self, mocker, api_mock, sse_mock, timer_mock, feedback_loop):
sse_constructor_mock = mocker.Mock()
sse_constructor_mock.return_value = sse_mock
mocker.patch('splitio.push.manager.Timer', new=timer_mock)
mocker.patch('splitio.push.manager.SplitSSEClient', new=sse_constructor_mock)
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
return PushManager(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
def test_auth_unexpected_exception(self, mocker):
"""Test a non-API error during auth (e.g. non-JSON 200 response) is reported as retryable."""
api_mock = mocker.Mock()
api_mock.authenticate.side_effect = ValueError('Expecting value: line 1 column 1 (char 0)')
sse_mock = mocker.Mock(spec=SplitSSEClient)
timer_mock = mocker.Mock()
feedback_loop = Queue()
manager = self._build_manager(mocker, api_mock, sse_mock, timer_mock, feedback_loop)
manager.start()
assert feedback_loop.get(timeout=1) == Status.PUSH_RETRYABLE_ERROR
assert sse_mock.mock_calls == []
assert not manager._running
def test_stop_while_authenticating(self, mocker):
"""Test the SSE connection is not opened if the manager is stopped during auth."""
feedback_loop = Queue()
sse_mock = mocker.Mock(spec=SplitSSEClient)
api_mock = mocker.Mock()
manager = self._build_manager(mocker, api_mock, sse_mock, mocker.Mock(), feedback_loop)
def authenticate():
manager.stop() # destroyed while waiting for the auth response
return Token(True, 'abc', {}, 2000000, 1000000)
api_mock.authenticate.side_effect = authenticate
manager.start()
assert sse_mock.start.mock_calls == []
assert feedback_loop.empty()
assert not manager._running
def test_stop_while_connecting(self, mocker):
"""Test the SSE connection is closed if the manager is stopped while connecting."""
feedback_loop = Queue()
sse_mock = mocker.Mock(spec=SplitSSEClient)
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(True, 'abc', {}, 2000000, 1000000)
timer_mock = mocker.Mock()
manager = self._build_manager(mocker, api_mock, sse_mock, timer_mock, feedback_loop)
def start(token):
manager.stop() # destroyed while opening the SSE connection
return True
sse_mock.start.side_effect = start
manager.start()
assert sse_mock.stop.mock_calls == [mocker.call()]
assert timer_mock.mock_calls == [mocker.call(0, Any())] # no token refresh scheduled
assert feedback_loop.empty()
assert not manager._running
# It can be started again
sse_mock.start.side_effect = None
sse_mock.start.return_value = True
manager.start()
assert manager._running
def test_sse_start_unexpected_exception(self, mocker):
"""Test an error raised by the sse client when connecting is reported as retryable."""
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(True, 'abc', {}, 2000000, 1000000)
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_mock.start.side_effect = Exception('SseClient already started.')
timer_mock = mocker.Mock()
feedback_loop = Queue()
manager = self._build_manager(mocker, api_mock, sse_mock, timer_mock, feedback_loop)
manager.start()
assert feedback_loop.get(timeout=1) == Status.PUSH_RETRYABLE_ERROR
assert timer_mock.mock_calls == [mocker.call(0, Any())] # no token refresh scheduled
assert not manager._running
def test_token_refresh_unexpected_exception(self, mocker):
"""Test a failed token refresh reports a retryable error instead of killing the thread."""
api_mock = mocker.Mock()
api_mock.authenticate.side_effect = [
Token(True, 'abc', {}, 2000000, 1000000),
KeyError('x-ably-capability'),
]
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_mock.start.return_value = True
timer_mock = mocker.Mock()
feedback_loop = Queue()
manager = self._build_manager(mocker, api_mock, sse_mock, timer_mock, feedback_loop)
manager.start()
assert manager._running
# Run the refresh in its own thread, as Timer would.
refresh = Thread(target=manager._token_refresh)
refresh.start()
refresh.join(1)
assert not refresh.is_alive()
assert feedback_loop.get(timeout=1) == Status.PUSH_RETRYABLE_ERROR
assert not manager._running
def test_token_refresh_stop_exception(self, mocker):
"""Test an error while closing the connection during a token refresh is reported."""
api_mock = mocker.Mock()
api_mock.authenticate.return_value = Token(True, 'abc', {}, 2000000, 1000000)
sse_mock = mocker.Mock(spec=SplitSSEClient)
sse_mock.start.return_value = True
sse_mock.stop.side_effect = OSError('Transport endpoint is not connected')
timer_mock = mocker.Mock()
feedback_loop = Queue()
manager = self._build_manager(mocker, api_mock, sse_mock, timer_mock, feedback_loop)
manager.start()
manager._token_refresh()
assert feedback_loop.get(timeout=1) == Status.PUSH_RETRYABLE_ERROR
def test_split_change(self, mocker):
"""Test update-type messages are properly forwarded to the processor."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
update_message = SplitChangeUpdate('chan', 123, 456, None, None, None)
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = update_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
processor_mock = mocker.Mock(spec=MessageProcessor)
mocker.patch('splitio.push.manager.MessageProcessor', new=processor_mock)
telemetry_runtime_producer = mocker.Mock()
synchronizer = mocker.Mock()
manager = PushManager(mocker.Mock(), synchronizer, mocker.Mock(), mocker.Mock(), telemetry_runtime_producer)
manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert processor_mock.mock_calls == [
mocker.call(synchronizer, telemetry_runtime_producer),
mocker.call().handle(update_message)
]
def test_split_kill(self, mocker):
"""Test update-type messages are properly forwarded to the processor."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
update_message = SplitKillUpdate('chan', 123, 456, 'some_split', 'off')
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = update_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
processor_mock = mocker.Mock(spec=MessageProcessor)
mocker.patch('splitio.push.manager.MessageProcessor', new=processor_mock)
telemetry_runtime_producer = mocker.Mock()
synchronizer = mocker.Mock()
manager = PushManager(mocker.Mock(), synchronizer, mocker.Mock(), mocker.Mock(), telemetry_runtime_producer)
manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert processor_mock.mock_calls == [
mocker.call(synchronizer, telemetry_runtime_producer),
mocker.call().handle(update_message)
]
def test_segment_change(self, mocker):
"""Test update-type messages are properly forwarded to the processor."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
update_message = SegmentChangeUpdate('chan', 123, 456, 'some_segment')
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = update_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
processor_mock = mocker.Mock(spec=MessageProcessor)
mocker.patch('splitio.push.manager.MessageProcessor', new=processor_mock)
telemetry_runtime_producer = mocker.Mock()
synchronizer = mocker.Mock()
manager = PushManager(mocker.Mock(), synchronizer, mocker.Mock(), mocker.Mock(), telemetry_runtime_producer)
manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert processor_mock.mock_calls == [
mocker.call(synchronizer, telemetry_runtime_producer),
mocker.call().handle(update_message)
]
def test_control_message(self, mocker):
"""Test control mesage is forwarded to status tracker."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
control_message = ControlMessage('chan', 123, ControlType.STREAMING_ENABLED)
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = control_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
status_tracker_mock = mocker.Mock(spec=PushStatusTracker)
mocker.patch('splitio.push.manager.PushStatusTracker', new=status_tracker_mock)
manager = PushManager(mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock())
manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert status_tracker_mock.mock_calls[1] == mocker.call().handle_control_message(control_message)
def test_occupancy_message(self, mocker):
"""Test control mesage is forwarded to status tracker."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
occupancy_message = OccupancyMessage('[?occupancy=metrics.publishers]control_pri', 123, 2)
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = occupancy_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
status_tracker_mock = mocker.Mock(spec=PushStatusTracker)
mocker.patch('splitio.push.manager.PushStatusTracker', new=status_tracker_mock)
manager = PushManager(mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock())
manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert status_tracker_mock.mock_calls[1] == mocker.call().handle_occupancy(occupancy_message)
class PushManagerAsyncTests(object):
"""Parser tests."""
@pytest.mark.asyncio
async def test_connection_success(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
async def authenticate():
return Token(True, 'abc', {}, 2000000, 1000000)
api_mock.authenticate.side_effect = authenticate
self.token = None
def timer_mock(token):
self.token = token
return (token.exp - token.iat) - _TOKEN_REFRESH_GRACE_PERIOD
async def coro():
t = 0
try:
while t < 3:
await asyncio.sleep(1)
yield SSEEvent('1', EventType.MESSAGE, '', '{}')
t += 1
except Exception:
pass
sse_mock = mocker.Mock(spec=SplitSSEClientAsync)
sse_mock.start.return_value = coro()
async def stop():
pass
sse_mock.stop = stop
feedback_loop = asyncio.Queue()
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager._get_time_period = timer_mock
manager._sse_client = sse_mock
async def deferred_shutdown():
await asyncio.sleep(2)
await manager.stop(True)
manager.start()
sse_mock.status = SplitSSEClient._Status.IDLE
shutdown_task = asyncio.get_running_loop().create_task(deferred_shutdown())
assert await feedback_loop.get() == Status.PUSH_SUBSYSTEM_UP
assert self.token.push_enabled
assert self.token.token == 'abc'
assert self.token.channels == {}
assert self.token.exp == 2000000
assert self.token.iat == 1000000
try:
await shutdown_task
except:
pass
assert not manager._running
assert(telemetry_storage._streaming_events._streaming_events[0]._type == StreamingEventTypes.TOKEN_REFRESH.value)
assert(telemetry_storage._streaming_events._streaming_events[1]._type == StreamingEventTypes.CONNECTION_ESTABLISHED.value)
@pytest.mark.asyncio
async def test_connection_failure(self, mocker):
"""Test the connection fails to be established."""
api_mock = mocker.Mock()
async def authenticate():
return Token(True, 'abc', {}, 2000000, 1000000)
api_mock.authenticate.side_effect = authenticate
sse_mock = mocker.Mock(spec=SplitSSEClientAsync)
feedback_loop = asyncio.Queue()
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager._sse_client = sse_mock
async def coro():
if False: yield '' # fit a never-called yield directive to force the func to be an async generator
return
sse_mock.start.return_value = coro()
manager.start()
assert await feedback_loop.get() == Status.PUSH_RETRYABLE_ERROR
await manager.stop(True)
assert not manager._running
@pytest.mark.asyncio
async def test_push_disabled(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
async def authenticate():
return Token(False, 'abc', {}, 1, 2)
api_mock.authenticate.side_effect = authenticate
sse_mock = mocker.Mock(spec=SplitSSEClientAsync)
feedback_loop = asyncio.Queue()
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager._sse_client = sse_mock
manager.start()
assert await feedback_loop.get() == Status.PUSH_NONRETRYABLE_ERROR
assert sse_mock.mock_calls == []
await manager.stop(True)
assert not manager._running
@pytest.mark.asyncio
async def test_auth_apiexception(self, mocker):
"""Test the initial status is ok and reset() works as expected."""
api_mock = mocker.Mock()
api_mock.authenticate.side_effect = APIException('something')
sse_mock = mocker.Mock(spec=SplitSSEClientAsync)
feedback_loop = asyncio.Queue()
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager._sse_client = sse_mock
manager.start()
assert await feedback_loop.get() == Status.PUSH_RETRYABLE_ERROR
assert sse_mock.mock_calls == []
await manager.stop(True)
assert not manager._running
@pytest.mark.asyncio
async def test_auth_unexpected_exception(self, mocker):
"""Test a non-API error during auth (e.g. non-JSON 200 response) is reported as retryable."""
api_mock = mocker.Mock()
async def authenticate():
raise ValueError('Expecting value: line 1 column 1 (char 0)')
api_mock.authenticate.side_effect = authenticate
sse_mock = mocker.Mock(spec=SplitSSEClientAsync)
feedback_loop = asyncio.Queue()
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager._sse_client = sse_mock
manager.start()
assert await asyncio.wait_for(feedback_loop.get(), 1) == Status.PUSH_RETRYABLE_ERROR
assert sse_mock.mock_calls == []
assert not manager._running
@pytest.mark.asyncio
async def test_sse_start_unexpected_exception(self, mocker):
"""Test an error raised by the sse client is reported as retryable."""
api_mock = mocker.Mock()
async def authenticate():
return Token(True, 'abc', {}, 2000000, 1000000)
api_mock.authenticate.side_effect = authenticate
sse_mock = mocker.Mock(spec=SplitSSEClientAsync)
sse_mock.start.side_effect = Exception('sse client error')
feedback_loop = asyncio.Queue()
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
manager._sse_client = sse_mock
manager.start()
assert await asyncio.wait_for(feedback_loop.get(), 1) == Status.PUSH_RETRYABLE_ERROR
assert not manager._running
@pytest.mark.asyncio
async def test_token_refresh_reconnects(self, mocker):
"""Test a token refresh is not cancelled by the cleanup of the connection it closes."""
api_mock = mocker.Mock()
auth_calls = []
async def authenticate():
auth_calls.append(1)
return Token(True, 'abc', {}, 2000000, 1000000)
api_mock.authenticate.side_effect = authenticate
class FakeSSEClient(object):
"""Ends the event stream on stop() and waits for it, without masking cancellation."""
def __init__(self):
self.starts = 0
def start(self, token):
self.starts += 1
self._shutdown = asyncio.Event()
self._ended = asyncio.Event()
async def events():
try:
yield SSEEvent('1', EventType.MESSAGE, None, None)
await self._shutdown.wait()
finally:
self._ended.set()
return events()
async def stop(self):
self._shutdown.set()
await self._ended.wait()
feedback_loop = asyncio.Queue()
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = PushManagerAsync(api_mock, mocker.Mock(), feedback_loop, mocker.Mock(), telemetry_runtime_producer)
processor = mocker.Mock()
async def update_workers_status(enabled):
pass
processor.update_workers_status = update_workers_status
manager._processor = processor
manager._get_time_period = lambda token: 0.1
manager._sse_client = FakeSSEClient()
manager.start()
await asyncio.sleep(0.5)
assert len(auth_calls) >= 3 # initial connection + refreshes
assert manager._sse_client.starts == len(auth_calls)
assert manager._running
await manager.stop(True)
assert not manager._running
async def _build_refresh_manager(self, mocker, feedback_loop):
async def noop(*_args, **_kwargs):
pass
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
manager = PushManagerAsync(mocker.Mock(), mocker.Mock(), feedback_loop, mocker.Mock(),
telemetry_producer.get_telemetry_runtime_producer())
manager._processor = mocker.Mock()
manager._processor.update_workers_status = noop
manager._sse_client = mocker.Mock()
manager._sse_client.stop = noop
manager._get_time_period = lambda token: 0
return manager
@pytest.mark.asyncio
async def test_token_refresh_connection_task_pending(self, mocker):
"""Test the refresh reconnects when the connection task is still ending when cancelled."""
feedback_loop = asyncio.Queue()
manager = await self._build_refresh_manager(mocker, feedback_loop)
async def ending_connection(): # e.g. still running its cleanup
await asyncio.sleep(1)
manager._running_task = asyncio.get_running_loop().create_task(ending_connection())
await asyncio.sleep(0)
flows = []
async def connection_flow():
flows.append(1)
manager._trigger_connection_flow = connection_flow
refresh = asyncio.get_running_loop().create_task(
manager._token_refresh(Token(True, 'abc', {}, 2000000, 1000000)))
await asyncio.wait_for(refresh, 1)
assert not refresh.cancelled()
await asyncio.sleep(0)
assert flows == [1] # new connection flow started
assert feedback_loop.empty()
@pytest.mark.asyncio
async def test_token_refresh_stop_exception(self, mocker):
"""Test an error while closing the connection during a token refresh is reported."""
feedback_loop = asyncio.Queue()
manager = await self._build_refresh_manager(mocker, feedback_loop)
async def stop():
raise OSError('Transport endpoint is not connected')
manager._sse_client.stop = stop
await manager._token_refresh(Token(True, 'abc', {}, 2000000, 1000000))
assert await asyncio.wait_for(feedback_loop.get(), 1) == Status.PUSH_RETRYABLE_ERROR
@pytest.mark.asyncio
async def test_stop_during_token_refresh(self, mocker):
"""Test a stop while the refresh closes the connection doesn't reconnect."""
feedback_loop = asyncio.Queue()
manager = await self._build_refresh_manager(mocker, feedback_loop)
manager._running = True
stop_tasks = []
async def sse_stop(): # stop() arrives while the refresh is closing the connection
if not stop_tasks:
stop_tasks.append(asyncio.get_running_loop().create_task(manager.stop(True)))
await asyncio.sleep(0)
manager._sse_client.stop = sse_stop
flows = []
async def connection_flow():
flows.append(1)
manager._trigger_connection_flow = connection_flow
await asyncio.wait_for(manager._token_refresh(Token(True, 'abc', {}, 2000000, 1000000)), 1)
await asyncio.gather(*stop_tasks)
await asyncio.sleep(0)
assert flows == [] # no new connection flow after stop
assert manager._running_task is None
assert feedback_loop.empty()
@pytest.mark.asyncio
async def test_stop_while_authenticating(self, mocker):
"""Test a stop during the auth request doesn't open the SSE connection."""
feedback_loop = asyncio.Queue()
manager = await self._build_refresh_manager(mocker, feedback_loop)
auth_started = asyncio.Event()
release_auth = asyncio.Event()
async def get_token():
auth_started.set()
await release_auth.wait()
return Token(True, 'abc', {}, 2000000, 1000000)
manager._get_auth_token = get_token
manager.start()
await asyncio.wait_for(auth_started.wait(), 1)
await manager.stop(True) # not running yet: only flags the stop
release_auth.set()
await asyncio.sleep(0.1)
assert manager._sse_client.start.mock_calls == []
assert not manager._running
assert feedback_loop.empty()
@pytest.mark.asyncio
async def test_split_change(self, mocker):
"""Test update-type messages are properly forwarded to the processor."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
update_message = SplitChangeUpdate('chan', 123, 456, None, None, None)
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = update_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
processor_mock = mocker.Mock(spec=MessageProcessorAsync)
mocker.patch('splitio.push.manager.MessageProcessorAsync', new=processor_mock)
telemetry_runtime_producer = mocker.Mock()
synchronizer = mocker.Mock()
manager = PushManagerAsync(mocker.Mock(), synchronizer, mocker.Mock(), mocker.Mock(), telemetry_runtime_producer)
await manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert processor_mock.mock_calls == [
mocker.call(synchronizer, telemetry_runtime_producer),
mocker.call().handle(update_message)
]
@pytest.mark.asyncio
async def test_split_kill(self, mocker):
"""Test update-type messages are properly forwarded to the processor."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
update_message = SplitKillUpdate('chan', 123, 456, 'some_split', 'off')
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = update_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
processor_mock = mocker.Mock(spec=MessageProcessorAsync)
mocker.patch('splitio.push.manager.MessageProcessorAsync', new=processor_mock)
telemetry_runtime_producer = mocker.Mock()
synchronizer = mocker.Mock()
manager = PushManagerAsync(mocker.Mock(), synchronizer, mocker.Mock(), mocker.Mock(), telemetry_runtime_producer)
await manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert processor_mock.mock_calls == [
mocker.call(synchronizer, telemetry_runtime_producer),
mocker.call().handle(update_message)
]
await manager.stop(True)
assert not manager._running
@pytest.mark.asyncio
async def test_segment_change(self, mocker):
"""Test update-type messages are properly forwarded to the processor."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
update_message = SegmentChangeUpdate('chan', 123, 456, 'some_segment')
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = update_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
processor_mock = mocker.Mock(spec=MessageProcessorAsync)
mocker.patch('splitio.push.manager.MessageProcessorAsync', new=processor_mock)
telemetry_runtime_producer = mocker.Mock()
synchronizer = mocker.Mock()
manager = PushManagerAsync(mocker.Mock(), synchronizer, mocker.Mock(), mocker.Mock(), telemetry_runtime_producer)
await manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert processor_mock.mock_calls == [
mocker.call(synchronizer, telemetry_runtime_producer),
mocker.call().handle(update_message)
]
@pytest.mark.asyncio
async def test_control_message(self, mocker):
"""Test control mesage is forwarded to status tracker."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
control_message = ControlMessage('chan', 123, ControlType.STREAMING_ENABLED)
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = control_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
status_tracker_mock = mocker.Mock(spec=PushStatusTracker)
mocker.patch('splitio.push.manager.PushStatusTrackerAsync', new=status_tracker_mock)
manager = PushManagerAsync(mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock())
await manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert status_tracker_mock.mock_calls[1] == mocker.call().handle_control_message(control_message)
@pytest.mark.asyncio
async def test_occupancy_message(self, mocker):
"""Test control mesage is forwarded to status tracker."""
sse_event = SSEEvent('1', EventType.MESSAGE, '', '{}')
occupancy_message = OccupancyMessage('[?occupancy=metrics.publishers]control_pri', 123, 2)
parse_event_mock = mocker.Mock(spec=parse_incoming_event)
parse_event_mock.return_value = occupancy_message
mocker.patch('splitio.push.manager.parse_incoming_event', new=parse_event_mock)
status_tracker_mock = mocker.Mock(spec=PushStatusTracker)
mocker.patch('splitio.push.manager.PushStatusTrackerAsync', new=status_tracker_mock)
manager = PushManagerAsync(mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock(), mocker.Mock())
await manager._event_handler(sse_event)
assert parse_event_mock.mock_calls == [mocker.call(sse_event)]
assert status_tracker_mock.mock_calls[1] == mocker.call().handle_occupancy(occupancy_message)