Closes netbox-community#14361: Add webhook description

jacobpfickes · jacobpfickes · commit b3235c5c69bc · 2023-11-28T18:21:31.000-07:00
diff --git a/docs/models/extras/webhook.md b/docs/models/extras/webhook.md
@@ -10,6 +10,10 @@ See the [webhooks documentation](../../integrations/webhooks.md) for more inform
 
 A unique human-friendly name.
 
+### Description
+
+A brief description of the webhook's purpose (optional).
+
 ### Content Types
 
 The type(s) of object in NetBox that will trigger the webhook.
diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py
@@ -70,7 +70,7 @@ class WebhookSerializer(NetBoxModelSerializer):
     class Meta:
         model = Webhook
         fields = [
-            'id', 'url', 'display', 'content_types', 'name', 'type_create', 'type_update', 'type_delete',
+            'id', 'url', 'display', 'content_types', 'name', 'description', 'type_create', 'type_update', 'type_delete',
             'type_job_start', 'type_job_end', 'payload_url', 'enabled', 'http_method', 'http_content_type',
             'additional_headers', 'body_template', 'secret', 'conditions', 'ssl_verification', 'ca_file_path',
             'custom_fields', 'tags', 'created', 'last_updated',
diff --git a/netbox/extras/forms/bulk_edit.py b/netbox/extras/forms/bulk_edit.py
@@ -177,6 +177,10 @@ class WebhookBulkEditForm(NetBoxModelBulkEditForm):
         queryset=Webhook.objects.all(),
         widget=forms.MultipleHiddenInput
     )
+    description = forms.CharField(
+        label=_('Description'),
+        required=False
+    )
     enabled = forms.NullBooleanField(
         label=_('Enabled'),
         required=False,
@@ -230,7 +234,7 @@ class WebhookBulkEditForm(NetBoxModelBulkEditForm):
         label=_('CA file path')
     )
 
-    nullable_fields = ('secret', 'conditions', 'ca_file_path')
+    nullable_fields = ('description', 'secret', 'conditions', 'ca_file_path')
 
 
 class TagBulkEditForm(BulkEditForm):
diff --git a/netbox/extras/forms/bulk_import.py b/netbox/extras/forms/bulk_import.py
@@ -152,7 +152,7 @@ class WebhookImportForm(NetBoxModelImportForm):
     class Meta:
         model = Webhook
         fields = (
-            'name', 'enabled', 'content_types', 'type_create', 'type_update', 'type_delete', 'type_job_start',
+            'name', 'description', 'enabled', 'content_types', 'type_create', 'type_update', 'type_delete', 'type_job_start',
             'type_job_end', 'payload_url', 'http_method', 'http_content_type', 'additional_headers', 'body_template',
             'secret', 'ssl_verification', 'ca_file_path', 'tags'
         )
