{{ object }}. '
- 'Links which render as empty text will not be displayed.'),
- 'link_url': _('Jinja2 template code for the link URL. Reference the object as {{ object }}.'),
+ 'link_text': _(
+ "Jinja2 template code for the link text. Reference the object as {{ object }}. Links "
+ "which render as empty text will not be displayed."
+ ),
+ 'link_url': _("Jinja2 template code for the link URL. Reference the object as {{ object }}."),
}
@@ -150,7 +154,7 @@ class WebhookForm(BootstrapMixin, forms.ModelForm):
fieldsets = (
('Webhook', ('name', 'content_types', 'enabled')),
- ('Events', ('type_create', 'type_update', 'type_delete')),
+ ('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',
)),
@@ -165,6 +169,8 @@ class WebhookForm(BootstrapMixin, forms.ModelForm):
'type_create': 'Creations',
'type_update': 'Updates',
'type_delete': 'Deletions',
+ 'type_job_start': 'Job executions',
+ 'type_job_end': 'Job terminations',
}
widgets = {
'additional_headers': forms.Textarea(attrs={'class': 'font-monospace'}),
diff --git a/netbox/extras/management/commands/runscript.py b/netbox/extras/management/commands/runscript.py
index ae49d53be..b10a4644d 100644
--- a/netbox/extras/management/commands/runscript.py
+++ b/netbox/extras/management/commands/runscript.py
@@ -41,16 +41,16 @@ class Command(BaseCommand):
the change_logging context manager (which is bypassed if commit == False).
"""
try:
- with transaction.atomic():
- script.output = script.run(data=data, commit=commit)
- job_result.set_status(JobResultStatusChoices.STATUS_COMPLETED)
-
- if not commit:
- raise AbortTransaction()
-
- except AbortTransaction:
- script.log_info("Database changes have been reverted automatically.")
- clear_webhooks.send(request)
+ try:
+ with transaction.atomic():
+ script.output = script.run(data=data, commit=commit)
+ if not commit:
+ raise AbortTransaction()
+ except AbortTransaction:
+ script.log_info("Database changes have been reverted automatically.")
+ clear_webhooks.send(request)
+ job_result.data = ScriptOutputSerializer(script).data
+ job_result.terminate()
except Exception as e:
stacktrace = traceback.format_exc()
script.log_failure(
@@ -58,11 +58,9 @@ class Command(BaseCommand):
)
script.log_info("Database changes have been reverted due to error.")
logger.error(f"Exception raised during script execution: {e}")
- job_result.set_status(JobResultStatusChoices.STATUS_ERRORED)
clear_webhooks.send(request)
- finally:
job_result.data = ScriptOutputSerializer(script).data
- job_result.save()
+ job_result.terminate(status=JobResultStatusChoices.STATUS_ERRORED)
logger.info(f"Script completed in {job_result.duration}")
diff --git a/netbox/extras/migrations/0087_dashboard.py b/netbox/extras/migrations/0087_dashboard.py
new file mode 100644
index 000000000..e64843e0e
--- /dev/null
+++ b/netbox/extras/migrations/0087_dashboard.py
@@ -0,0 +1,25 @@
+# Generated by Django 4.1.7 on 2023-02-24 00:56
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+ ('extras', '0086_configtemplate'),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name='Dashboard',
+ fields=[
+ ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)),
+ ('layout', models.JSONField()),
+ ('config', models.JSONField()),
+ ('user', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='dashboard', to=settings.AUTH_USER_MODEL)),
+ ],
+ ),
+ ]
diff --git a/netbox/extras/migrations/0088_jobresult_webhooks.py b/netbox/extras/migrations/0088_jobresult_webhooks.py
new file mode 100644
index 000000000..112bcca8c
--- /dev/null
+++ b/netbox/extras/migrations/0088_jobresult_webhooks.py
@@ -0,0 +1,23 @@
+# Generated by Django 4.1.7 on 2023-02-28 19:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('extras', '0087_dashboard'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='webhook',
+ name='type_job_end',
+ field=models.BooleanField(default=False),
+ ),
+ migrations.AddField(
+ model_name='webhook',
+ name='type_job_start',
+ field=models.BooleanField(default=False),
+ ),
+ ]
diff --git a/netbox/extras/models/__init__.py b/netbox/extras/models/__init__.py
index 33936cc4f..14e23366f 100644
--- a/netbox/extras/models/__init__.py
+++ b/netbox/extras/models/__init__.py
@@ -1,6 +1,7 @@
from .change_logging import ObjectChange
from .configs import *
from .customfields import CustomField
+from .dashboard import *
from .models import *
from .search import *
from .staging import *
@@ -15,6 +16,7 @@ __all__ = (
'ConfigTemplate',
'CustomField',
'CustomLink',
+ 'Dashboard',
'ExportTemplate',
'ImageAttachment',
'JobResult',
diff --git a/netbox/extras/models/configs.py b/netbox/extras/models/configs.py
index f2b50f161..8c6b3273a 100644
--- a/netbox/extras/models/configs.py
+++ b/netbox/extras/models/configs.py
@@ -152,6 +152,9 @@ class ConfigContextModel(models.Model):
local_context_data = models.JSONField(
blank=True,
null=True,
+ help_text=_(
+ "Local config context data takes precedence over source contexts in the final rendered config context"
+ )
)
class Meta:
diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py
index 8141ca76d..f5ec3ce94 100644
--- a/netbox/extras/models/customfields.py
+++ b/netbox/extras/models/customfields.py
@@ -25,7 +25,7 @@ from utilities.forms.fields import (
DynamicModelMultipleChoiceField, JSONField, LaxURLField,
)
from utilities.forms.utils import add_blank_choice
-from utilities.forms.widgets import DatePicker
+from utilities.forms.widgets import DatePicker, DateTimePicker
from utilities.querysets import RestrictedQuerySet
from utilities.validators import validate_regex
@@ -306,8 +306,9 @@ class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
"""
if value is None:
return value
- if self.type == CustomFieldTypeChoices.TYPE_DATE and type(value) is date:
- return value.isoformat()
+ if self.type in (CustomFieldTypeChoices.TYPE_DATE, CustomFieldTypeChoices.TYPE_DATETIME):
+ if type(value) in (date, datetime):
+ return value.isoformat()
if self.type == CustomFieldTypeChoices.TYPE_OBJECT:
return value.pk
if self.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT:
@@ -325,6 +326,11 @@ class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
return date.fromisoformat(value)
except ValueError:
return value
+ if self.type == CustomFieldTypeChoices.TYPE_DATETIME:
+ try:
+ return datetime.fromisoformat(value)
+ except ValueError:
+ return value
if self.type == CustomFieldTypeChoices.TYPE_OBJECT:
model = self.object_type.model_class()
return model.objects.filter(pk=value).first()
@@ -380,6 +386,10 @@ class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
elif self.type == CustomFieldTypeChoices.TYPE_DATE:
field = forms.DateField(required=required, initial=initial, widget=DatePicker())
+ # Date & time
+ elif self.type == CustomFieldTypeChoices.TYPE_DATETIME:
+ field = forms.DateTimeField(required=required, initial=initial, widget=DateTimePicker())
+
# Select
elif self.type in (CustomFieldTypeChoices.TYPE_SELECT, CustomFieldTypeChoices.TYPE_MULTISELECT):
choices = [(c, c) for c in self.choices]
@@ -490,6 +500,10 @@ class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
elif self.type == CustomFieldTypeChoices.TYPE_DATE:
filter_class = filters.MultiValueDateFilter
+ # Date & time
+ elif self.type == CustomFieldTypeChoices.TYPE_DATETIME:
+ filter_class = filters.MultiValueDateTimeFilter
+
# Select
elif self.type == CustomFieldTypeChoices.TYPE_SELECT:
filter_class = filters.MultiValueCharFilter
@@ -558,9 +572,17 @@ class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
elif self.type == CustomFieldTypeChoices.TYPE_DATE:
if type(value) is not date:
try:
- datetime.strptime(value, '%Y-%m-%d')
+ date.fromisoformat(value)
except ValueError:
- raise ValidationError("Date values must be in the format YYYY-MM-DD.")
+ raise ValidationError("Date values must be in ISO 8601 format (YYYY-MM-DD).")
+
+ # Validate date & time
+ elif self.type == CustomFieldTypeChoices.TYPE_DATETIME:
+ if type(value) is not datetime:
+ try:
+ datetime.fromisoformat(value)
+ except ValueError:
+ raise ValidationError("Date and time values must be in ISO 8601 format (YYYY-MM-DD HH:MM:SS).")
# Validate selected choice
elif self.type == CustomFieldTypeChoices.TYPE_SELECT:
diff --git a/netbox/extras/models/dashboard.py b/netbox/extras/models/dashboard.py
new file mode 100644
index 000000000..cdbf85b60
--- /dev/null
+++ b/netbox/extras/models/dashboard.py
@@ -0,0 +1,70 @@
+from django.contrib.auth import get_user_model
+from django.db import models
+
+from extras.dashboard.utils import get_widget_class
+
+__all__ = (
+ 'Dashboard',
+)
+
+
+class Dashboard(models.Model):
+ user = models.OneToOneField(
+ to=get_user_model(),
+ on_delete=models.CASCADE,
+ related_name='dashboard'
+ )
+ layout = models.JSONField()
+ config = models.JSONField()
+
+ class Meta:
+ pass
+
+ def get_widget(self, id):
+ """
+ Instantiate and return a widget by its ID
+ """
+ id = str(id)
+ config = dict(self.config[id]) # Copy to avoid mutating instance data
+ widget_class = get_widget_class(config.pop('class'))
+ return widget_class(id=id, **config)
+
+ def get_layout(self):
+ """
+ Return the dashboard's configured layout, suitable for rendering with gridstack.js.
+ """
+ widgets = []
+ for grid_item in self.layout:
+ widget = self.get_widget(grid_item['id'])
+ widget.set_layout(grid_item)
+ widgets.append(widget)
+ return widgets
+
+ def add_widget(self, widget, x=None, y=None):
+ """
+ Add a widget to the dashboard, optionally specifying its X & Y coordinates.
+ """
+ id = str(widget.id)
+ self.config[id] = {
+ 'class': widget.name,
+ 'title': widget.title,
+ 'color': widget.color,
+ 'config': widget.config,
+ }
+ self.layout.append({
+ 'id': id,
+ 'h': widget.height,
+ 'w': widget.width,
+ 'x': x,
+ 'y': y,
+ })
+
+ def delete_widget(self, id):
+ """
+ Delete a widget from the dashboard.
+ """
+ id = str(id)
+ del self.config[id]
+ self.layout = [
+ item for item in self.layout if item['id'] != id
+ ]
diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py
index 1360904dc..d1ca74822 100644
--- a/netbox/extras/models/models.py
+++ b/netbox/extras/models/models.py
@@ -5,7 +5,6 @@ from django.conf import settings
from django.contrib import admin
from django.contrib.auth.models import User
from django.contrib.contenttypes.fields import GenericForeignKey
-from django.contrib.contenttypes.models import ContentType
from django.core.cache import cache
from django.core.validators import MinValueValidator, ValidationError
from django.db import models
@@ -27,7 +26,7 @@ from netbox.constants import RQ_QUEUE_DEFAULT
from netbox.models import ChangeLoggedModel
from netbox.models.features import (
CloningMixin, CustomFieldsMixin, CustomLinksMixin, ExportTemplatesMixin, JobResultsMixin, SyncedDataMixin,
- TagsMixin,
+ TagsMixin, WebhooksMixin,
)
from utilities.querysets import RestrictedQuerySet
from utilities.utils import render_jinja2
@@ -65,15 +64,23 @@ class Webhook(ExportTemplatesMixin, ChangeLoggedModel):
)
type_create = models.BooleanField(
default=False,
- help_text=_("Call this webhook when a matching object is created.")
+ help_text=_("Triggers when a matching object is created.")
)
type_update = models.BooleanField(
default=False,
- help_text=_("Call this webhook when a matching object is updated.")
+ help_text=_("Triggers when a matching object is updated.")
)
type_delete = models.BooleanField(
default=False,
- help_text=_("Call this webhook when a matching object is deleted.")
+ help_text=_("Triggers when a matching object is deleted.")
+ )
+ type_job_start = models.BooleanField(
+ default=False,
+ help_text=_("Triggers when a job for a matching object is started.")
+ )
+ type_job_end = models.BooleanField(
+ default=False,
+ help_text=_("Triggers when a job for a matching object terminates.")
)
payload_url = models.CharField(
max_length=500,
@@ -159,8 +166,12 @@ class Webhook(ExportTemplatesMixin, ChangeLoggedModel):
super().clean()
# At least one action type must be selected
- if not self.type_create and not self.type_delete and not self.type_update:
- raise ValidationError("At least one type must be selected: create, update, and/or delete.")
+ if not any([
+ self.type_create, self.type_update, self.type_delete, self.type_job_start, self.type_job_end
+ ]):
+ raise ValidationError(
+ "At least one event type must be selected: create, update, delete, job_start, and/or job_end."
+ )
if self.conditions:
try:
@@ -678,19 +689,32 @@ class JobResult(models.Model):
"""
Record the job's start time and update its status to "running."
"""
- if self.started is None:
- self.started = timezone.now()
- self.status = JobResultStatusChoices.STATUS_RUNNING
- JobResult.objects.filter(pk=self.pk).update(started=self.started, status=self.status)
+ if self.started is not None:
+ return
- def set_status(self, status):
+ # Start the job
+ self.started = timezone.now()
+ self.status = JobResultStatusChoices.STATUS_RUNNING
+ JobResult.objects.filter(pk=self.pk).update(started=self.started, status=self.status)
+
+ # Handle webhooks
+ self.trigger_webhooks(event='job_start')
+
+ def terminate(self, status=JobResultStatusChoices.STATUS_COMPLETED):
"""
- Helper method to change the status of the job result. If the target status is terminal, the completion
- time is also set.
+ Mark the job as completed, optionally specifying a particular termination status.
"""
+ valid_statuses = JobResultStatusChoices.TERMINAL_STATE_CHOICES
+ if status not in valid_statuses:
+ raise ValueError(f"Invalid status for job termination. Choices are: {', '.join(valid_statuses)}")
+
+ # Mark the job as completed
self.status = status
- if status in JobResultStatusChoices.TERMINAL_STATE_CHOICES:
- self.completed = timezone.now()
+ self.completed = timezone.now()
+ JobResult.objects.filter(pk=self.pk).update(status=self.status, completed=self.completed)
+
+ # Handle webhooks
+ self.trigger_webhooks(event='job_end')
@classmethod
def enqueue_job(cls, func, name, obj_type, user, schedule_at=None, interval=None, *args, **kwargs):
@@ -725,6 +749,28 @@ class JobResult(models.Model):
return job_result
+ def trigger_webhooks(self, event):
+ rq_queue_name = get_config().QUEUE_MAPPINGS.get('webhook', RQ_QUEUE_DEFAULT)
+ rq_queue = django_rq.get_queue(rq_queue_name, is_async=False)
+
+ # Fetch any webhooks matching this object type and action
+ webhooks = Webhook.objects.filter(
+ **{f'type_{event}': True},
+ content_types=self.obj_type,
+ enabled=True
+ )
+
+ for webhook in webhooks:
+ rq_queue.enqueue(
+ "extras.webhooks_worker.process_webhook",
+ webhook=webhook,
+ model_name=self.obj_type.model,
+ event=event,
+ data=self.data,
+ timestamp=str(timezone.now()),
+ username=self.user.username
+ )
+
class ConfigRevision(models.Model):
"""
@@ -767,7 +813,7 @@ class ConfigRevision(models.Model):
# Custom scripts & reports
#
-class Script(JobResultsMixin, models.Model):
+class Script(JobResultsMixin, WebhooksMixin, models.Model):
"""
Dummy model used to generate permissions for custom scripts. Does not exist in the database.
"""
@@ -779,7 +825,7 @@ class Script(JobResultsMixin, models.Model):
# Reports
#
-class Report(JobResultsMixin, models.Model):
+class Report(JobResultsMixin, WebhooksMixin, models.Model):
"""
Dummy model used to generate permissions for reports. Does not exist in the database.
"""
diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py
index 37c78dd18..0a944a0d2 100644
--- a/netbox/extras/reports.py
+++ b/netbox/extras/reports.py
@@ -85,8 +85,7 @@ def run_report(job_result, *args, **kwargs):
job_result.start()
report.run(job_result)
except Exception:
- job_result.set_status(JobResultStatusChoices.STATUS_ERRORED)
- job_result.save()
+ job_result.terminate(status=JobResultStatusChoices.STATUS_ERRORED)
logging.error(f"Error during execution of report {job_result.name}")
finally:
# Schedule the next job if an interval has been set
@@ -241,28 +240,23 @@ class Report(object):
self.pre_run()
try:
-
for method_name in self.test_methods:
self.active_test = method_name
test_method = getattr(self, method_name)
test_method()
-
if self.failed:
self.logger.warning("Report failed")
job_result.status = JobResultStatusChoices.STATUS_FAILED
else:
self.logger.info("Report completed successfully")
job_result.status = JobResultStatusChoices.STATUS_COMPLETED
-
except Exception as e:
stacktrace = traceback.format_exc()
self.log_failure(None, f"An exception occurred: {type(e).__name__}: {e} {stacktrace}")
logger.error(f"Exception raised during report execution: {e}")
- job_result.set_status(JobResultStatusChoices.STATUS_ERRORED)
-
- job_result.data = self._results
- job_result.completed = timezone.now()
- job_result.save()
+ job_result.terminate(status=JobResultStatusChoices.STATUS_ERRORED)
+ finally:
+ job_result.terminate()
# Perform any post-run tasks
self.post_run()
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 313058d57..9b9167e17 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -460,36 +460,28 @@ def run_script(data, request, commit=True, *args, **kwargs):
the change_logging context manager (which is bypassed if commit == False).
"""
try:
- with transaction.atomic():
- script.output = script.run(data=data, commit=commit)
- job_result.set_status(JobResultStatusChoices.STATUS_COMPLETED)
-
- if not commit:
- raise AbortTransaction()
-
- except AbortTransaction:
- script.log_info("Database changes have been reverted automatically.")
- clear_webhooks.send(request)
- except AbortScript as e:
- script.log_failure(
- f"Script aborted with error: {e}"
- )
- script.log_info("Database changes have been reverted due to error.")
- logger.error(f"Script aborted with error: {e}")
- job_result.set_status(JobResultStatusChoices.STATUS_ERRORED)
- clear_webhooks.send(request)
- except Exception as e:
- stacktrace = traceback.format_exc()
- script.log_failure(
- f"An exception occurred: `{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"
- )
- script.log_info("Database changes have been reverted due to error.")
- logger.error(f"Exception raised during script execution: {e}")
- job_result.set_status(JobResultStatusChoices.STATUS_ERRORED)
- clear_webhooks.send(request)
- finally:
+ try:
+ with transaction.atomic():
+ script.output = script.run(data=data, commit=commit)
+ if not commit:
+ raise AbortTransaction()
+ except AbortTransaction:
+ script.log_info("Database changes have been reverted automatically.")
+ clear_webhooks.send(request)
job_result.data = ScriptOutputSerializer(script).data
- job_result.save()
+ job_result.terminate()
+ except Exception as e:
+ if type(e) is AbortScript:
+ script.log_failure(f"Script aborted with error: {e}")
+ logger.error(f"Script aborted with error: {e}")
+ else:
+ stacktrace = traceback.format_exc()
+ script.log_failure(f"An exception occurred: `{type(e).__name__}: {e}`\n```\n{stacktrace}\n```")
+ logger.error(f"Exception raised during script execution: {e}")
+ script.log_info("Database changes have been reverted due to error.")
+ job_result.data = ScriptOutputSerializer(script).data
+ job_result.terminate(status=JobResultStatusChoices.STATUS_ERRORED)
+ clear_webhooks.send(request)
logger.info(f"Script completed in {job_result.duration}")
diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py
index 5991203f2..31b6f02c3 100644
--- a/netbox/extras/tables/tables.py
+++ b/netbox/extras/tables/tables.py
@@ -146,6 +146,12 @@ class WebhookTable(NetBoxTable):
type_delete = columns.BooleanColumn(
verbose_name='Delete'
)
+ type_job_start = columns.BooleanColumn(
+ verbose_name='Job start'
+ )
+ type_job_end = columns.BooleanColumn(
+ verbose_name='Job end'
+ )
ssl_validation = columns.BooleanColumn(
verbose_name='SSL Validation'
)
@@ -153,12 +159,13 @@ class WebhookTable(NetBoxTable):
class Meta(NetBoxTable.Meta):
model = Webhook
fields = (
- 'pk', 'id', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete', 'http_method',
- 'payload_url', 'secret', 'ssl_validation', 'ca_file_path', 'created', 'last_updated',
+ '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',
+ 'created', 'last_updated',
)
default_columns = (
- 'pk', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete', 'http_method',
- 'payload_url',
+ 'pk', 'name', 'content_types', 'enabled', 'type_create', 'type_update', 'type_delete', 'type_job_start',
+ 'type_job_end', 'http_method', 'payload_url',
)
diff --git a/netbox/extras/templatetags/dashboard.py b/netbox/extras/templatetags/dashboard.py
new file mode 100644
index 000000000..4ac31abcf
--- /dev/null
+++ b/netbox/extras/templatetags/dashboard.py
@@ -0,0 +1,11 @@
+from django import template
+
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+def render_widget(context, widget):
+ request = context['request']
+
+ return widget.render(request)
diff --git a/netbox/extras/tests/test_customfields.py b/netbox/extras/tests/test_customfields.py
index d890e3ebe..f29a11e0e 100644
--- a/netbox/extras/tests/test_customfields.py
+++ b/netbox/extras/tests/test_customfields.py
@@ -1,3 +1,4 @@
+import datetime
from decimal import Decimal
from django.contrib.contenttypes.models import ContentType
@@ -157,12 +158,12 @@ class CustomFieldTest(TestCase):
self.assertIsNone(instance.custom_field_data.get(cf.name))
def test_date_field(self):
- value = '2016-06-23'
+ value = datetime.date(2016, 6, 23)
# Create a custom field & check that initial value is null
cf = CustomField.objects.create(
name='date_field',
- type=CustomFieldTypeChoices.TYPE_TEXT,
+ type=CustomFieldTypeChoices.TYPE_DATE,
required=False
)
cf.content_types.set([self.object_type])
@@ -170,10 +171,35 @@ class CustomFieldTest(TestCase):
self.assertIsNone(instance.custom_field_data[cf.name])
# Assign a value and check that it is saved
- instance.custom_field_data[cf.name] = value
+ instance.custom_field_data[cf.name] = cf.serialize(value)
instance.save()
instance.refresh_from_db()
- self.assertEqual(instance.custom_field_data[cf.name], value)
+ self.assertEqual(instance.cf[cf.name], value)
+
+ # Delete the stored value and check that it is now null
+ instance.custom_field_data.pop(cf.name)
+ instance.save()
+ instance.refresh_from_db()
+ self.assertIsNone(instance.custom_field_data.get(cf.name))
+
+ def test_datetime_field(self):
+ value = datetime.datetime(2016, 6, 23, 9, 45, 0)
+
+ # Create a custom field & check that initial value is null
+ cf = CustomField.objects.create(
+ name='date_field',
+ type=CustomFieldTypeChoices.TYPE_DATETIME,
+ required=False
+ )
+ cf.content_types.set([self.object_type])
+ instance = Site.objects.first()
+ self.assertIsNone(instance.custom_field_data[cf.name])
+
+ # Assign a value and check that it is saved
+ instance.custom_field_data[cf.name] = cf.serialize(value)
+ instance.save()
+ instance.refresh_from_db()
+ self.assertEqual(instance.cf[cf.name], value)
# Delete the stored value and check that it is now null
instance.custom_field_data.pop(cf.name)
@@ -408,6 +434,7 @@ class CustomFieldAPITest(APITestCase):
CustomField(type=CustomFieldTypeChoices.TYPE_DECIMAL, name='decimal_field', default=123.45),
CustomField(type=CustomFieldTypeChoices.TYPE_BOOLEAN, name='boolean_field', default=False),
CustomField(type=CustomFieldTypeChoices.TYPE_DATE, name='date_field', default='2020-01-01'),
+ CustomField(type=CustomFieldTypeChoices.TYPE_DATETIME, name='datetime_field', default='2020-01-01T01:23:45'),
CustomField(type=CustomFieldTypeChoices.TYPE_URL, name='url_field', default='http://example.com/1'),
CustomField(type=CustomFieldTypeChoices.TYPE_JSON, name='json_field', default='{"x": "y"}'),
CustomField(
@@ -459,12 +486,13 @@ class CustomFieldAPITest(APITestCase):
custom_fields[3].name: Decimal('456.78'),
custom_fields[4].name: True,
custom_fields[5].name: '2020-01-02',
- custom_fields[6].name: 'http://example.com/2',
- custom_fields[7].name: '{"foo": 1, "bar": 2}',
- custom_fields[8].name: 'Bar',
- custom_fields[9].name: ['Bar', 'Baz'],
- custom_fields[10].name: vlans[1].pk,
- custom_fields[11].name: [vlans[2].pk, vlans[3].pk],
+ custom_fields[6].name: '2020-01-02 12:00:00',
+ custom_fields[7].name: 'http://example.com/2',
+ custom_fields[8].name: '{"foo": 1, "bar": 2}',
+ custom_fields[9].name: 'Bar',
+ custom_fields[10].name: ['Bar', 'Baz'],
+ custom_fields[11].name: vlans[1].pk,
+ custom_fields[12].name: [vlans[2].pk, vlans[3].pk],
}
sites[1].save()
@@ -476,6 +504,7 @@ class CustomFieldAPITest(APITestCase):
CustomFieldTypeChoices.TYPE_DECIMAL: 'decimal',
CustomFieldTypeChoices.TYPE_BOOLEAN: 'boolean',
CustomFieldTypeChoices.TYPE_DATE: 'string',
+ CustomFieldTypeChoices.TYPE_DATETIME: 'string',
CustomFieldTypeChoices.TYPE_URL: 'string',
CustomFieldTypeChoices.TYPE_JSON: 'object',
CustomFieldTypeChoices.TYPE_SELECT: 'string',
@@ -511,6 +540,7 @@ class CustomFieldAPITest(APITestCase):
'decimal_field': None,
'boolean_field': None,
'date_field': None,
+ 'datetime_field': None,
'url_field': None,
'json_field': None,
'select_field': None,
@@ -536,6 +566,7 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(response.data['custom_fields']['decimal_field'], site2_cfvs['decimal_field'])
self.assertEqual(response.data['custom_fields']['boolean_field'], site2_cfvs['boolean_field'])
self.assertEqual(response.data['custom_fields']['date_field'], site2_cfvs['date_field'])
+ self.assertEqual(response.data['custom_fields']['datetime_field'], site2_cfvs['datetime_field'])
self.assertEqual(response.data['custom_fields']['url_field'], site2_cfvs['url_field'])
self.assertEqual(response.data['custom_fields']['json_field'], site2_cfvs['json_field'])
self.assertEqual(response.data['custom_fields']['select_field'], site2_cfvs['select_field'])
@@ -571,6 +602,7 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(response_cf['decimal_field'], cf_defaults['decimal_field'])
self.assertEqual(response_cf['boolean_field'], cf_defaults['boolean_field'])
self.assertEqual(response_cf['date_field'].isoformat(), cf_defaults['date_field'])
+ self.assertEqual(response_cf['datetime_field'].isoformat(), cf_defaults['datetime_field'])
self.assertEqual(response_cf['url_field'], cf_defaults['url_field'])
self.assertEqual(response_cf['json_field'], cf_defaults['json_field'])
self.assertEqual(response_cf['select_field'], cf_defaults['select_field'])
@@ -588,7 +620,8 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(site.custom_field_data['integer_field'], cf_defaults['integer_field'])
self.assertEqual(site.custom_field_data['decimal_field'], cf_defaults['decimal_field'])
self.assertEqual(site.custom_field_data['boolean_field'], cf_defaults['boolean_field'])
- self.assertEqual(str(site.custom_field_data['date_field']), cf_defaults['date_field'])
+ self.assertEqual(site.custom_field_data['date_field'], cf_defaults['date_field'])
+ self.assertEqual(site.custom_field_data['datetime_field'], cf_defaults['datetime_field'])
self.assertEqual(site.custom_field_data['url_field'], cf_defaults['url_field'])
self.assertEqual(site.custom_field_data['json_field'], cf_defaults['json_field'])
self.assertEqual(site.custom_field_data['select_field'], cf_defaults['select_field'])
@@ -609,7 +642,8 @@ class CustomFieldAPITest(APITestCase):
'integer_field': 456,
'decimal_field': 456.78,
'boolean_field': True,
- 'date_field': '2020-01-02',
+ 'date_field': datetime.date(2020, 1, 2),
+ 'datetime_field': datetime.datetime(2020, 1, 2, 12, 0, 0),
'url_field': 'http://example.com/2',
'json_field': '{"foo": 1, "bar": 2}',
'select_field': 'Bar',
@@ -632,7 +666,8 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(response_cf['integer_field'], data_cf['integer_field'])
self.assertEqual(response_cf['decimal_field'], data_cf['decimal_field'])
self.assertEqual(response_cf['boolean_field'], data_cf['boolean_field'])
- self.assertEqual(response_cf['date_field'].isoformat(), data_cf['date_field'])
+ self.assertEqual(response_cf['date_field'], data_cf['date_field'])
+ self.assertEqual(response_cf['datetime_field'], data_cf['datetime_field'])
self.assertEqual(response_cf['url_field'], data_cf['url_field'])
self.assertEqual(response_cf['json_field'], data_cf['json_field'])
self.assertEqual(response_cf['select_field'], data_cf['select_field'])
@@ -650,7 +685,8 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(site.custom_field_data['integer_field'], data_cf['integer_field'])
self.assertEqual(site.custom_field_data['decimal_field'], data_cf['decimal_field'])
self.assertEqual(site.custom_field_data['boolean_field'], data_cf['boolean_field'])
- self.assertEqual(str(site.custom_field_data['date_field']), data_cf['date_field'])
+ self.assertEqual(site.cf['date_field'], data_cf['date_field'])
+ self.assertEqual(site.cf['datetime_field'], data_cf['datetime_field'])
self.assertEqual(site.custom_field_data['url_field'], data_cf['url_field'])
self.assertEqual(site.custom_field_data['json_field'], data_cf['json_field'])
self.assertEqual(site.custom_field_data['select_field'], data_cf['select_field'])
@@ -697,6 +733,7 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(response_cf['decimal_field'], cf_defaults['decimal_field'])
self.assertEqual(response_cf['boolean_field'], cf_defaults['boolean_field'])
self.assertEqual(response_cf['date_field'].isoformat(), cf_defaults['date_field'])
+ self.assertEqual(response_cf['datetime_field'].isoformat(), cf_defaults['datetime_field'])
self.assertEqual(response_cf['url_field'], cf_defaults['url_field'])
self.assertEqual(response_cf['json_field'], cf_defaults['json_field'])
self.assertEqual(response_cf['select_field'], cf_defaults['select_field'])
@@ -714,7 +751,8 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(site.custom_field_data['integer_field'], cf_defaults['integer_field'])
self.assertEqual(site.custom_field_data['decimal_field'], cf_defaults['decimal_field'])
self.assertEqual(site.custom_field_data['boolean_field'], cf_defaults['boolean_field'])
- self.assertEqual(str(site.custom_field_data['date_field']), cf_defaults['date_field'])
+ self.assertEqual(site.custom_field_data['date_field'], cf_defaults['date_field'])
+ self.assertEqual(site.custom_field_data['datetime_field'], cf_defaults['datetime_field'])
self.assertEqual(site.custom_field_data['url_field'], cf_defaults['url_field'])
self.assertEqual(site.custom_field_data['json_field'], cf_defaults['json_field'])
self.assertEqual(site.custom_field_data['select_field'], cf_defaults['select_field'])
@@ -732,7 +770,8 @@ class CustomFieldAPITest(APITestCase):
'integer_field': 456,
'decimal_field': 456.78,
'boolean_field': True,
- 'date_field': '2020-01-02',
+ 'date_field': datetime.date(2020, 1, 2),
+ 'datetime_field': datetime.datetime(2020, 1, 2, 12, 0, 0),
'url_field': 'http://example.com/2',
'json_field': '{"foo": 1, "bar": 2}',
'select_field': 'Bar',
@@ -773,7 +812,8 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(response_cf['integer_field'], custom_field_data['integer_field'])
self.assertEqual(response_cf['decimal_field'], custom_field_data['decimal_field'])
self.assertEqual(response_cf['boolean_field'], custom_field_data['boolean_field'])
- self.assertEqual(response_cf['date_field'].isoformat(), custom_field_data['date_field'])
+ self.assertEqual(response_cf['date_field'], custom_field_data['date_field'])
+ self.assertEqual(response_cf['datetime_field'], custom_field_data['datetime_field'])
self.assertEqual(response_cf['url_field'], custom_field_data['url_field'])
self.assertEqual(response_cf['json_field'], custom_field_data['json_field'])
self.assertEqual(response_cf['select_field'], custom_field_data['select_field'])
@@ -791,7 +831,8 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(site.custom_field_data['integer_field'], custom_field_data['integer_field'])
self.assertEqual(site.custom_field_data['decimal_field'], custom_field_data['decimal_field'])
self.assertEqual(site.custom_field_data['boolean_field'], custom_field_data['boolean_field'])
- self.assertEqual(str(site.custom_field_data['date_field']), custom_field_data['date_field'])
+ self.assertEqual(site.cf['date_field'], custom_field_data['date_field'])
+ self.assertEqual(site.cf['datetime_field'], custom_field_data['datetime_field'])
self.assertEqual(site.custom_field_data['url_field'], custom_field_data['url_field'])
self.assertEqual(site.custom_field_data['json_field'], custom_field_data['json_field'])
self.assertEqual(site.custom_field_data['select_field'], custom_field_data['select_field'])
@@ -826,6 +867,7 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(response_cf['decimal_field'], original_cfvs['decimal_field'])
self.assertEqual(response_cf['boolean_field'], original_cfvs['boolean_field'])
self.assertEqual(response_cf['date_field'], original_cfvs['date_field'])
+ self.assertEqual(response_cf['datetime_field'], original_cfvs['datetime_field'])
self.assertEqual(response_cf['url_field'], original_cfvs['url_field'])
self.assertEqual(response_cf['json_field'], original_cfvs['json_field'])
self.assertEqual(response_cf['select_field'], original_cfvs['select_field'])
@@ -844,6 +886,7 @@ class CustomFieldAPITest(APITestCase):
self.assertEqual(site2.cf['decimal_field'], original_cfvs['decimal_field'])
self.assertEqual(site2.cf['boolean_field'], original_cfvs['boolean_field'])
self.assertEqual(site2.cf['date_field'], original_cfvs['date_field'])
+ self.assertEqual(site2.cf['datetime_field'], original_cfvs['datetime_field'])
self.assertEqual(site2.cf['url_field'], original_cfvs['url_field'])
self.assertEqual(site2.cf['json_field'], original_cfvs['json_field'])
self.assertEqual(site2.cf['select_field'], original_cfvs['select_field'])
@@ -977,6 +1020,7 @@ class CustomFieldImportTest(TestCase):
CustomField(name='decimal', type=CustomFieldTypeChoices.TYPE_DECIMAL),
CustomField(name='boolean', type=CustomFieldTypeChoices.TYPE_BOOLEAN),
CustomField(name='date', type=CustomFieldTypeChoices.TYPE_DATE),
+ CustomField(name='datetime', type=CustomFieldTypeChoices.TYPE_DATETIME),
CustomField(name='url', type=CustomFieldTypeChoices.TYPE_URL),
CustomField(name='json', type=CustomFieldTypeChoices.TYPE_JSON),
CustomField(name='select', type=CustomFieldTypeChoices.TYPE_SELECT, choices=[
@@ -995,10 +1039,10 @@ class CustomFieldImportTest(TestCase):
Import a Site in CSV format, including a value for each CustomField.
"""
data = (
- ('name', 'slug', 'status', 'cf_text', 'cf_longtext', 'cf_integer', 'cf_decimal', 'cf_boolean', 'cf_date', 'cf_url', 'cf_json', 'cf_select', 'cf_multiselect'),
- ('Site 1', 'site-1', 'active', 'ABC', 'Foo', '123', '123.45', 'True', '2020-01-01', 'http://example.com/1', '{"foo": 123}', 'Choice A', '"Choice A,Choice B"'),
- ('Site 2', 'site-2', 'active', 'DEF', 'Bar', '456', '456.78', 'False', '2020-01-02', 'http://example.com/2', '{"bar": 456}', 'Choice B', '"Choice B,Choice C"'),
- ('Site 3', 'site-3', 'active', '', '', '', '', '', '', '', '', '', ''),
+ ('name', 'slug', 'status', 'cf_text', 'cf_longtext', 'cf_integer', 'cf_decimal', 'cf_boolean', 'cf_date', 'cf_datetime', 'cf_url', 'cf_json', 'cf_select', 'cf_multiselect'),
+ ('Site 1', 'site-1', 'active', 'ABC', 'Foo', '123', '123.45', 'True', '2020-01-01', '2020-01-01 12:00:00', 'http://example.com/1', '{"foo": 123}', 'Choice A', '"Choice A,Choice B"'),
+ ('Site 2', 'site-2', 'active', 'DEF', 'Bar', '456', '456.78', 'False', '2020-01-02', '2020-01-02 12:00:00', 'http://example.com/2', '{"bar": 456}', 'Choice B', '"Choice B,Choice C"'),
+ ('Site 3', 'site-3', 'active', '', '', '', '', '', '', '', '', '', '', ''),
)
csv_data = '\n'.join(','.join(row) for row in data)
@@ -1008,13 +1052,14 @@ class CustomFieldImportTest(TestCase):
# Validate data for site 1
site1 = Site.objects.get(name='Site 1')
- self.assertEqual(len(site1.custom_field_data), 10)
+ self.assertEqual(len(site1.custom_field_data), 11)
self.assertEqual(site1.custom_field_data['text'], 'ABC')
self.assertEqual(site1.custom_field_data['longtext'], 'Foo')
self.assertEqual(site1.custom_field_data['integer'], 123)
self.assertEqual(site1.custom_field_data['decimal'], 123.45)
self.assertEqual(site1.custom_field_data['boolean'], True)
- self.assertEqual(site1.custom_field_data['date'], '2020-01-01')
+ self.assertEqual(site1.cf['date'].isoformat(), '2020-01-01')
+ self.assertEqual(site1.cf['datetime'].isoformat(), '2020-01-01T12:00:00+00:00')
self.assertEqual(site1.custom_field_data['url'], 'http://example.com/1')
self.assertEqual(site1.custom_field_data['json'], {"foo": 123})
self.assertEqual(site1.custom_field_data['select'], 'Choice A')
@@ -1022,13 +1067,14 @@ class CustomFieldImportTest(TestCase):
# Validate data for site 2
site2 = Site.objects.get(name='Site 2')
- self.assertEqual(len(site2.custom_field_data), 10)
+ self.assertEqual(len(site2.custom_field_data), 11)
self.assertEqual(site2.custom_field_data['text'], 'DEF')
self.assertEqual(site2.custom_field_data['longtext'], 'Bar')
self.assertEqual(site2.custom_field_data['integer'], 456)
self.assertEqual(site2.custom_field_data['decimal'], 456.78)
self.assertEqual(site2.custom_field_data['boolean'], False)
- self.assertEqual(site2.custom_field_data['date'], '2020-01-02')
+ self.assertEqual(site2.cf['date'].isoformat(), '2020-01-02')
+ self.assertEqual(site2.cf['datetime'].isoformat(), '2020-01-02T12:00:00+00:00')
self.assertEqual(site2.custom_field_data['url'], 'http://example.com/2')
self.assertEqual(site2.custom_field_data['json'], {"bar": 456})
self.assertEqual(site2.custom_field_data['select'], 'Choice B')
diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py
index 3c8899b5e..0c161cfae 100644
--- a/netbox/extras/tests/test_filtersets.py
+++ b/netbox/extras/tests/test_filtersets.py
@@ -89,12 +89,16 @@ class WebhookTestCase(TestCase, BaseFilterSetTests):
@classmethod
def setUpTestData(cls):
- content_types = ContentType.objects.filter(model__in=['site', 'rack', 'device'])
+ content_types = ContentType.objects.filter(model__in=['region', 'site', 'rack', 'location', 'device'])
webhooks = (
Webhook(
name='Webhook 1',
type_create=True,
+ type_update=False,
+ type_delete=False,
+ type_job_start=False,
+ type_job_end=False,
payload_url='http://example.com/?1',
enabled=True,
http_method='GET',
@@ -102,7 +106,11 @@ class WebhookTestCase(TestCase, BaseFilterSetTests):
),
Webhook(
name='Webhook 2',
+ type_create=False,
type_update=True,
+ type_delete=False,
+ type_job_start=False,
+ type_job_end=False,
payload_url='http://example.com/?2',
enabled=True,
http_method='POST',
@@ -110,26 +118,56 @@ class WebhookTestCase(TestCase, BaseFilterSetTests):
),
Webhook(
name='Webhook 3',
+ type_create=False,
+ type_update=False,
type_delete=True,
+ type_job_start=False,
+ type_job_end=False,
payload_url='http://example.com/?3',
enabled=False,
http_method='PATCH',
ssl_verification=False,
),
+ Webhook(
+ name='Webhook 4',
+ type_create=False,
+ type_update=False,
+ type_delete=False,
+ type_job_start=True,
+ type_job_end=False,
+ payload_url='http://example.com/?4',
+ enabled=False,
+ http_method='PATCH',
+ ssl_verification=False,
+ ),
+ Webhook(
+ name='Webhook 5',
+ type_create=False,
+ type_update=False,
+ type_delete=False,
+ type_job_start=False,
+ type_job_end=True,
+ payload_url='http://example.com/?5',
+ enabled=False,
+ http_method='PATCH',
+ ssl_verification=False,
+ ),
)
Webhook.objects.bulk_create(webhooks)
webhooks[0].content_types.add(content_types[0])
webhooks[1].content_types.add(content_types[1])
webhooks[2].content_types.add(content_types[2])
+ webhooks[3].content_types.add(content_types[3])
+ webhooks[4].content_types.add(content_types[4])
def test_name(self):
params = {'name': ['Webhook 1', 'Webhook 2']}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
def test_content_types(self):
- params = {'content_types': 'dcim.site'}
+ params = {'content_types': 'dcim.region'}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
- params = {'content_type_id': [ContentType.objects.get_for_model(Site).pk]}
+ params = {'content_type_id': [ContentType.objects.get_for_model(Region).pk]}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
def test_type_create(self):
@@ -144,6 +182,14 @@ class WebhookTestCase(TestCase, BaseFilterSetTests):
params = {'type_delete': True}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+ def test_type_job_start(self):
+ params = {'type_job_start': True}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
+ def test_type_job_end(self):
+ params = {'type_job_end': True}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
def test_enabled(self):
params = {'enabled': True}
self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/netbox/extras/tests/test_forms.py b/netbox/extras/tests/test_forms.py
index 35402bda3..722f32f0a 100644
--- a/netbox/extras/tests/test_forms.py
+++ b/netbox/extras/tests/test_forms.py
@@ -32,6 +32,9 @@ class CustomFieldModelFormTest(TestCase):
cf_date = CustomField.objects.create(name='date', type=CustomFieldTypeChoices.TYPE_DATE)
cf_date.content_types.set([obj_type])
+ cf_datetime = CustomField.objects.create(name='datetime', type=CustomFieldTypeChoices.TYPE_DATETIME)
+ cf_datetime.content_types.set([obj_type])
+
cf_url = CustomField.objects.create(name='url', type=CustomFieldTypeChoices.TYPE_URL)
cf_url.content_types.set([obj_type])
diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py
index dfbaa1bc6..e127e164a 100644
--- a/netbox/extras/urls.py
+++ b/netbox/extras/urls.py
@@ -87,6 +87,11 @@ urlpatterns = [
path('changelog/', views.ObjectChangeListView.as_view(), name='objectchange_list'),
path('changelog/| Interface | -Configured Device | -Configured Interface | -LLDP Device | -LLDP Interface | -||||
|---|---|---|---|---|---|---|---|---|
| {{ iface }} | - {% with peer=iface.connected_endpoints.0 %} - {% if peer.device %} -- {{ peer.device }} - | -- {{ peer }} - | - {% elif peer.circuit %} - {% with circuit=peer.circuit %} -- - {{ circuit.provider }} {{ circuit }} - | - {% endwith %} - {% else %} -None | - {% endif %} - {% endwith %} -- | - | ||
| Hostname | -- |
|---|---|
| FQDN | -- |
| Vendor | -- |
| Model | -- |
| Serial Number | -- |
| OS Version | -- |
| Uptime | -- - - | -
| CPU | -|
|---|---|
| Memory | -|
| Temperature | -|
| Fans | -|
| Power | -|
{{ object.napalm_args|json }}
-