support TZID= in schedule rrules

this commit allows schedule `rrule` strings to include local timezone information via TZID=NNNNN; occurrences are _generated_ in the local time specific by the user (or UTC, if e.g., DTSTART:YYYYMMDDTHHMMSSZ) while Schedule.next_run, Schedule.dtstart, and Schedule.dtend will be stored in the UTC equivalent (i.e., the scheduler will still do math on "what to run next" based on UTC datetimes). in addition to this change, there is now a new API endpoint, `/api/v2/schedules/preview/`, which takes an rrule and shows the next 10 occurrences in local and UTC time. see: https://github.com/ansible/ansible-tower/issues/823 related: https://github.com/dateutil/dateutil/issues/614
2026-05-03 23:55:28 -02:30 · 2018-01-19 11:11:21 -05:00
parent 5387846cbb
commit 15906b7e3c
7 changed files with 616 additions and 63 deletions
--- a/awx/api/serializers.py
+++ b/awx/api/serializers.py
@@ -9,7 +9,6 @@ import re
 import six
 import urllib
 from collections import OrderedDict
-from dateutil import rrule

 # Django
 from django.conf import settings
@@ -3873,7 +3872,67 @@ class LabelSerializer(BaseSerializer):
        return res


-class ScheduleSerializer(LaunchConfigurationBaseSerializer):
+class SchedulePreviewSerializer(BaseSerializer):
+
+    class Meta:
+        model = Schedule
+        fields = ('rrule',)
+
+    # We reject rrules if:
+    # - DTSTART is not include
+    # - INTERVAL is not included
+    # - SECONDLY is used
+    # - TZID is used
+    # - BYDAY prefixed with a number (MO is good but not 20MO)
+    # - BYYEARDAY
+    # - BYWEEKNO
+    # - Multiple DTSTART or RRULE elements
+    # - COUNT > 999
+    def validate_rrule(self, value):
+        rrule_value = value
+        multi_by_month_day = ".*?BYMONTHDAY[\:\=][0-9]+,-*[0-9]+"
+        multi_by_month = ".*?BYMONTH[\:\=][0-9]+,[0-9]+"
+        by_day_with_numeric_prefix = ".*?BYDAY[\:\=][0-9]+[a-zA-Z]{2}"
+        match_count = re.match(".*?(COUNT\=[0-9]+)", rrule_value)
+        match_multiple_dtstart = re.findall(".*?(DTSTART(;[^:]+)?\:[0-9]+T[0-9]+Z?)", rrule_value)
+        match_native_dtstart = re.findall(".*?(DTSTART:[0-9]+T[0-9]+) ", rrule_value)
+        match_multiple_rrule = re.findall(".*?(RRULE\:)", rrule_value)
+        if not len(match_multiple_dtstart):
+            raise serializers.ValidationError(_('Valid DTSTART required in rrule. Value should start with: DTSTART:YYYYMMDDTHHMMSSZ'))
+        if len(match_native_dtstart):
+            raise serializers.ValidationError(_('DTSTART cannot be a naive datetime.  Specify ;TZINFO= or YYYYMMDDTHHMMSSZZ.'))
+        if len(match_multiple_dtstart) > 1:
+            raise serializers.ValidationError(_('Multiple DTSTART is not supported.'))
+        if not len(match_multiple_rrule):
+            raise serializers.ValidationError(_('RRULE required in rrule.'))
+        if len(match_multiple_rrule) > 1:
+            raise serializers.ValidationError(_('Multiple RRULE is not supported.'))
+        if 'interval' not in rrule_value.lower():
+            raise serializers.ValidationError(_('INTERVAL required in rrule.'))
+        if 'secondly' in rrule_value.lower():
+            raise serializers.ValidationError(_('SECONDLY is not supported.'))
+        if re.match(multi_by_month_day, rrule_value):
+            raise serializers.ValidationError(_('Multiple BYMONTHDAYs not supported.'))
+        if re.match(multi_by_month, rrule_value):
+            raise serializers.ValidationError(_('Multiple BYMONTHs not supported.'))
+        if re.match(by_day_with_numeric_prefix, rrule_value):
+            raise serializers.ValidationError(_("BYDAY with numeric prefix not supported."))
+        if 'byyearday' in rrule_value.lower():
+            raise serializers.ValidationError(_("BYYEARDAY not supported."))
+        if 'byweekno' in rrule_value.lower():
+            raise serializers.ValidationError(_("BYWEEKNO not supported."))
+        if match_count:
+            count_val = match_count.groups()[0].strip().split("=")
+            if int(count_val[1]) > 999:
+                raise serializers.ValidationError(_("COUNT > 999 is unsupported."))
+        try:
+            Schedule.rrulestr(rrule_value)
+        except Exception:
+            raise serializers.ValidationError(_("rrule parsing failed validation."))
+        return value
+
+
+class ScheduleSerializer(LaunchConfigurationBaseSerializer, SchedulePreviewSerializer):
    show_capabilities = ['edit', 'delete']

    class Meta:
@@ -3900,58 +3959,6 @@ class ScheduleSerializer(LaunchConfigurationBaseSerializer):
                              'Schedule its source project `{}` instead.').format(value.source_project.name)))
        return value