diff --git a/netbox/extras/forms/model_forms.py b/netbox/extras/forms/model_forms.py
@@ -217,7 +217,7 @@ class WebhookForm(NetBoxModelForm):
     )
 
     fieldsets = (
-        (_('Webhook'), ('name', 'content_types', 'enabled', 'tags')),
+        (_('Webhook'), ('name', 'description', 'content_types', 'enabled', 'tags')),
         (_('Events'), ('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end')),
         (_('HTTP Request'), (
             'payload_url', 'http_method', 'http_content_type', 'additional_headers', 'body_template', 'secret',
diff --git a/netbox/extras/migrations/0102_webhook_description.py b/netbox/extras/migrations/0102_webhook_description.py
@@ -0,0 +1,18 @@
+# Generated by Django 4.2.7 on 2023-11-29 00:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0101_move_configrevision'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='webhook',
+            name='description',
+            field=models.CharField(blank=True, max_length=200),
+        ),
+    ]
diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py
@@ -53,6 +53,11 @@ class Webhook(CustomFieldsMixin, ExportTemplatesMixin, TagsMixin, ChangeLoggedMo
         max_length=150,
         unique=True
     )
+    description = models.CharField(
+        verbose_name=_('description'),
+        max_length=200,
+        blank=True
+    )
     type_create = models.BooleanField(
         verbose_name=_('on create'),
         default=False,
diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py
@@ -250,6 +250,9 @@ class WebhookTable(NetBoxTable):
         verbose_name=_('Name'),
         linkify=True
     )
+    description = columns.MarkdownColumn(
+        verbose_name=_('Description')
+    )
     content_types = columns.ContentTypesColumn(
         verbose_name=_('Content Types'),
     )
@@ -283,11 +286,11 @@ class Meta(NetBoxTable.Meta):
         fields = (
             'pk', 'id', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete',
             'type_job_start', 'type_job_end', 'http_method', 'payload_url', 'secret', 'ssl_validation', 'ca_file_path',
-            'tags', 'created', 'last_updated',
+            'tags', 'created', 'last_updated', 'description'
         )
         default_columns = (
             'pk', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete', 'type_job_start',
-            'type_job_end', 'http_method', 'payload_url',
+            'type_job_end', 'http_method', 'payload_url', 'description'
         )
 
 
diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py
@@ -52,6 +52,7 @@ class WebhookTest(APIViewTestCases.APIViewTestCase):
     ]
     bulk_update_data = {
         'ssl_verification': False,
+        'description': 'New description'
     }
 
     @classmethod
diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py
@@ -338,16 +338,17 @@ def setUpTestData(cls):
 
         site_ct = ContentType.objects.get_for_model(Site)
         webhooks = (
-            Webhook(name='Webhook 1', payload_url='http://example.com/?1', type_create=True, http_method='POST'),
-            Webhook(name='Webhook 2', payload_url='http://example.com/?2', type_create=True, http_method='POST'),
-            Webhook(name='Webhook 3', payload_url='http://example.com/?3', type_create=True, http_method='POST'),
+            Webhook(name='Webhook 1', description='Webhook 1 description', payload_url='http://example.com/?1', type_create=True, http_method='POST'),
+            Webhook(name='Webhook 2', description='Webhook 2 description', payload_url='http://example.com/?2', type_create=True, http_method='POST'),
+            Webhook(name='Webhook 3', description='Webhook 3 description', payload_url='http://example.com/?3', type_create=True, http_method='POST'),
         )
         for webhook in webhooks:
             webhook.save()
             webhook.content_types.add(site_ct)
 
         cls.form_data = {
             'name': 'Webhook X',
+            'description': 'A new webhook',
             'content_types': [site_ct.pk],
             'type_create': False,
             'type_update': True,
@@ -359,20 +360,21 @@ def setUpTestData(cls):
         }
 
         cls.csv_data = (
-            "name,content_types,type_create,payload_url,http_method,http_content_type",
-            "Webhook 4,dcim.site,True,http://example.com/?4,GET,application/json",
-            "Webhook 5,dcim.site,True,http://example.com/?5,GET,application/json",
-            "Webhook 6,dcim.site,True,http://example.com/?6,GET,application/json",
+            "name,description,content_types,type_create,payload_url,http_method,http_content_type",
+            "Webhook 4,Webhook 4 description,dcim.site,True,http://example.com/?4,GET,application/json",
+            "Webhook 5,Webhook 5 description,dcim.site,True,http://example.com/?5,GET,application/json",
+            "Webhook 6,Webhook 6 description,dcim.site,True,http://example.com/?6,GET,application/json",
         )
 
         cls.csv_update_data = (
-            "id,name",
-            f"{webhooks[0].pk},Webhook 7",
-            f"{webhooks[1].pk},Webhook 8",
-            f"{webhooks[2].pk},Webhook 9",
+            "id,name,description,",
+            f"{webhooks[0].pk},Webhook 7,Webhook 7 description",
+            f"{webhooks[1].pk},Webhook 8,Webhook 8 description",
+            f"{webhooks[2].pk},Webhook 9,Webhook 9 description",
         )
 
         cls.bulk_edit_data = {
+            'description': 'New description',
             'enabled': False,
             'type_create': False,
             'type_update': True,
diff --git a/netbox/templates/extras/webhook.html b/netbox/templates/extras/webhook.html
@@ -16,6 +16,10 @@ <h5 class="card-header">
             <th scope="row">{% trans "Name" %}</th>
             <td>{{ object.name }}</td>
           </tr>
+          <tr>
+            <th scope="row">{% trans "Description" %}</th>
+            <td>{{ object.description|markdown|placeholder }}</td>
+          </tr>
           <tr>
             <th scope="row">{% trans "Enabled" %}</th>
             <td>{% checkmark object.enabled %}</td>

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ class WebhookImportForm(NetBoxModelImportForm):`
`152`	`152`	`class Meta:`
`153`	`153`	`model = Webhook`
`154`	`154`	`fields = (`
`155`		`- 'name', 'enabled', 'content_types', 'type_create', 'type_update', 'type_delete', 'type_job_start',`
	`155`	`+ 'name', 'description', 'enabled', 'content_types', 'type_create', 'type_update', 'type_delete', 'type_job_start',`
`156`	`156`	`'type_job_end', 'payload_url', 'http_method', 'http_content_type', 'additional_headers', 'body_template',`
`157`	`157`	`'secret', 'ssl_verification', 'ca_file_path', 'tags'`
`158`	`158`	`)`
Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ class WebhookForm(NetBoxModelForm):`
`217`	`217`	`)`
`218`	`218`
`219`	`219`	`fieldsets = (`
`220`		`- (_('Webhook'), ('name', 'content_types', 'enabled', 'tags')),`
	`220`	`+ (_('Webhook'), ('name', 'description', 'content_types', 'enabled', 'tags')),`
`221`	`221`	`(_('Events'), ('type_create', 'type_update', 'type_delete', 'type_job_start', 'type_job_end')),`
`222`	`222`	`(_('HTTP Request'), (`
`223`	`223`	`'payload_url', 'http_method', 'http_content_type', 'additional_headers', 'body_template', 'secret',`
Original file line number	Diff line number	Diff line change
`@@ -250,6 +250,9 @@ class WebhookTable(NetBoxTable):`
`250`	`250`	`verbose_name=_('Name'),`
`251`	`251`	`linkify=True`
`252`	`252`	`)`
	`253`	`+ description = columns.MarkdownColumn(`
	`254`	`+ verbose_name=_('Description')`
	`255`	`+ )`
`253`	`256`	`content_types = columns.ContentTypesColumn(`
`254`	`257`	`verbose_name=_('Content Types'),`
`255`	`258`	`)`
`@@ -283,11 +286,11 @@ class Meta(NetBoxTable.Meta):`
`283`	`286`	`fields = (`
`284`	`287`	`'pk', 'id', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete',`
`285`	`288`	`'type_job_start', 'type_job_end', 'http_method', 'payload_url', 'secret', 'ssl_validation', 'ca_file_path',`
`286`		`- 'tags', 'created', 'last_updated',`
	`289`	`+ 'tags', 'created', 'last_updated', 'description'`
`287`	`290`	`)`
`288`	`291`	`default_columns = (`
`289`	`292`	`'pk', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete', 'type_job_start',`
`290`		`- 'type_job_end', 'http_method', 'payload_url',`
	`293`	`+ 'type_job_end', 'http_method', 'payload_url', 'description'`
`291`	`294`	`)`
`292`	`295`
`293`	`296`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@ class WebhookTest(APIViewTestCases.APIViewTestCase):`
`52`	`52`	`]`
`53`	`53`	`bulk_update_data = {`
`54`	`54`	`'ssl_verification': False,`
	`55`	`+ 'description': 'New description'`
`55`	`56`	`}`
`56`	`57`
`57`	`58`	`@classmethod`