Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Seconds interval units #1

Merged
merged 2 commits into from
Mar 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,7 @@ target/

# SQLite
*.sqlite3

# Pipenv
Pipfile
Pipfile.lock
18 changes: 18 additions & 0 deletions scheduler/migrations/0006_seconds_interval_units.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Generated by Django 2.1.2 on 2018-10-10 01:02

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('scheduler', '0005_added_result_ttl'),
]

operations = [
migrations.AlterField(
model_name='repeatablejob',
name='interval_unit',
field=models.CharField(choices=[('seconds', 'seconds'), ('minutes', 'minutes'), ('hours', 'hours'), ('days', 'days'), ('weeks', 'weeks')], default='hours', max_length=12, verbose_name='interval unit'),
),
]
20 changes: 19 additions & 1 deletion scheduler/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
from model_utils.models import TimeStampedModel


RQ_SCHEDULER_INTERVAL = getattr(settings, "DJANGO_RQ_SCHEDULER_INTERVAL", 60)


@python_2_unicode_compatible
class BaseJob(TimeStampedModel):

Expand Down Expand Up @@ -90,7 +93,7 @@ def delete(self, **kwargs):
super(BaseJob, self).delete(**kwargs)

def scheduler(self):
return django_rq.get_scheduler(self.queue)
return django_rq.get_scheduler(self.queue, interval=RQ_SCHEDULER_INTERVAL)

def is_schedulable(self):
if self.job_id:
Expand Down Expand Up @@ -147,6 +150,7 @@ class Meta:
class RepeatableJob(ScheduledTimeMixin, BaseJob):

UNITS = Choices(
('seconds', _('seconds')),
('minutes', _('minutes')),
('hours', _('hours')),
('days', _('days')),
Expand All @@ -159,6 +163,20 @@ class RepeatableJob(ScheduledTimeMixin, BaseJob):
)
repeat = models.PositiveIntegerField(_('repeat'), blank=True, null=True)

def clean(self):
super(RepeatableJob, self).clean()
self.clean_interval_unit()

def clean_interval_unit(self):
if RQ_SCHEDULER_INTERVAL > self.interval_seconds():
raise ValidationError({
'interval_unit': ValidationError(
_("Job interval is set lower than {} queue's interval.".format(self.queue)), code='invalid')
})
if self.interval_seconds() % RQ_SCHEDULER_INTERVAL:
raise ValidationError(_("Job interval is not a multiple of rq_scheduler's interval frequency: {}s".format(
RQ_SCHEDULER_INTERVAL)), code='invalid')

def interval_display(self):
return '{} {}'.format(self.interval, self.get_interval_unit_display())

Expand Down
39 changes: 39 additions & 0 deletions scheduler/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,39 @@ class TestRepeatableJob(TestScheduledJob):
JobClass = RepeatableJob
JobClassFactory = RepeatableJobFactory

def test_clean(self):
job = self.JobClass()
job.queue = list(settings.RQ_QUEUES)[0]
job.callable = 'scheduler.tests.test_job'
job.interval = 1
assert job.clean() is None

def test_clean_seconds(self):
job = self.JobClass()
job.queue = list(settings.RQ_QUEUES)[0]
job.callable = 'scheduler.tests.test_job'
job.interval = 60
job.interval_unit = 'seconds'
assert job.clean() is None

def test_clean_too_frequent(self):
job = self.JobClass()
job.queue = list(settings.RQ_QUEUES)[0]
job.callable = 'scheduler.tests.test_job'
job.interval = 30
job.interval_unit = 'seconds'
with self.assertRaises(ValidationError):
job.clean_interval_unit()

def test_clean_not_multiple(self):
job = self.JobClass()
job.queue = list(settings.RQ_QUEUES)[0]
job.callable = 'scheduler.tests.test_job'
job.interval = 121
job.interval_unit = 'seconds'
with self.assertRaises(ValidationError):
job.clean_interval_unit()

def test_interval_seconds_weeks(self):
job = RepeatableJob()
job.interval = 2
Expand All @@ -233,6 +266,12 @@ def test_interval_seconds_minutes(self):
job.interval_unit = 'minutes'
self.assertEqual(900.0, job.interval_seconds())

def test_interval_seconds_seconds(self):
job = RepeatableJob()
job.interval = 15
job.interval_unit = 'seconds'
self.assertEqual(15.0, job.interval_seconds())

def test_repeatable_schedule(self):
job = self.JobClassFactory()
job.id = 1
Expand Down