Support for generic webhooks

readthedocs/projects/forms.py

@@ -465,15 +465,15 @@ def __init__(self, *args, **kwargs):
             # Don't show the secret in the creation form.
             self.fields.pop('secret')
             self.fields['payload'].initial = json.dumps({
-                'event': '$event',
-                'name': '$project.name',
-                'slug': '$project.slug',
-                'version': '$version.slug',
-                'commit': '$build.commit',
-                'build': '$build.id',
-                'start_date': '$build.start_date',
-                'build_url': '$build.url',
-                'docs_url': '$build.docs_url',
+                'event': '{{ event }}',
+                'name': '{{ project.name }}',
+                'slug': '{{ project.slug }}',
+                'version': '{{ version.slug }}',
+                'commit': '{{ build.commit }}',
+                'build': '{{ build.id }}',
+                'start_date': '{{ build.start_date }}',
+                'build_url': '{{ build.url }}',
+                'docs_url': '{{ build.docs_url }}',
             }, indent=2)
 
     def clean_project(self):

readthedocs/projects/models.py

@@ -1546,7 +1546,11 @@ def save(self, *args, **kwargs):
         super().save(*args, **kwargs)
 
     def get_payload(self, version, build, event):
-        """Get the final payload replacing all placeholders."""
+        """
+        Get the final payload replacing all placeholders.
+
+        Placeholders are in the ``{{ foo }}`` or ``{{foo}}`` format.
+        """
         if not self.payload:
             return None
 
@@ -1577,25 +1581,26 @@ def get_payload(self, version, build, event):
         ).isoformat()
 
         substitutions = {
-            '$event': event,
-            '$build.id': build.id,
-            '$build.commit': commit,
-            '$build.url': build_url,
-            '$build.docs_url': build_docsurl,
-            '$build.start_date': start_date,
-            '$organization.name': organization_name,
-            '$organization.slug': organization_slug,
-            '$project.slug': project.slug,
-            '$project.name': project.name,
-            '$project.url': project_url,
-            '$version.slug': version.slug,
-            '$version.name': version.verbose_name,
+            'event': event,
+            'build.id': build.id,
+            'build.commit': commit,
+            'build.url': build_url,
+            'build.docs_url': build_docsurl,
+            'build.start_date': start_date,
+            'organization.name': organization_name,
+            'organization.slug': organization_slug,
+            'project.slug': project.slug,
+            'project.name': project.name,
+            'project.url': project_url,
+            'version.slug': version.slug,
+            'version.name': version.verbose_name,
         }
         payload = self.payload
         # Small protection for DDoS.
         max_substitutions = 99
         for substitution, value in substitutions.items():
-            payload = payload.replace(substitution, str(value), max_substitutions)
+            payload = payload.replace(f'{{{{ {substitution} }}}}', str(value), max_substitutions)
+            payload = payload.replace(f'{{{{{substitution}}}}}', str(value), max_substitutions)
         return payload
 
     def sign_payload(self, payload):

readthedocs/rtd_tests/tests/test_build_notifications.py

@@ -155,21 +155,21 @@ def test_send_webhook_custom_payload(self, mock_request):
             project=self.project,
             events=[WebHookEvent.objects.get(name=WebHookEvent.BUILD_FAILED)],
             payload=json.dumps({
-                'message': 'Event $event triggered for $version.slug',
+                'message': 'Event {{ event }} triggered for {{ version.slug }}',
                 'extra-data': {
-                    'build_id': '$build.id',
-                    'build_commit': '$build.commit',
-                    'build_url': '$build.url',
-                    'build_docsurl': '$build.docs_url',
-                    'build_start_date': '$build.start_date',
-                    'organization_slug': '$organization.slug',
-                    'organization_name': '$organization.name',
-                    'project_slug': '$project.slug',
-                    'project_name': '$project.name',
-                    'project_url': '$project.url',
-                    'version_slug': '$version.slug',
-                    'version_name': '$version.name',
-                    'invalid_substitution': '$invalid.substitution',
+                    'build_id': '{{build.id}}',
+                    'build_commit': '{{build.commit}}',
+                    'build_url': '{{ build.url }}',
+                    'build_docsurl': '{{ build.docs_url }}',
+                    'build_start_date': '{{ build.start_date }}',
+                    'organization_slug': '{{ organization.slug }}',
+                    'organization_name': '{{ organization.name }}',
+                    'project_slug': '{{ project.slug }}',
+                    'project_name': '{{ project.name }}',
+                    'project_url': '{{ project.url }}',
+                    'version_slug': '{{ version.slug }}',
+                    'version_name': '{{ version.name }}',
+                    'invalid_substitution': '{{ invalid.substitution }}',
                 }
             }),
         )
@@ -198,7 +198,7 @@ def test_send_webhook_custom_payload(self, mock_request):
                     'project_url': f'https://readthedocs.org{self.project.get_absolute_url()}',
                     'version_name': self.version.verbose_name,
                     'version_slug': self.version.slug,
-                    'invalid_substitution': '$invalid.substitution',
+                    'invalid_substitution': '{{ invalid.substitution }}',
                 },
             }
         )