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 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
|
import datetime
from pickle import dumps, loads
from unittest.mock import ANY, MagicMock, Mock, patch, sentinel
import dns.version
import pymongo
import pytest
from kombu.exceptions import EncodeError
try:
from pymongo.errors import ConfigurationError
except ImportError:
ConfigurationError = None
import sys
if sys.version_info >= (3, 9):
from zoneinfo import ZoneInfo
else:
from backports.zoneinfo import ZoneInfo
from celery import states, uuid
from celery.backends.mongodb import Binary, InvalidDocument, MongoBackend
from celery.exceptions import ImproperlyConfigured
from t.unit import conftest
COLLECTION = 'taskmeta_celery'
TASK_ID = uuid()
MONGODB_HOST = 'localhost'
MONGODB_PORT = 27017
MONGODB_USER = 'mongo'
MONGODB_PASSWORD = '1234'
MONGODB_DATABASE = 'testing'
MONGODB_COLLECTION = 'collection1'
MONGODB_GROUP_COLLECTION = 'group_collection1'
# uri with user, password, database name, replica set, DNS seedlist format
MONGODB_SEEDLIST_URI = ('srv://'
'celeryuser:celerypassword@'
'dns-seedlist-host.example.com/'
'celerydatabase')
MONGODB_BACKEND_HOST = [
'mongo1.example.com:27017',
'mongo2.example.com:27017',
'mongo3.example.com:27017',
]
CELERY_USER = 'celeryuser'
CELERY_PASSWORD = 'celerypassword'
CELERY_DATABASE = 'celerydatabase'
pytest.importorskip('pymongo')
def fake_resolver_dnspython():
TXT = pytest.importorskip('dns.rdtypes.ANY.TXT').TXT
SRV = pytest.importorskip('dns.rdtypes.IN.SRV').SRV
def mock_resolver(_, rdtype, rdclass=None, lifetime=None, **kwargs):
if rdtype == 'SRV':
return [
SRV(0, 0, 0, 0, 27017, hostname)
for hostname in [
'mongo1.example.com',
'mongo2.example.com',
'mongo3.example.com'
]
]
elif rdtype == 'TXT':
return [TXT(0, 0, [b'replicaSet=rs0'])]
return mock_resolver
class test_MongoBackend:
default_url = 'mongodb://uuuu:pwpw@hostname.dom/database'
replica_set_url = (
'mongodb://uuuu:pwpw@hostname.dom,'
'hostname.dom/database?replicaSet=rs'
)
sanitized_default_url = 'mongodb://uuuu:**@hostname.dom/database'
sanitized_replica_set_url = (
'mongodb://uuuu:**@hostname.dom/,'
'hostname.dom/database?replicaSet=rs'
)
def setup_method(self):
self.patching('celery.backends.mongodb.MongoBackend.encode')
self.patching('celery.backends.mongodb.MongoBackend.decode')
self.patching('celery.backends.mongodb.Binary')
self.backend = MongoBackend(app=self.app, url=self.default_url)
def test_init_no_mongodb(self, patching):
patching('celery.backends.mongodb.pymongo', None)
with pytest.raises(ImproperlyConfigured):
MongoBackend(app=self.app)
def test_init_no_settings(self):
self.app.conf.mongodb_backend_settings = []
with pytest.raises(ImproperlyConfigured):
MongoBackend(app=self.app)
def test_init_settings_is_None(self):
self.app.conf.mongodb_backend_settings = None
MongoBackend(app=self.app)
def test_init_with_settings(self):
self.app.conf.mongodb_backend_settings = None
# empty settings
mb = MongoBackend(app=self.app)
# uri
uri = 'mongodb://localhost:27017'
mb = MongoBackend(app=self.app, url=uri)
assert mb.mongo_host == ['localhost:27017']
assert mb.options == mb._prepare_client_options()
assert mb.database_name == 'celery'
# uri with database name
uri = 'mongodb://localhost:27017/celerydb'
mb = MongoBackend(app=self.app, url=uri)
assert mb.database_name == 'celerydb'
# uri with user, password, database name, replica set
uri = ('mongodb://'
'celeryuser:celerypassword@'
'mongo1.example.com:27017,'
'mongo2.example.com:27017,'
'mongo3.example.com:27017/'
'celerydatabase?replicaSet=rs0')
mb = MongoBackend(app=self.app, url=uri)
assert mb.mongo_host == MONGODB_BACKEND_HOST
assert mb.options == dict(
mb._prepare_client_options(),
replicaset='rs0',
)
assert mb.user == CELERY_USER
assert mb.password == CELERY_PASSWORD
assert mb.database_name == CELERY_DATABASE
# same uri, change some parameters in backend settings
self.app.conf.mongodb_backend_settings = {
'replicaset': 'rs1',
'user': 'backenduser',
'database': 'another_db',
'options': {
'socketKeepAlive': True,
},
}
mb = MongoBackend(app=self.app, url=uri)
assert mb.mongo_host == MONGODB_BACKEND_HOST
assert mb.options == dict(
mb._prepare_client_options(),
replicaset='rs1',
socketKeepAlive=True,
)
assert mb.user == 'backenduser'
assert mb.password == CELERY_PASSWORD
assert mb.database_name == 'another_db'
mb = MongoBackend(app=self.app, url='mongodb://')
@pytest.mark.skipif(dns.version.MAJOR > 1,
reason="For dnspython version > 1, pymongo's"
"srv_resolver calls resolver.resolve")
@pytest.mark.skipif(pymongo.version_tuple[0] > 3,
reason="For pymongo version > 3, options returns ssl")
def test_init_mongodb_dnspython1_pymongo3_seedlist(self):
resolver = fake_resolver_dnspython()
self.app.conf.mongodb_backend_settings = None
with patch('dns.resolver.query', side_effect=resolver):
mb = self.perform_seedlist_assertions()
assert mb.options == dict(
mb._prepare_client_options(),
replicaset='rs0',
ssl=True
)
@pytest.mark.skipif(dns.version.MAJOR <= 1,
reason="For dnspython versions 1.X, pymongo's"
"srv_resolver calls resolver.query")
@pytest.mark.skipif(pymongo.version_tuple[0] > 3,
reason="For pymongo version > 3, options returns ssl")
def test_init_mongodb_dnspython2_pymongo3_seedlist(self):
resolver = fake_resolver_dnspython()
self.app.conf.mongodb_backend_settings = None
with patch('dns.resolver.resolve', side_effect=resolver):
mb = self.perform_seedlist_assertions()
assert mb.options == dict(
mb._prepare_client_options(),
replicaset='rs0',
ssl=True
)
@pytest.mark.skipif(dns.version.MAJOR > 1,
reason="For dnspython version >= 2, pymongo's"
"srv_resolver calls resolver.resolve")
@pytest.mark.skipif(pymongo.version_tuple[0] <= 3,
reason="For pymongo version > 3, options returns tls")
def test_init_mongodb_dnspython1_pymongo4_seedlist(self):
resolver = fake_resolver_dnspython()
self.app.conf.mongodb_backend_settings = None
with patch('dns.resolver.query', side_effect=resolver):
mb = self.perform_seedlist_assertions()
assert mb.options == dict(
mb._prepare_client_options(),
replicaset='rs0',
tls=True
)
@pytest.mark.skipif(dns.version.MAJOR <= 1,
reason="For dnspython versions 1.X, pymongo's"
"srv_resolver calls resolver.query")
@pytest.mark.skipif(pymongo.version_tuple[0] <= 3,
reason="For pymongo version > 3, options returns tls")
def test_init_mongodb_dnspython2_pymongo4_seedlist(self):
resolver = fake_resolver_dnspython()
self.app.conf.mongodb_backend_settings = None
with patch('dns.resolver.resolve', side_effect=resolver):
mb = self.perform_seedlist_assertions()
assert mb.options == dict(
mb._prepare_client_options(),
replicaset='rs0',
tls=True
)
def perform_seedlist_assertions(self):
mb = MongoBackend(app=self.app, url=MONGODB_SEEDLIST_URI)
assert mb.mongo_host == MONGODB_BACKEND_HOST
assert mb.user == CELERY_USER
assert mb.password == CELERY_PASSWORD
assert mb.database_name == CELERY_DATABASE
return mb
def test_ensure_mongodb_uri_compliance(self):
mb = MongoBackend(app=self.app, url=None)
compliant_uri = mb._ensure_mongodb_uri_compliance
assert compliant_uri('mongodb://') == 'mongodb://localhost'
assert compliant_uri('mongodb+something://host') == \
'mongodb+something://host'
assert compliant_uri('something://host') == 'mongodb+something://host'
@pytest.mark.usefixtures('depends_on_current_app')
def test_reduce(self):
x = MongoBackend(app=self.app)
assert loads(dumps(x))
def test_get_connection_connection_exists(self):
with patch('pymongo.MongoClient') as mock_Connection:
self.backend._connection = sentinel._connection
connection = self.backend._get_connection()
assert sentinel._connection == connection
mock_Connection.assert_not_called()
def test_get_connection_no_connection_host(self):
with patch('pymongo.MongoClient') as mock_Connection:
self.backend._connection = None
self.backend.host = MONGODB_HOST
self.backend.port = MONGODB_PORT
mock_Connection.return_value = sentinel.connection
connection = self.backend._get_connection()
mock_Connection.assert_called_once_with(
host='mongodb://localhost:27017',
**self.backend._prepare_client_options()
)
assert sentinel.connection == connection
def test_get_connection_no_connection_mongodb_uri(self):
with patch('pymongo.MongoClient') as mock_Connection:
mongodb_uri = 'mongodb://%s:%d' % (MONGODB_HOST, MONGODB_PORT)
self.backend._connection = None
self.backend.host = mongodb_uri
mock_Connection.return_value = sentinel.connection
connection = self.backend._get_connection()
mock_Connection.assert_called_once_with(
host=mongodb_uri, **self.backend._prepare_client_options()
)
assert sentinel.connection == connection
def test_get_connection_with_authmechanism(self):
with patch('pymongo.MongoClient') as mock_Connection:
self.app.conf.mongodb_backend_settings = None
uri = ('mongodb://'
'celeryuser:celerypassword@'
'localhost:27017/'
'celerydatabase?authMechanism=SCRAM-SHA-256')
mb = MongoBackend(app=self.app, url=uri)
mock_Connection.return_value = sentinel.connection
connection = mb._get_connection()
mock_Connection.assert_called_once_with(
host=['localhost:27017'],
username=CELERY_USER,
password=CELERY_PASSWORD,
authmechanism='SCRAM-SHA-256',
**mb._prepare_client_options()
)
assert sentinel.connection == connection
def test_get_connection_with_authmechanism_no_username(self):
with patch('pymongo.MongoClient') as mock_Connection:
self.app.conf.mongodb_backend_settings = None
uri = ('mongodb://'
'localhost:27017/'
'celerydatabase?authMechanism=SCRAM-SHA-256')
mb = MongoBackend(app=self.app, url=uri)
mock_Connection.side_effect = ConfigurationError(
'SCRAM-SHA-256 requires a username.')
with pytest.raises(ConfigurationError):
mb._get_connection()
mock_Connection.assert_called_once_with(
host=['localhost:27017'],
authmechanism='SCRAM-SHA-256',
**mb._prepare_client_options()
)
@patch('celery.backends.mongodb.MongoBackend._get_connection')
def test_get_database_no_existing(self, mock_get_connection):
# Should really check for combinations of these two, to be complete.
self.backend.user = MONGODB_USER
self.backend.password = MONGODB_PASSWORD
mock_database = Mock()
mock_connection = MagicMock(spec=['__getitem__'])
mock_connection.__getitem__.return_value = mock_database
mock_get_connection.return_value = mock_connection
database = self.backend.database
assert database is mock_database
assert self.backend.__dict__['database'] is mock_database
@patch('celery.backends.mongodb.MongoBackend._get_connection')
def test_get_database_no_existing_no_auth(self, mock_get_connection):
# Should really check for combinations of these two, to be complete.
self.backend.user = None
self.backend.password = None
mock_database = Mock()
mock_connection = MagicMock(spec=['__getitem__'])
mock_connection.__getitem__.return_value = mock_database
mock_get_connection.return_value = mock_connection
database = self.backend.database
assert database is mock_database
assert self.backend.__dict__['database'] is mock_database
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_store_result(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
ret_val = self.backend._store_result(
sentinel.task_id, sentinel.result, sentinel.status)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(MONGODB_COLLECTION)
mock_collection.replace_one.assert_called_once_with(ANY, ANY,
upsert=True)
assert sentinel.result == ret_val
mock_collection.replace_one.side_effect = InvalidDocument()
with pytest.raises(EncodeError):
self.backend._store_result(
sentinel.task_id, sentinel.result, sentinel.status)
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_store_result_with_request(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_request = MagicMock(spec=['parent_id'])
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
mock_request.parent_id = sentinel.parent_id
ret_val = self.backend._store_result(
sentinel.task_id, sentinel.result, sentinel.status,
request=mock_request)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(MONGODB_COLLECTION)
parameters = mock_collection.replace_one.call_args[0][1]
assert parameters['parent_id'] == sentinel.parent_id
assert sentinel.result == ret_val
mock_collection.replace_one.side_effect = InvalidDocument()
with pytest.raises(EncodeError):
self.backend._store_result(
sentinel.task_id, sentinel.result, sentinel.status)
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_get_task_meta_for(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_collection.find_one.return_value = MagicMock()
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
ret_val = self.backend._get_task_meta_for(sentinel.task_id)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(MONGODB_COLLECTION)
assert list(sorted([
'status', 'task_id', 'date_done',
'traceback', 'result', 'children',
])) == list(sorted(ret_val.keys()))
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_get_task_meta_for_result_extended(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_collection.find_one.return_value = MagicMock()
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
self.app.conf.result_extended = True
ret_val = self.backend._get_task_meta_for(sentinel.task_id)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(MONGODB_COLLECTION)
assert list(sorted([
'status', 'task_id', 'date_done',
'traceback', 'result', 'children',
'name', 'args', 'queue', 'kwargs', 'worker', 'retries',
])) == list(sorted(ret_val.keys()))
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_get_task_meta_for_no_result(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_collection.find_one.return_value = None
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
ret_val = self.backend._get_task_meta_for(sentinel.task_id)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(MONGODB_COLLECTION)
assert {'status': states.PENDING, 'result': None} == ret_val
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_save_group(self, mock_get_database):
self.backend.groupmeta_collection = MONGODB_GROUP_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
res = [self.app.AsyncResult(i) for i in range(3)]
ret_val = self.backend._save_group(
sentinel.taskset_id, res,
)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(
MONGODB_GROUP_COLLECTION,
)
mock_collection.replace_one.assert_called_once_with(ANY, ANY,
upsert=True)
assert res == ret_val
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_restore_group(self, mock_get_database):
self.backend.groupmeta_collection = MONGODB_GROUP_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_collection.find_one.return_value = {
'_id': sentinel.taskset_id,
'result': [uuid(), uuid()],
'date_done': 1,
}
self.backend.decode.side_effect = lambda r: r
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
ret_val = self.backend._restore_group(sentinel.taskset_id)
mock_get_database.assert_called_once_with()
mock_collection.find_one.assert_called_once_with(
{'_id': sentinel.taskset_id})
assert (sorted(['date_done', 'result', 'task_id']) ==
sorted(list(ret_val.keys())))
mock_collection.find_one.return_value = None
self.backend._restore_group(sentinel.taskset_id)
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_delete_group(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
self.backend._delete_group(sentinel.taskset_id)
mock_get_database.assert_called_once_with()
mock_collection.delete_one.assert_called_once_with(
{'_id': sentinel.taskset_id})
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test__forget(self, mock_get_database):
# note: here tested _forget method, not forget method
self.backend.taskmeta_collection = MONGODB_COLLECTION
mock_database = MagicMock(spec=['__getitem__', '__setitem__'])
mock_collection = Mock()
mock_get_database.return_value = mock_database
mock_database.__getitem__.return_value = mock_collection
self.backend._forget(sentinel.task_id)
mock_get_database.assert_called_once_with()
mock_database.__getitem__.assert_called_once_with(
MONGODB_COLLECTION)
mock_collection.delete_one.assert_called_once_with(
{'_id': sentinel.task_id})
@patch('celery.backends.mongodb.MongoBackend._get_database')
def test_cleanup(self, mock_get_database):
self.backend.taskmeta_collection = MONGODB_COLLECTION
self.backend.groupmeta_collection = MONGODB_GROUP_COLLECTION
mock_database = Mock(spec=['__getitem__', '__setitem__'],
name='MD')
self.backend.collections = mock_collection = Mock()
mock_get_database.return_value = mock_database
mock_database.__getitem__ = Mock(name='MD.__getitem__')
mock_database.__getitem__.return_value = mock_collection
def now_func():
return datetime.datetime.now(datetime.timezone.utc)
self.backend.app.now = now_func
self.backend.cleanup()
mock_get_database.assert_called_once_with()
mock_collection.delete_many.assert_called()
self.backend.collections = mock_collection = Mock()
self.backend.expires = None
self.backend.cleanup()
mock_collection.delete_many.assert_not_called()
def test_prepare_client_options(self):
with patch('pymongo.version_tuple', new=(3, 0, 3)):
options = self.backend._prepare_client_options()
assert options == {
'maxPoolSize': self.backend.max_pool_size
}
def test_as_uri_include_password(self):
assert self.backend.as_uri(True) == self.default_url
def test_as_uri_exclude_password(self):
assert self.backend.as_uri() == self.sanitized_default_url
def test_as_uri_include_password_replica_set(self):
backend = MongoBackend(app=self.app, url=self.replica_set_url)
assert backend.as_uri(True) == self.replica_set_url
def test_as_uri_exclude_password_replica_set(self):
backend = MongoBackend(app=self.app, url=self.replica_set_url)
assert backend.as_uri() == self.sanitized_replica_set_url
def test_regression_worker_startup_info(self):
self.app.conf.result_backend = (
'mongodb://user:password@host0.com:43437,host1.com:43437'
'/work4us?replicaSet=rs&ssl=true'
)
worker = self.app.Worker()
with conftest.stdouts():
worker.on_start()
assert worker.startup_info()
@pytest.fixture(scope="function")
def mongo_backend_factory(app):
"""Return a factory that creates MongoBackend instance with given serializer, including BSON."""
def create_mongo_backend(serializer):
# NOTE: `bson` is a only mongodb-specific type and can be set only directly on MongoBackend instance.
if serializer == "bson":
beckend = MongoBackend(app=app)
beckend.serializer = serializer
else:
app.conf.accept_content = ['json', 'pickle', 'msgpack', 'yaml']
app.conf.result_serializer = serializer
beckend = MongoBackend(app=app)
return beckend
yield create_mongo_backend
@pytest.mark.parametrize("serializer,encoded_into", [
('bson', int),
('json', str),
('pickle', Binary),
('msgpack', Binary),
('yaml', str),
])
class test_MongoBackend_no_mock:
def test_encode(self, mongo_backend_factory, serializer, encoded_into):
backend = mongo_backend_factory(serializer=serializer)
assert isinstance(backend.encode(10), encoded_into)
def test_encode_decode(self, mongo_backend_factory, serializer,
encoded_into):
backend = mongo_backend_factory(serializer=serializer)
decoded = backend.decode(backend.encode(12))
assert decoded == 12
class _MyTestClass:
def __init__(self, a):
self.a = a
def __eq__(self, other):
assert self.__class__ == type(other)
return self.a == other.a
SUCCESS_RESULT_TEST_DATA = [
# json types
{
"result": "A simple string",
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
{
"result": 100,
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
{
"result": 9.1999999999999999,
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
{
"result": {"foo": "simple result"},
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
{
"result": ["a", "b"],
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
{
"result": False,
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
{
"result": None,
"serializers": ["bson", "pickle", "yaml", "json", "msgpack"],
},
# advanced essential types
{
"result": datetime.datetime(2000, 1, 1, 0, 0, 0, 0),
"serializers": ["bson", "pickle", "yaml"],
},
{
"result": datetime.datetime(2000, 1, 1, 0, 0, 0, 0, tzinfo=ZoneInfo("UTC")),
"serializers": ["pickle", "yaml"],
},
# custom types
{
"result": _MyTestClass("Hi!"),
"serializers": ["pickle"],
},
]
class test_MongoBackend_store_get_result:
@pytest.fixture(scope="function", autouse=True)
def fake_mongo_collection_patch(self, monkeypatch):
"""A fake collection with serialization experience close to MongoDB."""
bson = pytest.importorskip("bson")
class FakeMongoCollection:
def __init__(self):
self.data = {}
def replace_one(self, task_id, meta, upsert=True):
self.data[task_id['_id']] = bson.encode(meta)
def find_one(self, task_id):
return bson.decode(self.data[task_id['_id']])
monkeypatch.setattr(MongoBackend, "collection", FakeMongoCollection())
@pytest.mark.parametrize("serializer,result_type,result", [
(s, type(i['result']), i['result']) for i in SUCCESS_RESULT_TEST_DATA
for s in i['serializers']]
)
def test_encode_success_results(self, mongo_backend_factory, serializer,
result_type, result):
backend = mongo_backend_factory(serializer=serializer)
backend.store_result(TASK_ID, result, 'SUCCESS')
recovered = backend.get_result(TASK_ID)
assert isinstance(recovered, result_type)
assert recovered == result
@pytest.mark.parametrize("serializer",
["bson", "pickle", "yaml", "json", "msgpack"])
def test_encode_chain_results(self, mongo_backend_factory, serializer):
backend = mongo_backend_factory(serializer=serializer)
mock_request = MagicMock(spec=['children'])
children = [self.app.AsyncResult(uuid()) for i in range(10)]
mock_request.children = children
backend.store_result(TASK_ID, 0, 'SUCCESS', request=mock_request)
recovered = backend.get_children(TASK_ID)
def tuple_to_list(t): return [list(t[0]), t[1]]
assert recovered == [tuple_to_list(c.as_tuple()) for c in children]
@pytest.mark.parametrize("serializer",
["bson", "pickle", "yaml", "json", "msgpack"])
def test_encode_exception_error_results(self, mongo_backend_factory,
serializer):
backend = mongo_backend_factory(serializer=serializer)
exception = Exception("Basic Exception")
traceback = 'Traceback:\n Exception: Basic Exception\n'
backend.store_result(TASK_ID, exception, 'FAILURE', traceback)
recovered = backend.get_result(TASK_ID)
assert isinstance(recovered, type(exception))
assert recovered.args == exception.args
|