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
|
from time import sleep
import pytest
from pytest_celery import CeleryTestSetup, CeleryTestWorker, RabbitMQTestBroker
import celery
from celery import Celery
from celery.canvas import chain, group
from t.smoke.conftest import SuiteOperations, WorkerKill, WorkerRestart
from t.smoke.tasks import long_running_task
RESULT_TIMEOUT = 30
def assert_container_exited(worker: CeleryTestWorker, attempts: int = RESULT_TIMEOUT):
"""It might take a few moments for the container to exit after the worker is killed."""
while attempts:
worker.container.reload()
if worker.container.status == "exited":
break
attempts -= 1
sleep(1)
worker.container.reload()
assert worker.container.status == "exited"
@pytest.mark.parametrize("method", list(WorkerRestart.Method))
class test_worker_restart(SuiteOperations):
@pytest.fixture
def default_worker_app(self, default_worker_app: Celery) -> Celery:
app = default_worker_app
app.conf.worker_pool_restarts = True
app.conf.task_acks_late = True
return app
def test_restart_during_task_execution(
self,
celery_setup: CeleryTestSetup,
method: WorkerRestart.Method,
):
queue = celery_setup.worker.worker_queue
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
self.restart_worker(celery_setup.worker, method)
assert res.get(RESULT_TIMEOUT) is True
def test_restart_between_task_execution(
self,
celery_setup: CeleryTestSetup,
method: WorkerRestart.Method,
):
# We use freeze() to control the order of execution for the restart operation
queue = celery_setup.worker.worker_queue
first = long_running_task.si(5, verbose=True).set(queue=queue)
first_res = first.freeze()
second = long_running_task.si(5, verbose=True).set(queue=queue)
second_res = second.freeze()
sig = chain(first, second)
sig.delay()
assert first_res.get(RESULT_TIMEOUT) is True
self.restart_worker(celery_setup.worker, method)
assert second_res.get(RESULT_TIMEOUT) is True
class test_worker_shutdown(SuiteOperations):
@pytest.fixture
def default_worker_app(self, default_worker_app: Celery) -> Celery:
app = default_worker_app
app.conf.task_acks_late = True
return app
def test_warm_shutdown(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists("worker: Warm shutdown (MainProcess)")
assert_container_exited(worker)
assert res.get(RESULT_TIMEOUT)
def test_multiple_warm_shutdown_does_nothing(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
for _ in range(3):
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
assert_container_exited(worker)
assert res.get(RESULT_TIMEOUT)
def test_cold_shutdown(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_does_not_exist(f"long_running_task[{res.id}] succeeded", timeout=10)
assert_container_exited(worker)
with pytest.raises(celery.exceptions.TimeoutError):
res.get(timeout=5)
def test_hard_shutdown_from_warm(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(420, verbose=True).set(queue=queue)
sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists("worker: Warm shutdown (MainProcess)")
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
assert_container_exited(worker)
def test_hard_shutdown_from_cold(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(420, verbose=True).set(queue=queue)
sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
assert_container_exited(worker)
class test_REMAP_SIGTERM(SuiteOperations):
@pytest.fixture
def default_worker_env(self, default_worker_env: dict) -> dict:
default_worker_env.update({"REMAP_SIGTERM": "SIGQUIT"})
return default_worker_env
def test_cold_shutdown(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_does_not_exist(f"long_running_task[{res.id}] succeeded", timeout=10)
assert_container_exited(worker)
def test_hard_shutdown_from_cold(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(420, verbose=True).set(queue=queue)
sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
assert_container_exited(worker)
class test_worker_soft_shutdown_timeout(SuiteOperations):
@pytest.fixture
def default_worker_app(self, default_worker_app: Celery) -> Celery:
app = default_worker_app
app.conf.worker_soft_shutdown_timeout = 10
return app
def test_soft_shutdown(self, celery_setup: CeleryTestSetup):
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds",
timeout=5,
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
assert_container_exited(worker)
assert res.get(RESULT_TIMEOUT)
def test_hard_shutdown_from_soft(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(420, verbose=True).set(queue=queue)
sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists("Waiting gracefully for cold shutdown to complete...")
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
assert_container_exited(worker)
class test_REMAP_SIGTERM(SuiteOperations):
@pytest.fixture
def default_worker_env(self, default_worker_env: dict) -> dict:
default_worker_env.update({"REMAP_SIGTERM": "SIGQUIT"})
return default_worker_env
def test_soft_shutdown(self, celery_setup: CeleryTestSetup):
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
assert_container_exited(worker)
assert res.get(RESULT_TIMEOUT)
def test_hard_shutdown_from_soft(self, celery_setup: CeleryTestSetup):
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(420, verbose=True).set(queue=queue)
sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists("Waiting gracefully for cold shutdown to complete...")
worker.assert_log_exists("worker: Cold shutdown (MainProcess)", timeout=5)
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
assert_container_exited(worker)
class test_reset_visibility_timeout(SuiteOperations):
@pytest.fixture
def default_worker_app(self, default_worker_app: Celery) -> Celery:
app = default_worker_app
app.conf.prefetch_multiplier = 2
app.conf.worker_concurrency = 10
app.conf.visibility_timeout = 3600 # 1 hour
app.conf.broker_transport_options = {
"visibility_timeout": app.conf.visibility_timeout,
"polling_interval": 1,
}
app.conf.result_backend_transport_options = {
"visibility_timeout": app.conf.visibility_timeout,
"polling_interval": 1,
}
return app
def test_soft_shutdown_reset_visibility_timeout(self, celery_setup: CeleryTestSetup):
if isinstance(celery_setup.broker, RabbitMQTestBroker):
pytest.skip("RabbitMQ does not support visibility timeout")
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(15, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_exists("Restoring 1 unacknowledged message(s)")
assert_container_exited(worker)
worker.restart()
assert res.get(RESULT_TIMEOUT)
def test_soft_shutdown_reset_visibility_timeout_group_one_finish(self, celery_setup: CeleryTestSetup):
if isinstance(celery_setup.broker, RabbitMQTestBroker):
pytest.skip("RabbitMQ does not support visibility timeout")
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
short_task = long_running_task.si(3, verbose=True).set(queue=queue)
short_task_res = short_task.freeze()
long_task = long_running_task.si(15, verbose=True).set(queue=queue)
long_task_res = long_task.freeze()
sig = group(short_task, long_task)
sig.delay()
worker.assert_log_exists(f"long_running_task[{short_task_res.id}] received")
worker.assert_log_exists(f"long_running_task[{long_task_res.id}] received")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_exists("Restoring 1 unacknowledged message(s)")
assert_container_exited(worker)
assert short_task_res.get(RESULT_TIMEOUT)
def test_soft_shutdown_reset_visibility_timeout_group_none_finish(self, celery_setup: CeleryTestSetup):
if isinstance(celery_setup.broker, RabbitMQTestBroker):
pytest.skip("RabbitMQ does not support visibility timeout")
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
short_task = long_running_task.si(15, verbose=True).set(queue=queue)
short_task_res = short_task.freeze()
long_task = long_running_task.si(15, verbose=True).set(queue=queue)
long_task_res = long_task.freeze()
sig = group(short_task, long_task)
res = sig.delay()
worker.assert_log_exists(f"long_running_task[{short_task_res.id}] received")
worker.assert_log_exists(f"long_running_task[{long_task_res.id}] received")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_exists("Restoring 2 unacknowledged message(s)")
assert_container_exited(worker)
worker.restart()
assert res.get(RESULT_TIMEOUT) == [True, True]
assert short_task_res.get(RESULT_TIMEOUT)
assert long_task_res.get(RESULT_TIMEOUT)
class test_REMAP_SIGTERM(SuiteOperations):
@pytest.fixture
def default_worker_env(self, default_worker_env: dict) -> dict:
default_worker_env.update({"REMAP_SIGTERM": "SIGQUIT"})
return default_worker_env
def test_soft_shutdown_reset_visibility_timeout(self, celery_setup: CeleryTestSetup):
if isinstance(celery_setup.broker, RabbitMQTestBroker):
pytest.skip("RabbitMQ does not support visibility timeout")
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(15, verbose=True).set(queue=queue)
res = sig.delay()
worker.assert_log_exists("Starting long running task")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_exists("Restoring 1 unacknowledged message(s)")
assert_container_exited(worker)
worker.restart()
assert res.get(RESULT_TIMEOUT)
def test_soft_shutdown_reset_visibility_timeout_group_one_finish(
self,
celery_setup: CeleryTestSetup,
):
if isinstance(celery_setup.broker, RabbitMQTestBroker):
pytest.skip("RabbitMQ does not support visibility timeout")
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
short_task = long_running_task.si(3, verbose=True).set(queue=queue)
short_task_res = short_task.freeze()
long_task = long_running_task.si(15, verbose=True).set(queue=queue)
long_task_res = long_task.freeze()
sig = group(short_task, long_task)
sig.delay()
worker.assert_log_exists(f"long_running_task[{short_task_res.id}] received")
worker.assert_log_exists(f"long_running_task[{long_task_res.id}] received")
self.kill_worker(worker, WorkerKill.Method.SIGTERM)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_exists("Restoring 1 unacknowledged message(s)")
assert_container_exited(worker)
assert short_task_res.get(RESULT_TIMEOUT)
class test_worker_enable_soft_shutdown_on_idle(SuiteOperations):
@pytest.fixture
def default_worker_app(self, default_worker_app: Celery) -> Celery:
app = default_worker_app
app.conf.worker_enable_soft_shutdown_on_idle = True
return app
def test_soft_shutdown(self, celery_setup: CeleryTestSetup):
app = celery_setup.app
worker = celery_setup.worker
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds",
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
assert_container_exited(worker)
def test_soft_shutdown_eta(self, celery_setup: CeleryTestSetup):
if isinstance(celery_setup.broker, RabbitMQTestBroker):
pytest.skip("RabbitMQ does not support visibility timeout")
app = celery_setup.app
queue = celery_setup.worker.worker_queue
worker = celery_setup.worker
sig = long_running_task.si(5, verbose=True).set(queue=queue)
res = sig.apply_async(countdown=app.conf.worker_soft_shutdown_timeout + 5)
worker.assert_log_exists(f"long_running_task[{res.id}] received")
self.kill_worker(worker, WorkerKill.Method.SIGQUIT)
worker.assert_log_exists(
f"Initiating Soft Shutdown, terminating in {app.conf.worker_soft_shutdown_timeout} seconds"
)
worker.assert_log_exists("worker: Cold shutdown (MainProcess)")
worker.assert_log_exists("Restoring 1 unacknowledged message(s)")
assert_container_exited(worker)
worker.restart()
assert res.get(RESULT_TIMEOUT)
|
