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
|
from decimal import Decimal
from unittest.mock import ANY, MagicMock, Mock, call, patch, sentinel
import pytest
from celery import states, uuid
from celery.backends import dynamodb as module
from celery.backends.dynamodb import DynamoDBBackend
from celery.exceptions import ImproperlyConfigured
pytest.importorskip('boto3')
class test_DynamoDBBackend:
def setup_method(self):
self._static_timestamp = Decimal(1483425566.52)
self.app.conf.result_backend = 'dynamodb://'
@property
def backend(self):
""":rtype: DynamoDBBackend"""
return self.app.backend
def test_init_no_boto3(self):
prev, module.boto3 = module.boto3, None
try:
with pytest.raises(ImproperlyConfigured):
DynamoDBBackend(app=self.app)
finally:
module.boto3 = prev
def test_init_aws_credentials(self):
with pytest.raises(ImproperlyConfigured):
DynamoDBBackend(
app=self.app,
url='dynamodb://a:@'
)
def test_init_invalid_ttl_seconds_raises(self):
with pytest.raises(ValueError):
DynamoDBBackend(
app=self.app,
url='dynamodb://@?ttl_seconds=1d'
)
def test_get_client_explicit_endpoint(self):
table_creation_path = \
'celery.backends.dynamodb.DynamoDBBackend._get_or_create_table'
with patch('boto3.client') as mock_boto_client, \
patch(table_creation_path):
self.app.conf.dynamodb_endpoint_url = 'http://my.domain.com:666'
backend = DynamoDBBackend(
app=self.app,
url='dynamodb://@us-east-1'
)
client = backend._get_client()
assert backend.client is client
mock_boto_client.assert_called_once_with(
'dynamodb',
endpoint_url='http://my.domain.com:666',
region_name='us-east-1'
)
assert backend.endpoint_url == 'http://my.domain.com:666'
@pytest.mark.parametrize("dynamodb_host", [
'localhost', '127.0.0.1',
])
def test_get_client_local(self, dynamodb_host):
table_creation_path = \
'celery.backends.dynamodb.DynamoDBBackend._get_or_create_table'
with patch('boto3.client') as mock_boto_client, \
patch(table_creation_path):
backend = DynamoDBBackend(
app=self.app,
url=f'dynamodb://@{dynamodb_host}:8000'
)
client = backend._get_client()
assert backend.client is client
mock_boto_client.assert_called_once_with(
'dynamodb',
endpoint_url=f'http://{dynamodb_host}:8000',
region_name='us-east-1'
)
assert backend.endpoint_url == f'http://{dynamodb_host}:8000'
def test_get_client_credentials(self):
table_creation_path = \
'celery.backends.dynamodb.DynamoDBBackend._get_or_create_table'
with patch('boto3.client') as mock_boto_client, \
patch(table_creation_path):
backend = DynamoDBBackend(
app=self.app,
url='dynamodb://key:secret@test'
)
client = backend._get_client()
assert client is backend.client
mock_boto_client.assert_called_once_with(
'dynamodb',
aws_access_key_id='key',
aws_secret_access_key='secret',
region_name='test'
)
assert backend.aws_region == 'test'
@patch('boto3.client')
@patch('celery.backends.dynamodb.DynamoDBBackend._get_or_create_table')
@patch('celery.backends.dynamodb.DynamoDBBackend._validate_ttl_methods')
@patch('celery.backends.dynamodb.DynamoDBBackend._set_table_ttl')
def test_get_client_time_to_live_called(
self,
mock_set_table_ttl,
mock_validate_ttl_methods,
mock_get_or_create_table,
mock_boto_client,
):
backend = DynamoDBBackend(
app=self.app,
url='dynamodb://key:secret@test?ttl_seconds=30'
)
backend._get_client()
mock_validate_ttl_methods.assert_called_once()
mock_set_table_ttl.assert_called_once()
def test_get_or_create_table_not_exists(self):
from botocore.exceptions import ClientError
self.backend._client = MagicMock()
mock_create_table = self.backend._client.create_table = MagicMock()
client_error = ClientError(
{
'Error': {
'Code': 'ResourceNotFoundException'
}
},
'DescribeTable'
)
mock_describe_table = self.backend._client.describe_table = \
MagicMock()
mock_describe_table.side_effect = client_error
self.backend._wait_for_table_status = MagicMock()
self.backend._get_or_create_table()
mock_describe_table.assert_called_once_with(
TableName=self.backend.table_name
)
mock_create_table.assert_called_once_with(
**self.backend._get_table_schema()
)
def test_get_or_create_table_already_exists(self):
self.backend._client = MagicMock()
mock_create_table = self.backend._client.create_table = MagicMock()
mock_describe_table = self.backend._client.describe_table = \
MagicMock()
mock_describe_table.return_value = {
'Table': {
'TableStatus': 'ACTIVE'
}
}
self.backend._get_or_create_table()
mock_describe_table.assert_called_once_with(
TableName=self.backend.table_name
)
mock_create_table.assert_not_called()
def test_wait_for_table_status(self):
self.backend._client = MagicMock()
mock_describe_table = self.backend._client.describe_table = \
MagicMock()
mock_describe_table.side_effect = [
{'Table': {
'TableStatus': 'CREATING'
}},
{'Table': {
'TableStatus': 'SOME_STATE'
}}
]
self.backend._wait_for_table_status(expected='SOME_STATE')
assert mock_describe_table.call_count == 2
def test_has_ttl_none_returns_none(self):
self.backend.time_to_live_seconds = None
assert self.backend._has_ttl() is None
def test_has_ttl_lt_zero_returns_false(self):
self.backend.time_to_live_seconds = -1
assert self.backend._has_ttl() is False
def test_has_ttl_gte_zero_returns_true(self):
self.backend.time_to_live_seconds = 30
assert self.backend._has_ttl() is True
def test_validate_ttl_methods_present_returns_none(self):
self.backend._client = MagicMock()
assert self.backend._validate_ttl_methods() is None
def test_validate_ttl_methods_missing_raise(self):
self.backend._client = MagicMock()
delattr(self.backend._client, 'describe_time_to_live')
delattr(self.backend._client, 'update_time_to_live')
with pytest.raises(AttributeError):
self.backend._validate_ttl_methods()
with pytest.raises(AttributeError):
self.backend._validate_ttl_methods()
def test_set_table_ttl_describe_time_to_live_fails_raises(self):
from botocore.exceptions import ClientError
self.backend.time_to_live_seconds = -1
self.backend._client = MagicMock()
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
client_error = ClientError(
{
'Error': {
'Code': 'Foo',
'Message': 'Bar',
}
},
'DescribeTimeToLive'
)
mock_describe_time_to_live.side_effect = client_error
with pytest.raises(ClientError):
self.backend._set_table_ttl()
def test_set_table_ttl_enable_when_disabled_succeeds(self):
self.backend.time_to_live_seconds = 30
self.backend._client = MagicMock()
mock_update_time_to_live = self.backend._client.update_time_to_live = \
MagicMock()
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
mock_describe_time_to_live.return_value = {
'TimeToLiveDescription': {
'TimeToLiveStatus': 'DISABLED',
'AttributeName': self.backend._ttl_field.name
}
}
self.backend._set_table_ttl()
mock_describe_time_to_live.assert_called_once_with(
TableName=self.backend.table_name
)
mock_update_time_to_live.assert_called_once()
def test_set_table_ttl_enable_when_enabled_with_correct_attr_succeeds(self):
self.backend.time_to_live_seconds = 30
self.backend._client = MagicMock()
self.backend._client.update_time_to_live = MagicMock()
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
mock_describe_time_to_live.return_value = {
'TimeToLiveDescription': {
'TimeToLiveStatus': 'ENABLED',
'AttributeName': self.backend._ttl_field.name
}
}
self.backend._set_table_ttl()
mock_describe_time_to_live.assert_called_once_with(
TableName=self.backend.table_name
)
def test_set_table_ttl_enable_when_currently_disabling_raises(self):
from botocore.exceptions import ClientError
self.backend.time_to_live_seconds = 30
self.backend._client = MagicMock()
mock_update_time_to_live = self.backend._client.update_time_to_live = \
MagicMock()
client_error = ClientError(
{
'Error': {
'Code': 'ValidationException',
'Message': (
'Time to live has been modified multiple times '
'within a fixed interval'
)
}
},
'UpdateTimeToLive'
)
mock_update_time_to_live.side_effect = client_error
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
mock_describe_time_to_live.return_value = {
'TimeToLiveDescription': {
'TimeToLiveStatus': 'DISABLING',
'AttributeName': self.backend._ttl_field.name
}
}
with pytest.raises(ClientError):
self.backend._set_table_ttl()
def test_set_table_ttl_enable_when_enabled_with_wrong_attr_raises(self):
from botocore.exceptions import ClientError
self.backend.time_to_live_seconds = 30
self.backend._client = MagicMock()
mock_update_time_to_live = self.backend._client.update_time_to_live = \
MagicMock()
wrong_attr_name = self.backend._ttl_field.name + 'x'
client_error = ClientError(
{
'Error': {
'Code': 'ValidationException',
'Message': (
'TimeToLive is active on a different AttributeName: '
'current AttributeName is {}'
).format(wrong_attr_name)
}
},
'UpdateTimeToLive'
)
mock_update_time_to_live.side_effect = client_error
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
mock_describe_time_to_live.return_value = {
'TimeToLiveDescription': {
'TimeToLiveStatus': 'ENABLED',
'AttributeName': self.backend._ttl_field.name + 'x'
}
}
with pytest.raises(ClientError):
self.backend._set_table_ttl()
def test_set_table_ttl_disable_when_disabled_succeeds(self):
self.backend.time_to_live_seconds = -1
self.backend._client = MagicMock()
self.backend._client.update_time_to_live = MagicMock()
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
mock_describe_time_to_live.return_value = {
'TimeToLiveDescription': {
'TimeToLiveStatus': 'DISABLED'
}
}
self.backend._set_table_ttl()
mock_describe_time_to_live.assert_called_once_with(
TableName=self.backend.table_name
)
def test_set_table_ttl_disable_when_currently_enabling_raises(self):
from botocore.exceptions import ClientError
self.backend.time_to_live_seconds = -1
self.backend._client = MagicMock()
mock_update_time_to_live = self.backend._client.update_time_to_live = \
MagicMock()
client_error = ClientError(
{
'Error': {
'Code': 'ValidationException',
'Message': (
'Time to live has been modified multiple times '
'within a fixed interval'
)
}
},
'UpdateTimeToLive'
)
mock_update_time_to_live.side_effect = client_error
mock_describe_time_to_live = \
self.backend._client.describe_time_to_live = MagicMock()
mock_describe_time_to_live.return_value = {
'TimeToLiveDescription': {
'TimeToLiveStatus': 'ENABLING',
'AttributeName': self.backend._ttl_field.name
}
}
with pytest.raises(ClientError):
self.backend._set_table_ttl()
def test_prepare_get_request(self):
expected = {
'TableName': 'celery',
'Key': {'id': {'S': 'abcdef'}}
}
assert self.backend._prepare_get_request('abcdef') == expected
def test_prepare_put_request(self):
expected = {
'TableName': 'celery',
'Item': {
'id': {'S': 'abcdef'},
'result': {'B': 'val'},
'timestamp': {
'N': str(Decimal(self._static_timestamp))
}
}
}
with patch('celery.backends.dynamodb.time', self._mock_time):
result = self.backend._prepare_put_request('abcdef', 'val')
assert result == expected
def test_prepare_put_request_with_ttl(self):
ttl = self.backend.time_to_live_seconds = 30
expected = {
'TableName': 'celery',
'Item': {
'id': {'S': 'abcdef'},
'result': {'B': 'val'},
'timestamp': {
'N': str(Decimal(self._static_timestamp))
},
'ttl': {
'N': str(int(self._static_timestamp + ttl))
}
}
}
with patch('celery.backends.dynamodb.time', self._mock_time):
result = self.backend._prepare_put_request('abcdef', 'val')
assert result == expected
def test_prepare_init_count_request(self):
expected = {
'TableName': 'celery',
'Item': {
'id': {'S': 'abcdef'},
'chord_count': {'N': '0'},
'timestamp': {
'N': str(Decimal(self._static_timestamp))
},
}
}
with patch('celery.backends.dynamodb.time', self._mock_time):
result = self.backend._prepare_init_count_request('abcdef')
assert result == expected
def test_prepare_inc_count_request(self):
expected = {
'TableName': 'celery',
'Key': {
'id': {'S': 'abcdef'},
},
'UpdateExpression': 'set chord_count = chord_count + :num',
'ExpressionAttributeValues': {":num": {"N": "1"}},
'ReturnValues': 'UPDATED_NEW',
}
result = self.backend._prepare_inc_count_request('abcdef')
assert result == expected
def test_item_to_dict(self):
boto_response = {
'Item': {
'id': {
'S': sentinel.key
},
'result': {
'B': sentinel.value
},
'timestamp': {
'N': Decimal(1)
}
}
}
converted = self.backend._item_to_dict(boto_response)
assert converted == {
'id': sentinel.key,
'result': sentinel.value,
'timestamp': Decimal(1)
}
def test_get(self):
self.backend._client = Mock(name='_client')
self.backend._client.get_item = MagicMock()
assert self.backend.get('1f3fab') is None
self.backend.client.get_item.assert_called_once_with(
Key={'id': {'S': '1f3fab'}},
TableName='celery'
)
def _mock_time(self):
return self._static_timestamp
def test_set(self):
self.backend._client = MagicMock()
self.backend._client.put_item = MagicMock()
# should return None
with patch('celery.backends.dynamodb.time', self._mock_time):
assert self.backend._set_with_state(sentinel.key, sentinel.value, states.SUCCESS) is None
assert self.backend._client.put_item.call_count == 1
_, call_kwargs = self.backend._client.put_item.call_args
expected_kwargs = {
'Item': {
'timestamp': {'N': str(self._static_timestamp)},
'id': {'S': str(sentinel.key)},
'result': {'B': sentinel.value}
},
'TableName': 'celery'
}
assert call_kwargs['Item'] == expected_kwargs['Item']
assert call_kwargs['TableName'] == 'celery'
def test_set_with_ttl(self):
ttl = self.backend.time_to_live_seconds = 30
self.backend._client = MagicMock()
self.backend._client.put_item = MagicMock()
# should return None
with patch('celery.backends.dynamodb.time', self._mock_time):
assert self.backend._set_with_state(sentinel.key, sentinel.value, states.SUCCESS) is None
assert self.backend._client.put_item.call_count == 1
_, call_kwargs = self.backend._client.put_item.call_args
expected_kwargs = {
'Item': {
'timestamp': {'N': str(self._static_timestamp)},
'id': {'S': str(sentinel.key)},
'result': {'B': sentinel.value},
'ttl': {'N': str(int(self._static_timestamp + ttl))},
},
'TableName': 'celery'
}
assert call_kwargs['Item'] == expected_kwargs['Item']
assert call_kwargs['TableName'] == 'celery'
def test_delete(self):
self.backend._client = Mock(name='_client')
mocked_delete = self.backend._client.delete = Mock('client.delete')
mocked_delete.return_value = None
# should return None
assert self.backend.delete('1f3fab') is None
self.backend.client.delete_item.assert_called_once_with(
Key={'id': {'S': '1f3fab'}},
TableName='celery'
)
def test_inc(self):
mocked_incr_response = {
'Attributes': {
'chord_count': {
'N': '1'
}
},
'ResponseMetadata': {
'RequestId': '16d31c72-51f6-4538-9415-499f1135dc59',
'HTTPStatusCode': 200,
'HTTPHeaders': {
'date': 'Wed, 10 Jan 2024 17:53:41 GMT',
'x-amzn-requestid': '16d31c72-51f6-4538-9415-499f1135dc59',
'content-type': 'application/x-amz-json-1.0',
'x-amz-crc32': '3438282865',
'content-length': '40',
'server': 'Jetty(11.0.17)'
},
'RetryAttempts': 0
}
}
self.backend._client = MagicMock()
self.backend._client.update_item = MagicMock(return_value=mocked_incr_response)
assert self.backend.incr('1f3fab') == 1
self.backend.client.update_item.assert_called_once_with(
Key={'id': {'S': '1f3fab'}},
TableName='celery',
UpdateExpression='set chord_count = chord_count + :num',
ExpressionAttributeValues={":num": {"N": "1"}},
ReturnValues='UPDATED_NEW',
)
def test_backend_by_url(self, url='dynamodb://'):
from celery.app import backends
from celery.backends.dynamodb import DynamoDBBackend
backend, url_ = backends.by_url(url, self.app.loader)
assert backend is DynamoDBBackend
assert url_ == url
def test_backend_params_by_url(self):
self.app.conf.result_backend = (
'dynamodb://@us-east-1/celery_results'
'?read=10'
'&write=20'
'&ttl_seconds=600'
)
assert self.backend.aws_region == 'us-east-1'
assert self.backend.table_name == 'celery_results'
assert self.backend.read_capacity_units == 10
assert self.backend.write_capacity_units == 20
assert self.backend.time_to_live_seconds == 600
assert self.backend.endpoint_url is None
def test_apply_chord(self, unlock="celery.chord_unlock"):
self.app.tasks[unlock] = Mock()
chord_uuid = uuid()
header_result_args = (
chord_uuid,
[self.app.AsyncResult(x) for x in range(3)],
)
self.backend._client = MagicMock()
self.backend.apply_chord(header_result_args, None)
assert self.backend._client.put_item.call_args_list == [
call(
TableName="celery",
Item={
"id": {"S": f"b'chord-unlock-{chord_uuid}'"},
"chord_count": {"N": "0"},
"timestamp": {"N": ANY},
},
),
call(
TableName="celery",
Item={
"id": {"S": f"b'celery-taskset-meta-{chord_uuid}'"},
"result": {
"B": ANY,
},
"timestamp": {"N": ANY},
},
),
]
|