From d3e2a6c82c000a120ba1fa6d62156297df436b0e Mon Sep 17 00:00:00 2001 From: Luke Anderson Date: Mon, 15 Feb 2021 21:01:55 +1030 Subject: [PATCH 01/90] Fix #5819 and #5872 - Fix Primary IP Sorting Issues for Devices and VMs --- netbox/dcim/tables/devices.py | 18 +++++++++++++----- netbox/virtualization/tables.py | 18 +++++++++++++----- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index edd9e7a43..52f4449af 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -1,5 +1,6 @@ import django_tables2 as tables from django_tables2.utils import Accessor +from django.conf import settings from dcim.models import ( ConsolePort, ConsoleServerPort, Device, DeviceBay, DeviceRole, FrontPort, Interface, InventoryItem, Platform, @@ -127,11 +128,18 @@ class DeviceTable(BaseTable): verbose_name='Type', text=lambda record: record.device_type.display_name ) - primary_ip = tables.Column( - linkify=True, - order_by=('primary_ip6', 'primary_ip4'), - verbose_name='IP Address' - ) + if settings.PREFER_IPV4: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip4', 'primary_ip6'), + verbose_name='IP Address' + ) + else: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip6', 'primary_ip4'), + verbose_name='IP Address' + ) primary_ip4 = tables.Column( linkify=True, verbose_name='IPv4 Address' diff --git a/netbox/virtualization/tables.py b/netbox/virtualization/tables.py index 34a070623..e183765f1 100644 --- a/netbox/virtualization/tables.py +++ b/netbox/virtualization/tables.py @@ -1,5 +1,5 @@ import django_tables2 as tables - +from django.conf import settings from dcim.tables.devices import BaseInterfaceTable from tenancy.tables import COL_TENANT from utilities.tables import ( @@ -125,10 +125,18 @@ class VirtualMachineDetailTable(VirtualMachineTable): linkify=True, verbose_name='IPv6 Address' ) - primary_ip = tables.Column( - linkify=True, - verbose_name='IP Address' - ) + if settings.PREFER_IPV4: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip4', 'primary_ip6'), + verbose_name='IP Address' + ) + else: + primary_ip = tables.Column( + linkify=True, + order_by=('primary_ip6', 'primary_ip4'), + verbose_name='IP Address' + ) tags = TagColumn( url_name='virtualization:virtualmachine_list' ) From 1cdd187e922a3bef6108facdac43aabbc7862696 Mon Sep 17 00:00:00 2001 From: Julian Jacobi Date: Mon, 1 Mar 2021 09:27:21 +0100 Subject: [PATCH 02/90] add custom links to device components --- netbox/dcim/models/device_components.py | 18 +++++++++--------- netbox/templates/dcim/device_component.html | 4 ++++ 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 452aacb56..40063234f 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -198,7 +198,7 @@ class PathEndpoint(models.Model): # Console ports # -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class ConsolePort(CableTermination, PathEndpoint, ComponentModel): """ A physical console port within a Device. ConsolePorts connect to ConsoleServerPorts. @@ -234,7 +234,7 @@ class ConsolePort(CableTermination, PathEndpoint, ComponentModel): # Console server ports # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel): """ A physical port within a Device (typically a designated console server) which provides access to ConsolePorts. @@ -270,7 +270,7 @@ class ConsoleServerPort(CableTermination, PathEndpoint, ComponentModel): # Power ports # -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class PowerPort(CableTermination, PathEndpoint, ComponentModel): """ A physical power supply (intake) port within a Device. PowerPorts connect to PowerOutlets. @@ -379,7 +379,7 @@ class PowerPort(CableTermination, PathEndpoint, ComponentModel): # Power outlets # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class PowerOutlet(CableTermination, PathEndpoint, ComponentModel): """ A physical power outlet (output) within a Device which provides power to a PowerPort. @@ -479,7 +479,7 @@ class BaseInterface(models.Model): return super().save(*args, **kwargs) -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): """ A network interface within a Device. A physical Interface can connect to exactly one other Interface. @@ -624,7 +624,7 @@ class Interface(CableTermination, PathEndpoint, ComponentModel, BaseInterface): # Pass-through ports # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class FrontPort(CableTermination, ComponentModel): """ A pass-through port on the front of a Device. @@ -687,7 +687,7 @@ class FrontPort(CableTermination, ComponentModel): }) -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class RearPort(CableTermination, ComponentModel): """ A pass-through port on the rear of a Device. @@ -740,7 +740,7 @@ class RearPort(CableTermination, ComponentModel): # Device bays # -@extras_features('webhooks') +@extras_features('webhooks', 'custom_links') class DeviceBay(ComponentModel): """ An empty space within a Device which can house a child device @@ -800,7 +800,7 @@ class DeviceBay(ComponentModel): # Inventory items # -@extras_features('export_templates', 'webhooks') +@extras_features('export_templates', 'webhooks', 'custom_links') class InventoryItem(MPTTModel, ComponentModel): """ An InventoryItem represents a serialized piece of hardware within a Device, such as a line card or power supply. diff --git a/netbox/templates/dcim/device_component.html b/netbox/templates/dcim/device_component.html index c0ce453b3..234d10fdd 100644 --- a/netbox/templates/dcim/device_component.html +++ b/netbox/templates/dcim/device_component.html @@ -1,6 +1,7 @@ {% extends 'base.html' %} {% load helpers %} {% load perms %} +{% load custom_links %} {% load plugins %} {% block header %} @@ -30,6 +31,9 @@ {% endif %}

