Merge pull request #8897 from wenottingham/right-on-schedule

Add schedule info from summary fields to allowed notification content.

Reviewed-by: https://github.com/apps/softwarefactory-project-zuul

awx/main/models/notifications.py

@@ -280,6 +280,7 @@ class JobNotificationMixin(object):
                                                    {'unified_job_template': ['id', 'name', 'description', 'unified_job_type']},
                                                    {'instance_group': ['name', 'id']},
                                                    {'created_by': ['id', 'username', 'first_name', 'last_name']},
+                                                   {'schedule': ['id', 'name', 'description', 'next_run']},
                                                    {'labels': ['count', 'results']}]}]
 
     @classmethod
@@ -344,6 +345,10 @@ class JobNotificationMixin(object):
                                                           'name': 'Stub project',
                                                           'scm_type': 'git',
                                                           'status': 'successful'},
+                                              'schedule': {'description': 'Sample schedule',
+                                                           'id': 42,
+                                                           'name': 'Stub schedule',
+                                                           'next_run': datetime.datetime(2038, 1, 1, 0, 0, 0, 0, tzinfo=datetime.timezone.utc)},
                                               'unified_job_template': {'description': 'Sample unified job template description',
                                                                        'id': 39,
                                                                        'name': 'Stub Job Template',

awx/main/tests/functional/models/test_notifications.py

@@ -6,7 +6,7 @@ import pytest
 
 #from awx.main.models import NotificationTemplates, Notifications, JobNotificationMixin
 from awx.main.models import (AdHocCommand, InventoryUpdate, Job, JobNotificationMixin, ProjectUpdate,
-                             SystemJob, WorkflowJob)
+                             Schedule, SystemJob, WorkflowJob)
 from awx.api.serializers import UnifiedJobSerializer
 
 
@@ -72,6 +72,10 @@ class TestJobNotificationMixin(object):
                                                                 'name': str,
                                                                 'scm_type': str,
                                                                 'status': str},
+                                                    'schedule': {'description': str,
+                                                                 'id': int,
+                                                                 'name': str,
+                                                                 'next_run': datetime.datetime},
                                                     'unified_job_template': {'description': str,
                                                                              'id': int,
                                                                              'name': str,
@@ -89,27 +93,27 @@ class TestJobNotificationMixin(object):
                          'workflow_url': str,
                          'url': str}
 
+    def check_structure(self, expected_structure, obj):
+        if isinstance(expected_structure, dict):
+            assert isinstance(obj, dict)
+            for key in obj:
+                assert key in expected_structure
+                if obj[key] is None:
+                    continue
+                if isinstance(expected_structure[key], dict):
+                    assert isinstance(obj[key], dict)
+                    self.check_structure(expected_structure[key], obj[key])
+                else:
+                    if key == 'job_explanation':
+                        assert isinstance(str(obj[key]), expected_structure[key])
+                    else:
+                        assert isinstance(obj[key], expected_structure[key])
 
     @pytest.mark.django_db
     @pytest.mark.parametrize('JobClass', [AdHocCommand, InventoryUpdate, Job, ProjectUpdate, SystemJob, WorkflowJob])
     def test_context(self, JobClass, sqlite_copy_expert, project, inventory_source):
         """The Jinja context defines all of the fields that can be used by a template. Ensure that the context generated
         for each job type has the expected structure."""
-        def check_structure(expected_structure, obj):
-            if isinstance(expected_structure, dict):
-                assert isinstance(obj, dict)
-                for key in obj:
-                    assert key in expected_structure
-                    if obj[key] is None:
-                        continue
-                    if isinstance(expected_structure[key], dict):
-                        assert isinstance(obj[key], dict)
-                        check_structure(expected_structure[key], obj[key])
-                    else:
-                        if key == 'job_explanation':
-                            assert isinstance(str(obj[key]), expected_structure[key])
-                        else:
-                            assert isinstance(obj[key], expected_structure[key])
         kwargs = {}
         if JobClass is InventoryUpdate:
             kwargs['inventory_source'] = inventory_source
@@ -121,8 +125,26 @@ class TestJobNotificationMixin(object):
         job_serialization = UnifiedJobSerializer(job).to_representation(job)
 
         context = job.context(job_serialization)
-        check_structure(TestJobNotificationMixin.CONTEXT_STRUCTURE, context)
+        self.check_structure(TestJobNotificationMixin.CONTEXT_STRUCTURE, context)
 
+    @pytest.mark.django_db
+    def test_schedule_context(self, job_template, admin_user):
+        schedule = Schedule.objects.create(
+            name='job-schedule',
+            rrule='DTSTART:20171129T155939z\nFREQ=MONTHLY',
+            unified_job_template=job_template
+        )
+        job = Job.objects.create(
+            name='fake-job',
+            launch_type='workflow',
+            schedule=schedule,
+            job_template=job_template
+        )
+
+        job_serialization = UnifiedJobSerializer(job).to_representation(job)
+
+        context = job.context(job_serialization)
+        self.check_structure(TestJobNotificationMixin.CONTEXT_STRUCTURE, context)
 
     @pytest.mark.django_db
     def test_context_job_metadata_with_unicode(self):