Merge pull request #109 from datosgobar/105-synchronizer-day-of-week-select

Permito programar Synchronizers por día de semana

Author: lucaslavandeira

django_datajsonar/admin.py

@@ -1,10 +1,11 @@
 #!coding=utf8
 from __future__ import unicode_literals
 
+import json
+
 from django import forms
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
-from django.core.exceptions import ValidationError
 from django.forms.models import formset_factory
 from django.contrib import admin, messages
 from django.contrib.admin import helpers, SimpleListFilter
@@ -386,7 +387,8 @@ def _synchro_view(self, request, synchro=None):
             synchro_form = SynchroForm({
                 'name': synchro.name,
                 'frequency': synchro.frequency,
-                'scheduled_time': synchro.scheduled_time
+                'scheduled_time': synchro.scheduled_time,
+                'week_days': synchro.get_days_of_week()
             })
         else:
             synchro_form = SynchroForm()
@@ -443,6 +445,7 @@ def post_synchro_edit(self, request, object_id=None):
             'name': synchro_name,
             'frequency': synchro_form.cleaned_data['frequency'],
             'scheduled_time': synchro_form.cleaned_data['scheduled_time'],
+            'week_days': json.dumps(synchro_form.cleaned_data['week_days']),
         }
         create_or_update_synchro(object_id, stages, data)
 

django_datajsonar/forms.py

@@ -9,8 +9,8 @@
 
 from scheduler.models import RepeatableJob
 
-from django_datajsonar.models import Synchronizer, Stage, AbstractTask
-from django_datajsonar.utils import get_qualified_name
+from django_datajsonar.models import Stage
+from . import strings
 
 
 class ScheduleJobForm(forms.ModelForm):
@@ -72,10 +72,32 @@ class SynchroForm(forms.Form):
     scheduled_time = forms.TimeField(
         widget=AdminTimeWidget(attrs={'type': 'time'}))
 
+    MON = strings.MON
+    TUE = strings.TUE
+    WED = strings.WED
+    THU = strings.THU
+    FRI = strings.FRI
+    SAT = strings.SAT
+    SUN = strings.SUN
+
+    WEEK_DAY_CHOICES = (
+        (MON, 'Monday'),
+        (TUE, 'Tuesday'),
+        (WED, 'Wednesday'),
+        (THU, 'Thursday'),
+        (FRI, 'Friday'),
+        (SAT, 'Saturday'),
+        (SUN, 'Sunday'),
+    )
+
+    week_days = forms.MultipleChoiceField(choices=WEEK_DAY_CHOICES, required=False)
+
     def clean(self):
         cleaned_data = super(SynchroForm, self).clean()
-        if cleaned_data['frequency'] == self.WEEK_DAYS:
-            self.add_error('frequency', 'week days not yet implemented')
+        days = cleaned_data['week_days']
+        frequency = cleaned_data['frequency']
+        if frequency == self.WEEK_DAYS and not days:
+            self.add_error('week_days', 'Days of week not selected')
 
 
 class StageForm(forms.Form):

django_datajsonar/frequency.py

@@ -2,13 +2,17 @@
 
 from croniter import croniter
 
-from django_datajsonar.strings import SYNCHRO_DAILY_FREQUENCY
 
+def get_next_run_date(start_time, scheduled_time, week_days=None):
+    if not week_days:
+        week_days_field = "*"
+    else:
+        week_days_field = ','.join(week_days)
 
-def get_next_run_date(start_time, scheduled_time, frequency):
-    if frequency != SYNCHRO_DAILY_FREQUENCY:
-        raise NotImplementedError
-
-    cron_string = "{} {} * * *".format(scheduled_time.minute, scheduled_time.hour)
+    cron_string = "{} {} * * {}".format(
+        scheduled_time.minute,
+        scheduled_time.hour,
+        week_days_field
+    )
 
     return croniter(cron_string, start_time=start_time).get_next(datetime)

django_datajsonar/migrations/0002_auto_20190205_1555.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.18 on 2019-02-05 18:55
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('django_datajsonar', '0001_auto_20190201_1344'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='synchronizer',
+            name='week_days',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AlterField(
+            model_name='synchronizer',
+            name='frequency',
+            field=models.CharField(choices=[('every day', 'Every day'), ('week days', 'Week days')], default='every day', max_length=16),
+        ),
+    ]

django_datajsonar/models.py

@@ -1,6 +1,7 @@
 #! coding: utf-8
 from __future__ import unicode_literals
 
+import json
 from importlib import import_module
 
 from django.contrib.auth.models import User
@@ -461,14 +462,16 @@ class Synchronizer(models.Model):
     WEEK_DAYS = SYNCHRO_WEEK_DAYS_FREQUENCY
     DAILY = SYNCHRO_DAILY_FREQUENCY
     FREQUENCY_CHOICES = (
-        (DAILY, DAILY),
-        (WEEK_DAYS, WEEK_DAYS),
+        (DAILY, 'Every day'),
+        (WEEK_DAYS, 'Week days'),
     )
     frequency = models.CharField(choices=FREQUENCY_CHOICES, max_length=16, default=DAILY)
-    scheduled_time = models.TimeField(auto_now_add=True)
+    scheduled_time = models.TimeField(default=timezone.now)
 
     last_time_ran = models.DateTimeField(auto_now_add=True)
 
+    week_days = models.TextField(blank=True)
+
     def begin_stage(self, stage=None):
         if self.status == self.RUNNING and stage is None:
             raise Exception('El synchronizer ya está corriendo, pero no se pasó la siguiente etapa.')
