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
|
import itertools
import sys
from logging import LogRecord
from typing import Iterator
from unittest.mock import MagicMock, Mock, patch
if sys.version_info < (3, 11): # pragma: no cover
from exceptiongroup import ExceptionGroup
import pytest
from amqp import NotFound
from kombu import Exchange, Queue
from kombu.utils.functional import retry_over_time
from celery.worker.consumer.delayed_delivery import MAX_RETRIES, RETRY_INTERVAL, DelayedDelivery
class test_DelayedDelivery:
@patch('celery.worker.consumer.delayed_delivery.detect_quorum_queues', return_value=[False, ""])
def test_include_if_no_quorum_queues_detected(self, _):
consumer_mock = Mock()
delayed_delivery = DelayedDelivery(consumer_mock)
assert delayed_delivery.include_if(consumer_mock) is False
@patch('celery.worker.consumer.delayed_delivery.detect_quorum_queues', return_value=[True, ""])
def test_include_if_quorum_queues_detected(self, _):
consumer_mock = Mock()
delayed_delivery = DelayedDelivery(consumer_mock)
assert delayed_delivery.include_if(consumer_mock) is True
def test_start_native_delayed_delivery_direct_exchange(self, caplog):
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
consumer_mock.app.amqp.queues = {
'celery': Queue('celery', exchange=Exchange('celery', type='direct'))
}
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
assert len(caplog.records) == 1
record: LogRecord = caplog.records[0]
assert record.levelname == "WARNING"
assert record.message == (
"Exchange celery is a direct exchange "
"and native delayed delivery do not support direct exchanges.\n"
"ETA tasks published to this exchange "
"will block the worker until the ETA arrives."
)
def test_start_native_delayed_delivery_topic_exchange(self, caplog):
consumer_mock = Mock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
consumer_mock.app.amqp.queues = {
'celery': Queue('celery', exchange=Exchange('celery', type='topic'))
}
connection = MagicMock()
consumer_mock.app.connection_for_write.return_value = connection
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
assert len(caplog.records) == 0
# Verify connection context was called
assert connection.__enter__.called
assert connection.__exit__.called
def test_start_native_delayed_delivery_fanout_exchange(self, caplog):
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
consumer_mock.app.amqp.queues = {
'celery': Queue('celery', exchange=Exchange('celery', type='fanout'))
}
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
assert len(caplog.records) == 0
@pytest.mark.parametrize(
"broker_urls, expected_result",
[
("amqp://", {"amqp://"}),
("amqp://;redis://", {"amqp://", "redis://"}),
(
["amqp://", "redis://", "sqs://"],
{"amqp://", "redis://", "sqs://"},
),
],
)
def test_validate_broker_urls_valid(self, broker_urls, expected_result):
delayed_delivery = DelayedDelivery(Mock())
urls = delayed_delivery._validate_broker_urls(broker_urls)
assert urls == expected_result
@pytest.mark.parametrize(
"broker_urls, exception_type, exception_match",
[
("", ValueError, "broker_url configuration is empty"),
(None, ValueError, "broker_url configuration is empty"),
([], ValueError, "broker_url configuration is empty"),
(123, ValueError, "broker_url must be a string or list"),
(["amqp://", 123, None, "amqp://"], ValueError, "All broker URLs must be strings"),
],
)
def test_validate_broker_urls_invalid(self, broker_urls, exception_type, exception_match):
delayed_delivery = DelayedDelivery(Mock())
with pytest.raises(exception_type, match=exception_match):
delayed_delivery._validate_broker_urls(broker_urls)
def test_validate_queue_type_empty(self):
delayed_delivery = DelayedDelivery(Mock())
with pytest.raises(ValueError, match="broker_native_delayed_delivery_queue_type is not configured"):
delayed_delivery._validate_queue_type(None)
with pytest.raises(ValueError, match="broker_native_delayed_delivery_queue_type is not configured"):
delayed_delivery._validate_queue_type("")
def test_validate_queue_type_invalid(self):
delayed_delivery = DelayedDelivery(Mock())
with pytest.raises(ValueError, match="Invalid queue type 'invalid'. Must be one of: classic, quorum"):
delayed_delivery._validate_queue_type("invalid")
def test_validate_queue_type_valid(self):
delayed_delivery = DelayedDelivery(Mock())
delayed_delivery._validate_queue_type("classic")
delayed_delivery._validate_queue_type("quorum")
@patch('celery.worker.consumer.delayed_delivery.retry_over_time')
def test_start_retry_on_connection_error(self, mock_retry, caplog):
consumer_mock = Mock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://localhost;amqp://backup'
consumer_mock.app.amqp.queues = {
'celery': Queue('celery', exchange=Exchange('celery', type='topic'))
}
mock_retry.side_effect = ConnectionRefusedError("Connection refused")
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
# Should try both URLs
assert mock_retry.call_count == 2
# Should log warning for each failed attempt
assert len([r for r in caplog.records if r.levelname == "WARNING"]) == 2
# Should log critical when all URLs fail
assert len([r for r in caplog.records if r.levelname == "CRITICAL"]) == 1
def test_on_retry_logging(self, caplog):
delayed_delivery = DelayedDelivery(Mock())
exc = ConnectionRefusedError("Connection refused")
# Create a dummy float iterator
interval_range = iter([1.0, 2.0, 3.0])
intervals_count = 1
delayed_delivery._on_retry(exc, interval_range, intervals_count)
assert len(caplog.records) == 1
record = caplog.records[0]
assert record.levelname == "WARNING"
assert "attempt 2/3" in record.message
assert "Connection refused" in record.message
def test_on_retry_argument_types(self):
delayed_delivery_instance = DelayedDelivery(parent=Mock())
fake_exception = ConnectionRefusedError("Simulated failure")
# Define a custom errback to check types
def type_checking_errback(self, exc, interval_range, intervals_count):
assert isinstance(exc, Exception), f"Expected Exception, got {type(exc)}"
assert isinstance(interval_range, Iterator), f"Expected Iterator, got {type(interval_range)}"
assert isinstance(intervals_count, int), f"Expected int, got {type(intervals_count)}"
peek_iter, interval_range = itertools.tee(interval_range)
try:
first = next(peek_iter)
assert isinstance(first, float)
except StopIteration:
pass
return 0.1
# Patch _setup_delayed_delivery to raise the exception immediately
with patch.object(delayed_delivery_instance, '_setup_delayed_delivery', side_effect=fake_exception):
# Patch _on_retry properly as a bound method to avoid 'missing self'
with patch.object(
delayed_delivery_instance,
'_on_retry',
new=type_checking_errback.__get__(delayed_delivery_instance)
):
try:
with pytest.raises(ConnectionRefusedError):
retry_over_time(
delayed_delivery_instance._setup_delayed_delivery,
args=(Mock(), "amqp://localhost"),
catch=(ConnectionRefusedError,),
errback=delayed_delivery_instance._on_retry,
interval_start=RETRY_INTERVAL,
max_retries=MAX_RETRIES,
)
except ConnectionRefusedError:
pass # expected
def test_retry_over_time_with_float_return(self):
delayed_delivery = DelayedDelivery(parent=Mock())
return_values = []
# Wrap the real _on_retry method to capture its return value
original_on_retry = delayed_delivery._on_retry
def wrapped_on_retry(exc, interval_range, intervals_count):
result = original_on_retry(exc, interval_range, intervals_count)
return_values.append(result)
return result
with patch.object(
delayed_delivery, '_setup_delayed_delivery',
side_effect=ConnectionRefusedError("Simulated failure")
):
with pytest.raises(ConnectionRefusedError):
retry_over_time(
fun=delayed_delivery._setup_delayed_delivery,
args=(Mock(), "amqp://localhost"),
catch=(ConnectionRefusedError,),
errback=wrapped_on_retry,
interval_start=RETRY_INTERVAL,
max_retries=MAX_RETRIES
)
assert len(return_values) == MAX_RETRIES
for value in return_values:
assert isinstance(value, float), f"Expected float, got {type(value)}"
def test_start_with_no_queues(self, caplog):
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
consumer_mock.app.amqp.queues = {}
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
assert len([r for r in caplog.records if r.levelname == "WARNING"]) == 1
assert "No queues found to bind for delayed delivery" in caplog.records[0].message
def test_start_configuration_validation_error(self, caplog):
consumer_mock = Mock()
consumer_mock.app.conf.broker_url = "" # Invalid broker URL
delayed_delivery = DelayedDelivery(consumer_mock)
with pytest.raises(ValueError, match="broker_url configuration is empty"):
delayed_delivery.start(consumer_mock)
assert len(caplog.records) == 1
record = caplog.records[0]
assert record.levelname == "CRITICAL"
assert "Configuration validation failed" in record.message
@patch('celery.worker.consumer.delayed_delivery.declare_native_delayed_delivery_exchanges_and_queues')
def test_setup_declare_error(self, mock_declare, caplog):
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
consumer_mock.app.amqp.queues = {
'celery': Queue('celery', exchange=Exchange('celery', type='topic'))
}
mock_declare.side_effect = Exception("Failed to declare")
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
# Should log warning and critical messages
assert len([r for r in caplog.records if r.levelname == "WARNING"]) == 2
assert len([r for r in caplog.records if r.levelname == "CRITICAL"]) == 1
assert any("Failed to declare exchanges and queues" in r.message for r in caplog.records)
assert any("Failed to setup delayed delivery for all broker URLs" in r.message for r in caplog.records)
@patch('celery.worker.consumer.delayed_delivery.bind_queue_to_native_delayed_delivery_exchange')
def test_setup_bind_error(self, mock_bind, caplog):
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = 'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
consumer_mock.app.amqp.queues = {
'celery': Queue('celery', exchange=Exchange('celery', type='topic'))
}
mock_bind.side_effect = Exception("Failed to bind")
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
# Should log warning and critical messages
assert len([r for r in caplog.records if r.levelname == "WARNING"]) == 2
assert len([r for r in caplog.records if r.levelname == "CRITICAL"]) == 1
assert any("Failed to bind queue" in r.message for r in caplog.records)
assert any("Failed to setup delayed delivery for all broker URLs" in r.message for r in caplog.records)
@patch('celery.worker.consumer.delayed_delivery.bind_queue_to_native_delayed_delivery_exchange')
def test_bind_queues_continues_after_failure(self, mock_bind, caplog):
"""
Test that binding continues for remaining queues after one fails.
"""
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = \
'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
# Create three queues
queue1 = Queue('queue1', exchange=Exchange('exchange1', type='topic'))
queue2 = Queue('queue2', exchange=Exchange('exchange2', type='topic'))
queue3 = Queue('queue3', exchange=Exchange('exchange3', type='topic'))
consumer_mock.app.amqp.queues = {
'queue1': queue1,
'queue2': queue2,
'queue3': queue3,
}
# Make the second queue fail to bind
def bind_side_effect(connection, queue):
if queue.name == 'queue2':
raise NotFound(
reply_text="NOT_FOUND - no queue 'queue2' in vhost '/'",
method_name="Queue.bind",
reply_code=404,
)
mock_bind.side_effect = bind_side_effect
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
# Verify that bind was called for all three queues
assert mock_bind.call_count == 3
# Verify error was logged for queue2
error_logs = [r for r in caplog.records if r.levelname == "ERROR"]
expected_msg = \
"Queue.bind: (404) NOT_FOUND - no queue 'queue2' in vhost '/'"
assert any(expected_msg in r.message for r in error_logs)
@patch('celery.worker.consumer.delayed_delivery.bind_queue_to_native_delayed_delivery_exchange')
def test_bind_queues_raises_exceptions_on_failures(self, mock_bind):
"""Test that Exceptions are raised with all binding failures."""
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = \
'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
# Create three queues
queue1 = Queue('queue1', exchange=Exchange('exchange1', type='topic'))
queue2 = Queue('queue2', exchange=Exchange('exchange2', type='topic'))
queue3 = Queue('queue3', exchange=Exchange('exchange3', type='topic'))
consumer_mock.app.amqp.queues = {
'queue1': queue1,
'queue2': queue2,
'queue3': queue3,
}
# Make queue1 and queue3 fail with different errors
def bind_side_effect(connection, queue):
if queue.name == 'queue1':
raise ValueError("Queue1 binding failed")
elif queue.name == 'queue3':
raise RuntimeError("Queue3 binding failed")
mock_bind.side_effect = bind_side_effect
delayed_delivery = DelayedDelivery(consumer_mock)
# Should raise RuntimeError containing both exceptions messages
with pytest.raises(ExceptionGroup) as exc_info:
delayed_delivery._setup_delayed_delivery(consumer_mock, 'amqp://')
# Verify the RuntimeError message contains both exceptions
exception_group = exc_info.value
assert str(exception_group) == (
"One or more failures occurred while binding queues to delayed "
"delivery exchanges (2 sub-exceptions)"
)
# Verify the ExceptionGroup contains both exceptions
exceptions = exception_group.exceptions
assert len(exceptions) == 2
assert any(
isinstance(ex, ValueError) and str(ex) == "Queue1 binding failed"
for ex in exceptions
)
assert any(
isinstance(ex, RuntimeError) and str(ex) == "Queue3 binding failed"
for ex in exceptions
)
# Verify bind was called for all three queues
assert mock_bind.call_count == 3
@patch('celery.worker.consumer.delayed_delivery.bind_queue_to_native_delayed_delivery_exchange')
def test_bind_retries_on_retried_exception(self, mock_bind, caplog):
"""
Test that retried exceptions from
bind_queue_to_native_delayed_delivery_exchange trigger the retry
mechanism.
"""
consumer_mock = MagicMock()
consumer_mock.app.conf.broker_native_delayed_delivery_queue_type = \
'classic'
consumer_mock.app.conf.broker_url = 'amqp://'
# Create a queue
queue1 = Queue('queue1', exchange=Exchange('exchange1', type='topic'))
consumer_mock.app.amqp.queues = {'queue1': queue1}
# Track bind attempts
bind_attempts = [0]
# Make bind raise a ConnectionRefusedError twice, then succeed
# This simulates a transient connection issue that resolves on retry
def bind_side_effect(connection, queue):
bind_attempts[0] += 1
if bind_attempts[0] <= 2:
# ConnectionRefusedError is one of the RETRIED_EXCEPTIONS
raise ConnectionRefusedError("Connection refused")
# Succeed on third attempt
mock_bind.side_effect = bind_side_effect
delayed_delivery = DelayedDelivery(consumer_mock)
delayed_delivery.start(consumer_mock)
# Verify bind was attempted multiple times (indicating retries
# occurred)
assert bind_attempts[0] == 3, \
"Expected 3 bind attempts (2 failures + 1 success), got " + \
f"{bind_attempts[0]}"
# Verify retry warnings were logged
warning_logs = [r for r in caplog.records if r.levelname == "WARNING"]
retry_warnings = [
r for r in warning_logs
if "Retrying delayed delivery setup" in r.message
]
# Should have 2 retry warnings (one for each failed attempt)
assert len(retry_warnings) == 2, \
f"Expected 2 retry warnings, got {len(retry_warnings)}. " + \
f"All warnings: {[r.message for r in warning_logs]}"
# Verify the retry messages contain the expected information and
# correct attempt numbers
assert "Connection refused" in retry_warnings[0].message
assert "attempt 1/" in retry_warnings[0].message
assert "Connection refused" in retry_warnings[1].message
assert "attempt 2/" in retry_warnings[1].message
|