-    # We reject rrules if:
-    # - DTSTART is not include
-    # - INTERVAL is not included
-    # - SECONDLY is used
-    # - TZID is used
-    # - BYDAY prefixed with a number (MO is good but not 20MO)
-    # - BYYEARDAY
-    # - BYWEEKNO
-    # - Multiple DTSTART or RRULE elements
-    # - COUNT > 999
-    def validate_rrule(self, value):
-        rrule_value = value
-        multi_by_month_day = ".*?BYMONTHDAY[\:\=][0-9]+,-*[0-9]+"
-        multi_by_month = ".*?BYMONTH[\:\=][0-9]+,[0-9]+"
-        by_day_with_numeric_prefix = ".*?BYDAY[\:\=][0-9]+[a-zA-Z]{2}"
-        match_count = re.match(".*?(COUNT\=[0-9]+)", rrule_value)
-        match_multiple_dtstart = re.findall(".*?(DTSTART\:[0-9]+T[0-9]+Z)", rrule_value)
-        match_multiple_rrule = re.findall(".*?(RRULE\:)", rrule_value)
-        if not len(match_multiple_dtstart):
-            raise serializers.ValidationError(_('DTSTART required in rrule. Value should match: DTSTART:YYYYMMDDTHHMMSSZ'))
-        if len(match_multiple_dtstart) > 1:
-            raise serializers.ValidationError(_('Multiple DTSTART is not supported.'))
-        if not len(match_multiple_rrule):
-            raise serializers.ValidationError(_('RRULE require in rrule.'))
-        if len(match_multiple_rrule) > 1:
-            raise serializers.ValidationError(_('Multiple RRULE is not supported.'))
-        if 'interval' not in rrule_value.lower():
-            raise serializers.ValidationError(_('INTERVAL required in rrule.'))
-        if 'tzid' in rrule_value.lower():
-            raise serializers.ValidationError(_('TZID is not supported.'))
-        if 'secondly' in rrule_value.lower():
-            raise serializers.ValidationError(_('SECONDLY is not supported.'))
-        if re.match(multi_by_month_day, rrule_value):
-            raise serializers.ValidationError(_('Multiple BYMONTHDAYs not supported.'))
-        if re.match(multi_by_month, rrule_value):
-            raise serializers.ValidationError(_('Multiple BYMONTHs not supported.'))
-        if re.match(by_day_with_numeric_prefix, rrule_value):
-            raise serializers.ValidationError(_("BYDAY with numeric prefix not supported."))
-        if 'byyearday' in rrule_value.lower():
-            raise serializers.ValidationError(_("BYYEARDAY not supported."))
-        if 'byweekno' in rrule_value.lower():
-            raise serializers.ValidationError(_("BYWEEKNO not supported."))
-        if match_count:
-            count_val = match_count.groups()[0].strip().split("=")
-            if int(count_val[1]) > 999:
-                raise serializers.ValidationError(_("COUNT > 999 is unsupported."))
-        try:
-            rrule.rrulestr(rrule_value)
-        except Exception:
-            raise serializers.ValidationError(_("rrule parsing failed validation."))
-        return value
-

 class InstanceSerializer(BaseSerializer):

--- a/awx/api/urls/urls.py
+++ b/awx/api/urls/urls.py
@@ -22,6 +22,8 @@ from awx.api.views import (
    JobExtraCredentialsList,
    JobTemplateCredentialsList,
    JobTemplateExtraCredentialsList,
+    SchedulePreview,
+    ScheduleZoneInfo,
 )

 from .organization import urls as organization_urls
@@ -113,6 +115,8 @@ v2_urls = [
    url(r'^jobs/(?P<pk>[0-9]+)/credentials/$', JobCredentialsList.as_view(), name='job_credentials_list'),
    url(r'^job_templates/(?P<pk>[0-9]+)/extra_credentials/$', JobTemplateExtraCredentialsList.as_view(), name='job_template_extra_credentials_list'),
    url(r'^job_templates/(?P<pk>[0-9]+)/credentials/$', JobTemplateCredentialsList.as_view(), name='job_template_credentials_list'),
+    url(r'^schedules/preview/$', SchedulePreview.as_view(), name='schedule_rrule'),
+    url(r'^schedules/zoneinfo/$', ScheduleZoneInfo.as_view(), name='schedule_zoneinfo'),
 ]

 app_name = 'api'
--- a/awx/api/views.py
+++ b/awx/api/views.py
@@ -53,6 +53,7 @@ import ansiconv
 # Python Social Auth
 from social_core.backends.utils import load_backends

+import pytz
 from wsgiref.util import FileWrapper

 # AWX
@@ -608,6 +609,31 @@ class ScheduleDetail(RetrieveUpdateDestroyAPIView):
    new_in_148 = True


+class SchedulePreview(GenericAPIView):
+
+    model = Schedule
+    view_name = _('Schedule Recurrence Rule Preview')
+    serializer_class = SchedulePreviewSerializer
+    new_in_api_v2 = True
+
+    def post(self, request):
+        serializer = self.get_serializer(data=request.data)
+        if serializer.is_valid():
+            schedule = list(Schedule.rrulestr(serializer.validated_data['rrule']).xafter(now(), count=10))
+            return Response({
+                'local': schedule,
+                'utc': [s.astimezone(pytz.utc) for s in schedule]
+            })
+        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+
+
+class ScheduleZoneInfo(APIView):
+
+    def get(self, request):
+        from dateutil.zoneinfo import get_zonefile_instance
+        return Response(sorted(get_zonefile_instance().zones.keys()))
+
+
 class LaunchConfigCredentialsBase(SubListAttachDetachAPIView):

    model = Credential