{% block title %}{{ object.device }} / {{ object }}{% endblock %}

+
+ {% custom_links object %} +
{% endblock %} From 720f05976fae150707e6146373db93bbff3e258e Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 16 Mar 2021 15:57:23 -0400 Subject: [PATCH 84/90] Add JournalEntry list view w/filtering --- netbox/extras/filters.py | 30 ++++++++++------ netbox/extras/forms.py | 34 +++++++++++++++++++ netbox/extras/migrations/0058_journalentry.py | 1 + netbox/extras/models/models.py | 1 + netbox/extras/tables.py | 25 ++++++++++++++ netbox/extras/urls.py | 1 + netbox/extras/views.py | 8 +++++ netbox/templates/extras/object_journal.html | 1 + netbox/templates/inc/nav_menu.html | 3 ++ 9 files changed, 94 insertions(+), 10 deletions(-) diff --git a/netbox/extras/filters.py b/netbox/extras/filters.py index 7893b050f..afe3bff16 100644 --- a/netbox/extras/filters.py +++ b/netbox/extras/filters.py @@ -119,22 +119,32 @@ class ImageAttachmentFilterSet(BaseFilterSet): class JournalEntryFilterSet(BaseFilterSet): + q = django_filters.CharFilter( + method='search', + label='Search', + ) + created = django_filters.DateTimeFromToRangeFilter() assigned_object_type = ContentTypeFilter() - # created_by_id = django_filters.ModelMultipleChoiceFilter( - # queryset=User.objects.all(), - # label='User (ID)', - # ) - # created_by = django_filters.ModelMultipleChoiceFilter( - # field_name='user__username', - # queryset=User.objects.all(), - # to_field_name='username', - # label='User (name)', - # ) + created_by_id = django_filters.ModelMultipleChoiceFilter( + queryset=User.objects.all(), + label='User (ID)', + ) + created_by = django_filters.ModelMultipleChoiceFilter( + field_name='created_by__username', + queryset=User.objects.all(), + to_field_name='username', + label='User (name)', + ) class Meta: model = JournalEntry fields = ['id', 'assigned_object_type_id', 'assigned_object_id', 'created'] + def search(self, queryset, name, value): + if not value.strip(): + return queryset + return queryset.filter(comments__icontains=value) + class TagFilterSet(BaseFilterSet): q = django_filters.CharFilter( diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index f6a960bd9..a126378fa 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -386,6 +386,40 @@ class JournalEntryForm(BootstrapMixin, forms.ModelForm): } +class JournalEntryFilterForm(BootstrapMixin, forms.Form): + model = JournalEntry + q = forms.CharField( + required=False, + label=_('Search') + ) + created_after = forms.DateTimeField( + required=False, + label=_('After'), + widget=DateTimePicker() + ) + created_before = forms.DateTimeField( + required=False, + label=_('Before'), + widget=DateTimePicker() + ) + created_by_id = DynamicModelMultipleChoiceField( + queryset=User.objects.all(), + required=False, + label=_('User'), + widget=APISelectMultiple( + api_url='/api/users/users/', + ) + ) + assigned_object_type_id = DynamicModelMultipleChoiceField( + queryset=ContentType.objects.all(), + required=False, + label=_('Object Type'), + widget=APISelectMultiple( + api_url='/api/extras/content-types/', + ) + ) + + # # Change logging # diff --git a/netbox/extras/migrations/0058_journalentry.py b/netbox/extras/migrations/0058_journalentry.py index a3a83cb78..014b9ad05 100644 --- a/netbox/extras/migrations/0058_journalentry.py +++ b/netbox/extras/migrations/0058_journalentry.py @@ -23,6 +23,7 @@ class Migration(migrations.Migration): ('created_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)), ], options={ + 'verbose_name_plural': 'journal entries', 'ordering': ('-created',), }, ), diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index 6970265e9..1bed166f8 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -405,6 +405,7 @@ class JournalEntry(BigIDModel): class Meta: ordering = ('-created',) + verbose_name_plural = 'journal entries' def __str__(self): return f"{self.created}" diff --git a/netbox/extras/tables.py b/netbox/extras/tables.py index ff3befc11..99a3a4d71 100644 --- a/netbox/extras/tables.py +++ b/netbox/extras/tables.py @@ -98,7 +98,32 @@ class ObjectChangeTable(BaseTable): fields = ('time', 'user_name', 'action', 'changed_object_type', 'object_repr', 'request_id') +class JournalEntryTable(BaseTable): + created = tables.DateTimeColumn( + format=settings.SHORT_DATETIME_FORMAT + ) + assigned_object_type = tables.Column( + verbose_name='Object type' + ) + assigned_object = tables.Column( + linkify=True, + orderable=False, + verbose_name='Object' + ) + actions = ButtonsColumn( + model=JournalEntry, + buttons=('edit', 'delete') + ) + + class Meta(BaseTable.Meta): + model = JournalEntry + fields = ('created', 'created_by', 'assigned_object_type', 'assigned_object', 'comments', 'actions') + + class ObjectJournalTable(BaseTable): + """ + Used for displaying a set of JournalEntries within the context of a single object. + """ created = tables.DateTimeColumn( format=settings.SHORT_DATETIME_FORMAT ) diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py index 1b28eea84..6fbfd8bf1 100644 --- a/netbox/extras/urls.py +++ b/netbox/extras/urls.py @@ -32,6 +32,7 @@ urlpatterns = [ path('image-attachments//delete/', views.ImageAttachmentDeleteView.as_view(), name='imageattachment_delete'), # Journal entries + path('journal-entries/', views.JournalEntryListView.as_view(), name='journalentry_list'), path('journal-entries/add/', views.JournalEntryEditView.as_view(), name='journalentry_add'), path('journal-entries//edit/', views.JournalEntryEditView.as_view(), name='journalentry_edit'), path('journal-entries//delete/', views.JournalEntryDeleteView.as_view(), name='journalentry_delete'), diff --git a/netbox/extras/views.py b/netbox/extras/views.py index b41f09af3..b0caab4a6 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -286,6 +286,14 @@ class ImageAttachmentDeleteView(generic.ObjectDeleteView): # Journal entries # +class JournalEntryListView(generic.ObjectListView): + queryset = JournalEntry.objects.all() + filterset = filters.JournalEntryFilterSet + filterset_form = forms.JournalEntryFilterForm + table = tables.JournalEntryTable + action_buttons = ('export',) + + class JournalEntryEditView(generic.ObjectEditView): queryset = JournalEntry.objects.all() model_form = forms.JournalEntryForm diff --git a/netbox/templates/extras/object_journal.html b/netbox/templates/extras/object_journal.html index c643cc5b5..5e21b0cb2 100644 --- a/netbox/templates/extras/object_journal.html +++ b/netbox/templates/extras/object_journal.html @@ -27,4 +27,5 @@ {% endif %} {% include 'panel_table.html' %} + {% include 'inc/paginator.html' with paginator=table.paginator page=table.page %} {% endblock %} diff --git a/netbox/templates/inc/nav_menu.html b/netbox/templates/inc/nav_menu.html index 621251ffb..4fff16141 100644 --- a/netbox/templates/inc/nav_menu.html +++ b/netbox/templates/inc/nav_menu.html @@ -520,6 +520,9 @@
  • Logging
    • + + Journal Entries + Change Log From 9cba554ec90383d8c777aa27fe785a487ddde2f2 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 16 Mar 2021 16:47:35 -0400 Subject: [PATCH 85/90] Add JournalEntry tests --- netbox/extras/api/serializers.py | 13 ++--- netbox/extras/tests/test_api.py | 51 ++++++++++++++++++ netbox/extras/tests/test_filters.py | 84 +++++++++++++++++++++++++++++ netbox/extras/tests/test_views.py | 38 ++++++++++++- netbox/extras/views.py | 2 + 5 files changed, 180 insertions(+), 8 deletions(-) diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 100edc458..01a006e20 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -203,12 +203,13 @@ class JournalEntrySerializer(ValidatedModelSerializer): def validate(self, data): # Validate that the parent object exists - try: - data['content_type'].get_object_for_this_type(id=data['object_id']) - except ObjectDoesNotExist: - raise serializers.ValidationError( - "Invalid parent object: {} ID {}".format(data['content_type'], data['object_id']) - ) + if 'assigned_object_type' in data and 'assigned_object_id' in data: + try: + data['assigned_object_type'].get_object_for_this_type(id=data['assigned_object_id']) + except ObjectDoesNotExist: + raise serializers.ValidationError( + f"Invalid assigned_object: {data['assigned_object_type']} ID {data['assigned_object_id']}" + ) # Enforce model validation super().validate(data) diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py index 0bd4aea02..da0e6dbb2 100644 --- a/netbox/extras/tests/test_api.py +++ b/netbox/extras/tests/test_api.py @@ -1,6 +1,7 @@ import datetime from unittest import skipIf +from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType from django.test import override_settings from django.urls import reverse @@ -309,6 +310,56 @@ class ImageAttachmentTest( ImageAttachment.objects.bulk_create(image_attachments) +class JournalEntryTest(APIViewTestCases.APIViewTestCase): + model = JournalEntry + brief_fields = ['created', 'display', 'id', 'url'] + bulk_update_data = { + 'comments': 'Overwritten', + } + + @classmethod + def setUpTestData(cls): + user = User.objects.first() + site = Site.objects.create(name='Site 1', slug='site-1') + + journal_entries = ( + JournalEntry( + created_by=user, + assigned_object=site, + comments='Fourth entry', + ), + JournalEntry( + created_by=user, + assigned_object=site, + comments='Fifth entry', + ), + JournalEntry( + created_by=user, + assigned_object=site, + comments='Sixth entry', + ), + ) + JournalEntry.objects.bulk_create(journal_entries) + + cls.create_data = [ + { + 'assigned_object_type': 'dcim.site', + 'assigned_object_id': site.pk, + 'comments': 'First entry', + }, + { + 'assigned_object_type': 'dcim.site', + 'assigned_object_id': site.pk, + 'comments': 'Second entry', + }, + { + 'assigned_object_type': 'dcim.site', + 'assigned_object_id': site.pk, + 'comments': 'Third entry', + }, + ] + + class ConfigContextTest(APIViewTestCases.APIViewTestCase): model = ConfigContext brief_fields = ['display', 'id', 'name', 'url'] diff --git a/netbox/extras/tests/test_filters.py b/netbox/extras/tests/test_filters.py index 2d5eeca6f..f4cfd2c88 100644 --- a/netbox/extras/tests/test_filters.py +++ b/netbox/extras/tests/test_filters.py @@ -255,6 +255,90 @@ class ImageAttachmentTestCase(TestCase): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) +class JournalEntryTestCase(TestCase): + queryset = JournalEntry.objects.all() + filterset = JournalEntryFilterSet + + @classmethod + def setUpTestData(cls): + sites = ( + Site(name='Site 1', slug='site-1'), + Site(name='Site 2', slug='site-2'), + ) + Site.objects.bulk_create(sites) + + racks = ( + Rack(name='Rack 1', site=sites[0]), + Rack(name='Rack 2', site=sites[1]), + ) + Rack.objects.bulk_create(racks) + + users = ( + User(username='Alice'), + User(username='Bob'), + User(username='Charlie'), + ) + User.objects.bulk_create(users) + + journal_entries = ( + JournalEntry( + assigned_object=sites[0], + created_by=users[0], + comments='New journal entry' + ), + JournalEntry( + assigned_object=sites[0], + created_by=users[1], + comments='New journal entry' + ), + JournalEntry( + assigned_object=sites[1], + created_by=users[2], + comments='New journal entry' + ), + JournalEntry( + assigned_object=racks[0], + created_by=users[0], + comments='New journal entry' + ), + JournalEntry( + assigned_object=racks[0], + created_by=users[1], + comments='New journal entry' + ), + JournalEntry( + assigned_object=racks[1], + created_by=users[2], + comments='New journal entry' + ), + ) + JournalEntry.objects.bulk_create(journal_entries) + + def test_id(self): + params = {'id': self.queryset.values_list('pk', flat=True)[:2]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_created_by(self): + users = User.objects.filter(username__in=['Alice', 'Bob']) + params = {'created_by': [users[0].username, users[1].username]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + params = {'created_by_id': [users[0].pk, users[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + + def test_assigned_object_type(self): + params = {'assigned_object_type': 'dcim.site'} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + params = {'assigned_object_type_id': ContentType.objects.get(app_label='dcim', model='site').pk} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + + def test_assigned_object(self): + params = { + 'assigned_object_type': 'dcim.site', + 'assigned_object_id': [Site.objects.first().pk], + } + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + class ConfigContextTestCase(TestCase): queryset = ConfigContext.objects.all() filterset = ConfigContextFilterSet diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py index 703072601..39f3f707f 100644 --- a/netbox/extras/tests/test_views.py +++ b/netbox/extras/tests/test_views.py @@ -3,12 +3,11 @@ import uuid from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType -from django.test import override_settings from django.urls import reverse from dcim.models import Site from extras.choices import ObjectChangeActionChoices -from extras.models import ConfigContext, CustomLink, ObjectChange, Tag +from extras.models import ConfigContext, CustomLink, JournalEntry, ObjectChange, Tag from utilities.testing import ViewTestCases, TestCase @@ -128,6 +127,41 @@ class ObjectChangeTestCase(TestCase): self.assertHttpStatus(response, 200) +class JournalEntryTestCase( + # ViewTestCases.GetObjectViewTestCase, + ViewTestCases.CreateObjectViewTestCase, + ViewTestCases.EditObjectViewTestCase, + ViewTestCases.DeleteObjectViewTestCase, + ViewTestCases.ListObjectsViewTestCase, + # ViewTestCases.BulkEditObjectsViewTestCase, + # ViewTestCases.BulkDeleteObjectsViewTestCase +): + model = JournalEntry + + @classmethod + def setUpTestData(cls): + site_ct = ContentType.objects.get_for_model(Site) + + site = Site.objects.create(name='Site 1', slug='site-1') + user = User.objects.create(username='User 1') + + JournalEntry.objects.bulk_create(( + JournalEntry(assigned_object=site, created_by=user, comments='First entry'), + JournalEntry(assigned_object=site, created_by=user, comments='Second entry'), + JournalEntry(assigned_object=site, created_by=user, comments='Third entry'), + )) + + cls.form_data = { + 'assigned_object_type': site_ct.pk, + 'assigned_object_id': site.pk, + 'comments': 'A new entry', + } + + cls.bulk_edit_data = { + 'comments': 'Overwritten', + } + + class CustomLinkTest(TestCase): user_permissions = ['dcim.view_site'] diff --git a/netbox/extras/views.py b/netbox/extras/views.py index b0caab4a6..41ea7baa9 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -304,6 +304,8 @@ class JournalEntryEditView(generic.ObjectEditView): return obj def get_return_url(self, request, instance): + if not instance.assigned_object: + return reverse('extras:journalentry_list') obj = instance.assigned_object viewname = f'{obj._meta.app_label}:{obj._meta.model_name}_journal' return reverse(viewname, kwargs={'pk': obj.pk}) From a0fe83bdfa1d1e72e256c2a15186f1ffe8ea1ce6 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 16 Mar 2021 16:48:08 -0400 Subject: [PATCH 86/90] Skip secondary check if get_absolute_url() not defined for model --- netbox/utilities/testing/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/utilities/testing/views.py b/netbox/utilities/testing/views.py index 35492a26b..aa8db346d 100644 --- a/netbox/utilities/testing/views.py +++ b/netbox/utilities/testing/views.py @@ -580,7 +580,7 @@ class ViewTestCases: if hasattr(self.model, 'name'): self.assertIn(instance1.name, content) self.assertNotIn(instance2.name, content) - else: + elif hasattr(self.model, 'get_absolute_url'): self.assertIn(instance1.get_absolute_url(), content) self.assertNotIn(instance2.get_absolute_url(), content) From 7b95167aba04dd4026d8db88c5d14b3a3e877d47 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 17 Mar 2021 10:41:06 -0400 Subject: [PATCH 87/90] Add bulk edit, delete views for journal entries --- netbox/extras/forms.py | 16 +++++++++++++++- netbox/extras/tables.py | 3 ++- netbox/extras/tests/test_views.py | 4 ++-- netbox/extras/urls.py | 2 ++ netbox/extras/views.py | 13 +++++++++++++ 5 files changed, 34 insertions(+), 4 deletions(-) diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index a126378fa..3ab3a4c83 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -8,7 +8,7 @@ from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup from tenancy.models import Tenant, TenantGroup from utilities.forms import ( add_blank_choice, APISelectMultiple, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect, ColorSelect, - CSVModelForm, DateTimePicker, DynamicModelMultipleChoiceField, JSONField, SlugField, StaticSelect2, + CommentField, CSVModelForm, DateTimePicker, DynamicModelMultipleChoiceField, JSONField, SlugField, StaticSelect2, BOOLEAN_WITH_BLANK_CHOICES, ) from virtualization.models import Cluster, ClusterGroup @@ -386,6 +386,20 @@ class JournalEntryForm(BootstrapMixin, forms.ModelForm): } +class JournalEntryBulkEditForm(BootstrapMixin, BulkEditForm): + pk = forms.ModelMultipleChoiceField( + queryset=JournalEntry.objects.all(), + widget=forms.MultipleHiddenInput + ) + comments = forms.CharField( + required=False, + widget=forms.Textarea() + ) + + class Meta: + nullable_fields = [] + + class JournalEntryFilterForm(BootstrapMixin, forms.Form): model = JournalEntry q = forms.CharField( diff --git a/netbox/extras/tables.py b/netbox/extras/tables.py index 99a3a4d71..9146a19ad 100644 --- a/netbox/extras/tables.py +++ b/netbox/extras/tables.py @@ -99,6 +99,7 @@ class ObjectChangeTable(BaseTable): class JournalEntryTable(BaseTable): + pk = ToggleColumn() created = tables.DateTimeColumn( format=settings.SHORT_DATETIME_FORMAT ) @@ -117,7 +118,7 @@ class JournalEntryTable(BaseTable): class Meta(BaseTable.Meta): model = JournalEntry - fields = ('created', 'created_by', 'assigned_object_type', 'assigned_object', 'comments', 'actions') + fields = ('pk', 'created', 'created_by', 'assigned_object_type', 'assigned_object', 'comments', 'actions') class ObjectJournalTable(BaseTable): diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py index 39f3f707f..d21b0c004 100644 --- a/netbox/extras/tests/test_views.py +++ b/netbox/extras/tests/test_views.py @@ -133,8 +133,8 @@ class JournalEntryTestCase( ViewTestCases.EditObjectViewTestCase, ViewTestCases.DeleteObjectViewTestCase, ViewTestCases.ListObjectsViewTestCase, - # ViewTestCases.BulkEditObjectsViewTestCase, - # ViewTestCases.BulkDeleteObjectsViewTestCase + ViewTestCases.BulkEditObjectsViewTestCase, + ViewTestCases.BulkDeleteObjectsViewTestCase ): model = JournalEntry diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py index 6fbfd8bf1..ee435307d 100644 --- a/netbox/extras/urls.py +++ b/netbox/extras/urls.py @@ -34,6 +34,8 @@ urlpatterns = [ # Journal entries path('journal-entries/', views.JournalEntryListView.as_view(), name='journalentry_list'), path('journal-entries/add/', views.JournalEntryEditView.as_view(), name='journalentry_add'), + path('journal-entries/edit/', views.JournalEntryBulkEditView.as_view(), name='journalentry_bulk_edit'), + path('journal-entries/delete/', views.JournalEntryBulkDeleteView.as_view(), name='journalentry_bulk_delete'), path('journal-entries//edit/', views.JournalEntryEditView.as_view(), name='journalentry_edit'), path('journal-entries//delete/', views.JournalEntryDeleteView.as_view(), name='journalentry_delete'), diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 41ea7baa9..976c13760 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -320,6 +320,19 @@ class JournalEntryDeleteView(generic.ObjectDeleteView): return reverse(viewname, kwargs={'pk': obj.pk}) +class JournalEntryBulkEditView(generic.BulkEditView): + queryset = JournalEntry.objects.prefetch_related('created_by') + filterset = filters.JournalEntryFilterSet + table = tables.JournalEntryTable + form = forms.JournalEntryBulkEditForm + + +class JournalEntryBulkDeleteView(generic.BulkDeleteView): + queryset = JournalEntry.objects.prefetch_related('created_by') + filterset = filters.JournalEntryFilterSet + table = tables.JournalEntryTable + + class ObjectJournalView(View): """ Show all journal entries for an object. From bb007552ee1ba283ff62634330a7bebb221457cd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 17 Mar 2021 10:58:40 -0400 Subject: [PATCH 88/90] Changelog and documentation for #151 --- docs/models/extras/journalentry.md | 5 +++++ docs/release-notes/version-2.11.md | 4 ++++ 2 files changed, 9 insertions(+) create mode 100644 docs/models/extras/journalentry.md diff --git a/docs/models/extras/journalentry.md b/docs/models/extras/journalentry.md new file mode 100644 index 000000000..c95340a01 --- /dev/null +++ b/docs/models/extras/journalentry.md @@ -0,0 +1,5 @@ +# Journal Entries + +All primary objects in NetBox support journaling. A journal is a collection of human-generated notes and comments about an object maintained for historical context. It supplements NetBox's change log to provide additional information about why changes have been made or to convey events which occur outside of NetBox. Unlike the change log, which is typically limited in the amount of history it retains, journal entries never expire. + +Each journal entry has a user-populated `commnets` field. Each entry records the date and time, associated user, and object automatically upon being created. diff --git a/docs/release-notes/version-2.11.md b/docs/release-notes/version-2.11.md index 973b00f1c..6bfdd414b 100644 --- a/docs/release-notes/version-2.11.md +++ b/docs/release-notes/version-2.11.md @@ -9,6 +9,10 @@ later will be required. ### New Features +#### Journaling Support ([#151](https://github.com/netbox-community/netbox/issues/151)) + +NetBox now supports journaling for all primary objects. The journal is a collection of human-generated notes and comments about an object maintained for historical context. It supplements NetBox's change log to provide additional information about why changes have been made or to convey events which occur outside of NetBox. Unlike the change log, which is typically limited in the amount of history it retains, journal entries never expire. + #### Parent Interface Assignments ([#1519](https://github.com/netbox-community/netbox/issues/1519)) Virtual interfaces can now be assigned to a "parent" physical interface, by setting the `parent` field on the Interface model. This is helpful for associating subinterfaces with their physical counterpart. For example, you might assign virtual interfaces Gi0/0.100 and Gi0/0.200 to the physical interface Gi0/0. From 856efd0617e8af24e297991538c8e73e48122932 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 17 Mar 2021 12:51:39 -0400 Subject: [PATCH 89/90] Add kind field to JournalEntry --- netbox/extras/api/serializers.py | 6 ++++- netbox/extras/choices.py | 26 +++++++++++++++++++ netbox/extras/forms.py | 11 +++++++- netbox/extras/migrations/0058_journalentry.py | 1 + netbox/extras/models/models.py | 10 ++++++- netbox/extras/tables.py | 8 ++++-- netbox/extras/tests/test_views.py | 2 ++ netbox/templates/extras/object_journal.html | 1 + 8 files changed, 60 insertions(+), 5 deletions(-) diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 01a006e20..d1eea15ee 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -192,12 +192,16 @@ class JournalEntrySerializer(ValidatedModelSerializer): queryset=ContentType.objects.all() ) assigned_object = serializers.SerializerMethodField(read_only=True) + kind = ChoiceField( + choices=JournalEntryKindChoices, + required=False + ) class Meta: model = JournalEntry fields = [ 'id', 'url', 'display', 'assigned_object_type', 'assigned_object_id', 'assigned_object', 'created', - 'created_by', 'comments', + 'created_by', 'kind', 'comments', ] def validate(self, data): diff --git a/netbox/extras/choices.py b/netbox/extras/choices.py index 47c3a1039..33c70f70d 100644 --- a/netbox/extras/choices.py +++ b/netbox/extras/choices.py @@ -87,6 +87,32 @@ class ObjectChangeActionChoices(ChoiceSet): } +# +# Jounral entries +# + +class JournalEntryKindChoices(ChoiceSet): + + KIND_INFO = 'info' + KIND_SUCCESS = 'success' + KIND_WARNING = 'warning' + KIND_DANGER = 'danger' + + CHOICES = ( + (KIND_INFO, 'Info'), + (KIND_SUCCESS, 'Success'), + (KIND_WARNING, 'Warning'), + (KIND_DANGER, 'Danger'), + ) + + CSS_CLASSES = { + KIND_INFO: 'default', + KIND_SUCCESS: 'success', + KIND_WARNING: 'warning', + KIND_DANGER: 'danger', + } + + # # Log Levels for Reports and Scripts # diff --git a/netbox/extras/forms.py b/netbox/extras/forms.py index 3ab3a4c83..b12ecc11d 100644 --- a/netbox/extras/forms.py +++ b/netbox/extras/forms.py @@ -379,7 +379,7 @@ class JournalEntryForm(BootstrapMixin, forms.ModelForm): class Meta: model = JournalEntry - fields = ['assigned_object_type', 'assigned_object_id', 'comments'] + fields = ['assigned_object_type', 'assigned_object_id', 'kind', 'comments'] widgets = { 'assigned_object_type': forms.HiddenInput, 'assigned_object_id': forms.HiddenInput, @@ -391,6 +391,10 @@ class JournalEntryBulkEditForm(BootstrapMixin, BulkEditForm): queryset=JournalEntry.objects.all(), widget=forms.MultipleHiddenInput ) + kind = forms.ChoiceField( + choices=JournalEntryKindChoices, + required=False + ) comments = forms.CharField( required=False, widget=forms.Textarea() @@ -432,6 +436,11 @@ class JournalEntryFilterForm(BootstrapMixin, forms.Form): api_url='/api/extras/content-types/', ) ) + kind = forms.ChoiceField( + choices=add_blank_choice(JournalEntryKindChoices), + required=False, + widget=StaticSelect2() + ) # diff --git a/netbox/extras/migrations/0058_journalentry.py b/netbox/extras/migrations/0058_journalentry.py index 014b9ad05..14be2a50d 100644 --- a/netbox/extras/migrations/0058_journalentry.py +++ b/netbox/extras/migrations/0058_journalentry.py @@ -18,6 +18,7 @@ class Migration(migrations.Migration): ('id', models.BigAutoField(primary_key=True, serialize=False)), ('assigned_object_id', models.PositiveIntegerField()), ('created', models.DateTimeField(auto_now_add=True)), + ('kind', models.CharField(default='info', max_length=30)), ('comments', models.TextField()), ('assigned_object_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.contenttype')), ('created_by', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL)), diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index 1bed166f8..61d06d264 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -399,6 +399,11 @@ class JournalEntry(BigIDModel): blank=True, null=True ) + kind = models.CharField( + max_length=30, + choices=JournalEntryKindChoices, + default=JournalEntryKindChoices.KIND_INFO + ) comments = models.TextField() objects = RestrictedQuerySet.as_manager() @@ -408,7 +413,10 @@ class JournalEntry(BigIDModel): verbose_name_plural = 'journal entries' def __str__(self): - return f"{self.created}" + return f"{self.created} - {self.get_kind_display()}" + + def get_kind_class(self): + return JournalEntryKindChoices.CSS_CLASSES.get(self.kind) # diff --git a/netbox/extras/tables.py b/netbox/extras/tables.py index 9146a19ad..e034b915a 100644 --- a/netbox/extras/tables.py +++ b/netbox/extras/tables.py @@ -111,6 +111,7 @@ class JournalEntryTable(BaseTable): orderable=False, verbose_name='Object' ) + kind = ChoiceFieldColumn() actions = ButtonsColumn( model=JournalEntry, buttons=('edit', 'delete') @@ -118,7 +119,9 @@ class JournalEntryTable(BaseTable): class Meta(BaseTable.Meta): model = JournalEntry - fields = ('pk', 'created', 'created_by', 'assigned_object_type', 'assigned_object', 'comments', 'actions') + fields = ( + 'pk', 'created', 'created_by', 'assigned_object_type', 'assigned_object', 'kind', 'comments', 'actions' + ) class ObjectJournalTable(BaseTable): @@ -128,6 +131,7 @@ class ObjectJournalTable(BaseTable): created = tables.DateTimeColumn( format=settings.SHORT_DATETIME_FORMAT ) + kind = ChoiceFieldColumn() actions = ButtonsColumn( model=JournalEntry, buttons=('edit', 'delete') @@ -135,4 +139,4 @@ class ObjectJournalTable(BaseTable): class Meta(BaseTable.Meta): model = JournalEntry - fields = ('created', 'created_by', 'comments', 'actions') + fields = ('created', 'created_by', 'kind', 'comments', 'actions') diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py index d21b0c004..286fa7613 100644 --- a/netbox/extras/tests/test_views.py +++ b/netbox/extras/tests/test_views.py @@ -154,10 +154,12 @@ class JournalEntryTestCase( cls.form_data = { 'assigned_object_type': site_ct.pk, 'assigned_object_id': site.pk, + 'kind': 'info', 'comments': 'A new entry', } cls.bulk_edit_data = { + 'kind': 'success', 'comments': 'Overwritten', } diff --git a/netbox/templates/extras/object_journal.html b/netbox/templates/extras/object_journal.html index 5e21b0cb2..6c50ca547 100644 --- a/netbox/templates/extras/object_journal.html +++ b/netbox/templates/extras/object_journal.html @@ -16,6 +16,7 @@ {% endfor %}
    + {% render_field form.kind %} {% render_field form.comments %}
    From 32ee80f8344fee9fa2360dd1faf677bfe83303f4 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 17 Mar 2021 13:02:40 -0400 Subject: [PATCH 90/90] Add JournalEntry filter for kind --- netbox/extras/filters.py | 5 ++++- netbox/extras/tests/test_filters.py | 12 +++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/netbox/extras/filters.py b/netbox/extras/filters.py index afe3bff16..3ac25eec4 100644 --- a/netbox/extras/filters.py +++ b/netbox/extras/filters.py @@ -135,10 +135,13 @@ class JournalEntryFilterSet(BaseFilterSet): to_field_name='username', label='User (name)', ) + kind = django_filters.MultipleChoiceFilter( + choices=JournalEntryKindChoices + ) class Meta: model = JournalEntry - fields = ['id', 'assigned_object_type_id', 'assigned_object_id', 'created'] + fields = ['id', 'assigned_object_type_id', 'assigned_object_id', 'created', 'kind'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/extras/tests/test_filters.py b/netbox/extras/tests/test_filters.py index f4cfd2c88..5e1b0401d 100644 --- a/netbox/extras/tests/test_filters.py +++ b/netbox/extras/tests/test_filters.py @@ -5,7 +5,7 @@ from django.contrib.contenttypes.models import ContentType from django.test import TestCase from dcim.models import DeviceRole, Platform, Rack, Region, Site, SiteGroup -from extras.choices import ObjectChangeActionChoices +from extras.choices import JournalEntryKindChoices, ObjectChangeActionChoices from extras.filters import * from extras.models import * from ipam.models import IPAddress @@ -284,31 +284,37 @@ class JournalEntryTestCase(TestCase): JournalEntry( assigned_object=sites[0], created_by=users[0], + kind=JournalEntryKindChoices.KIND_INFO, comments='New journal entry' ), JournalEntry( assigned_object=sites[0], created_by=users[1], + kind=JournalEntryKindChoices.KIND_SUCCESS, comments='New journal entry' ), JournalEntry( assigned_object=sites[1], created_by=users[2], + kind=JournalEntryKindChoices.KIND_WARNING, comments='New journal entry' ), JournalEntry( assigned_object=racks[0], created_by=users[0], + kind=JournalEntryKindChoices.KIND_INFO, comments='New journal entry' ), JournalEntry( assigned_object=racks[0], created_by=users[1], + kind=JournalEntryKindChoices.KIND_SUCCESS, comments='New journal entry' ), JournalEntry( assigned_object=racks[1], created_by=users[2], + kind=JournalEntryKindChoices.KIND_WARNING, comments='New journal entry' ), ) @@ -338,6 +344,10 @@ class JournalEntryTestCase(TestCase): } self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_kind(self): + params = {'kind': [JournalEntryKindChoices.KIND_INFO, JournalEntryKindChoices.KIND_SUCCESS]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + class ConfigContextTestCase(TestCase): queryset = ConfigContext.objects.all()