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 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
|
import datetime
import json
import pickle
import re
from unittest import mock
import celery
import pytest
from celery import states, uuid
from celery.app.task import Context
from celery.result import AsyncResult, GroupResult
from celery.utils.serialization import b64decode
from celery.worker.request import Request
from celery.worker.strategy import hybrid_to_proto2
from django.test import TransactionTestCase
from django_celery_results.backends.database import DatabaseBackend
from django_celery_results.models import ChordCounter, TaskResult
class SomeClass:
def __init__(self, data):
self.data = data
@pytest.mark.django_db()
@pytest.mark.usefixtures('depends_on_current_app')
class test_DatabaseBackend:
@pytest.fixture(autouse=True)
def setup_backend(self):
self.app.conf.result_serializer = 'json'
self.app.conf.result_backend = (
'django_celery_results.backends:DatabaseBackend')
self.app.conf.result_extended = True
self.b = DatabaseBackend(app=self.app)
def _create_request(self, task_id, name, args, kwargs,
argsrepr=None, kwargsrepr=None, task_protocol=2):
msg = self.app.amqp.task_protocols[task_protocol](
task_id=task_id,
name=name,
args=args,
kwargs=kwargs,
argsrepr=argsrepr,
kwargsrepr=kwargsrepr,
)
if task_protocol == 1:
body, headers, _, _ = hybrid_to_proto2(msg, msg.body)
properties = None
sent_event = {}
else:
headers, properties, body, sent_event = msg
context = Context(
headers=headers,
properties=properties,
body=body,
sent_event=sent_event,
)
request = Request(context, decoded=True, task=name)
if task_protocol == 1:
assert request.argsrepr is None
assert request.kwargsrepr is None
else:
assert request.argsrepr is not None
assert request.kwargsrepr is not None
return request
def test_backend__pickle_serialization__dict_result(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
)
result = {'foo': 'baz', 'bar': SomeClass(12345)}
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result').get('foo') == 'baz'
assert mindb.get('result').get('bar').data == 12345
assert len(mindb.get('worker')) > 1
assert mindb.get('task_name') == 'my_task'
assert bool(re.match(
r"\['a', 1, <.*SomeClass object at .*>\]",
mindb.get('task_args')
))
assert bool(re.match(
r"{'c': 6, 'd': 'e', 'f': <.*SomeClass object at .*>}",
mindb.get('task_kwargs')
))
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
task_args = pickle.loads(b64decode(tr.task_args))
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_args == mindb.get('task_args')
assert task_kwargs == mindb.get('task_kwargs')
# check async_result
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
# check backward compatibility
task_kwargs2 = str(request.kwargs)
task_args2 = str(request.args)
assert tr.task_args != task_args2
assert tr.task_kwargs != task_kwargs2
tr.task_args = task_args2
tr.task_kwargs = task_kwargs2
tr.save()
mindb = self.b.get_task_meta(tid2)
assert bool(re.match(
r"\['a', 1, <.*SomeClass object at .*>\]",
mindb.get('task_args')
))
assert bool(re.match(
r"{'c': 6, 'd': 'e', 'f': <.*SomeClass object at .*>}",
mindb.get('task_kwargs')
))
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
tid3 = uuid()
try:
raise KeyError('foo')
except KeyError as exception:
self.b.mark_as_failure(tid3, exception)
assert self.b.get_status(tid3) == states.FAILURE
assert isinstance(self.b.get_result(tid3), KeyError)
def test_backend__pickle_serialization__str_result(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
)
result = 'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') == 'foo'
assert mindb.get('task_name') == 'my_task'
assert len(mindb.get('worker')) > 1
assert bool(re.match(
r"\['a', 1, <.*SomeClass object at .*>\]",
mindb.get('task_args')
))
assert bool(re.match(
r"{'c': 6, 'd': 'e', 'f': <.*SomeClass object at .*>}",
mindb.get('task_kwargs')
))
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
task_args = pickle.loads(b64decode(tr.task_args))
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_args == mindb.get('task_args')
assert task_kwargs == mindb.get('task_kwargs')
# check async_result
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
def test_backend__pickle_serialization__bytes_result(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
)
result = b'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') == b'foo'
assert mindb.get('task_name') == 'my_task'
assert len(mindb.get('worker')) > 1
assert bool(re.match(
r"\['a', 1, <.*SomeClass object at .*>\]",
mindb.get('task_args')
))
assert bool(re.match(
r"{'c': 6, 'd': 'e', 'f': <.*SomeClass object at .*>}",
mindb.get('task_kwargs')
))
# check task_result objects
tr = TaskResult.objects.get(task_id=tid2)
task_args = pickle.loads(b64decode(tr.task_args))
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_args == mindb.get('task_args')
assert task_kwargs == mindb.get('task_kwargs')
# check async_result
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
def test_backend__json_serialization__dict_result(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
)
result = {'foo': 'baz', 'bar': True}
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result').get('foo') == 'baz'
assert mindb.get('result').get('bar') is True
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args') == "['a', 1, True]"
assert mindb.get('task_kwargs') == "{'c': 6, 'd': 'e', 'f': False}"
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
assert json.loads(tr.task_args) == "['a', 1, True]"
assert json.loads(tr.task_kwargs) == "{'c': 6, 'd': 'e', 'f': False}"
# check async_result
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
# check backward compatibility
task_kwargs2 = str(request.kwargs)
task_args2 = str(request.args)
assert tr.task_args != task_args2
assert tr.task_kwargs != task_kwargs2
tr.task_args = task_args2
tr.task_kwargs = task_kwargs2
tr.save()
mindb = self.b.get_task_meta(tid2)
assert mindb.get('task_args') == "['a', 1, True]"
assert mindb.get('task_kwargs') == "{'c': 6, 'd': 'e', 'f': False}"
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
tid3 = uuid()
try:
raise KeyError('foo')
except KeyError as exception:
self.b.mark_as_failure(tid3, exception)
assert self.b.get_status(tid3) == states.FAILURE
assert isinstance(self.b.get_result(tid3), KeyError)
def test_backend__json_serialization__str_result(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
)
result = 'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') == 'foo'
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args') == "['a', 1, True]"
assert mindb.get('task_kwargs') == "{'c': 6, 'd': 'e', 'f': False}"
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
assert json.loads(tr.task_args) == "['a', 1, True]"
assert json.loads(tr.task_kwargs) == "{'c': 6, 'd': 'e', 'f': False}"
# check async_result
ar = AsyncResult(tid2)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
def test_backend__pickle_serialization__dict_result__protocol_1(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
task_protocol=1,
)
result = {'foo': 'baz', 'bar': SomeClass(12345)}
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result').get('foo') == 'baz'
assert mindb.get('result').get('bar').data == 12345
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
task_args = pickle.loads(b64decode(tr.task_args))
assert task_args[0] == 'a'
assert task_args[1] == 1
assert task_args[2].data == 67
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_kwargs['c'] == 6
assert task_kwargs['d'] == 'e'
assert task_kwargs['f'].data == 89
tid3 = uuid()
try:
raise KeyError('foo')
except KeyError as exception:
self.b.mark_as_failure(tid3, exception)
assert self.b.get_status(tid3) == states.FAILURE
assert isinstance(self.b.get_result(tid3), KeyError)
def test_backend__pickle_serialization__str_result__protocol_1(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
task_protocol=1,
)
result = 'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') == 'foo'
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
task_args = pickle.loads(b64decode(tr.task_args))
assert task_args[0] == 'a'
assert task_args[1] == 1
assert task_args[2].data == 67
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_kwargs['c'] == 6
assert task_kwargs['d'] == 'e'
assert task_kwargs['f'].data == 89
def test_backend__pickle_serialization__bytes_result__protocol_1(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
task_protocol=1,
)
result = b'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') == b'foo'
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
task_args = pickle.loads(b64decode(tr.task_args))
assert task_args[0] == 'a'
assert task_args[1] == 1
assert task_args[2].data == 67
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_kwargs['c'] == 6
assert task_kwargs['d'] == 'e'
assert task_kwargs['f'].data == 89
def test_backend__json_serialization__dict_result__protocol_1(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
task_protocol=1,
)
result = {'foo': 'baz', 'bar': True}
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result').get('foo') == 'baz'
assert mindb.get('result').get('bar') is True
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args') == ['a', 1, True]
assert mindb.get('task_kwargs') == {'c': 6, 'd': 'e', 'f': False}
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
assert json.loads(tr.task_args) == ['a', 1, True]
assert json.loads(tr.task_kwargs) == {'c': 6, 'd': 'e', 'f': False}
tid3 = uuid()
try:
raise KeyError('foo')
except KeyError as exception:
self.b.mark_as_failure(tid3, exception)
assert self.b.get_status(tid3) == states.FAILURE
assert isinstance(self.b.get_result(tid3), KeyError)
def test_backend__json_serialization__str_result__protocol_1(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
task_protocol=1,
)
result = 'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') == 'foo'
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args') == ['a', 1, True]
assert mindb.get('task_kwargs') == {'c': 6, 'd': 'e', 'f': False}
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
assert json.loads(tr.task_args) == ['a', 1, True]
assert json.loads(tr.task_kwargs) == {'c': 6, 'd': 'e', 'f': False}
def test_backend__task_result_meta_injection(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=[],
kwargs={},
task_protocol=1,
)
result = None
# inject request meta arbitrary data
request.meta = {
'key': 'value'
}
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check task meta
assert mindb.get('result') is None
assert mindb.get('task_name') == 'my_task'
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
assert json.loads(tr.meta) == {'key': 'value', 'children': []}
def test_backend__task_result_date(self):
tid2 = uuid()
self.b.store_result(tid2, None, states.PENDING)
tr = TaskResult.objects.get(task_id=tid2)
assert tr.status == states.PENDING
assert isinstance(tr.date_created, datetime.datetime)
assert tr.date_started is None
assert isinstance(tr.date_done, datetime.datetime)
date_created = tr.date_created
date_done = tr.date_done
self.b.mark_as_started(tid2)
tr = TaskResult.objects.get(task_id=tid2)
assert tr.status == states.STARTED
assert date_created == tr.date_created
assert isinstance(tr.date_started, datetime.datetime)
assert tr.date_done > date_done
date_started = tr.date_started
date_done = tr.date_done
self.b.mark_as_done(tid2, 42)
tr = TaskResult.objects.get(task_id=tid2)
assert tr.status == states.SUCCESS
assert tr.date_created == date_created
assert tr.date_started == date_started
assert tr.date_done > date_done
def xxx_backend(self):
tid = uuid()
assert self.b.get_status(tid) == states.PENDING
assert self.b.get_result(tid) is None
self.b.mark_as_done(tid, 42)
assert self.b.get_status(tid) == states.SUCCESS
assert self.b.get_result(tid) == 42
tid2 = uuid()
try:
raise KeyError('foo')
except KeyError as exception:
self.b.mark_as_failure(tid2, exception)
assert self.b.get_status(tid2) == states.FAILURE
assert isinstance(self.b.get_result(tid2), KeyError)
def test_forget(self):
tid = uuid()
self.b.mark_as_done(tid, {'foo': 'bar'})
x = self.app.AsyncResult(tid)
assert x.result.get('foo') == 'bar'
x.forget()
if celery.VERSION[0:3] == (3, 1, 10):
# bug in 3.1.10 means result did not clear cache after forget.
x._cache = None
assert x.result is None
def test_secrets__pickle_serialization(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid = uuid()
request = self._create_request(
task_id=tid,
name='my_task',
args=['a', 1, 'password'],
kwargs={'c': 3, 'd': 'e', 'password': 'password'},
argsrepr='argsrepr',
kwargsrepr='kwargsrepr',
)
result = {'foo': 'baz'}
self.b.mark_as_done(tid, result, request=request)
mindb = self.b.get_task_meta(tid)
# check task meta
assert mindb.get('result') == {'foo': 'baz'}
assert mindb.get('task_args') == 'argsrepr'
assert mindb.get('task_kwargs') == 'kwargsrepr'
assert len(mindb.get('worker')) > 1
# check task_result object
tr = TaskResult.objects.get(task_id=tid)
task_args = pickle.loads(b64decode(tr.task_args))
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_args == 'argsrepr'
assert task_kwargs == 'kwargsrepr'
# check async_result
ar = AsyncResult(tid)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
def test_secrets__json_serialization(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid = uuid()
request = self._create_request(
task_id=tid,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
argsrepr='argsrepr',
kwargsrepr='kwargsrepr',
)
result = {'foo': 'baz'}
self.b.mark_as_done(tid, result, request=request)
mindb = self.b.get_task_meta(tid)
# check task meta
assert mindb.get('result') == {'foo': 'baz'}
assert mindb.get('task_args') == 'argsrepr'
assert mindb.get('task_kwargs') == 'kwargsrepr'
# check task_result object
tr = TaskResult.objects.get(task_id=tid)
assert json.loads(tr.task_args) == 'argsrepr'
assert json.loads(tr.task_kwargs) == 'kwargsrepr'
# check async_result
ar = AsyncResult(tid)
assert ar.args == mindb.get('task_args')
assert ar.kwargs == mindb.get('task_kwargs')
def test_secrets__pickle_serialization__protocol_1(self):
self.app.conf.result_serializer = 'pickle'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid = uuid()
request = self._create_request(
task_id=tid,
name='my_task',
args=['a', 1, SomeClass(67)],
kwargs={'c': 6, 'd': 'e', 'f': SomeClass(89)},
argsrepr='argsrepr',
kwargsrepr='kwargsrepr',
task_protocol=1,
)
result = {'foo': 'baz'}
self.b.mark_as_done(tid, result, request=request)
mindb = self.b.get_task_meta(tid)
assert mindb.get('result') == {'foo': 'baz'}
assert mindb.get('task_args')[0] == 'a'
assert mindb.get('task_args')[1] == 1
assert mindb.get('task_args')[2].data == 67
assert mindb.get('task_kwargs')['c'] == 6
assert mindb.get('task_kwargs')['d'] == 'e'
assert mindb.get('task_kwargs')['f'].data == 89
tr = TaskResult.objects.get(task_id=tid)
task_args = pickle.loads(b64decode(tr.task_args))
assert task_args[0] == 'a'
assert task_args[1] == 1
assert task_args[2].data == 67
task_kwargs = pickle.loads(b64decode(tr.task_kwargs))
assert task_kwargs['c'] == 6
assert task_kwargs['d'] == 'e'
assert task_kwargs['f'].data == 89
def test_secrets__json_serialization__protocol_1(self):
self.app.conf.result_serializer = 'json'
self.app.conf.accept_content = {'pickle', 'json'}
self.b = DatabaseBackend(app=self.app)
tid = uuid()
request = self._create_request(
task_id=tid,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
argsrepr='argsrepr',
kwargsrepr='kwargsrepr',
task_protocol=1,
)
result = {'foo': 'baz'}
self.b.mark_as_done(tid, result, request=request)
mindb = self.b.get_task_meta(tid)
assert mindb.get('result') == {'foo': 'baz'}
assert mindb.get('task_name') == 'my_task'
assert mindb.get('task_args') == ['a', 1, True]
assert mindb.get('task_kwargs') == {'c': 6, 'd': 'e', 'f': False}
tr = TaskResult.objects.get(task_id=tid)
assert json.loads(tr.task_args) == ['a', 1, True]
assert json.loads(tr.task_kwargs) == {'c': 6, 'd': 'e', 'f': False}
def test_apply_chord_header_result_arg(self):
"""Test if apply_chord can handle Celery <= 5.1 call signature"""
gid = uuid()
tid1 = uuid()
tid2 = uuid()
subtasks = [AsyncResult(tid1), AsyncResult(tid2)]
group = GroupResult(id=gid, results=subtasks)
# Celery < 5.1
self.b.apply_chord(group, self.add.s())
# Celery 5.1
self.b.apply_chord((uuid(), subtasks), self.add.s())
def test_on_chord_part_return(self):
"""Test if the ChordCounter is properly decremented and the callback is
triggered after all chord parts have returned"""
gid = uuid()
tid1 = uuid()
tid2 = uuid()
subtasks = [AsyncResult(tid1), AsyncResult(tid2)]
group = GroupResult(id=gid, results=subtasks)
self.b.apply_chord(group, self.add.s())
chord_counter = ChordCounter.objects.get(group_id=gid)
assert chord_counter.count == 2
request = mock.MagicMock()
request.id = subtasks[0].id
request.group = gid
request.task = "my_task"
request.args = ["a", 1, "password"]
request.kwargs = {"c": 3, "d": "e", "password": "password"}
request.argsrepr = "argsrepr"
request.kwargsrepr = "kwargsrepr"
request.hostname = "celery@ip-0-0-0-0"
request.periodic_task_name = "my_periodic_task"
request.ignore_result = False
result = {"foo": "baz"}
self.b.mark_as_done(tid1, result, request=request)
chord_counter.refresh_from_db()
assert chord_counter.count == 1
self.b.mark_as_done(tid2, result, request=request)
with pytest.raises(ChordCounter.DoesNotExist):
ChordCounter.objects.get(group_id=gid)
request.chord.delay.assert_called_once()
def test_on_chord_part_return_counter_not_found(self):
"""Test if the chord does not raise an error if the ChordCounter is
not found
Basically this covers the case where a chord was created with a version
<2.0.0 and the update was done before the chord was finished
"""
request = mock.MagicMock()
request.id = uuid()
request.group = uuid()
self.b.on_chord_part_return(request=request, state=None, result=None)
def test_callback_failure(self):
"""Test if a failure in the chord callback is properly handled"""
gid = uuid()
tid1 = uuid()
tid2 = uuid()
cid = uuid()
subtasks = [AsyncResult(tid1), AsyncResult(tid2)]
group = GroupResult(id=gid, results=subtasks)
self.b.apply_chord(group, self.add.s())
chord_counter = ChordCounter.objects.get(group_id=gid)
assert chord_counter.count == 2
request = mock.MagicMock()
request.id = subtasks[0].id
request.group = gid
request.task = "my_task"
request.args = ["a", 1, "password"]
request.kwargs = {"c": 3, "d": "e", "password": "password"}
request.argsrepr = "argsrepr"
request.kwargsrepr = "kwargsrepr"
request.hostname = "celery@ip-0-0-0-0"
request.periodic_task_name = "my_periodic_task"
request.ignore_result = False
request.chord.id = cid
result = {"foo": "baz"}
# Trigger an exception when the callback is triggered
request.chord.delay.side_effect = ValueError()
self.b.mark_as_done(tid1, result, request=request)
chord_counter.refresh_from_db()
assert chord_counter.count == 1
self.b.mark_as_done(tid2, result, request=request)
with pytest.raises(ChordCounter.DoesNotExist):
ChordCounter.objects.get(group_id=gid)
request.chord.delay.assert_called_once()
assert TaskResult.objects.get(task_id=cid).status == states.FAILURE
def test_on_chord_part_return_failure(self):
"""Test if a failure in one of the chord header tasks is properly
handled and the callback was not triggered
"""
gid = uuid()
tid1 = uuid()
tid2 = uuid()
cid = uuid()
subtasks = [AsyncResult(tid1), AsyncResult(tid2)]
group = GroupResult(id=gid, results=subtasks)
self.b.apply_chord(group, self.add.s())
chord_counter = ChordCounter.objects.get(group_id=gid)
assert chord_counter.count == 2
request = mock.MagicMock()
request.id = tid1
request.group = gid
request.task = "my_task"
request.args = ["a", 1, "password"]
request.kwargs = {"c": 3, "d": "e", "password": "password"}
request.argsrepr = "argsrepr"
request.kwargsrepr = "kwargsrepr"
request.hostname = "celery@ip-0-0-0-0"
request.periodic_task_name = "my_periodic_task"
request.chord.id = cid
result = {"foo": "baz"}
self.b.mark_as_done(tid1, result, request=request)
chord_counter.refresh_from_db()
assert chord_counter.count == 1
request.id = tid2
self.b.mark_as_failure(tid2, ValueError(), request=request)
with pytest.raises(ChordCounter.DoesNotExist):
ChordCounter.objects.get(group_id=gid)
request.chord.delay.assert_not_called()
def test_groupresult_save_restore(self):
"""Test if we can save and restore a GroupResult"""
group_id = uuid()
results = [AsyncResult(id=uuid())]
group = GroupResult(id=group_id, results=results)
group.save(backend=self.b)
restored_group = self.b.restore_group(group_id=group_id)
assert restored_group == group
def test_groupresult_save_restore_nested(self):
"""Test if we can save and restore a nested GroupResult"""
group_id = uuid()
async_result = AsyncResult(id=uuid())
nested_results = [AsyncResult(id=uuid()), AsyncResult(id=uuid())]
nested_group = GroupResult(id=uuid(), results=nested_results)
group = GroupResult(id=group_id, results=[nested_group, async_result])
group.save(backend=self.b)
restored_group = self.b.restore_group(group_id=group_id)
assert restored_group == group
def test_backend_result_extended_is_false(self):
self.app.conf.result_extended = False
self.b = DatabaseBackend(app=self.app)
tid2 = uuid()
request = self._create_request(
task_id=tid2,
name='my_task',
args=['a', 1, True],
kwargs={'c': 6, 'd': 'e', 'f': False},
)
result = 'foo'
self.b.mark_as_done(tid2, result, request=request)
mindb = self.b.get_task_meta(tid2)
# check meta data
assert mindb.get('result') == 'foo'
assert mindb.get('task_name') is None
assert mindb.get('task_args') is None
assert mindb.get('task_kwargs') is None
# check task_result object
tr = TaskResult.objects.get(task_id=tid2)
assert tr.task_args is None
assert tr.task_kwargs is None
def test_custom_state(self):
tid = uuid()
assert self.b.get_status(tid) == states.PENDING
self.b.store_result(tid, state="Progress", result={"progress": 10})
assert self.b.get_status(tid) == "Progress"
assert self.b.get_result(tid) == {"progress": 10}
self.b.mark_as_done(tid, 42)
assert self.b.get_status(tid) == states.SUCCESS
assert self.b.get_result(tid) == 42
class DjangoCeleryResultRouter:
route_app_labels = {"django_celery_results"}
def db_for_read(self, model, **hints):
"""Route read access to the read-only database"""
if model._meta.app_label in self.route_app_labels:
return "read-only"
return None
def db_for_write(self, model, **hints):
"""Route write access to the default database"""
if model._meta.app_label in self.route_app_labels:
return "default"
return None
class ChordPartReturnTestCase(TransactionTestCase):
databases = {"default", "read-only"}
def setUp(self):
super().setUp()
self.app.conf.result_serializer = 'json'
self.app.conf.result_backend = (
'django_celery_results.backends:DatabaseBackend')
self.app.conf.result_extended = True
self.b = DatabaseBackend(app=self.app)
def test_on_chord_part_return_multiple_databases(self):
"""
Test if the ChordCounter is properly decremented and the callback is
triggered after all chord parts have returned with multiple databases
"""
with self.settings(DATABASE_ROUTERS=[DjangoCeleryResultRouter()]):
gid = uuid()
tid1 = uuid()
tid2 = uuid()
subtasks = [AsyncResult(tid1), AsyncResult(tid2)]
group = GroupResult(id=gid, results=subtasks)
assert ChordCounter.objects.count() == 0
assert ChordCounter.objects.using("read-only").count() == 0
assert ChordCounter.objects.using("default").count() == 0
self.b.apply_chord(group, self.add.s())
# Check if the ChordCounter was created in the correct database
assert ChordCounter.objects.count() == 1
assert ChordCounter.objects.using("read-only").count() == 1
assert ChordCounter.objects.using("default").count() == 1
chord_counter = ChordCounter.objects.get(group_id=gid)
assert chord_counter.count == 2
request = mock.MagicMock()
request.id = subtasks[0].id
request.group = gid
request.task = "my_task"
request.args = ["a", 1, "password"]
request.kwargs = {"c": 3, "d": "e", "password": "password"}
request.argsrepr = "argsrepr"
request.kwargsrepr = "kwargsrepr"
request.hostname = "celery@ip-0-0-0-0"
request.periodic_task_name = "my_periodic_task"
request.ignore_result = False
result = {"foo": "baz"}
self.b.mark_as_done(tid1, result, request=request)
chord_counter.refresh_from_db()
assert chord_counter.count == 1
self.b.mark_as_done(tid2, result, request=request)
with pytest.raises(ChordCounter.DoesNotExist):
ChordCounter.objects.get(group_id=gid)
request.chord.delay.assert_called_once()
|