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
|
import logging
import platform
import time
from datetime import datetime, timedelta, timezone
from multiprocessing import set_start_method
from time import perf_counter, sleep
from uuid import uuid4
import pytest
import celery
from celery import chain, chord, group
from celery.canvas import StampingVisitor
from celery.signals import task_received
from celery.utils.serialization import UnpickleableExceptionWrapper
from celery.worker import state as worker_state
from .conftest import TEST_BACKEND, get_active_redis_channels, get_redis_connection
from .tasks import (ClassBasedAutoRetryTask, ExpectedException, add, add_ignore_result, add_not_typed, add_pydantic,
fail, fail_unpickleable, print_unicode, retry, retry_once, retry_once_headers,
retry_once_priority, retry_unpickleable, return_properties, second_order_replace1, sleeping,
soft_time_limit_must_exceed_time_limit)
TIMEOUT = 10
_flaky = pytest.mark.flaky(reruns=5, reruns_delay=2)
_timeout = pytest.mark.timeout(timeout=300)
def flaky(fn):
return _timeout(_flaky(fn))
def set_multiprocessing_start_method():
"""Set multiprocessing start method to 'fork' if not on Linux."""
if platform.system() != 'Linux':
try:
set_start_method('fork')
except RuntimeError:
# The method is already set
pass
class test_class_based_tasks:
@flaky
def test_class_based_task_retried(self, celery_session_app,
celery_session_worker):
task = ClassBasedAutoRetryTask()
celery_session_app.register_task(task)
res = task.delay()
assert res.get(timeout=TIMEOUT) == 1
def _producer(j):
"""Single producer helper function"""
results = []
for i in range(20):
results.append([i + j, add.delay(i, j)])
for expected, result in results:
value = result.get(timeout=10)
assert value == expected
assert result.status == 'SUCCESS'
assert result.ready() is True
assert result.successful() is True
return j
class test_tasks:
def test_simple_call(self):
"""Tests direct simple call of task"""
assert add(1, 1) == 2
assert add(1, 1, z=1) == 3
@flaky
def test_basic_task(self, manager):
"""Tests basic task call"""
results = []
# Tests calling task only with args
for i in range(10):
results.append([i + i, add.delay(i, i)])
for expected, result in results:
value = result.get(timeout=10)
assert value == expected
assert result.status == 'SUCCESS'
assert result.ready() is True
assert result.successful() is True
results = []
# Tests calling task with args and kwargs
for i in range(10):
results.append([3*i, add.delay(i, i, z=i)])
for expected, result in results:
value = result.get(timeout=10)
assert value == expected
assert result.status == 'SUCCESS'
assert result.ready() is True
assert result.successful() is True
@flaky
def test_multiprocess_producer(self, manager):
"""Testing multiple processes calling tasks."""
set_multiprocessing_start_method()
from multiprocessing import Pool
pool = Pool(20)
ret = pool.map(_producer, range(120))
assert list(ret) == list(range(120))
@flaky
def test_multithread_producer(self, manager):
"""Testing multiple threads calling tasks."""
set_multiprocessing_start_method()
from multiprocessing.pool import ThreadPool
pool = ThreadPool(20)
ret = pool.map(_producer, range(120))
assert list(ret) == list(range(120))
@flaky
def test_ignore_result(self, manager):
"""Testing calling task with ignoring results."""
result = add.apply_async((1, 2), ignore_result=True)
assert result.get() is None
# We wait since it takes a bit of time for the result to be
# persisted in the result backend.
sleep(1)
assert result.result is None
@flaky
def test_pydantic_annotations(self, manager):
"""Tests task call with Pydantic model serialization."""
results = []
# Tests calling task only with args
for i in range(10):
results.append([i + i, add_pydantic.delay({'x': i, 'y': i})])
for expected, result in results:
value = result.get(timeout=10)
assert value == {'result': expected}
assert result.status == 'SUCCESS'
assert result.ready() is True
assert result.successful() is True
@flaky
def test_timeout(self, manager):
"""Testing timeout of getting results from tasks."""
result = sleeping.delay(10)
with pytest.raises(celery.exceptions.TimeoutError):
result.get(timeout=5)
@flaky
def test_expired(self, manager):
"""Testing expiration of task."""
# Fill the queue with tasks which took > 1 sec to process
for _ in range(4):
sleeping.delay(2)
# Execute task with expiration = 1 sec
result = add.apply_async((1, 1), expires=1)
with pytest.raises(celery.exceptions.TaskRevokedError):
result.get()
assert result.status == 'REVOKED'
assert result.ready() is True
assert result.failed() is False
assert result.successful() is False
# Fill the queue with tasks which took > 1 sec to process
for _ in range(4):
sleeping.delay(2)
# Execute task with expiration at now + 1 sec
result = add.apply_async((1, 1), expires=datetime.now(timezone.utc) + timedelta(seconds=1))
with pytest.raises(celery.exceptions.TaskRevokedError):
result.get()
assert result.status == 'REVOKED'
assert result.ready() is True
assert result.failed() is False
assert result.successful() is False
@flaky
def test_eta(self, manager):
"""Tests tasks scheduled at some point in future."""
start = perf_counter()
# Schedule task to be executed in 3 seconds
result = add.apply_async((1, 1), countdown=3)
sleep(1)
assert result.status == 'PENDING'
assert result.ready() is False
assert result.get() == 2
end = perf_counter()
assert result.status == 'SUCCESS'
assert result.ready() is True
# Difference between calling the task and result must be bigger than 3 secs
assert (end - start) > 3
start = perf_counter()
# Schedule task to be executed at time now + 3 seconds
result = add.apply_async((2, 2), eta=datetime.now(timezone.utc) + timedelta(seconds=3))
sleep(1)
assert result.status == 'PENDING'
assert result.ready() is False
assert result.get() == 4
end = perf_counter()
assert result.status == 'SUCCESS'
assert result.ready() is True
# Difference between calling the task and result must be bigger than 3 secs
assert (end - start) > 3
@flaky
def test_fail(self, manager):
"""Tests that the failing task propagates back correct exception."""
result = fail.delay()
with pytest.raises(ExpectedException):
result.get(timeout=5)
assert result.status == 'FAILURE'
assert result.ready() is True
assert result.failed() is True
assert result.successful() is False
@flaky
def test_revoked(self, manager):
"""Testing revoking of task"""
# Fill the queue with tasks to fill the queue
for _ in range(4):
sleeping.delay(2)
# Execute task and revoke it
result = add.apply_async((1, 1))
result.revoke()
with pytest.raises(celery.exceptions.TaskRevokedError):
result.get()
assert result.status == 'REVOKED'
assert result.ready() is True
assert result.failed() is False
assert result.successful() is False
def test_revoked_by_headers_simple_canvas(self, manager):
"""Testing revoking of task using a stamped header"""
target_monitoring_id = uuid4().hex
class MonitoringIdStampingVisitor(StampingVisitor):
def on_signature(self, sig, **headers) -> dict:
return {'monitoring_id': target_monitoring_id}
for monitoring_id in [target_monitoring_id, uuid4().hex, 4242, None]:
stamped_task = add.si(1, 1)
stamped_task.stamp(visitor=MonitoringIdStampingVisitor())
result = stamped_task.freeze()
result.revoke_by_stamped_headers(headers={'monitoring_id': [monitoring_id]})
stamped_task.apply_async()
if monitoring_id == target_monitoring_id:
with pytest.raises(celery.exceptions.TaskRevokedError):
result.get()
assert result.status == 'REVOKED'
assert result.ready() is True
assert result.failed() is False
assert result.successful() is False
else:
assert result.get() == 2
assert result.status == 'SUCCESS'
assert result.ready() is True
assert result.failed() is False
assert result.successful() is True
# Clear the set of revoked stamps in the worker state.
# This step is performed in each iteration of the loop to ensure that only tasks
# stamped with a specific monitoring ID will be revoked.
# For subsequent iterations with different monitoring IDs, the revoked stamps will
# not match the task's stamps, allowing those tasks to proceed successfully.
worker_state.revoked_stamps.clear()
def test_revoked_by_headers_complex_canvas(self, manager, subtests):
"""Testing revoking of task using a stamped header"""
try:
manager.app.backend.ensure_chords_allowed()
except NotImplementedError as e:
raise pytest.skip(e.args[0])
for monitoring_id in ["4242", [1234, uuid4().hex]]:
# Try to purge the queue before we start
# to attempt to avoid interference from other tests
manager.wait_until_idle()
target_monitoring_id = isinstance(monitoring_id, list) and monitoring_id[0] or monitoring_id
class MonitoringIdStampingVisitor(StampingVisitor):
def on_signature(self, sig, **headers) -> dict:
return {'monitoring_id': target_monitoring_id, 'stamped_headers': ['monitoring_id']}
stamped_task = sleeping.si(4)
stamped_task.stamp(visitor=MonitoringIdStampingVisitor())
result = stamped_task.freeze()
canvas = [
group([stamped_task]),
chord(group([stamped_task]), sleeping.si(2)),
chord(group([sleeping.si(2)]), stamped_task),
chain(stamped_task),
group([sleeping.si(2), stamped_task, sleeping.si(2)]),
chord([sleeping.si(2), stamped_task], sleeping.si(2)),
chord([sleeping.si(2), sleeping.si(2)], stamped_task),
chain(sleeping.si(2), stamped_task),
chain(sleeping.si(2), group([sleeping.si(2), stamped_task, sleeping.si(2)])),
chain(sleeping.si(2), group([sleeping.si(2), stamped_task]), sleeping.si(2)),
chain(sleeping.si(2), group([sleeping.si(2), sleeping.si(2)]), stamped_task),
]
result.revoke_by_stamped_headers(headers={'monitoring_id': monitoring_id})
for sig in canvas:
sig_result = sig.apply_async()
with subtests.test(msg='Testing if task was revoked'):
with pytest.raises(celery.exceptions.TaskRevokedError):
sig_result.get()
assert result.status == 'REVOKED'
assert result.ready() is True
assert result.failed() is False
assert result.successful() is False
worker_state.revoked_stamps.clear()
@flaky
def test_revoke_by_stamped_headers_no_match(self, manager):
response = manager.app.control.revoke_by_stamped_headers(
{"myheader": ["myvalue"]},
terminate=False,
reply=True,
)
expected_response = "headers {'myheader': ['myvalue']} flagged as revoked, but not terminated"
assert response[0][list(response[0].keys())[0]]["ok"] == expected_response
@flaky
def test_wrong_arguments(self, manager):
"""Tests that proper exceptions are raised when task is called with wrong arguments."""
with pytest.raises(TypeError):
add(5)
with pytest.raises(TypeError):
add(5, 5, wrong_arg=5)
with pytest.raises(TypeError):
add.delay(5)
with pytest.raises(TypeError):
add.delay(5, wrong_arg=5)
# Tasks with typing=False are not checked but execution should fail
result = add_not_typed.delay(5)
with pytest.raises(TypeError):
result.get(timeout=5)
assert result.status == 'FAILURE'
result = add_not_typed.delay(5, wrong_arg=5)
with pytest.raises(TypeError):
result.get(timeout=5)
assert result.status == 'FAILURE'
@pytest.mark.xfail(
condition=TEST_BACKEND == "rpc",
reason="Retry failed on rpc backend",
strict=False,
)
def test_retry(self, manager):
"""Tests retrying of task."""
# Tests when max. retries is reached
result = retry.delay()
tik = time.monotonic()
while time.monotonic() < tik + 5:
status = result.status
if status != 'PENDING':
break
sleep(0.1)
else:
raise AssertionError("Timeout while waiting for the task to be retried")
assert status == 'RETRY'
with pytest.raises(ExpectedException):
result.get()
assert result.status == 'FAILURE'
# Tests when task is retried but after returns correct result
result = retry.delay(return_value='bar')
tik = time.monotonic()
while time.monotonic() < tik + 5:
status = result.status
if status != 'PENDING':
break
sleep(0.1)
else:
raise AssertionError("Timeout while waiting for the task to be retried")
assert status == 'RETRY'
assert result.get() == 'bar'
assert result.status == 'SUCCESS'
def test_retry_with_unpickleable_exception(self, manager):
"""Test a task that retries with an unpickleable exception.
We expect to be able to fetch the result (exception) correctly.
"""
job = retry_unpickleable.delay(
"foo",
"bar",
retry_kwargs={"countdown": 10, "max_retries": 1},
)
# Wait for the task to raise the Retry exception
tik = time.monotonic()
while time.monotonic() < tik + 5:
status = job.status
if status != 'PENDING':
break
sleep(0.1)
else:
raise AssertionError("Timeout while waiting for the task to be retried")
assert status == 'RETRY'
# Get the exception
res = job.result
assert job.status == 'RETRY' # make sure that it wasn't completed yet
# Check it
assert isinstance(res, UnpickleableExceptionWrapper)
assert res.exc_cls_name == "UnpickleableException"
assert res.exc_args == ("foo",)
job.revoke()
def test_fail_with_unpickleable_exception(self, manager):
"""Test a task that fails with an unpickleable exception.
We expect to be able to fetch the result (exception) correctly.
"""
result = fail_unpickleable.delay("foo", "bar")
with pytest.raises(UnpickleableExceptionWrapper) as exc_info:
result.get()
exc_wrapper = exc_info.value
assert exc_wrapper.exc_cls_name == "UnpickleableException"
assert exc_wrapper.exc_args == ("foo",)
assert result.status == 'FAILURE'
# Requires investigation why it randomly succeeds/fails
@pytest.mark.skip(reason="Randomly fails")
def test_task_accepted(self, manager, sleep=1):
r1 = sleeping.delay(sleep)
sleeping.delay(sleep)
manager.assert_accepted([r1.id])
@flaky
def test_task_retried_once(self, manager):
res = retry_once.delay()
assert res.get(timeout=TIMEOUT) == 1 # retried once
@flaky
def test_task_retried_once_with_expires(self, manager):
res = retry_once.delay(expires=60)
assert res.get(timeout=TIMEOUT) == 1 # retried once
@flaky
def test_task_retried_priority(self, manager):
res = retry_once_priority.apply_async(priority=7)
assert res.get(timeout=TIMEOUT) == 7 # retried once with priority 7
@flaky
def test_task_retried_headers(self, manager):
res = retry_once_headers.apply_async(headers={'x-test-header': 'test-value'})
headers = res.get(timeout=TIMEOUT)
assert headers is not None # retried once with headers
assert 'x-test-header' in headers # retry keeps custom headers
@flaky
def test_unicode_task(self, manager):
manager.join(
group(print_unicode.s() for _ in range(5))(),
timeout=TIMEOUT, propagate=True,
)
@flaky
def test_properties(self, celery_session_worker):
res = return_properties.apply_async(app_id="1234")
assert res.get(timeout=TIMEOUT)["app_id"] == "1234"
@flaky
def test_soft_time_limit_exceeding_time_limit(self):
with pytest.raises(ValueError, match='soft_time_limit must be less than or equal to time_limit'):
result = soft_time_limit_must_exceed_time_limit.apply_async()
result.get(timeout=5)
assert result.status == 'FAILURE'
class test_trace_log_arguments:
args = "CUSTOM ARGS"
kwargs = "CUSTOM KWARGS"
def assert_trace_log(self, caplog, result, expected):
# wait for logs from worker
sleep(.01)
records = [(r.name, r.levelno, r.msg, r.data["args"], r.data["kwargs"])
for r in caplog.records
if r.name in {'celery.worker.strategy', 'celery.app.trace'}
if r.data["id"] == result.task_id
]
assert records == [(*e, self.args, self.kwargs) for e in expected]
def call_task_with_reprs(self, task):
return task.set(argsrepr=self.args, kwargsrepr=self.kwargs).delay()
@flaky
def test_task_success(self, caplog):
result = self.call_task_with_reprs(add.s(2, 2))
value = result.get()
assert value == 4
assert result.successful() is True
self.assert_trace_log(caplog, result, [
('celery.worker.strategy', logging.INFO,
celery.app.trace.LOG_RECEIVED,
),
('celery.app.trace', logging.INFO,
celery.app.trace.LOG_SUCCESS,
),
])
@flaky
def test_task_failed(self, caplog):
result = self.call_task_with_reprs(fail.s(2, 2))
with pytest.raises(ExpectedException):
result.get(timeout=5)
assert result.failed() is True
self.assert_trace_log(caplog, result, [
('celery.worker.strategy', logging.INFO,
celery.app.trace.LOG_RECEIVED,
),
('celery.app.trace', logging.ERROR,
celery.app.trace.LOG_FAILURE,
),
])
class test_task_redis_result_backend:
@pytest.fixture()
def manager(self, manager):
if not manager.app.conf.result_backend.startswith('redis'):
raise pytest.skip('Requires redis result backend.')
return manager
def test_ignoring_result_no_subscriptions(self, manager):
channels_before_test = get_active_redis_channels()
result = add_ignore_result.delay(1, 2)
assert result.ignored is True
new_channels = [channel for channel in get_active_redis_channels() if channel not in channels_before_test]
assert new_channels == []
@flaky
def test_asyncresult_forget_cancels_subscription(self, manager):
channels_before_test = get_active_redis_channels()
result = add.delay(1, 2)
assert set(get_active_redis_channels()) == {
f"celery-task-meta-{result.id}".encode(), *channels_before_test
}
result.forget()
new_channels = [channel for channel in get_active_redis_channels() if channel not in channels_before_test]
assert new_channels == []
@flaky
def test_asyncresult_get_cancels_subscription(self, manager):
channels_before_test = get_active_redis_channels()
result = add.delay(1, 2)
assert set(get_active_redis_channels()) == {
f"celery-task-meta-{result.id}".encode(), *channels_before_test
}
assert result.get(timeout=3) == 3
new_channels = [channel for channel in get_active_redis_channels() if channel not in channels_before_test]
assert new_channels == []
class test_task_replacement:
def test_replaced_task_nesting_level_0(self, manager):
@task_received.connect
def task_received_handler(request, **kwargs):
nonlocal assertion_result
try:
# This tests mainly that the field even exists and set to default 0
assertion_result = request.replaced_task_nesting < 1
except Exception:
assertion_result = False
non_replaced_task = add.si(4, 2)
res = non_replaced_task.delay()
assertion_result = False
assert res.get(timeout=TIMEOUT) == 6
assert assertion_result
def test_replaced_task_nesting_level_1(self, manager):
if not manager.app.conf.result_backend.startswith("redis"):
raise pytest.skip("Requires redis result backend.")
redis_connection = get_redis_connection()
redis_connection.delete("redis-echo")
@task_received.connect
def task_received_handler(request, **kwargs):
nonlocal assertion_result
try:
assertion_result = request.replaced_task_nesting <= 2
except Exception:
assertion_result = False
replaced_task = second_order_replace1.si()
res = replaced_task.delay()
assertion_result = False
res.get(timeout=TIMEOUT)
assert assertion_result
redis_messages = list(redis_connection.lrange("redis-echo", 0, -1))
expected_messages = [b"In A", b"In B", b"In/Out C", b"Out B", b"Out A"]
assert redis_messages == expected_messages
def test_replaced_task_nesting_chain(self, manager):
if not manager.app.conf.result_backend.startswith("redis"):
raise pytest.skip("Requires redis result backend.")
redis_connection = get_redis_connection()
redis_connection.delete("redis-echo")
@task_received.connect
def task_received_handler(request, **kwargs):
nonlocal assertion_result
try:
assertion_result = request.replaced_task_nesting <= 3
except Exception:
assertion_result = False
assertion_result = False
chain_task = second_order_replace1.si() | add.si(4, 2)
res = chain_task.delay()
res.get(timeout=TIMEOUT)
assert assertion_result
redis_messages = list(redis_connection.lrange("redis-echo", 0, -1))
expected_messages = [b"In A", b"In B", b"In/Out C", b"Out B", b"Out A"]
assert redis_messages == expected_messages
|