Repository navigation
Expand file tree
/
Copy pathtest_manager.py
More file actions
411 lines (341 loc) · 18.9 KB
/
Copy pathtest_manager.py
File metadata and controls
411 lines (341 loc) · 18.9 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
"""Manager tests."""
import threading
import unittest.mock as mock
import time
import pytest
from splitio.optional.loaders import asyncio
from splitio.api.auth import AuthAPI
from splitio.api import auth, client, APIException
from splitio.client.util import get_metadata
from splitio.client.config import DEFAULT_CONFIG
from splitio.tasks.split_sync import SplitSynchronizationTask, SplitSynchronizationTaskAsync
from splitio.tasks.segment_sync import SegmentSynchronizationTask
from splitio.tasks.impressions_sync import ImpressionsSyncTask, ImpressionsCountSyncTask
from splitio.tasks.events_sync import EventsSyncTask
from splitio.engine.telemetry import TelemetryStorageProducer, TelemetryStorageProducerAsync
from splitio.storage.inmemmory import InMemoryTelemetryStorage, InMemoryTelemetryStorageAsync
from splitio.models.telemetry import SSESyncMode, StreamingEventTypes
from splitio.push.manager import Status
from splitio.sync.split import SplitSynchronizer, SplitSynchronizerAsync
from splitio.sync.segment import SegmentSynchronizer
from splitio.sync.impression import ImpressionSynchronizer, ImpressionsCountSynchronizer
from splitio.sync.event import EventSynchronizer
from splitio.sync.synchronizer import Synchronizer, SynchronizerAsync, SplitTasks, SplitSynchronizers, RedisSynchronizer, RedisSynchronizerAsync
from splitio.sync.manager import Manager, ManagerAsync, RedisManager, RedisManagerAsync
from splitio.storage import SplitStorage, RuleBasedSegmentsStorage
from splitio.api import APIException
from splitio.client.util import SdkMetadata
@pytest.fixture(autouse=True)
def _no_backoff_wait(mocker):
"""Retry loops back off 1, 2, 4... seconds; don't actually wait in tests."""
mocker.patch('splitio.util.backoff.Backoff.get', return_value=0)
class SyncManagerTests(object):
"""Synchronizer Manager tests."""
def test_error(self, mocker):
split_task = mocker.Mock(spec=SplitSynchronizationTask)
split_tasks = SplitTasks(split_task, mocker.Mock(), mocker.Mock(), mocker.Mock(),
mocker.Mock(), mocker.Mock())
storage = mocker.Mock(spec=SplitStorage)
rb_storage = mocker.Mock(spec=RuleBasedSegmentsStorage)
api = mocker.Mock()
def run(x):
raise APIException("something broke")
api.fetch_splits.side_effect = run
storage.get_change_number.return_value = -1
split_sync = SplitSynchronizer(api, storage, rb_storage)
synchronizers = SplitSynchronizers(split_sync, mocker.Mock(), mocker.Mock(),
mocker.Mock(), mocker.Mock(), mocker.Mock())
synchronizer = Synchronizer(synchronizers, split_tasks)
manager = Manager(threading.Event(), synchronizer, mocker.Mock(), False, SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
manager._SYNC_ALL_ATTEMPTS = 1
manager.start(2) # should not throw!
def test_start_streaming_false(self, mocker):
splits_ready_event = threading.Event()
synchronizer = mocker.Mock(spec=Synchronizer)
manager = Manager(splits_ready_event, synchronizer, mocker.Mock(), False, SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
try:
manager.start()
except:
pass
splits_ready_event.wait(2)
assert splits_ready_event.is_set()
assert len(synchronizer.sync_all.mock_calls) == 1
assert len(synchronizer.start_periodic_fetching.mock_calls) == 1
assert len(synchronizer.start_periodic_data_recording.mock_calls) == 1
def test_telemetry(self, mocker):
splits_ready_event = threading.Event()
synchronizer = mocker.Mock(spec=Synchronizer)
telemetry_storage = InMemoryTelemetryStorage()
telemetry_producer = TelemetryStorageProducer(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = Manager(splits_ready_event, synchronizer, mocker.Mock(), True, SdkMetadata('1.0', 'some', '1.2.3.4'), telemetry_runtime_producer)
manager._push = mocker.Mock() # don't open a real streaming connection
try:
manager.start()
except:
pass
splits_ready_event.wait(2)
manager._queue.put(Status.PUSH_SUBSYSTEM_UP)
manager._queue.put(Status.PUSH_NONRETRYABLE_ERROR)
time.sleep(1)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-2]._type == StreamingEventTypes.SYNC_MODE_UPDATE.value)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-2]._data == SSESyncMode.STREAMING.value)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-1]._type == StreamingEventTypes.SYNC_MODE_UPDATE.value)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-1]._data == SSESyncMode.POLLING.value)
def _wait_for(self, condition, timeout=2):
deadline = time.time() + timeout
while not condition() and time.time() < deadline:
time.sleep(0.01)
return condition()
def _build_streaming_manager(self, mocker):
synchronizer = mocker.Mock(spec=Synchronizer)
manager = Manager(threading.Event(), synchronizer, mocker.Mock(), True,
SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
manager._backoff = mocker.Mock()
manager._backoff.get.return_value = 0
manager._push = mocker.Mock()
return manager, synchronizer, manager._push
def _stop_handler(self, manager):
manager._push_status_handler_active = False
manager._queue.put(manager._CENTINEL_EVENT)
manager._push_status_handler.join(1)
assert not manager._push_status_handler.is_alive()
def test_streaming_handler_survives_unexpected_exception(self, mocker):
"""Test the status handler falls back to polling, retries streaming and keeps running."""
manager, synchronizer, push_mock = self._build_streaming_manager(mocker)
worker_calls = []
def update_workers_status(enabled):
worker_calls.append(enabled)
if len(worker_calls) == 1:
raise RuntimeError("can't start new thread")
push_mock.update_workers_status.side_effect = update_workers_status
manager._push_status_handler.start()
# PUSH_SUBSYSTEM_UP stops polling and then fails enabling workers: polling must restart
# and the streaming flow must be retried (as a retryable error).
manager._queue.put(Status.PUSH_SUBSYSTEM_UP)
assert self._wait_for(lambda: len(push_mock.start.mock_calls) == 1)
assert len(synchronizer.stop_periodic_fetching.mock_calls) == 1
assert len(synchronizer.start_periodic_fetching.mock_calls) == 2 # fallback + retry flow
assert push_mock.stop.mock_calls == [mocker.call(True)]
assert manager._push_status_handler.is_alive()
# The handler still processes later status changes.
manager._queue.put(Status.PUSH_SUBSYSTEM_DOWN)
assert self._wait_for(lambda: len(synchronizer.start_periodic_fetching.mock_calls) == 3)
assert manager._push_status_handler.is_alive()
self._stop_handler(manager)
def test_streaming_handler_retryable_error_restart_fails(self, mocker):
"""Test streaming is retried when restarting it raises after a retryable error."""
manager, synchronizer, push_mock = self._build_streaming_manager(mocker)
push_mock.start.side_effect = [Exception('SseClient already started.'), None]
manager._push_status_handler.start()
manager._queue.put(Status.PUSH_RETRYABLE_ERROR)
assert self._wait_for(lambda: len(push_mock.start.mock_calls) == 2)
assert len(synchronizer.start_periodic_fetching.mock_calls) == 3 # flow, fallback, flow
assert manager._push_status_handler.is_alive()
time.sleep(0.1)
assert len(push_mock.start.mock_calls) == 2 # no more retries once it succeeds
self._stop_handler(manager)
def test_streaming_handler_nonretryable_error_fails(self, mocker):
"""Test an error while disabling streaming leaves polling on and streaming off."""
manager, synchronizer, push_mock = self._build_streaming_manager(mocker)
push_mock.stop.side_effect = OSError('Transport endpoint is not connected')
manager._push_status_handler.start()
manager._queue.put(Status.PUSH_NONRETRYABLE_ERROR)
manager._push_status_handler.join(1)
assert not manager._push_status_handler.is_alive()
assert len(synchronizer.start_periodic_fetching.mock_calls) == 1
assert push_mock.start.mock_calls == []
def test_stop_while_backing_off(self, mocker):
"""Test streaming is not restarted when the manager is stopped during the retry backoff."""
manager, synchronizer, push_mock = self._build_streaming_manager(mocker)
manager._backoff.get.return_value = 30
manager._push_status_handler.start()
manager._queue.put(Status.PUSH_RETRYABLE_ERROR)
assert self._wait_for(lambda: len(synchronizer.start_periodic_fetching.mock_calls) == 1)
start = time.time()
manager.stop(True)
manager._push_status_handler.join(1)
assert not manager._push_status_handler.is_alive()
assert time.time() - start < 1 # the backoff wait was interrupted
assert push_mock.start.mock_calls == []
class SyncManagerAsyncTests(object):
"""Synchronizer Manager tests."""
@pytest.mark.asyncio
async def test_error(self, mocker):
split_task = mocker.Mock(spec=SplitSynchronizationTask)
split_tasks = SplitTasks(split_task, mocker.Mock(), mocker.Mock(), mocker.Mock(),
mocker.Mock(), mocker.Mock())
storage = mocker.Mock(spec=SplitStorage)
rb_storage = mocker.Mock(spec=RuleBasedSegmentsStorage)
api = mocker.Mock()
async def run(x):
raise APIException("something broke")
api.fetch_splits = run
async def get_change_number():
return -1
storage.get_change_number = get_change_number
split_sync = SplitSynchronizerAsync(api, storage, rb_storage)
synchronizers = SplitSynchronizers(split_sync, mocker.Mock(), mocker.Mock(),
mocker.Mock(), mocker.Mock(), mocker.Mock())
synchronizer = SynchronizerAsync(synchronizers, split_tasks)
manager = ManagerAsync(synchronizer, mocker.Mock(), False, SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
manager._SYNC_ALL_ATTEMPTS = 1
await manager.start(2) # should not throw!
@pytest.mark.asyncio
async def test_start_streaming_false(self, mocker):
synchronizer = mocker.Mock(spec=SynchronizerAsync)
self.sync_all_called = 0
async def sync_all(retry):
self.sync_all_called += 1
synchronizer.sync_all = sync_all
self.fetching_called = 0
def start_periodic_fetching():
self.fetching_called += 1
synchronizer.start_periodic_fetching = start_periodic_fetching
self.rcording_called = 0
def start_periodic_data_recording():
self.rcording_called += 1
synchronizer.start_periodic_data_recording = start_periodic_data_recording
manager = ManagerAsync(synchronizer, mocker.Mock(), False, SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
try:
await manager.start()
except:
pass
assert self.sync_all_called == 1
assert self.fetching_called == 1
assert self.rcording_called == 1
@pytest.mark.asyncio
async def test_telemetry(self, mocker):
synchronizer = mocker.Mock(spec=SynchronizerAsync)
async def sync_all(retry=1):
pass
synchronizer.sync_all = sync_all
async def stop_periodic_fetching():
pass
synchronizer.stop_periodic_fetching = stop_periodic_fetching
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
telemetry_runtime_producer = telemetry_producer.get_telemetry_runtime_producer()
manager = ManagerAsync(synchronizer, mocker.Mock(), True, SdkMetadata('1.0', 'some', '1.2.3.4'), telemetry_runtime_producer)
try:
await manager.start()
except:
pass
await manager._queue.put(Status.PUSH_SUBSYSTEM_UP)
await manager._queue.put(Status.PUSH_NONRETRYABLE_ERROR)
await asyncio.sleep(1)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-2]._type == StreamingEventTypes.SYNC_MODE_UPDATE.value)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-2]._data == SSESyncMode.STREAMING.value)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-1]._type == StreamingEventTypes.SYNC_MODE_UPDATE.value)
assert(telemetry_storage._streaming_events._streaming_events[len(telemetry_storage._streaming_events._streaming_events)-1]._data == SSESyncMode.POLLING.value)
@pytest.mark.asyncio
async def test_streaming_handler_survives_unexpected_exception(self, mocker):
"""Test the status handler falls back to polling, retries streaming and keeps running."""
synchronizer = mocker.Mock(spec=SynchronizerAsync)
calls = {'sync_all': 0, 'stop_periodic_fetching': 0}
async def sync_all(retry=1):
calls['sync_all'] += 1
synchronizer.sync_all = sync_all
async def stop_periodic_fetching():
calls['stop_periodic_fetching'] += 1
synchronizer.stop_periodic_fetching = stop_periodic_fetching
telemetry_storage = await InMemoryTelemetryStorageAsync.create()
telemetry_producer = TelemetryStorageProducerAsync(telemetry_storage)
manager = ManagerAsync(synchronizer, mocker.Mock(), True,
SdkMetadata('1.0', 'some', '1.2.3.4'),
telemetry_producer.get_telemetry_runtime_producer())
manager._backoff = mocker.Mock()
manager._backoff.get.return_value = 0
push_mock = mocker.Mock()
worker_calls = []
async def update_workers_status(enabled):
worker_calls.append(enabled)
if len(worker_calls) == 1:
raise RuntimeError('worker failure')
push_mock.update_workers_status = update_workers_status
stop_calls = []
async def stop(blocking=False):
stop_calls.append(blocking)
push_mock.stop = stop
manager._push = push_mock
handler = asyncio.get_running_loop().create_task(manager._streaming_feedback_handler())
# PUSH_SUBSYSTEM_UP stops polling and then fails enabling workers: polling must restart
# and the streaming flow must be retried (as a retryable error).
await manager._queue.put(Status.PUSH_SUBSYSTEM_UP)
await asyncio.sleep(0.1)
assert calls['stop_periodic_fetching'] == 1
assert len(synchronizer.start_periodic_fetching.mock_calls) == 2 # fallback + retry flow
assert stop_calls == [True]
assert len(push_mock.start.mock_calls) == 1
assert not handler.done()
# The handler still processes later status changes.
await manager._queue.put(Status.PUSH_SUBSYSTEM_DOWN)
await asyncio.sleep(0.1)
assert len(synchronizer.start_periodic_fetching.mock_calls) == 3
assert not handler.done()
manager._push_status_handler_active = False
await manager._queue.put(manager._CENTINEL_EVENT)
await asyncio.wait_for(handler, 1)
@pytest.mark.asyncio
async def test_stop_while_backing_off(self, mocker):
"""Test streaming is not restarted when the manager is stopped during the retry backoff."""
synchronizer = mocker.Mock(spec=SynchronizerAsync)
async def noop(*_args, **_kwargs):
pass
synchronizer.sync_all = noop
manager = ManagerAsync(synchronizer, mocker.Mock(), True,
SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
manager._backoff = mocker.Mock()
manager._backoff.get.return_value = 0.2
push_mock = mocker.Mock()
push_mock.update_workers_status = noop
push_mock.stop = noop
manager._push = push_mock
handler = asyncio.get_running_loop().create_task(manager._streaming_feedback_handler())
await manager._queue.put(Status.PUSH_RETRYABLE_ERROR)
await asyncio.sleep(0.05)
manager._push_status_handler_active = False # as done by stop()
await asyncio.wait_for(handler, 1)
assert push_mock.start.mock_calls == []
class RedisSyncManagerTests(object):
"""Synchronizer Redis Manager tests."""
synchronizers = SplitSynchronizers(None, None, None, None, None, None, None, None)
tasks = SplitTasks(None, None, None, None, None, None, None, None)
synchronizer = RedisSynchronizer(synchronizers, tasks)
manager = RedisManager(synchronizer)
@mock.patch('splitio.sync.synchronizer.RedisSynchronizer.start_periodic_data_recording')
def test_recreate_and_start(self, mocker):
assert(isinstance(self.manager._synchronizer, RedisSynchronizer))
self.manager.recreate()
assert(not mocker.called)
self.manager.start()
assert(mocker.called)
@mock.patch('splitio.sync.synchronizer.RedisSynchronizer.shutdown')
def test_recreate_and_stop(self, mocker):
self.manager.recreate()
assert(not mocker.called)
self.manager.stop(True)
assert(mocker.called)
class RedisSyncManagerAsyncTests(object):
"""Synchronizer Redis Manager async tests."""
synchronizers = SplitSynchronizers(None, None, None, None, None, None, None, None)
tasks = SplitTasks(None, None, None, None, None, None, None, None)
synchronizer = RedisSynchronizerAsync(synchronizers, tasks)
manager = RedisManagerAsync(synchronizer)
@mock.patch('splitio.sync.synchronizer.RedisSynchronizerAsync.start_periodic_data_recording')
def test_recreate_and_start(self, mocker):
assert(isinstance(self.manager._synchronizer, RedisSynchronizerAsync))
self.manager.recreate()
assert(not mocker.called)
self.manager.start()
assert(mocker.called)
@pytest.mark.asyncio
async def test_recreate_and_stop(self, mocker):
self.called = False
async def shutdown(block):
self.called = True
self.manager._synchronizer.shutdown = shutdown
self.manager.recreate()
assert(not self.called)
await self.manager.stop(True)
assert(self.called)