mirror of https://github.com/peter4431/rq.git
Dependency with failures (#1681)
* added Dependency class with allow_failures * Requested changes * Check type before setting `job.dependency_allow_fail` within `Job.create` * Set `job.dependency_allow_fail` within `Job.create` * Added test to ensure persistence of `dependency_allow_fail` * Removed typing and allow mixed list of ints and Job objects * Convert dependency_allow_fail boolean to integer during serialization to avoid redis DataError * Updated `test_multiple_dependencies_are_accepted_and_persisted` test to include `Dependency` cases * Adding placeholder test to test actual behavior of new `Dependency` usage in `depends_on` * Updated `test_job_dependency` to include cases using `Dependency` * Added dependency_allow_fail logic to `Job.restore` * Renamed `dependency_allow_fail` to a simpler `allow_failure` * Update docs to add section about the new `Dependency` class and use-case * Updated `Job.dependencies_are_met` logic to take `FAILED` and `STOPPED` jobs into account when `allow_failure=True` * Updated `test_job_dependency` test. Still failing with `Dependency` case. * Fix `allow_failure` type coercion in `Job.restore` * Re-arrange tests, so default `Dependency.allow_failure` is before explicit `allow_failure=True` * Fixed Dependency, so it works correctly when allow_failure=True * Attempt to execute pipeline prior to queueing a failed job's dependents. test_create_and_cancel_job_enqueue_dependents_in_registry test now passes. * Added `Depedency` test utilizing multiple dependencies * Removed irrelevant on_success and on_failure keyword arguments in example * Replaced use of long_running_job * Add test to verify `Dependency.jobs` contraints * Suppress connection error in handle_job_failure * test_dependencies have passed * All tests pass if enqueue_dependents called without pipeline.watch() * All tests now pass * Removed print statements * Cleanup Dependency implementation * Renamed job.allow_failure to job.allow_dependency_failures Co-authored-by: mattchan <mattchan@tencent.com> Co-authored-by: Mike Hill <mhilluniversal@gmail.com>main
parent
d82af1469f
commit
5b95725dc4
@ -0,0 +1,99 @@
|
||||
from tests import RQTestCase
|
||||
from tests.fixtures import div_by_zero, say_hello
|
||||
|
||||
from rq import Queue, SimpleWorker
|
||||
from rq.job import Job, JobStatus, Dependency
|
||||
|
||||
|
||||
class TestDependencies(RQTestCase):
|
||||
|
||||
def test_allow_failure_is_persisted(self):
|
||||
"""Ensure that job.allow_dependency_failures is properly set
|
||||
when providing Dependency object to depends_on."""
|
||||
dep_job = Job.create(func=say_hello)
|
||||
|
||||
# default to False, maintaining current behavior
|
||||
job = Job.create(func=say_hello, depends_on=Dependency([dep_job]))
|
||||
job.save()
|
||||
Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertFalse(job.allow_dependency_failures)
|
||||
|
||||
job = Job.create(func=say_hello, depends_on=Dependency([dep_job], allow_failure=True))
|
||||
job.save()
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertTrue(job.allow_dependency_failures)
|
||||
|
||||
jobs = Job.fetch_many([job.id], connection=self.testconn)
|
||||
self.assertTrue(jobs[0].allow_dependency_failures)
|
||||
|
||||
def test_job_dependency(self):
|
||||
"""Enqueue dependent jobs only when appropriate"""
|
||||
q = Queue(connection=self.testconn)
|
||||
w = SimpleWorker([q], connection=q.connection)
|
||||
|
||||
# enqueue dependent job when parent successfully finishes
|
||||
parent_job = q.enqueue(say_hello)
|
||||
job = q.enqueue_call(say_hello, depends_on=parent_job)
|
||||
w.work(burst=True)
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertEqual(job.get_status(), JobStatus.FINISHED)
|
||||
q.empty()
|
||||
|
||||
# don't enqueue dependent job when parent fails
|
||||
parent_job = q.enqueue(div_by_zero)
|
||||
job = q.enqueue_call(say_hello, depends_on=parent_job)
|
||||
w.work(burst=True)
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertNotEqual(job.get_status(), JobStatus.FINISHED)
|
||||
q.empty()
|
||||
|
||||
# don't enqueue dependent job when Dependency.allow_failure=False (the default)
|
||||
parent_job = q.enqueue(div_by_zero)
|
||||
dependency = Dependency(jobs=parent_job)
|
||||
job = q.enqueue_call(say_hello, depends_on=dependency)
|
||||
w.work(burst=True)
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertNotEqual(job.get_status(), JobStatus.FINISHED)
|
||||
|
||||
# enqueue dependent job when Dependency.allow_failure=True
|
||||
parent_job = q.enqueue(div_by_zero)
|
||||
dependency = Dependency(jobs=parent_job, allow_failure=True)
|
||||
job = q.enqueue_call(say_hello, depends_on=dependency)
|
||||
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertTrue(job.allow_dependency_failures)
|
||||
|
||||
w.work(burst=True)
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertEqual(job.get_status(), JobStatus.FINISHED)
|
||||
|
||||
# When a failing job has multiple dependents, only enqueue those
|
||||
# with allow_failure=True
|
||||
parent_job = q.enqueue(div_by_zero)
|
||||
job_allow_failure = q.enqueue(say_hello,
|
||||
depends_on=Dependency(jobs=parent_job, allow_failure=True))
|
||||
job = q.enqueue(say_hello,
|
||||
depends_on=Dependency(jobs=parent_job, allow_failure=False))
|
||||
w.work(burst=True, max_jobs=1)
|
||||
self.assertEqual(parent_job.get_status(), JobStatus.FAILED)
|
||||
self.assertEqual(job_allow_failure.get_status(), JobStatus.QUEUED)
|
||||
self.assertEqual(job.get_status(), JobStatus.DEFERRED)
|
||||
q.empty()
|
||||
|
||||
# only enqueue dependent job when all dependencies have finished/failed
|
||||
first_parent_job = q.enqueue(div_by_zero)
|
||||
second_parent_job = q.enqueue(say_hello)
|
||||
dependencies = Dependency(jobs=[first_parent_job, second_parent_job], allow_failure=True)
|
||||
job = q.enqueue_call(say_hello, depends_on=dependencies)
|
||||
w.work(burst=True, max_jobs=1)
|
||||
self.assertEqual(first_parent_job.get_status(), JobStatus.FAILED)
|
||||
self.assertEqual(second_parent_job.get_status(), JobStatus.QUEUED)
|
||||
self.assertEqual(job.get_status(), JobStatus.DEFERRED)
|
||||
|
||||
# When second job finishes, dependent job should be queued
|
||||
w.work(burst=True, max_jobs=1)
|
||||
self.assertEqual(second_parent_job.get_status(), JobStatus.FINISHED)
|
||||
self.assertEqual(job.get_status(), JobStatus.QUEUED)
|
||||
w.work(burst=True)
|
||||
job = Job.fetch(job.id, connection=self.testconn)
|
||||
self.assertEqual(job.get_status(), JobStatus.FINISHED)
|
Loading…
Reference in New Issue