Fix crashes and ensure usage of correct timezone for solar and crontab schedules (#56)

* Return schedule for solar periodic tasks so that Celery Beat does not crash when one is scheduled.

* Adding nowfun to solar and crontab schedulers so that the Django timezone is used.

* Adding solar schedule tests.

* Test environment now needs ephem in order to test Solar schedules.

* Fixing typo in package name.

* Fixed flake8 errors.

Author: DDevine

django_celery_beat/models.py

@@ -12,7 +12,7 @@
 from celery.five import python_2_unicode_compatible
 
 from . import managers
-from .utils import now
+from .utils import now, make_aware
 
 DAYS = 'days'
 HOURS = 'hours'
@@ -60,7 +60,10 @@ class Meta:
 
     @property
     def schedule(self):
-        return schedules.solar(self.event, self.latitude, self.longitude)
+        return schedules.solar(self.event, 
+                               self.latitude, 
+                               self.longitude, 
+                               nowfun=lambda: make_aware(now()))
 
     @classmethod
     def from_schedule(cls, schedule):
@@ -171,7 +174,8 @@ def schedule(self):
                                  hour=self.hour,
                                  day_of_week=self.day_of_week,
                                  day_of_month=self.day_of_month,
-                                 month_of_year=self.month_of_year)
+                                 month_of_year=self.month_of_year,
+                                 nowfun=lambda: make_aware(now()))
 
     @classmethod
     def from_schedule(cls, schedule):
@@ -317,6 +321,8 @@ def schedule(self):
             return self.interval.schedule
         if self.crontab:
             return self.crontab.schedule
+        if self.solar:
+            return self.solar.schedule
 
 
 signals.pre_delete.connect(PeriodicTasks.changed, sender=PeriodicTask)

requirements/default.txt

@@ -1 +1,2 @@
 celery>=4.0,<5.0
+ephem>=3.7.6.0

t/unit/test_schedulers.py

@@ -10,13 +10,15 @@
 from django.test import RequestFactory
 
 from celery.five import monotonic, text_t
-from celery.schedules import schedule, crontab
+from celery.schedules import schedule, crontab, solar
 
 from django_celery_beat import schedulers
 from django_celery_beat.admin import PeriodicTaskAdmin
 from django_celery_beat.models import (
     PeriodicTask, PeriodicTasks, IntervalSchedule, CrontabSchedule,
+    SolarSchedule
 )
+from django_celery_beat.utils import make_aware
 
 _ids = count(0)
 
@@ -69,6 +71,11 @@ def create_model_crontab(self, schedule, **kwargs):
         crontab.save()
         return self.create_model(crontab=crontab, **kwargs)
 
+    def create_model_solar(self, schedule, **kwargs):
+        solar = SolarSchedule.from_schedule(schedule)
+        solar.save()
+        return self.create_model(solar=solar, **kwargs)
+
     def create_conf_entry(self):
         name = 'thefoo{0}'.format(next(_ids))
         return name, dict(
@@ -181,20 +188,27 @@ def setup_scheduler(self, app):
             schedule(timedelta(seconds=10)))
         self.m1.save()
         self.m1.refresh_from_db()
+
         self.m2 = self.create_model_interval(
             schedule(timedelta(minutes=20)))
         self.m2.save()
         self.m2.refresh_from_db()
+
         self.m3 = self.create_model_crontab(
             crontab(minute='2,4,5'))
         self.m3.save()
         self.m3.refresh_from_db()
 
+        self.m4 = self.create_model_solar(
+            solar('solar_noon', 48.06, 12.86))
+        self.m4.save()
+        self.m4.refresh_from_db()
+
         # disabled, should not be in schedule
-        m4 = self.create_model_interval(
+        m5 = self.create_model_interval(
             schedule(timedelta(seconds=1)))
-        m4.enabled = False
-        m4.save()
+        m5.enabled = False
+        m5.save()
 
         self.s = self.Scheduler(app=self.app)
 
@@ -206,7 +220,7 @@ def test_constructor(self):
     def test_all_as_schedule(self):
         sched = self.s.schedule
         assert sched
-        assert len(sched) == 4
+        assert len(sched) == 5
         assert 'celery.backend_cleanup' in sched
         for n, e in sched.items():
             assert isinstance(e, self.s.Entry)
@@ -379,6 +393,14 @@ def test_PeriodicTask_unicode_crontab(self):
         ))
         assert text_t(p) == '{0}: * 4,5 4,5 * * (m/h/d/dM/MY)'.format(p.name)
 
+    def test_PeriodicTask_unicode_solar(self):
+        p = self.create_model_solar(
+            solar('solar_noon', 48.06, 12.86), name='solar_event'
+        )
+        assert text_t(p) == 'solar_event: {0} ({1}, {2})'.format(
+            'solar_noon', '48.06', '12.86'
+        )
+
     def test_PeriodicTask_schedule_property(self):
         p1 = self.create_model_interval(schedule(timedelta(seconds=10)))
         s1 = p1.schedule
@@ -415,6 +437,18 @@ def test_CrontabSchedule_schedule(self):
         assert s.schedule.day_of_month == {1, 16}
         assert s.schedule.month_of_year == {1, 7}
 
+    def test_SolarSchedule_schedule(self):
+        s = SolarSchedule(event='solar_noon', latitude=48.06, longitude=12.86)
+        dt = datetime(day=25, month=7, year=2017, hour=12, minute=0)
+        dt_lastrun = make_aware(dt)
+
+        assert s.schedule is not None
+
+        isdue, nextcheck = s.schedule.is_due(dt_lastrun)
+        assert isdue is False  # False means scheduler needs to keep checking.
+        assert (nextcheck > 0) and (isdue is False) or \
+            (nextcheck == s.max_interval) and (isdue is True)
+
 
 @pytest.mark.django_db()
 class test_model_PeriodicTasks(SchedulerCase):