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
|
import json
import queue
import time
import zlib
from datetime import datetime, timezone
from pickle import dumps, loads
from uuid import uuid4
from rq.defaults import CALLBACK_TIMEOUT
from rq.exceptions import DeserializationError, InvalidJobOperation, NoSuchJobError
from rq.executions import Execution
from rq.job import Callback, Job, JobStatus, cancel_job, get_current_job
from rq.queue import Queue
from rq.registry import (
CanceledJobRegistry,
DeferredJobRegistry,
FailedJobRegistry,
FinishedJobRegistry,
ScheduledJobRegistry,
StartedJobRegistry,
)
from rq.serializers import JSONSerializer
from rq.utils import as_text, now, utcformat
from rq.worker import Worker
from tests import RQTestCase, fixtures, min_redis_version
class TestJob(RQTestCase):
def test_unicode(self):
"""Unicode in job description [issue405]"""
job = Job.create(
'myfunc',
args=[12, '☃'],
kwargs=dict(snowman='☃', null=None),
connection=self.connection,
)
self.assertEqual(
job.description,
"myfunc(12, '☃', null=None, snowman='☃')",
)
def test_create_empty_job(self):
"""Creation of new empty jobs."""
job = Job(uuid4().hex, connection=self.connection)
job.description = 'test job'
# Jobs have a random UUID and a creation date
self.assertIsNotNone(job.id)
self.assertIsNotNone(job.created_at)
self.assertEqual(str(job), f'<Job {job.id}: test job>')
# ...and nothing else
self.assertEqual(job.origin, '')
self.assertIsNone(job.enqueued_at)
self.assertIsNone(job.started_at)
self.assertIsNone(job.ended_at)
self.assertIsNone(job.result)
self.assertIsNone(job._exc_info)
with self.assertRaises(DeserializationError):
job.func
with self.assertRaises(DeserializationError):
job.instance
with self.assertRaises(DeserializationError):
job.args
with self.assertRaises(DeserializationError):
job.kwargs
def test_create_param_errors(self):
"""Creation of jobs may result in errors"""
self.assertRaises(TypeError, Job.create, fixtures.say_hello, args='string')
self.assertRaises(TypeError, Job.create, fixtures.say_hello, kwargs='string')
self.assertRaises(TypeError, Job.create, func=42)
def test_create_typical_job(self):
"""Creation of jobs for function calls."""
job = Job.create(func=fixtures.some_calculation, args=(3, 4), kwargs=dict(z=2), connection=self.connection)
# Jobs have a random UUID
self.assertIsNotNone(job.id)
self.assertIsNotNone(job.created_at)
self.assertIsNotNone(job.description)
self.assertIsNone(job.instance)
# Job data is set...
self.assertEqual(job.func, fixtures.some_calculation)
self.assertEqual(job.args, (3, 4))
self.assertEqual(job.kwargs, {'z': 2})
# ...but metadata is not
self.assertEqual(job.origin, '')
self.assertIsNone(job.enqueued_at)
self.assertIsNone(job.result)
def test_create_instance_method_job(self):
"""Creation of jobs for instance methods."""
n = fixtures.Number(2)
job = Job.create(func=n.div, args=(4,), connection=self.connection)
# Job data is set
self.assertEqual(job.func, n.div)
self.assertEqual(job.instance, n)
self.assertEqual(job.args, (4,))
def test_create_job_with_serializer(self):
"""Creation of jobs with serializer for instance methods."""
# Test using json serializer
n = fixtures.Number(2)
job = Job.create(func=n.div, args=(4,), serializer=json, connection=self.connection)
self.assertIsNotNone(job.serializer)
self.assertEqual(job.func, n.div)
self.assertEqual(job.instance, n)
self.assertEqual(job.args, (4,))
def test_create_job_from_string_function(self):
"""Creation of jobs using string specifier."""
job = Job.create(func='tests.fixtures.say_hello', args=('World',), connection=self.connection)
# Job data is set
self.assertEqual(job.func, fixtures.say_hello)
self.assertIsNone(job.instance)
self.assertEqual(job.args, ('World',))
def test_create_job_from_callable_class(self):
"""Creation of jobs using a callable class specifier."""
kallable = fixtures.CallableObject()
job = Job.create(func=kallable, connection=self.connection)
self.assertEqual(job.func, kallable.__call__)
self.assertEqual(job.instance, kallable)
def test_job_properties_set_data_property(self):
"""Data property gets derived from the job tuple."""
job = Job(id=uuid4().hex, connection=self.connection)
job.func_name = 'foo'
fname, instance, args, kwargs = loads(job.data)
self.assertEqual(fname, job.func_name)
self.assertEqual(instance, None)
self.assertEqual(args, ())
self.assertEqual(kwargs, {})
def test_data_property_sets_job_properties(self):
"""Job tuple gets derived lazily from data property."""
job = Job(id=uuid4().hex, connection=self.connection)
job.data = dumps(('foo', None, (1, 2, 3), {'bar': 'qux'}))
self.assertEqual(job.func_name, 'foo')
self.assertEqual(job.instance, None)
self.assertEqual(job.args, (1, 2, 3))
self.assertEqual(job.kwargs, {'bar': 'qux'})
def test_save(self): # noqa
"""Storing jobs."""
job = Job.create(func=fixtures.some_calculation, args=(3, 4), kwargs=dict(z=2), connection=self.connection)
# Saving creates a Redis hash
self.assertEqual(self.connection.exists(job.key), False)
job.save()
self.assertEqual(self.connection.type(job.key), b'hash')
# Saving writes pickled job data
unpickled_data = loads(zlib.decompress(self.connection.hget(job.key, 'data')))
self.assertEqual(unpickled_data[0], 'tests.fixtures.some_calculation')
def test_fetch(self):
"""Fetching jobs."""
# Prepare test
self.connection.hset(
'rq:job:some_id', 'data', "(S'tests.fixtures.some_calculation'\nN(I3\nI4\nt(dp1\nS'z'\nI2\nstp2\n."
)
self.connection.hset('rq:job:some_id', 'created_at', '2012-02-07T22:13:24.123456Z')
# Fetch returns a job
job = Job.fetch('some_id', connection=self.connection)
self.assertEqual(job.id, 'some_id')
self.assertEqual(job.func_name, 'tests.fixtures.some_calculation')
self.assertIsNone(job.instance)
self.assertEqual(job.args, (3, 4))
self.assertEqual(job.kwargs, dict(z=2))
self.assertEqual(job.created_at, datetime(2012, 2, 7, 22, 13, 24, 123456, tzinfo=timezone.utc))
# Job.fetch also works with execution IDs
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello)
worker = Worker([queue], connection=self.connection)
worker.prepare_execution(job=job)
worker.prepare_job_execution(job=job)
execution = worker.execution
self.assertEqual(Job.fetch(execution.composite_key, self.connection), job) # type: ignore
self.assertEqual(Job.fetch(job.id, self.connection), job)
def test_fetch_many(self):
"""Fetching many jobs at once."""
data = {
'func': fixtures.some_calculation,
'args': (3, 4),
'kwargs': dict(z=2),
'connection': self.connection,
}
job = Job.create(**data)
job.save()
job2 = Job.create(**data)
job2.save()
jobs = Job.fetch_many([job.id, job2.id, 'invalid_id'], self.connection)
self.assertEqual(jobs, [job, job2, None])
# Job.fetch_many also works with execution IDs
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello)
worker = Worker([queue], connection=self.connection)
worker.prepare_execution(job=job)
worker.prepare_job_execution(job=job)
execution = worker.execution
self.assertEqual(Job.fetch_many([execution.composite_key], self.connection), [job]) # type: ignore
self.assertEqual(Job.fetch_many([job.id], self.connection), [job])
def test_persistence_of_empty_jobs(self): # noqa
"""Storing empty jobs."""
job = Job(id='foo', connection=self.connection)
with self.assertRaises(ValueError):
job.save()
def test_persistence_of_typical_jobs(self):
"""Storing typical jobs."""
job = Job.create(func=fixtures.some_calculation, args=(3, 4), kwargs=dict(z=2), connection=self.connection)
job.save()
stored_date = self.connection.hget(job.key, 'created_at').decode('utf-8')
self.assertEqual(stored_date, utcformat(job.created_at))
# ... and no other keys are stored
self.assertEqual(
{
b'created_at',
b'data',
b'description',
b'ended_at',
b'last_heartbeat',
b'started_at',
b'worker_name',
b'success_callback_name',
b'failure_callback_name',
b'stopped_callback_name',
b'group_id',
b'status',
},
set(self.connection.hkeys(job.key)),
)
self.assertEqual(job.last_heartbeat, None)
self.assertEqual(job.last_heartbeat, None)
ts = now()
job.heartbeat(ts, 0)
self.assertEqual(job.last_heartbeat, ts)
def test_persistence_of_parent_job(self):
"""Storing jobs with parent job, either instance or key."""
parent_job = Job.create(func=fixtures.some_calculation, connection=self.connection)
parent_job.save()
job = Job.create(func=fixtures.some_calculation, depends_on=parent_job, connection=self.connection)
job.save()
stored_job = Job.fetch(job.id, connection=self.connection)
self.assertEqual(stored_job._dependency_id, parent_job.id)
self.assertEqual(stored_job._dependency_ids, [parent_job.id])
self.assertEqual(stored_job.dependency.id, parent_job.id)
self.assertEqual(stored_job.dependency, parent_job)
job = Job.create(func=fixtures.some_calculation, depends_on=parent_job.id, connection=self.connection)
job.save()
stored_job = Job.fetch(job.id, connection=self.connection)
self.assertEqual(stored_job._dependency_id, parent_job.id)
self.assertEqual(stored_job._dependency_ids, [parent_job.id])
self.assertEqual(stored_job.dependency.id, parent_job.id)
self.assertEqual(stored_job.dependency, parent_job)
def test_persistence_of_callbacks(self):
"""Storing jobs with success and/or failure callbacks."""
job = Job.create(
func=fixtures.some_calculation,
on_success=Callback(fixtures.say_hello, timeout=10),
on_failure=fixtures.say_pid,
on_stopped=fixtures.say_hello,
connection=self.connection,
) # deprecated callable
job.save()
stored_job = Job.fetch(job.id, connection=self.connection)
self.assertEqual(fixtures.say_hello, stored_job.success_callback)
self.assertEqual(10, stored_job.success_callback_timeout)
self.assertEqual(fixtures.say_pid, stored_job.failure_callback)
self.assertEqual(fixtures.say_hello, stored_job.stopped_callback)
self.assertEqual(CALLBACK_TIMEOUT, stored_job.failure_callback_timeout)
self.assertEqual(CALLBACK_TIMEOUT, stored_job.stopped_callback_timeout)
# None(s)
job = Job.create(func=fixtures.some_calculation, on_failure=None, connection=self.connection)
job.save()
stored_job = Job.fetch(job.id, connection=self.connection)
self.assertIsNone(stored_job.success_callback)
self.assertEqual(CALLBACK_TIMEOUT, job.success_callback_timeout) # timeout should be never none
self.assertEqual(CALLBACK_TIMEOUT, stored_job.success_callback_timeout)
self.assertIsNone(stored_job.failure_callback)
self.assertEqual(CALLBACK_TIMEOUT, job.failure_callback_timeout) # timeout should be never none
self.assertEqual(CALLBACK_TIMEOUT, stored_job.failure_callback_timeout)
self.assertEqual(CALLBACK_TIMEOUT, job.stopped_callback_timeout) # timeout should be never none
self.assertIsNone(stored_job.stopped_callback)
def test_store_then_fetch(self):
"""Store, then fetch."""
job = Job.create(
func=fixtures.some_calculation, timeout=3600, args=(3, 4), kwargs=dict(z=2), connection=self.connection
)
job.save()
job2 = Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.func, job2.func)
self.assertEqual(job.args, job2.args)
self.assertEqual(job.kwargs, job2.kwargs)
self.assertEqual(job.timeout, job2.timeout)
# Mathematical equation
self.assertEqual(job, job2)
def test_fetching_can_fail(self):
"""Fetching fails for non-existing jobs."""
with self.assertRaises(NoSuchJobError):
Job.fetch('b4a44d44-da16-4620-90a6-798e8cd72ca0', connection=self.connection)
def test_fetching_unreadable_data(self):
"""Fetching succeeds on unreadable data, but lazy props fail."""
# Set up
job = Job.create(func=fixtures.some_calculation, args=(3, 4), kwargs=dict(z=2), connection=self.connection)
job.save()
# Just replace the data hkey with some random noise
self.connection.hset(job.key, 'data', 'this is no pickle string')
job.refresh()
for attr in ('func_name', 'instance', 'args', 'kwargs'):
with self.assertRaises(Exception):
getattr(job, attr)
def test_job_is_unimportable(self):
"""Jobs that cannot be imported throw exception on access."""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.save()
# Now slightly modify the job to make it unimportable (this is
# equivalent to a worker not having the most up-to-date source code
# and unable to import the function)
job_data = job.data
unimportable_data = job_data.replace(b'say_hello', b'nay_hello')
self.connection.hset(job.key, 'data', zlib.compress(unimportable_data))
job.refresh()
with self.assertRaises(ValueError):
job.func # accessing the func property should fail
def test_compressed_exc_info_handling(self):
"""Jobs handle both compressed and uncompressed exc_info"""
exception_string = 'Some exception'
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job._exc_info = exception_string
job.save()
# exc_info is stored in compressed format
exc_info = self.connection.hget(job.key, 'exc_info')
self.assertEqual(as_text(zlib.decompress(exc_info)), exception_string)
job.refresh()
self.assertEqual(job.exc_info, exception_string)
# Uncompressed exc_info is also handled
self.connection.hset(job.key, 'exc_info', exception_string)
job.refresh()
self.assertEqual(job.exc_info, exception_string)
def test_compressed_job_data_handling(self):
"""Jobs handle both compressed and uncompressed data"""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.save()
# Job data is stored in compressed format
job_data = job.data
self.assertEqual(zlib.compress(job_data), self.connection.hget(job.key, 'data'))
self.connection.hset(job.key, 'data', job_data)
job.refresh()
self.assertEqual(job.data, job_data)
def test_custom_meta_is_persisted(self):
"""Additional meta data on jobs are stored persisted correctly."""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.meta['foo'] = 'bar'
job.save()
raw_data = self.connection.hget(job.key, 'meta')
self.assertEqual(loads(raw_data)['foo'], 'bar')
job2 = Job.fetch(job.id, connection=self.connection)
self.assertEqual(job2.meta['foo'], 'bar')
def test_get_meta(self):
"""Test get_meta() function"""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.meta['foo'] = 'bar'
job.save()
self.assertEqual(job.get_meta()['foo'], 'bar')
# manually write different data in meta
self.connection.hset(job.key, 'meta', dumps({'fee': 'boo'}))
# check if refresh=False keeps old data
self.assertEqual(job.get_meta(False)['foo'], 'bar')
# check if meta is updated
self.assertEqual(job.get_meta()['fee'], 'boo')
def test_custom_meta_is_rewriten_by_save_meta(self):
"""New meta data can be stored by save_meta."""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.save()
serialized = job.to_dict()
job.meta['foo'] = 'bar'
job.save_meta()
raw_meta = self.connection.hget(job.key, 'meta')
self.assertEqual(loads(raw_meta)['foo'], 'bar')
job2 = Job.fetch(job.id, connection=self.connection)
self.assertEqual(job2.meta['foo'], 'bar')
# nothing else was changed
serialized2 = job2.to_dict()
serialized2.pop('meta')
self.assertDictEqual(serialized, serialized2)
def test_unpickleable_result(self):
"""Unpickleable job result doesn't crash job.save() and job.refresh()"""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job._result = queue.Queue()
job.save()
self.assertEqual(self.connection.hget(job.key, 'result').decode('utf-8'), 'Unserializable return value')
job = Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.result, 'Unserializable return value')
def test_result_ttl_is_persisted(self):
"""Ensure that job's result_ttl is set properly"""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), result_ttl=10, connection=self.connection)
job.save()
Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.result_ttl, 10)
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.save()
Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.result_ttl, None)
def test_failure_ttl_is_persisted(self):
"""Ensure job.failure_ttl is set and restored properly"""
job = Job.create(func=fixtures.say_hello, args=('Lionel',), failure_ttl=15, connection=self.connection)
job.save()
Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.failure_ttl, 15)
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.save()
Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.failure_ttl, None)
def test_description_is_persisted(self):
"""Ensure that job's custom description is set properly"""
job = Job.create(
func=fixtures.say_hello, args=('Lionel',), description='Say hello!', connection=self.connection
)
job.save()
Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.description, 'Say hello!')
# Ensure job description is constructed from function call string
job = Job.create(func=fixtures.say_hello, args=('Lionel',), connection=self.connection)
job.save()
Job.fetch(job.id, connection=self.connection)
self.assertEqual(job.description, "tests.fixtures.say_hello('Lionel')")
def test_prepare_for_execution(self):
"""job.prepare_for_execution works properly"""
job = Job.create(func=fixtures.say_hello, connection=self.connection)
job.save()
with self.connection.pipeline() as pipeline:
job.prepare_for_execution('worker_name', pipeline)
pipeline.execute()
job.refresh()
self.assertEqual(job.worker_name, 'worker_name')
self.assertEqual(job.get_status(), JobStatus.STARTED)
self.assertIsNotNone(job.last_heartbeat)
self.assertIsNotNone(job.started_at)
def test_job_status_always_exists(self):
"""Job status is always guaranteed to exist, defaulting to CREATED."""
job = Job.create(func=fixtures.say_hello, connection=self.connection)
self.assertEqual(job.get_status(refresh=False), JobStatus.CREATED)
job.save()
self.assertEqual(job.get_status(refresh=True), JobStatus.CREATED)
def test_get_status_fails_when_job_deleted_from_redis(self):
"""get_status() raises InvalidJobOperation when job hash is deleted from Redis."""
job = Job.create(func=fixtures.say_hello, connection=self.connection)
job.save()
# Delete the job hash from Redis
self.connection.delete(job.key)
# Now get_status with refresh should raise an exception
self.assertRaises(InvalidJobOperation, job.get_status, refresh=True)
def test_job_access_outside_job_fails(self):
"""The current job is accessible only within a job context."""
self.assertIsNone(get_current_job())
def test_job_access_within_job_function(self):
"""The current job is accessible within the job function."""
q = Queue(connection=self.connection)
job = q.enqueue(fixtures.access_self)
w = Worker([q])
w.work(burst=True)
# access_self calls get_current_job() and executes successfully
self.assertEqual(job.get_status(), JobStatus.FINISHED)
def test_job_access_within_synchronous_job_function(self):
queue = Queue(is_async=False, connection=self.connection)
queue.enqueue(fixtures.access_self)
def test_job_async_status_finished(self):
queue = Queue(is_async=False, connection=self.connection)
job = queue.enqueue(fixtures.say_hello)
self.assertEqual(job.result, 'Hi there, Stranger!')
self.assertEqual(job.get_status(), JobStatus.FINISHED)
def test_enqueue_job_async_status_finished(self):
queue = Queue(is_async=False, connection=self.connection)
job = Job.create(func=fixtures.say_hello, connection=self.connection)
job = queue.enqueue_job(job)
self.assertEqual(job.result, 'Hi there, Stranger!')
self.assertEqual(job.get_status(), JobStatus.FINISHED)
def test_get_result_ttl(self):
"""Getting job result TTL."""
job_result_ttl = 1
default_ttl = 2
job = Job.create(func=fixtures.say_hello, result_ttl=job_result_ttl, connection=self.connection)
job.save()
self.assertEqual(job.get_result_ttl(default_ttl=default_ttl), job_result_ttl)
job = Job.create(func=fixtures.say_hello, connection=self.connection)
job.save()
self.assertEqual(job.get_result_ttl(default_ttl=default_ttl), default_ttl)
def test_get_job_ttl(self):
"""Getting job TTL."""
ttl = 1
job = Job.create(func=fixtures.say_hello, ttl=ttl, connection=self.connection)
job.save()
self.assertEqual(job.get_ttl(), ttl)
job = Job.create(func=fixtures.say_hello, connection=self.connection)
job.save()
self.assertEqual(job.get_ttl(), None)
def test_ttl_via_enqueue(self):
ttl = 1
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello, ttl=ttl)
self.assertEqual(job.get_ttl(), ttl)
def test_never_expire_during_execution(self):
"""Test what happens when job expires during execution"""
ttl = 1
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.long_running_job, args=(2,), ttl=ttl)
self.assertEqual(job.get_ttl(), ttl)
job.save()
job.perform()
self.assertEqual(job.get_ttl(), ttl)
self.assertTrue(job.exists(job.id, connection=self.connection))
self.assertEqual(job.result, 'Done sleeping...')
def test_cleanup(self):
"""Test that jobs and results are expired properly."""
job = Job.create(func=fixtures.say_hello, connection=self.connection, status=JobStatus.QUEUED)
job.save()
# Jobs with negative TTLs don't expire
job.cleanup(ttl=-1)
self.assertEqual(self.connection.ttl(job.key), -1)
# Jobs with positive TTLs are eventually deleted
job.cleanup(ttl=100)
self.assertEqual(self.connection.ttl(job.key), 100)
# Jobs with 0 TTL are immediately deleted
job.cleanup(ttl=0)
self.assertRaises(NoSuchJobError, Job.fetch, job.id, self.connection)
def test_job_get_position(self):
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello)
job2 = queue.enqueue(fixtures.say_hello)
job3 = Job(uuid4().hex, connection=self.connection)
self.assertEqual(0, job.get_position())
self.assertEqual(1, job2.get_position())
self.assertEqual(None, job3.get_position())
def test_job_delete_removes_itself_from_registries(self):
"""job.delete() should remove itself from job registries"""
job = Job.create(
func=fixtures.say_hello,
status=JobStatus.FAILED,
connection=self.connection,
origin='default',
serializer=JSONSerializer,
)
job.save()
registry = FailedJobRegistry(connection=self.connection, serializer=JSONSerializer)
registry.add(job, 500)
job.delete()
self.assertNotIn(job, registry)
job = Job.create(
func=fixtures.say_hello,
status=JobStatus.STOPPED,
connection=self.connection,
origin='default',
serializer=JSONSerializer,
)
job.save()
registry = FailedJobRegistry(connection=self.connection, serializer=JSONSerializer)
registry.add(job, 500)
job.delete()
self.assertNotIn(job, registry)
job = Job.create(
func=fixtures.say_hello,
status=JobStatus.FINISHED,
connection=self.connection,
origin='default',
serializer=JSONSerializer,
)
job.save()
registry = FinishedJobRegistry(connection=self.connection, serializer=JSONSerializer)
registry.add(job, 500)
job.delete()
self.assertNotIn(job, registry)
job = Job.create(
func=fixtures.say_hello,
status=JobStatus.STARTED,
connection=self.connection,
origin='default',
serializer=JSONSerializer,
)
job.save()
registry = StartedJobRegistry(connection=self.connection, serializer=JSONSerializer)
with self.connection.pipeline() as pipe:
# this will also add the execution to the registry
Execution.create(job, ttl=500, pipeline=pipe)
pipe.execute()
job.delete()
self.assertNotIn(job, registry)
job = Job.create(
func=fixtures.say_hello,
status=JobStatus.DEFERRED,
connection=self.connection,
origin='default',
serializer=JSONSerializer,
)
job.save()
registry = DeferredJobRegistry(connection=self.connection, serializer=JSONSerializer)
registry.add(job, 500)
job.delete()
self.assertNotIn(job, registry)
job = Job.create(
func=fixtures.say_hello,
status=JobStatus.SCHEDULED,
connection=self.connection,
origin='default',
serializer=JSONSerializer,
)
job.save()
registry = ScheduledJobRegistry(connection=self.connection, serializer=JSONSerializer)
registry.add(job, 500)
job.delete()
self.assertNotIn(job, registry)
def test_job_delete_execution_registry(self):
"""job.delete() also deletes ExecutionRegistry and all job executions"""
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello)
worker = Worker([queue], connection=self.connection)
execution = worker.prepare_execution(job=job)
self.assertTrue(self.connection.exists(job.execution_registry.key))
self.assertTrue(self.connection.exists(execution.key))
job.delete()
self.assertFalse(self.connection.exists(job.execution_registry.key))
self.assertFalse(self.connection.exists(execution.key))
def test_create_job_with_id(self):
"""test creating jobs with a custom ID"""
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello, job_id='1234')
self.assertEqual(job.id, '1234')
job.perform()
self.assertRaises(TypeError, queue.enqueue, fixtures.say_hello, job_id=1234)
def test_create_job_with_invalid_id(self):
"""test creating jobs with a custom invalid ID (with character :)"""
queue = Queue(connection=self.connection)
with self.assertRaises(ValueError):
queue.enqueue(fixtures.say_hello, job_id='1234:4321')
def test_create_job_with_async(self):
"""test creating jobs with async function"""
queue = Queue(connection=self.connection)
async_job = queue.enqueue(fixtures.say_hello_async, job_id='async_job')
sync_job = queue.enqueue(fixtures.say_hello, job_id='sync_job')
self.assertEqual(async_job.id, 'async_job')
self.assertEqual(sync_job.id, 'sync_job')
async_task_result = async_job.perform()
sync_task_result = sync_job.perform()
self.assertEqual(sync_task_result, async_task_result)
def test_get_call_string_unicode(self):
"""test call string with unicode keyword arguments"""
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.echo, arg_with_unicode=fixtures.UnicodeStringObject())
self.assertIsNotNone(job.get_call_string())
job.perform()
def test_create_job_from_static_method(self):
"""test creating jobs with static method"""
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.ClassWithAStaticMethod.static_method)
self.assertIsNotNone(job.get_call_string())
job.perform()
def test_create_job_with_ttl_should_have_ttl_after_enqueued(self):
"""test creating jobs with ttl and checks if get_jobs returns it properly [issue502]"""
queue = Queue(connection=self.connection)
queue.enqueue(fixtures.say_hello, job_id='1234', ttl=10)
job = queue.get_jobs()[0]
self.assertEqual(job.ttl, 10)
def test_create_job_with_ttl_should_expire(self):
"""test if a job created with ttl expires [issue502]"""
queue = Queue(connection=self.connection)
queue.enqueue(fixtures.say_hello, job_id='1234', ttl=1)
time.sleep(1.1)
self.assertEqual(0, len(queue.get_jobs()))
def test_create_and_cancel_job(self):
"""Ensure job.cancel() works properly"""
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello)
self.assertEqual(1, len(queue.get_jobs()))
cancel_job(job.id, connection=self.connection)
self.assertEqual(0, len(queue.get_jobs()))
registry = CanceledJobRegistry(connection=self.connection, queue=queue)
self.assertIn(job, registry)
self.assertEqual(job.get_status(), JobStatus.CANCELED)
# If job is deleted, it's also removed from CanceledJobRegistry
job.delete()
self.assertNotIn(job, registry)
def test_create_and_cancel_job_fails_already_canceled(self):
"""Ensure job.cancel() fails on already canceled job"""
queue = Queue(connection=self.connection)
job = queue.enqueue(fixtures.say_hello, job_id='fake_job_id')
self.assertEqual(1, len(queue.get_jobs()))
# First cancel should be fine
cancel_job(job.id, connection=self.connection)
self.assertEqual(0, len(queue.get_jobs()))
registry = CanceledJobRegistry(connection=self.connection, queue=queue)
self.assertIn(job, registry)
self.assertEqual(job.get_status(), JobStatus.CANCELED)
# Second cancel should fail
self.assertRaisesRegex(
InvalidJobOperation,
r'Cannot cancel already canceled job: fake_job_id',
cancel_job,
job.id,
connection=self.connection,
)
def test_create_and_cancel_job_with_serializer(self):
"""test creating and using cancel_job (with serializer) deletes job properly"""
queue = Queue(connection=self.connection, serializer=JSONSerializer)
job = queue.enqueue(fixtures.say_hello)
self.assertEqual(1, len(queue.get_jobs()))
cancel_job(job.id, serializer=JSONSerializer, connection=self.connection)
self.assertEqual(0, len(queue.get_jobs()))
def test_key_for_should_return_prefixed_job_id(self):
"""test redis key to store job hash under"""
job_id = 'random'
key = Job.key_for(job_id=job_id)
assert key == Job.redis_job_namespace_prefix + job_id
@min_redis_version((5, 0, 0))
def test_blocking_result_fetch(self):
# Ensure blocking waits for the time to run the job, but not right up until the timeout.
job_sleep_seconds = 2
block_seconds = 5
queue_name = 'test_blocking_queue'
q = Queue(queue_name, connection=self.connection)
job = q.enqueue(fixtures.long_running_job, job_sleep_seconds)
started_at = time.time()
fixtures.start_worker_process(queue_name, connection=self.connection, burst=True)
result = job.latest_result(timeout=block_seconds)
blocked_for = time.time() - started_at
self.assertEqual(job.get_status(), JobStatus.FINISHED)
self.assertIsNotNone(result)
self.assertGreaterEqual(blocked_for, job_sleep_seconds)
self.assertLess(blocked_for, block_seconds)
|