@@ -496,8 +499,9 @@ def next_stage(self):
             self.begin_stage(self.actual_stage.next_stage)
 
     def next_start_date(self):
-        localtime = self.last_time_ran.astimezone(timezone.get_current_timezone())
-        return get_next_run_date(localtime, self.scheduled_time, self.frequency)
+        start_time = self.last_time_ran.astimezone(timezone.get_current_timezone())
+        week_days = self.get_days_of_week()
+        return get_next_run_date(start_time, self.scheduled_time, week_days=week_days)
 
     def __unicode__(self):
         return self.name
@@ -512,3 +516,8 @@ def get_stages(self):
             stages.append(current_stage)
             current_stage = current_stage.next_stage
         return stages
+
+    def get_days_of_week(self):
+        if self.frequency == self.WEEK_DAYS:
+            return json.loads(self.week_days)
+        return []

django_datajsonar/static/django_datajsonar/js/synchronizer.js

@@ -0,0 +1,25 @@
+window.onload = function() {
+    const frequency = document.getElementById('id_frequency');
+    frequency.addEventListener("change", hideWeekDays);
+    hideWeekDays();
+};
+
+function hideWeekDays() {
+    const frequency = document.getElementById('id_frequency');
+    const weekDays = document.getElementById('id_week_days');
+    const weekDaysDiv = weekDays.closest('.field-week_days');
+    const option = frequency.options[frequency.selectedIndex].text;
+
+    if (option === 'week days') {
+        weekDaysDiv.style.display = "";
+    }
+
+    if (option === 'every day') {
+        const options = weekDays.options;
+        for (let i = 0; i < options.length; i++) {
+            options[i].selected = false;
+        }
+
+        weekDaysDiv.style.display = "none";
+    }
+}

django_datajsonar/strings.py

@@ -5,3 +5,13 @@
 
 SYNCHRO_DAILY_FREQUENCY = 'every day'
 SYNCHRO_WEEK_DAYS_FREQUENCY = 'week days'
+
+
+# Valores de días de la semana leídos por librerías de crontab, según el estándar.
+MON = 'MON'
+TUE = 'TUE'
+WED = 'WED'
+THU = 'THU'
+FRI = 'FRI'
+SAT = 'SAT'
+SUN = 'SUN'

django_datajsonar/templates/synchronizer.html

@@ -50,6 +50,7 @@
     </form>
 <script src="{% static 'django_datajsonar/js/jquery-3.3.1.min.js' %}"></script>
 <script src="{% static 'django_datajsonar/js/jquery.formset.js' %}"></script>
+<script src="{% static 'django_datajsonar/js/synchronizer.js' %}"></script>
 <script type="text/javascript">
     $(function() {
         $('#synchroForm tbody tr').formset();

django_datajsonar/tests/frequency_tests.py

@@ -0,0 +1,61 @@
+from datetime import time, datetime
+
+from django.test import TestCase
+from freezegun import freeze_time
+
+from django_datajsonar.frequency import get_next_run_date
+from django_datajsonar import strings
+
+
+@freeze_time("2019-01-01 06:00:00")  # Tuesday
+class NextRunDateTests(TestCase):
+
+    def setUp(self):
+        self.now = datetime.now()  # Localtime
+
+    def test_get_daily_next_run_date(self):
+
+        nine_am = time(9, 0)
+        next_run_date = get_next_run_date(start_time=self.now, scheduled_time=nine_am)
+
+        self.assertEqual(next_run_date, datetime(2019, 1, 1, 9, 0, 0))
+
+    def test_get_daily_next_run_date_for_tomorrow(self):
+
+        before_now = time(5, 0)
+        next_run_date = get_next_run_date(start_time=self.now, scheduled_time=before_now)
+
+        self.assertEqual(next_run_date, datetime(2019, 1, 2, 5, 0, 0))
+
+    def test_get_next_run_date_weekdays(self):
+
+        nine_am = time(9, 0)
+        week_days = [strings.MON, strings.TUE]
+        next_run_date = get_next_run_date(start_time=self.now, scheduled_time=nine_am, week_days=week_days)
+
+        self.assertEqual(next_run_date, datetime(2019, 1, 1, 9, 0, 0))  # Today is tuesday!
+
+    def test_get_next_run_date_weekdays_not_today(self):
+        nine_am = time(9, 0)
+        week_days = ['MON']
+        next_run_date = get_next_run_date(start_time=self.now, scheduled_time=nine_am, week_days=week_days)
+
+        self.assertEqual(next_run_date, datetime(2019, 1, 7, 9, 0, 0))  # Next monday
+
+    def test_iterate_next_run_dates(self):
+        nine_am = time(9, 0)
+        week_days = [strings.MON, strings.TUE, strings.WED, strings.THU]
+
+        expected_dates = [  # Tuesday, Wednesday, Thursday, then next week's Monday
+            datetime(2019, 1, 1, 9, 0, 0),
+            datetime(2019, 1, 2, 9, 0, 0),
+            datetime(2019, 1, 3, 9, 0, 0),
+            datetime(2019, 1, 7, 9, 0, 0),
+        ]
+
+        start_time = self.now
+        for expected_date in expected_dates:
+            next_run_date = get_next_run_date(start_time=start_time, scheduled_time=nine_am, week_days=week_days)
+
+            self.assertEqual(next_run_date, expected_date)
+            start_time = next_run_date