From 49d7cda7cfeb79fbd5b56693dcdaa96a211425f0 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Fri, 15 Jul 2022 19:42:43 +0000 Subject: [PATCH 01/38] rename extended rules --- .devcontainer/configuration/plugins.py | 2 +- netbox_access_lists/api/serializers.py | 14 +++---- netbox_access_lists/api/urls.py | 2 +- netbox_access_lists/api/views.py | 10 ++--- netbox_access_lists/filtersets.py | 6 +-- netbox_access_lists/forms.py | 10 ++--- netbox_access_lists/graphql.py | 10 ++--- .../{0001_initial.py => 0001_accesslist.py} | 39 ++++++++++++++----- netbox_access_lists/models.py | 6 +-- netbox_access_lists/navigation.py | 8 ++-- netbox_access_lists/tables.py | 8 ++-- .../netbox_access_lists/accesslist.html | 2 +- ...trule.html => accesslistextendedrule.html} | 0 netbox_access_lists/urls.py | 14 +++---- netbox_access_lists/views.py | 28 ++++++------- 15 files changed, 89 insertions(+), 70 deletions(-) rename netbox_access_lists/migrations/{0001_initial.py => 0001_accesslist.py} (71%) rename netbox_access_lists/templates/netbox_access_lists/{accesslistrule.html => accesslistextendedrule.html} (100%) diff --git a/.devcontainer/configuration/plugins.py b/.devcontainer/configuration/plugins.py index a92555c..67b1017 100644 --- a/.devcontainer/configuration/plugins.py +++ b/.devcontainer/configuration/plugins.py @@ -6,7 +6,7 @@ PLUGINS = [ "netbox_access_lists", - "netbox_secretstore" + #"netbox_secretstore" ] PLUGINS_CONFIG = { diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index a5b92db..f8262bf 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from ipam.api.serializers import NestedPrefixSerializer from dcim.api.serializers import NestedDeviceSerializer from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer -from ..models import AccessList, AccessListRule +from ..models import AccessList, AccessListExtendedRule # @@ -20,13 +20,13 @@ class NestedAccessListSerializer(WritableNestedSerializer): fields = ('id', 'url', 'display', 'name', 'device') -class NestedAccessListRuleSerializer(WritableNestedSerializer): +class NestedAccessListExtendedRuleSerializer(WritableNestedSerializer): url = serializers.HyperlinkedIdentityField( - view_name='plugins-api:netbox_access_lists-api:accesslistrule-detail' + view_name='plugins-api:netbox_access_lists-api:accesslistextendedrule-detail' ) class Meta: - model = AccessListRule + model = AccessListExtendedRule fields = ('id', 'url', 'display', 'index') @@ -49,16 +49,16 @@ class AccessListSerializer(NetBoxModelSerializer): ) -class AccessListRuleSerializer(NetBoxModelSerializer): +class AccessListExtendedRuleSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField( - view_name='plugins-api:netbox_access_lists-api:accesslistrule-detail' + view_name='plugins-api:netbox_access_lists-api:accesslistextendedrule-detail' ) access_list = NestedAccessListSerializer() source_prefix = NestedPrefixSerializer() destination_prefix = NestedPrefixSerializer() class Meta: - model = AccessListRule + model = AccessListExtendedRule fields = ( 'id', 'url', 'display', 'access_list', 'index', 'protocol', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'action', 'tags', 'custom_fields', 'created', diff --git a/netbox_access_lists/api/urls.py b/netbox_access_lists/api/urls.py index 7afe0a2..358e620 100644 --- a/netbox_access_lists/api/urls.py +++ b/netbox_access_lists/api/urls.py @@ -6,6 +6,6 @@ app_name = 'netbox_access_list' router = NetBoxRouter() router.register('access-lists', views.AccessListViewSet) -router.register('access-list-rules', views.AccessListRuleViewSet) +router.register('access-list-rules', views.AccessListExtendedRuleViewSet) urlpatterns = router.urls diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index fa477dc..023ed12 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -3,7 +3,7 @@ from django.db.models import Count from netbox.api.viewsets import NetBoxModelViewSet from .. import filtersets, models -from .serializers import AccessListSerializer, AccessListRuleSerializer +from .serializers import AccessListSerializer, AccessListExtendedRuleSerializer class AccessListViewSet(NetBoxModelViewSet): @@ -16,9 +16,9 @@ class AccessListViewSet(NetBoxModelViewSet): filterset_class = filtersets.AccessListFilterSet -class AccessListRuleViewSet(NetBoxModelViewSet): - queryset = models.AccessListRule.objects.prefetch_related( +class AccessListExtendedRuleViewSet(NetBoxModelViewSet): + queryset = models.AccessListExtendedRule.objects.prefetch_related( 'access_list', 'source_prefix', 'destination_prefix', 'tags' ) - serializer_class = AccessListRuleSerializer - filterset_class = filtersets.AccessListRuleFilterSet + serializer_class = AccessListExtendedRuleSerializer + filterset_class = filtersets.AccessListExtendedRuleFilterSet diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index a588dbf..0c7480b 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -1,5 +1,5 @@ from netbox.filtersets import NetBoxModelFilterSet -from .models import AccessList, AccessListRule +from .models import AccessList, AccessListExtendedRule class AccessListFilterSet(NetBoxModelFilterSet): @@ -11,10 +11,10 @@ class AccessListFilterSet(NetBoxModelFilterSet): return queryset.filter(description__icontains=value) -class AccessListRuleFilterSet(NetBoxModelFilterSet): +class AccessListExtendedRuleFilterSet(NetBoxModelFilterSet): class Meta: - model = AccessListRule + model = AccessListExtendedRule fields = ('id', 'access_list', 'index', 'protocol', 'action', 'remark') def search(self, queryset, name, value): diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index 8c43f75..ffbfe67 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -4,7 +4,7 @@ from extras.models import Tag from ipam.models import Prefix from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelectMultiple, TagFilterField -from .models import AccessList, AccessListRule, AccessListActionChoices, AccessListProtocolChoices, AccessListTypeChoices +from .models import AccessList, AccessListExtendedRule, AccessListActionChoices, AccessListProtocolChoices, AccessListTypeChoices class AccessListForm(NetBoxModelForm): @@ -34,7 +34,7 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): tag = TagFilterField(model) -class AccessListRuleForm(NetBoxModelForm): +class AccessListExtendedRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all() ) @@ -50,15 +50,15 @@ class AccessListRuleForm(NetBoxModelForm): ) class Meta: - model = AccessListRule + model = AccessListExtendedRule fields = ( 'access_list', 'index', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol', 'action', 'tags', ) -class AccessListRuleFilterForm(NetBoxModelFilterSetForm): - model = AccessListRule +class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): + model = AccessListExtendedRule access_list = forms.ModelMultipleChoiceField( queryset=AccessList.objects.all(), required=False, diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index fe84a0b..85fbe91 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -16,12 +16,12 @@ class AccessListType(NetBoxObjectType): filterset_class = filtersets.AccessListFilterSet -class AccessListRuleType(NetBoxObjectType): +class AccessListExtendedRuleType(NetBoxObjectType): class Meta: - model = models.AccessListRule + model = models.AccessListExtendedRule fields = '__all__' - filterset_class = filtersets.AccessListRuleFilterSet + filterset_class = filtersets.AccessListExtendedRuleFilterSet # @@ -32,8 +32,8 @@ class Query(ObjectType): access_list = ObjectField(AccessListType) access_list_list = ObjectListField(AccessListType) - access_list_rule = ObjectField(AccessListRuleType) - access_list_rule_list = ObjectListField(AccessListRuleType) + access_list_rule = ObjectField(AccessListExtendedRuleType) + access_list_rule_list = ObjectListField(AccessListExtendedRuleType) schema = Query diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_accesslist.py similarity index 71% rename from netbox_access_lists/migrations/0001_initial.py rename to netbox_access_lists/migrations/0001_accesslist.py index e1f7f4d..492c685 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_accesslist.py @@ -35,22 +35,41 @@ class Migration(migrations.Migration): }, ), migrations.CreateModel( - name='AccessListRule', + name='AccessListStandardRule', fields=[ ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), ('created', models.DateTimeField(auto_now_add=True, null=True)), ('last_updated', models.DateTimeField(auto_now=True, null=True)), ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), - ('index', models.PositiveIntegerField()), - ('protocol', models.CharField(blank=True, max_length=30)), - ('source_ports', django.contrib.postgres.fields.ArrayField(base_field=models.PositiveIntegerField(), blank=True, null=True, size=None)), - ('destination_ports', django.contrib.postgres.fields.ArrayField(base_field=models.PositiveIntegerField(), blank=True, null=True, size=None)), - ('action', models.CharField(max_length=30)), - ('remark', models.CharField(blank=True, null=True, max_length=500)), - ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='netbox_access_lists.accesslist')), - ('destination_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), - ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), + ('index', models.PositiveIntegerField()), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='netbox_access_lists.accesslist')), + ('remark', models.CharField(blank=True, null=True, max_length=500)), + ('action', models.CharField(max_length=30)), + ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), + ], + options={ + 'ordering': ('access_list', 'index'), + 'unique_together': {('access_list', 'index')}, + }, + ), + migrations.CreateModel( + name='AccessListExtendedRule', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), + ('created', models.DateTimeField(auto_now_add=True, null=True)), + ('last_updated', models.DateTimeField(auto_now=True, null=True)), + ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), + ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), + ('index', models.PositiveIntegerField()), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='netbox_access_lists.accesslist')), + ('remark', models.CharField(blank=True, null=True, max_length=500)), + ('action', models.CharField(max_length=30)), + ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), + ('source_ports', django.contrib.postgres.fields.ArrayField(base_field=models.PositiveIntegerField(), blank=True, null=True, size=None)), + ('destination_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), + ('destination_ports', django.contrib.postgres.fields.ArrayField(base_field=models.PositiveIntegerField(), blank=True, null=True, size=None)), + ('protocol', models.CharField(blank=True, max_length=30)), ], options={ 'ordering': ('access_list', 'index'), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 0d0d6b6..6efcea3 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -7,7 +7,7 @@ from utilities.choices import ChoiceSet class AccessListActionChoices(ChoiceSet): - key = 'AccessListRule.action' + key = 'AccessListExtendedRule.action' ACTION_DENY = 'deny' ACTION_PERMIT = 'permit' ACTION_REJECT = 'reject' @@ -75,7 +75,7 @@ class AccessList(NetBoxModel): return AccessListTypeChoices.colors.get(self.type) -class AccessListRule(NetBoxModel): +class AccessListExtendedRule(NetBoxModel): access_list = models.ForeignKey( on_delete=models.CASCADE, related_name='rules', @@ -135,7 +135,7 @@ class AccessListRule(NetBoxModel): return f'{self.access_list}: Rule {self.index}' def get_absolute_url(self): - return reverse('plugins:netbox_access_lists:accesslistrule', args=[self.pk]) + return reverse('plugins:netbox_access_lists:accesslistextendedrule', args=[self.pk]) def get_protocol_color(self): return AccessListProtocolChoices.colors.get(self.protocol) diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index 5fbe6ec..abde06e 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -11,9 +11,9 @@ accesslist_buttons = [ ) ] -accesslistrule_butons = [ +accesslistextendedrule_butons = [ PluginMenuButton( - link='plugins:netbox_access_lists:accesslistrule_add', + link='plugins:netbox_access_lists:accesslistextendedrule_add', title='Add', icon_class='mdi mdi-plus-thick', color=ButtonColorChoices.GREEN @@ -28,8 +28,8 @@ menu_items = ( ), # # Comment out Access List Rule to force creation in the ACL view # PluginMenuItem( - # link='plugins:netbox_access_lists:accesslistrule_list', + # link='plugins:netbox_access_lists:accesslistextendedrule_list', # link_text='Access List Rules', - # buttons=accesslistrule_butons + # buttons=accesslistextendedrule_butons # ), ) diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index aa6b5e9..ae49355 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns, ChoiceFieldColumn -from .models import AccessList, AccessListRule +from .models import AccessList, AccessListExtendedRule class AccessListTable(NetBoxTable): @@ -26,7 +26,7 @@ class AccessListTable(NetBoxTable): default_columns = ('name', 'device', 'type', 'rule_count', 'default_action', 'tags') -class AccessListRuleTable(NetBoxTable): +class AccessListExtendedRuleTable(NetBoxTable): access_list = tables.Column( linkify=True ) @@ -36,11 +36,11 @@ class AccessListRuleTable(NetBoxTable): protocol = ChoiceFieldColumn() action = ChoiceFieldColumn() tags = columns.TagColumn( - url_name='plugins:netbox_access_lists:accesslistrule_list' + url_name='plugins:netbox_access_lists:accesslistextendedrule_list' ) class Meta(NetBoxTable.Meta): - model = AccessListRule + model = AccessListExtendedRule fields = ( 'pk', 'id', 'access_list', 'index', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol', 'action', 'remark', 'actions', 'tags' diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslist.html b/netbox_access_lists/templates/netbox_access_lists/accesslist.html index 43e6d23..7939e50 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accesslist.html +++ b/netbox_access_lists/templates/netbox_access_lists/accesslist.html @@ -7,7 +7,7 @@ {% block controls %}
{% if perms.netbox_access_lists.change_policy %} - + Rule {% endif %} diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslistrule.html b/netbox_access_lists/templates/netbox_access_lists/accesslistextendedrule.html similarity index 100% rename from netbox_access_lists/templates/netbox_access_lists/accesslistrule.html rename to netbox_access_lists/templates/netbox_access_lists/accesslistextendedrule.html diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index 6451342..c5cdc32 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -17,13 +17,13 @@ urlpatterns = ( }), # Access list rules - path('rules/', views.AccessListRuleListView.as_view(), name='accesslistrule_list'), - path('rules/add/', views.AccessListRuleEditView.as_view(), name='accesslistrule_add'), - path('rules//', views.AccessListRuleView.as_view(), name='accesslistrule'), - path('rules//edit/', views.AccessListRuleEditView.as_view(), name='accesslistrule_edit'), - path('rules//delete/', views.AccessListRuleDeleteView.as_view(), name='accesslistrule_delete'), - path('rules//changelog/', ObjectChangeLogView.as_view(), name='accesslistrule_changelog', kwargs={ - 'model': models.AccessListRule + path('rules/', views.AccessListExtendedRuleListView.as_view(), name='accesslistextendedrule_list'), + path('rules/add/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_add'), + path('rules//', views.AccessListExtendedRuleView.as_view(), name='accesslistextendedrule'), + path('rules//edit/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_edit'), + path('rules//delete/', views.AccessListExtendedRuleDeleteView.as_view(), name='accesslistextendedrule_delete'), + path('rules//changelog/', ObjectChangeLogView.as_view(), name='accesslistextendedrule_changelog', kwargs={ + 'model': models.AccessListExtendedRule }), ) diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 39db83c..66bb406 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -12,7 +12,7 @@ class AccessListView(generic.ObjectView): queryset = models.AccessList.objects.all() def get_extra_context(self, request, instance): - table = tables.AccessListRuleTable(instance.rules.all()) + table = tables.AccessListExtendedRuleTable(instance.rules.all()) table.configure(request) return { @@ -39,24 +39,24 @@ class AccessListDeleteView(generic.ObjectDeleteView): # -# AccessListRule views +# AccessListExtendedRule views # -class AccessListRuleView(generic.ObjectView): - queryset = models.AccessListRule.objects.all() +class AccessListExtendedRuleView(generic.ObjectView): + queryset = models.AccessListExtendedRule.objects.all() -class AccessListRuleListView(generic.ObjectListView): - queryset = models.AccessListRule.objects.all() - table = tables.AccessListRuleTable - filterset = filtersets.AccessListRuleFilterSet - filterset_form = forms.AccessListRuleFilterForm +class AccessListExtendedRuleListView(generic.ObjectListView): + queryset = models.AccessListExtendedRule.objects.all() + table = tables.AccessListExtendedRuleTable + filterset = filtersets.AccessListExtendedRuleFilterSet + filterset_form = forms.AccessListExtendedRuleFilterForm -class AccessListRuleEditView(generic.ObjectEditView): - queryset = models.AccessListRule.objects.all() - form = forms.AccessListRuleForm +class AccessListExtendedRuleEditView(generic.ObjectEditView): + queryset = models.AccessListExtendedRule.objects.all() + form = forms.AccessListExtendedRuleForm -class AccessListRuleDeleteView(generic.ObjectDeleteView): - queryset = models.AccessListRule.objects.all() +class AccessListExtendedRuleDeleteView(generic.ObjectDeleteView): + queryset = models.AccessListExtendedRule.objects.all() From 76fa4ab77712d69b56ea61d0bed30a39e23ef0d2 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Fri, 15 Jul 2022 22:05:00 +0000 Subject: [PATCH 02/38] draft --- netbox_access_lists/api/serializers.py | 31 +++++++- netbox_access_lists/api/views.py | 10 ++- netbox_access_lists/filtersets.py | 12 +++- netbox_access_lists/forms.py | 49 ++++++++++++- netbox_access_lists/graphql.py | 14 ++++ netbox_access_lists/models.py | 70 +++++++++++++++---- netbox_access_lists/navigation.py | 17 ++++- netbox_access_lists/tables.py | 22 +++++- .../netbox_access_lists/accesslist.html | 6 +- netbox_access_lists/urls.py | 24 +++++-- netbox_access_lists/views.py | 33 ++++++++- 11 files changed, 254 insertions(+), 34 deletions(-) diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index f8262bf..3717793 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from ipam.api.serializers import NestedPrefixSerializer from dcim.api.serializers import NestedDeviceSerializer from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer -from ..models import AccessList, AccessListExtendedRule +from ..models import AccessList, AccessListExtendedRule, AccessListStandardRule # @@ -20,6 +20,16 @@ class NestedAccessListSerializer(WritableNestedSerializer): fields = ('id', 'url', 'display', 'name', 'device') +class NestedAccessListStandardRuleSerializer(WritableNestedSerializer): + url = serializers.HyperlinkedIdentityField( + view_name='plugins-api:netbox_access_lists-api:accessliststandardrule-detail' + ) + + class Meta: + model = AccessListStandardRule + fields = ('id', 'url', 'display', 'index') + + class NestedAccessListExtendedRuleSerializer(WritableNestedSerializer): url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:accesslistextendedrule-detail' @@ -45,7 +55,22 @@ class AccessListSerializer(NetBoxModelSerializer): model = AccessList fields = ( 'id', 'url', 'display', 'name', 'device', 'type', 'default_action', 'comments', 'tags', 'custom_fields', 'created', - 'last_updated', 'rule_count', + 'last_updated', 'rule_count' + ) + + +class AccessListStandardRuleSerializer(NetBoxModelSerializer): + url = serializers.HyperlinkedIdentityField( + view_name='plugins-api:netbox_access_lists-api:accessliststandardrule-detail' + ) + access_list = NestedAccessListSerializer() + source_prefix = NestedPrefixSerializer() + + class Meta: + model = AccessListStandardRule + fields = ( + 'id', 'url', 'display', 'access_list', 'index', 'source_prefix', 'action', + 'tags', 'custom_fields', 'created', 'last_updated' ) @@ -62,5 +87,5 @@ class AccessListExtendedRuleSerializer(NetBoxModelSerializer): fields = ( 'id', 'url', 'display', 'access_list', 'index', 'protocol', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'action', 'tags', 'custom_fields', 'created', - 'last_updated', + 'last_updated' ) diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index 023ed12..4272871 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -3,7 +3,7 @@ from django.db.models import Count from netbox.api.viewsets import NetBoxModelViewSet from .. import filtersets, models -from .serializers import AccessListSerializer, AccessListExtendedRuleSerializer +from .serializers import AccessListSerializer, AccessListExtendedRuleSerializer, AccessListStandardRuleSerializer class AccessListViewSet(NetBoxModelViewSet): @@ -16,6 +16,14 @@ class AccessListViewSet(NetBoxModelViewSet): filterset_class = filtersets.AccessListFilterSet +class AccessListStandardRuleViewSet(NetBoxModelViewSet): + queryset = models.AccessListStandardRule.objects.prefetch_related( + 'access_list', 'source_prefix', 'tags' + ) + serializer_class = AccessListStandardRuleSerializer + filterset_class = filtersets.AccessListStandardRuleFilterSet + + class AccessListExtendedRuleViewSet(NetBoxModelViewSet): queryset = models.AccessListExtendedRule.objects.prefetch_related( 'access_list', 'source_prefix', 'destination_prefix', 'tags' diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index 0c7480b..5f76d81 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -1,5 +1,5 @@ from netbox.filtersets import NetBoxModelFilterSet -from .models import AccessList, AccessListExtendedRule +from .models import AccessList, AccessListExtendedRule, AccessListStandardRule class AccessListFilterSet(NetBoxModelFilterSet): @@ -19,3 +19,13 @@ class AccessListExtendedRuleFilterSet(NetBoxModelFilterSet): def search(self, queryset, name, value): return queryset.filter(description__icontains=value) + + +class AccessListStandardRuleFilterSet(NetBoxModelFilterSet): + + class Meta: + model = AccessListStandardRule + fields = ('id', 'access_list', 'index', 'action', 'remark') + + def search(self, queryset, name, value): + return queryset.filter(description__icontains=value) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index ffbfe67..363cbd8 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -4,7 +4,7 @@ from extras.models import Tag from ipam.models import Prefix from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelectMultiple, TagFilterField -from .models import AccessList, AccessListExtendedRule, AccessListActionChoices, AccessListProtocolChoices, AccessListTypeChoices +from .models import AccessList, AccessListExtendedRule, AccessListActionChoices, AccessListProtocolChoices, AccessListTypeChoices, AccessListStandardRule class AccessListForm(NetBoxModelForm): @@ -36,7 +36,10 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): class AccessListExtendedRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( - queryset=AccessList.objects.all() + queryset=AccessList.objects.all(), + query_params={ + 'type': 'extended' + } ) source_prefix = DynamicModelChoiceField( queryset=Prefix.objects.all() @@ -53,7 +56,7 @@ class AccessListExtendedRuleForm(NetBoxModelForm): model = AccessListExtendedRule fields = ( 'access_list', 'index', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', - 'destination_ports', 'protocol', 'action', 'tags', + 'destination_ports', 'protocol', 'action', 'tags' ) @@ -78,3 +81,43 @@ class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): widget=StaticSelectMultiple() ) tag = TagFilterField(model) + + +class AccessListStandardRuleForm(NetBoxModelForm): + access_list = DynamicModelChoiceField( + queryset=AccessList.objects.all(), + query_params={ + 'type': 'standard' + } + ) + source_prefix = DynamicModelChoiceField( + queryset=Prefix.objects.all() + ) + tags = DynamicModelMultipleChoiceField( + queryset=Tag.objects.all(), + required=False + ) + + class Meta: + model = AccessListStandardRule + fields = ( + 'access_list', 'index', 'remark', 'source_prefix', 'action', 'tags' + ) + + +class AccessListStandardRuleFilterForm(NetBoxModelFilterSetForm): + model = AccessListStandardRule + access_list = forms.ModelMultipleChoiceField( + queryset=AccessList.objects.all(), + required=False, + widget=StaticSelectMultiple() + ) + index = forms.IntegerField( + required=False + ) + action = forms.MultipleChoiceField( + choices=AccessListActionChoices, + required=False, + widget=StaticSelectMultiple() + ) + tag = TagFilterField(model) diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index 85fbe91..1a7795f 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -24,6 +24,13 @@ class AccessListExtendedRuleType(NetBoxObjectType): filterset_class = filtersets.AccessListExtendedRuleFilterSet +#class AccessListStandardRuleType(NetBoxObjectType): +# +# class Meta: +# model = models.AccessListStandardRule +# fields = '__all__' +# filterset_class = filtersets.AccessListStandardRuleFilterSet + # # Queries # @@ -36,4 +43,11 @@ class Query(ObjectType): access_list_rule_list = ObjectListField(AccessListExtendedRuleType) +#class Query(ObjectType): +# access_list = ObjectField(AccessListType) +# access_list_list = ObjectListField(AccessListType) +# +# access_list_rule = ObjectField(AccessListStandardRuleType) +# access_list_rule_list = ObjectListField(AccessListStandardRuleType) + schema = Query diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 6efcea3..a300808 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -75,6 +75,50 @@ class AccessList(NetBoxModel): return AccessListTypeChoices.colors.get(self.type) +#class AccessListRule(NetBoxModel): + + +class AccessListStandardRule(NetBoxModel): + access_list = models.ForeignKey( + on_delete=models.CASCADE, + related_name='standard_acl_rules', + to=AccessList, + verbose_name='Access List' + ) + index = models.PositiveIntegerField() + remark = models.CharField( + max_length=200, + blank=True, + null=True + ) + action = models.CharField( + choices=AccessListActionChoices, + default=AccessListActionChoices.ACTION_PERMIT, + max_length=30, + ) + source_prefix = models.ForeignKey( + blank=True, + null=True, + on_delete=models.PROTECT, + related_name='+', + to='ipam.Prefix', + verbose_name='Source Prefix' + ) + + class Meta: + ordering = ('access_list', 'index') + unique_together = ('access_list', 'index') + + def __str__(self): + return f'{self.access_list}: Rule {self.index}' + + def get_action_color(self): + return AccessListActionChoices.colors.get(self.action) + + def get_absolute_url(self): + return reverse('plugins:netbox_access_lists:accessliststandardrule', args=[self.pk]) + + class AccessListExtendedRule(NetBoxModel): access_list = models.ForeignKey( on_delete=models.CASCADE, @@ -83,9 +127,14 @@ class AccessListExtendedRule(NetBoxModel): verbose_name='Access List' ) index = models.PositiveIntegerField() - protocol = models.CharField( + remark = models.CharField( + max_length=200, blank=True, - choices=AccessListProtocolChoices, + null=True + ) + action = models.CharField( + choices=AccessListActionChoices, + default=AccessListActionChoices.ACTION_PERMIT, max_length=30, ) source_prefix = models.ForeignKey( @@ -116,15 +165,10 @@ class AccessListExtendedRule(NetBoxModel): null=True, verbose_name='Destination Ports' ) - action = models.CharField( - choices=AccessListActionChoices, - default=AccessListActionChoices.ACTION_PERMIT, - max_length=30, - ) - remark = models.CharField( - max_length=200, + protocol = models.CharField( blank=True, - null=True + choices=AccessListProtocolChoices, + max_length=30, ) class Meta: @@ -134,11 +178,11 @@ class AccessListExtendedRule(NetBoxModel): def __str__(self): return f'{self.access_list}: Rule {self.index}' + def get_action_color(self): + return AccessListActionChoices.colors.get(self.action) + def get_absolute_url(self): return reverse('plugins:netbox_access_lists:accesslistextendedrule', args=[self.pk]) def get_protocol_color(self): return AccessListProtocolChoices.colors.get(self.protocol) - - def get_action_color(self): - return AccessListActionChoices.colors.get(self.action) diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index abde06e..9265dd6 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -11,6 +11,15 @@ accesslist_buttons = [ ) ] +#accessliststandardrule_butons = [ +# PluginMenuButton( +# link='plugins:netbox_access_lists:accessliststandardrule_add', +# title='Add', +# icon_class='mdi mdi-plus-thick', +# color=ButtonColorChoices.GREEN +# ) +#] + accesslistextendedrule_butons = [ PluginMenuButton( link='plugins:netbox_access_lists:accesslistextendedrule_add', @@ -26,7 +35,13 @@ menu_items = ( link_text='Access Lists', buttons=accesslist_buttons ), - # # Comment out Access List Rule to force creation in the ACL view + # # Comment out Standard Access List Rule to force creation in the ACL view + # PluginMenuItem( + # link='plugins:netbox_access_lists:accessliststandardrule_list', + # link_text='Access List Rules', + # buttons=accessliststandardrule_butons + # ), + # # Comment out Extended Access List Rule to force creation in the ACL view # PluginMenuItem( # link='plugins:netbox_access_lists:accesslistextendedrule_list', # link_text='Access List Rules', diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index ae49355..a89d5b4 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns, ChoiceFieldColumn -from .models import AccessList, AccessListExtendedRule +from .models import AccessList, AccessListExtendedRule, AccessListStandardRule class AccessListTable(NetBoxTable): @@ -26,6 +26,26 @@ class AccessListTable(NetBoxTable): default_columns = ('name', 'device', 'type', 'rule_count', 'default_action', 'tags') +class AccessListStandardRuleTable(NetBoxTable): + access_list = tables.Column( + linkify=True + ) + index = tables.Column( + linkify=True + ) + action = ChoiceFieldColumn() + tags = columns.TagColumn( + url_name='plugins:netbox_access_lists:accessliststandardrule_list' + ) + class Meta(NetBoxTable.Meta): + model = AccessListStandardRule + fields = ( + 'pk', 'id', 'access_list', 'index', 'source_prefix', 'action', 'remark', 'tags' + ) + default_columns = ( + 'access_list', 'index', 'source_prefix', 'action', 'remark', 'tags' + ) + class AccessListExtendedRuleTable(NetBoxTable): access_list = tables.Column( linkify=True diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslist.html b/netbox_access_lists/templates/netbox_access_lists/accesslist.html index 7939e50..9870749 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accesslist.html +++ b/netbox_access_lists/templates/netbox_access_lists/accesslist.html @@ -7,7 +7,11 @@ {% block controls %}
{% if perms.netbox_access_lists.change_policy %} + {% if object.type == 'extended' %} + {% elif object.type == 'standard' %} + + {% endif %} Rule {% endif %} @@ -74,7 +78,7 @@
-
Rules
+
{{ object.get_type_display }} Rules
{% render_table rules_table %}
diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index c5cdc32..0ade3db 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -16,13 +16,23 @@ urlpatterns = ( 'model': models.AccessList }), - # Access list rules - path('rules/', views.AccessListExtendedRuleListView.as_view(), name='accesslistextendedrule_list'), - path('rules/add/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_add'), - path('rules//', views.AccessListExtendedRuleView.as_view(), name='accesslistextendedrule'), - path('rules//edit/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_edit'), - path('rules//delete/', views.AccessListExtendedRuleDeleteView.as_view(), name='accesslistextendedrule_delete'), - path('rules//changelog/', ObjectChangeLogView.as_view(), name='accesslistextendedrule_changelog', kwargs={ + # Standard Access list rules + path('standard-rules/', views.AccessListStandardRuleListView.as_view(), name='accessliststandardrule_list'), + path('standard-rules/add/', views.AccessListStandardRuleEditView.as_view(), name='accessliststandardrule_add'), + path('standard-rules//', views.AccessListStandardRuleView.as_view(), name='accessliststandardrule'), + path('standard-rules//edit/', views.AccessListStandardRuleEditView.as_view(), name='accessliststandardrule_edit'), + path('standard-rules//delete/', views.AccessListStandardRuleDeleteView.as_view(), name='accessliststandardrule_delete'), + path('standard-rules//changelog/', ObjectChangeLogView.as_view(), name='accessliststandardrule_changelog', kwargs={ + 'model': models.AccessListStandardRule + }), + + # Extended Access list rules + path('extended-rules/', views.AccessListExtendedRuleListView.as_view(), name='accesslistextendedrule_list'), + path('extended-rules/add/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_add'), + path('extended-rules//', views.AccessListExtendedRuleView.as_view(), name='accesslistextendedrule'), + path('extended-rules//edit/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_edit'), + path('extended-rules//delete/', views.AccessListExtendedRuleDeleteView.as_view(), name='accesslistextendedrule_delete'), + path('extended-rules//changelog/', ObjectChangeLogView.as_view(), name='accesslistextendedrule_changelog', kwargs={ 'model': models.AccessListExtendedRule }), diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 66bb406..fb30e85 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -12,17 +12,20 @@ class AccessListView(generic.ObjectView): queryset = models.AccessList.objects.all() def get_extra_context(self, request, instance): - table = tables.AccessListExtendedRuleTable(instance.rules.all()) + if instance.type == 'extended': + table = tables.AccessListExtendedRuleTable(instance.rules.all()) + elif instance.type == 'standard': + table = tables.AccessListStandardRuleTable(instance.standard_acl_rules.all()) table.configure(request) return { - 'rules_table': table, + 'rules_table': table } class AccessListListView(generic.ObjectListView): queryset = models.AccessList.objects.annotate( - rule_count=Count('rules') + rule_count=Count('rules') + Count('standard_acl_rules') ) table = tables.AccessListTable filterset = filtersets.AccessListFilterSet @@ -38,6 +41,30 @@ class AccessListDeleteView(generic.ObjectDeleteView): queryset = models.AccessList.objects.all() +# +# AccessListStandardRule views +# + +class AccessListStandardRuleView(generic.ObjectView): + queryset = models.AccessListStandardRule.objects.all() + + +class AccessListStandardRuleListView(generic.ObjectListView): + queryset = models.AccessListStandardRule.objects.all() + table = tables.AccessListStandardRuleTable + filterset = filtersets.AccessListStandardRuleFilterSet + filterset_form = forms.AccessListStandardRuleFilterForm + + +class AccessListStandardRuleEditView(generic.ObjectEditView): + queryset = models.AccessListStandardRule.objects.all() + form = forms.AccessListStandardRuleForm + + +class AccessListStandardRuleDeleteView(generic.ObjectDeleteView): + queryset = models.AccessListStandardRule.objects.all() + + # # AccessListExtendedRule views # From 67d40d1e183ebf8489528eeb6c80fc6f1eb2b55d Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Fri, 15 Jul 2022 22:45:44 +0000 Subject: [PATCH 03/38] add navigation --- netbox_access_lists/navigation.py | 40 +++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index 9265dd6..fc4ed97 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -11,14 +11,14 @@ accesslist_buttons = [ ) ] -#accessliststandardrule_butons = [ -# PluginMenuButton( -# link='plugins:netbox_access_lists:accessliststandardrule_add', -# title='Add', -# icon_class='mdi mdi-plus-thick', -# color=ButtonColorChoices.GREEN -# ) -#] +accessliststandardrule_butons = [ + PluginMenuButton( + link='plugins:netbox_access_lists:accessliststandardrule_add', + title='Add', + icon_class='mdi mdi-plus-thick', + color=ButtonColorChoices.GREEN + ) +] accesslistextendedrule_butons = [ PluginMenuButton( @@ -35,16 +35,16 @@ menu_items = ( link_text='Access Lists', buttons=accesslist_buttons ), - # # Comment out Standard Access List Rule to force creation in the ACL view - # PluginMenuItem( - # link='plugins:netbox_access_lists:accessliststandardrule_list', - # link_text='Access List Rules', - # buttons=accessliststandardrule_butons - # ), - # # Comment out Extended Access List Rule to force creation in the ACL view - # PluginMenuItem( - # link='plugins:netbox_access_lists:accesslistextendedrule_list', - # link_text='Access List Rules', - # buttons=accesslistextendedrule_butons - # ), + # Comment out Standard Access List Rule to force creation in the ACL view + PluginMenuItem( + link='plugins:netbox_access_lists:accessliststandardrule_list', + link_text='Standard Access List Rules', + buttons=accessliststandardrule_butons + ), + # Comment out Extended Access List Rule to force creation in the ACL view + PluginMenuItem( + link='plugins:netbox_access_lists:accesslistextendedrule_list', + link_text='Extended Access List Rules', + buttons=accesslistextendedrule_butons + ), ) From cb0117ae944417733893fe0ee08ea794d15fc8cc Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Fri, 15 Jul 2022 22:46:07 +0000 Subject: [PATCH 04/38] add standardacl template --- .../accessliststandardrule.html | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html diff --git a/netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html b/netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html new file mode 100644 index 0000000..ea5e41e --- /dev/null +++ b/netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html @@ -0,0 +1,76 @@ +{% extends 'generic/object.html' %} + +{% block content %} +
+
+
+
Access List Rule
+
+ + + + + + + + + +
Access List + {{ object.access_list }} +
Index{{ object.index }}
+
+
+ {% include 'inc/panels/custom_fields.html' %} + {% include 'inc/panels/tags.html' %} +
+
+
+
Details
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Remark{{ object.get_remark_display|placeholder }}
Protocol{{ object.get_protocol_display|placeholder }}
Source Prefix + {% if object.source_prefix %} + {{ object.source_prefix }} + {% else %} + {{ ''|placeholder }} + {% endif %} +
Source Ports{{ object.source_ports|join:", "|placeholder }}
Destination Prefix + {% if object.destination_prefix %} + {{ object.destination_prefix }} + {% else %} + {{ ''|placeholder }} + {% endif %} +
Destination Ports{{ object.destination_ports|join:", "|placeholder }}
Action{{ object.get_action_display }}
+
+
+
+
+{% endblock content %} From 00e707f27d8942560922e00fb1be0f31eec059ea Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Fri, 15 Jul 2022 23:00:53 +0000 Subject: [PATCH 05/38] remove required fields --- netbox_access_lists/forms.py | 9 ++++++--- netbox_access_lists/models.py | 4 ++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index 363cbd8..a7f469f 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -42,10 +42,12 @@ class AccessListExtendedRuleForm(NetBoxModelForm): } ) source_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all() + queryset=Prefix.objects.all(), + required=False ) destination_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all() + queryset=Prefix.objects.all(), + required=False ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), @@ -91,7 +93,8 @@ class AccessListStandardRuleForm(NetBoxModelForm): } ) source_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all() + queryset=Prefix.objects.all(), + required=False ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index a300808..c430248 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -92,6 +92,8 @@ class AccessListStandardRule(NetBoxModel): null=True ) action = models.CharField( + blank=True, + null=True, choices=AccessListActionChoices, default=AccessListActionChoices.ACTION_PERMIT, max_length=30, @@ -133,6 +135,8 @@ class AccessListExtendedRule(NetBoxModel): null=True ) action = models.CharField( + blank=True, + null=True, choices=AccessListActionChoices, default=AccessListActionChoices.ACTION_PERMIT, max_length=30, From 588b5ee9511fd335bdaaaada16e7d9c0bcae3ea8 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sat, 16 Jul 2022 13:01:11 +0000 Subject: [PATCH 06/38] update devcontainer plugins --- .devcontainer/devcontainer.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index a56c043..a49e525 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -65,7 +65,9 @@ "aaron-bond.better-comments", "GitHub.codespaces", "codezombiech.gitignore", - "Tyriar.sort-lines" + "Tyriar.sort-lines", + "GitHub.vscode-pull-request-github", + "sourcery.sourcery" ] } }, From 6dee870249763542cd7956e0251e8611f69ca02e Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sat, 16 Jul 2022 13:29:22 +0000 Subject: [PATCH 07/38] update extendedACL related_name --- netbox_access_lists/api/views.py | 2 +- netbox_access_lists/migrations/0001_accesslist.py | 4 ++-- netbox_access_lists/models.py | 2 +- netbox_access_lists/views.py | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index 4272871..e0d4dd4 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -10,7 +10,7 @@ class AccessListViewSet(NetBoxModelViewSet): queryset = models.AccessList.objects.prefetch_related( 'device', 'tags' ).annotate( - rule_count=Count('rules') + rule_count=Count('extended_acl_rules') + Count('standard_acl_rules') ) serializer_class = AccessListSerializer filterset_class = filtersets.AccessListFilterSet diff --git a/netbox_access_lists/migrations/0001_accesslist.py b/netbox_access_lists/migrations/0001_accesslist.py index 492c685..561d27e 100644 --- a/netbox_access_lists/migrations/0001_accesslist.py +++ b/netbox_access_lists/migrations/0001_accesslist.py @@ -43,7 +43,7 @@ class Migration(migrations.Migration): ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ('index', models.PositiveIntegerField()), - ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='netbox_access_lists.accesslist')), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='standard_acl_rules', to='netbox_access_lists.accesslist')), ('remark', models.CharField(blank=True, null=True, max_length=500)), ('action', models.CharField(max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), @@ -62,7 +62,7 @@ class Migration(migrations.Migration): ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ('index', models.PositiveIntegerField()), - ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rules', to='netbox_access_lists.accesslist')), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='extended_acl_rules', to='netbox_access_lists.accesslist')), ('remark', models.CharField(blank=True, null=True, max_length=500)), ('action', models.CharField(max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index c430248..4ec2647 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -124,7 +124,7 @@ class AccessListStandardRule(NetBoxModel): class AccessListExtendedRule(NetBoxModel): access_list = models.ForeignKey( on_delete=models.CASCADE, - related_name='rules', + related_name='extended_acl_rules', to=AccessList, verbose_name='Access List' ) diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index fb30e85..829760c 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -13,7 +13,7 @@ class AccessListView(generic.ObjectView): def get_extra_context(self, request, instance): if instance.type == 'extended': - table = tables.AccessListExtendedRuleTable(instance.rules.all()) + table = tables.AccessListExtendedRuleTable(instance.extended_acl_rules.all()) elif instance.type == 'standard': table = tables.AccessListStandardRuleTable(instance.standard_acl_rules.all()) table.configure(request) @@ -25,7 +25,7 @@ class AccessListView(generic.ObjectView): class AccessListListView(generic.ObjectListView): queryset = models.AccessList.objects.annotate( - rule_count=Count('rules') + Count('standard_acl_rules') + rule_count=Count('extended_acl_rules') + Count('standard_acl_rules') ) table = tables.AccessListTable filterset = filtersets.AccessListFilterSet From f46141361966967c1a6f029799d51e33deecb10d Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sat, 16 Jul 2022 14:41:56 +0000 Subject: [PATCH 08/38] correct api issues --- netbox_access_lists/api/serializers.py | 10 +-- netbox_access_lists/api/urls.py | 3 +- netbox_access_lists/api/views.py | 4 +- netbox_access_lists/filtersets.py | 20 ++--- netbox_access_lists/forms.py | 114 +++++++++++++------------ netbox_access_lists/tables.py | 15 ++-- 6 files changed, 85 insertions(+), 81 deletions(-) diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index 3717793..2b885e3 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -69,8 +69,8 @@ class AccessListStandardRuleSerializer(NetBoxModelSerializer): class Meta: model = AccessListStandardRule fields = ( - 'id', 'url', 'display', 'access_list', 'index', 'source_prefix', 'action', - 'tags', 'custom_fields', 'created', 'last_updated' + 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', + 'created', 'custom_fields', 'last_updated', 'source_prefix' ) @@ -85,7 +85,7 @@ class AccessListExtendedRuleSerializer(NetBoxModelSerializer): class Meta: model = AccessListExtendedRule fields = ( - 'id', 'url', 'display', 'access_list', 'index', 'protocol', 'source_prefix', 'source_ports', - 'destination_prefix', 'destination_ports', 'action', 'tags', 'custom_fields', 'created', - 'last_updated' + 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', + 'created', 'custom_fields', 'last_updated', 'source_prefix', 'source_ports', + 'destination_prefix', 'destination_ports', 'protocol' ) diff --git a/netbox_access_lists/api/urls.py b/netbox_access_lists/api/urls.py index 358e620..411ee89 100644 --- a/netbox_access_lists/api/urls.py +++ b/netbox_access_lists/api/urls.py @@ -6,6 +6,7 @@ app_name = 'netbox_access_list' router = NetBoxRouter() router.register('access-lists', views.AccessListViewSet) -router.register('access-list-rules', views.AccessListExtendedRuleViewSet) +router.register('standard-acl-rules', views.AccessListStandardRuleViewSet) +router.register('extended-acl-rules', views.AccessListExtendedRuleViewSet) urlpatterns = router.urls diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index e0d4dd4..ead8156 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -18,7 +18,7 @@ class AccessListViewSet(NetBoxModelViewSet): class AccessListStandardRuleViewSet(NetBoxModelViewSet): queryset = models.AccessListStandardRule.objects.prefetch_related( - 'access_list', 'source_prefix', 'tags' + 'access_list', 'tags', 'source_prefix' ) serializer_class = AccessListStandardRuleSerializer filterset_class = filtersets.AccessListStandardRuleFilterSet @@ -26,7 +26,7 @@ class AccessListStandardRuleViewSet(NetBoxModelViewSet): class AccessListExtendedRuleViewSet(NetBoxModelViewSet): queryset = models.AccessListExtendedRule.objects.prefetch_related( - 'access_list', 'source_prefix', 'destination_prefix', 'tags' + 'access_list', 'tags', 'source_prefix', 'destination_prefix', ) serializer_class = AccessListExtendedRuleSerializer filterset_class = filtersets.AccessListExtendedRuleFilterSet diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index 5f76d81..f4bc50d 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -11,16 +11,6 @@ class AccessListFilterSet(NetBoxModelFilterSet): return queryset.filter(description__icontains=value) -class AccessListExtendedRuleFilterSet(NetBoxModelFilterSet): - - class Meta: - model = AccessListExtendedRule - fields = ('id', 'access_list', 'index', 'protocol', 'action', 'remark') - - def search(self, queryset, name, value): - return queryset.filter(description__icontains=value) - - class AccessListStandardRuleFilterSet(NetBoxModelFilterSet): class Meta: @@ -29,3 +19,13 @@ class AccessListStandardRuleFilterSet(NetBoxModelFilterSet): def search(self, queryset, name, value): return queryset.filter(description__icontains=value) + + +class AccessListExtendedRuleFilterSet(NetBoxModelFilterSet): + + class Meta: + model = AccessListExtendedRule + fields = ('id', 'access_list', 'index', 'action', 'remark', 'protocol') + + def search(self, queryset, name, value): + return queryset.filter(description__icontains=value) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index a7f469f..fa42a56 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -34,57 +34,6 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): tag = TagFilterField(model) -class AccessListExtendedRuleForm(NetBoxModelForm): - access_list = DynamicModelChoiceField( - queryset=AccessList.objects.all(), - query_params={ - 'type': 'extended' - } - ) - source_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all(), - required=False - ) - destination_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all(), - required=False - ) - tags = DynamicModelMultipleChoiceField( - queryset=Tag.objects.all(), - required=False - ) - - class Meta: - model = AccessListExtendedRule - fields = ( - 'access_list', 'index', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', - 'destination_ports', 'protocol', 'action', 'tags' - ) - - -class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): - model = AccessListExtendedRule - access_list = forms.ModelMultipleChoiceField( - queryset=AccessList.objects.all(), - required=False, - widget=StaticSelectMultiple() - ) - index = forms.IntegerField( - required=False - ) - protocol = forms.MultipleChoiceField( - choices=AccessListProtocolChoices, - required=False, - widget=StaticSelectMultiple() - ) - action = forms.MultipleChoiceField( - choices=AccessListActionChoices, - required=False, - widget=StaticSelectMultiple() - ) - tag = TagFilterField(model) - - class AccessListStandardRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), @@ -92,19 +41,20 @@ class AccessListStandardRuleForm(NetBoxModelForm): 'type': 'standard' } ) - source_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all(), - required=False - ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), required=False ) + source_prefix = DynamicModelChoiceField( + queryset=Prefix.objects.all(), + required=False + ) + class Meta: model = AccessListStandardRule fields = ( - 'access_list', 'index', 'remark', 'source_prefix', 'action', 'tags' + 'access_list', 'index', 'remark', 'action', 'tags', 'source_prefix', ) @@ -118,9 +68,61 @@ class AccessListStandardRuleFilterForm(NetBoxModelFilterSetForm): index = forms.IntegerField( required=False ) + tag = TagFilterField(model) action = forms.MultipleChoiceField( choices=AccessListActionChoices, required=False, widget=StaticSelectMultiple() ) + + +class AccessListExtendedRuleForm(NetBoxModelForm): + access_list = DynamicModelChoiceField( + queryset=AccessList.objects.all(), + query_params={ + 'type': 'extended' + } + ) + tags = DynamicModelMultipleChoiceField( + queryset=Tag.objects.all(), + required=False + ) + source_prefix = DynamicModelChoiceField( + queryset=Prefix.objects.all(), + required=False + ) + destination_prefix = DynamicModelChoiceField( + queryset=Prefix.objects.all(), + required=False + ) + + + class Meta: + model = AccessListExtendedRule + fields = ( + 'access_list', 'index', 'remark', 'action', 'tags', 'source_prefix', + 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' + ) + + +class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): + model = AccessListExtendedRule + access_list = forms.ModelMultipleChoiceField( + queryset=AccessList.objects.all(), + required=False, + widget=StaticSelectMultiple() + ) + index = forms.IntegerField( + required=False + ) tag = TagFilterField(model) + action = forms.MultipleChoiceField( + choices=AccessListActionChoices, + required=False, + widget=StaticSelectMultiple() + ) + protocol = forms.MultipleChoiceField( + choices=AccessListProtocolChoices, + required=False, + widget=StaticSelectMultiple() + ) diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index a89d5b4..5a5bf57 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -40,12 +40,13 @@ class AccessListStandardRuleTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = AccessListStandardRule fields = ( - 'pk', 'id', 'access_list', 'index', 'source_prefix', 'action', 'remark', 'tags' + 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags' ) default_columns = ( - 'access_list', 'index', 'source_prefix', 'action', 'remark', 'tags' + 'access_list', 'index', 'action', 'actions', 'remark', 'tags' ) + class AccessListExtendedRuleTable(NetBoxTable): access_list = tables.Column( linkify=True @@ -53,19 +54,19 @@ class AccessListExtendedRuleTable(NetBoxTable): index = tables.Column( linkify=True ) - protocol = ChoiceFieldColumn() action = ChoiceFieldColumn() tags = columns.TagColumn( url_name='plugins:netbox_access_lists:accesslistextendedrule_list' ) + protocol = ChoiceFieldColumn() class Meta(NetBoxTable.Meta): model = AccessListExtendedRule fields = ( - 'pk', 'id', 'access_list', 'index', 'source_prefix', 'source_ports', 'destination_prefix', - 'destination_ports', 'protocol', 'action', 'remark', 'actions', 'tags' + 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags', + 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' ) default_columns = ( - 'access_list', 'index', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', - 'destination_ports', 'protocol', 'action', 'actions', 'tags' + 'access_list', 'index', 'action', 'actions', 'remark', 'tags', + 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' ) From 8186fbb6b541b75fc71dfe09da27a637e0cbe512 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sat, 16 Jul 2022 17:25:54 +0000 Subject: [PATCH 09/38] from logic --- netbox_access_lists/forms.py | 47 +++++++++++++++++++ .../migrations/0001_accesslist.py | 4 +- netbox_access_lists/models.py | 2 - 3 files changed, 49 insertions(+), 4 deletions(-) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index fa42a56..8d0a552 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -1,4 +1,5 @@ from django import forms +from django.core.exceptions import ValidationError from extras.models import Tag from ipam.models import Prefix @@ -18,6 +19,22 @@ class AccessListForm(NetBoxModelForm): model = AccessList fields = ('name', 'device', 'type', 'default_action', 'comments', 'tags') + #def validate_unique(self, value): + # accesslists = AccessList.objects.exclude(pk=self.pk) + # if accesslists.filter(name=self.name, device=self.device).exists(): + # raise ValidationError({ + # "name": f"An Access List with this name on device {self.device} already exists." + # }) + + def clean(self): + cleaned_data = super().clean() + if self.errors.get('name'): + return cleaned_data + name = cleaned_data.get('name') + device = cleaned_data.get('device') + if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): + raise forms.ValidationError('An Access-List with this name on this device already exists.') + return cleaned_data class AccessListFilterForm(NetBoxModelFilterSetForm): model = AccessList @@ -57,6 +74,17 @@ class AccessListStandardRuleForm(NetBoxModelForm): 'access_list', 'index', 'remark', 'action', 'tags', 'source_prefix', ) + def clean(self): + cleaned_data = super().clean() + if cleaned_data.get('remark'): + if cleaned_data.get('action'): + raise forms.ValidationError('Cannot input a remark AND an action. Remove one.') + if cleaned_data.get('source_prefix'): + raise forms.ValidationError('Cannot input a remark AND a source prefix. Remove one.') + #if cleaned_data.get('access_list_type') == 'standard' and (source_ports or destination_prefix or destination_ports): + # raise forms.ValidationError('Standard Access-Lists only allow a source_prefix or remark') + return cleaned_data + class AccessListStandardRuleFilterForm(NetBoxModelFilterSetForm): model = AccessListStandardRule @@ -104,6 +132,25 @@ class AccessListExtendedRuleForm(NetBoxModelForm): 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' ) + def clean(self): + cleaned_data = super().clean() + if cleaned_data.get('remark'): + if cleaned_data.get('action'): + raise forms.ValidationError('Cannot input a remark AND an action. Remove one.') + if cleaned_data.get('source_prefix'): + raise forms.ValidationError('Cannot input a remark AND a source prefix. Remove one.') + if cleaned_data.get('source_ports'): + raise forms.ValidationError('Cannot input a remark AND source ports. Remove one.') + if cleaned_data.get('destination_prefix'): + raise forms.ValidationError('Cannot input a remark AND a destination prefix. Remove one.') + if cleaned_data.get('destination_ports'): + raise forms.ValidationError('Cannot input a remark AND destination ports. Remove one.') + if cleaned_data.get('protocol'): + raise forms.ValidationError('Cannot input a remark AND a protocol. Remove one.') + #if cleaned_data.get('access_list_type') == 'standard' and (source_ports or destination_prefix or destination_ports): + # raise forms.ValidationError('Standard Access-Lists only allow a source_prefix or remark') + return cleaned_data + class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): model = AccessListExtendedRule diff --git a/netbox_access_lists/migrations/0001_accesslist.py b/netbox_access_lists/migrations/0001_accesslist.py index 561d27e..a2e84c9 100644 --- a/netbox_access_lists/migrations/0001_accesslist.py +++ b/netbox_access_lists/migrations/0001_accesslist.py @@ -45,7 +45,7 @@ class Migration(migrations.Migration): ('index', models.PositiveIntegerField()), ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='standard_acl_rules', to='netbox_access_lists.accesslist')), ('remark', models.CharField(blank=True, null=True, max_length=500)), - ('action', models.CharField(max_length=30)), + ('action', models.CharField(blank=True, null=True, max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), ], options={ @@ -64,7 +64,7 @@ class Migration(migrations.Migration): ('index', models.PositiveIntegerField()), ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='extended_acl_rules', to='netbox_access_lists.accesslist')), ('remark', models.CharField(blank=True, null=True, max_length=500)), - ('action', models.CharField(max_length=30)), + ('action', models.CharField(blank=True, null=True, max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), ('source_ports', django.contrib.postgres.fields.ArrayField(base_field=models.PositiveIntegerField(), blank=True, null=True, size=None)), ('destination_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 4ec2647..92fe77f 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -95,7 +95,6 @@ class AccessListStandardRule(NetBoxModel): blank=True, null=True, choices=AccessListActionChoices, - default=AccessListActionChoices.ACTION_PERMIT, max_length=30, ) source_prefix = models.ForeignKey( @@ -138,7 +137,6 @@ class AccessListExtendedRule(NetBoxModel): blank=True, null=True, choices=AccessListActionChoices, - default=AccessListActionChoices.ACTION_PERMIT, max_length=30, ) source_prefix = models.ForeignKey( From 2b821c1e3f87a0db76ec3b86e065b165f5ab76c0 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sun, 17 Jul 2022 05:55:31 +0000 Subject: [PATCH 10/38] update existing ACL error --- netbox_access_lists/forms.py | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index 8d0a552..cb18e37 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -19,13 +19,6 @@ class AccessListForm(NetBoxModelForm): model = AccessList fields = ('name', 'device', 'type', 'default_action', 'comments', 'tags') - #def validate_unique(self, value): - # accesslists = AccessList.objects.exclude(pk=self.pk) - # if accesslists.filter(name=self.name, device=self.device).exists(): - # raise ValidationError({ - # "name": f"An Access List with this name on device {self.device} already exists." - # }) - def clean(self): cleaned_data = super().clean() if self.errors.get('name'): @@ -33,7 +26,7 @@ class AccessListForm(NetBoxModelForm): name = cleaned_data.get('name') device = cleaned_data.get('device') if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): - raise forms.ValidationError('An Access-List with this name on this device already exists.') + raise forms.ValidationError('An Access-List with this name is already associated to this device.') return cleaned_data class AccessListFilterForm(NetBoxModelFilterSetForm): From 47c64ebd42ed13770381dae57dec69935511681c Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sun, 17 Jul 2022 17:12:59 +0000 Subject: [PATCH 11/38] form fieldsets --- netbox_access_lists/forms.py | 100 ++++++++++++++++++++++++++++------- 1 file changed, 82 insertions(+), 18 deletions(-) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index cb18e37..1c969f7 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -1,5 +1,6 @@ from django import forms from django.core.exceptions import ValidationError +from django.utils.safestring import mark_safe from extras.models import Tag from ipam.models import Prefix @@ -8,6 +9,8 @@ from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelM from .models import AccessList, AccessListExtendedRule, AccessListActionChoices, AccessListProtocolChoices, AccessListTypeChoices, AccessListStandardRule +acl_rule_logic_help = mark_safe('*Note: CANNOT be set if remark is set.') + class AccessListForm(NetBoxModelForm): comments = CommentField() tags = DynamicModelMultipleChoiceField( @@ -15,9 +18,18 @@ class AccessListForm(NetBoxModelForm): required=False ) + fieldsets = [ + ('Access-List Details', ('name', 'device', 'type', 'default_action', 'tags')), + ] + class Meta: model = AccessList fields = ('name', 'device', 'type', 'default_action', 'comments', 'tags') + help_texts = { + 'default_action': 'The default behavior of the ACL.', + 'name': 'The name uniqueness per device is case insensitive.', + 'type': 'Sets the type of the ACL & its rules.', + } def clean(self): cleaned_data = super().clean() @@ -26,7 +38,7 @@ class AccessListForm(NetBoxModelForm): name = cleaned_data.get('name') device = cleaned_data.get('device') if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): - raise forms.ValidationError('An Access-List with this name is already associated to this device.') + raise forms.ValidationError('An ACL with this name (case insensitive) is already associated to this device.') return cleaned_data class AccessListFilterForm(NetBoxModelFilterSetForm): @@ -34,7 +46,7 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): type = forms.MultipleChoiceField( choices=AccessListTypeChoices, required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), ) default_action = forms.MultipleChoiceField( choices=AccessListActionChoices, @@ -43,29 +55,46 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): ) tag = TagFilterField(model) + fieldsets = ( + (None, ('q', 'tag')), + ('ACL Details', ('type', 'default_action')), + ) + class AccessListStandardRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), query_params={ 'type': 'standard' - } + }, + help_text=mark_safe('*Note: This field will only display Standard ACLs.'), + ) + source_prefix = DynamicModelChoiceField( + queryset=Prefix.objects.all(), + required=False, + help_text=acl_rule_logic_help, ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), required=False ) - source_prefix = DynamicModelChoiceField( - queryset=Prefix.objects.all(), - required=False - ) + fieldsets = ( + ('Access-List Details', ('access_list', 'index', 'tags')), + ('Rule Logic', ('remark', 'action', 'source_prefix')), + ) class Meta: model = AccessListStandardRule fields = ( - 'access_list', 'index', 'remark', 'action', 'tags', 'source_prefix', + 'access_list', 'index', 'remark', 'action', 'source_prefix', + 'tags', ) + help_texts = { + 'action': acl_rule_logic_help, + 'index': 'Determines the order of the rule in the ACL processing.', + 'remark': mark_safe('*Note: CANNOT be set if source prefix OR action is set.'), + } def clean(self): cleaned_data = super().clean() @@ -86,23 +115,29 @@ class AccessListStandardRuleFilterForm(NetBoxModelFilterSetForm): required=False, widget=StaticSelectMultiple() ) - index = forms.IntegerField( - required=False - ) tag = TagFilterField(model) + source_prefix = forms.ModelMultipleChoiceField( + queryset=Prefix.objects.all(), + required=False, + widget=StaticSelectMultiple() + ) action = forms.MultipleChoiceField( choices=AccessListActionChoices, required=False, widget=StaticSelectMultiple() ) - + fieldsets = ( + (None, ('q', 'tag')), + ('Rule Details', ('access_list', 'action', 'source_prefix',)), + ) class AccessListExtendedRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), query_params={ 'type': 'extended' - } + }, + help_text=mark_safe('*Note: This field will only display Extended ACLs.'), ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), @@ -110,20 +145,34 @@ class AccessListExtendedRuleForm(NetBoxModelForm): ) source_prefix = DynamicModelChoiceField( queryset=Prefix.objects.all(), - required=False + required=False, + help_text=acl_rule_logic_help, ) destination_prefix = DynamicModelChoiceField( queryset=Prefix.objects.all(), - required=False + required=False, + help_text=acl_rule_logic_help, + ) + fieldsets = ( + ('Access-List Details', ('access_list', 'index', 'tags')), + ('Rule Details', ('remark', 'action', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol',)), ) - class Meta: model = AccessListExtendedRule fields = ( - 'access_list', 'index', 'remark', 'action', 'tags', 'source_prefix', - 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' + 'access_list', 'index', 'remark', 'action', 'source_prefix', + 'source_ports', 'destination_prefix', 'destination_ports', 'protocol', + 'tags' ) + help_texts = { + 'action': acl_rule_logic_help, + 'destination_ports': acl_rule_logic_help, + 'index': 'Determines the order of the rule in the ACL processing.', + 'protocol': acl_rule_logic_help, + 'remark': mark_safe('*Note: CANNOT be set if a prefix, port, OR action is set.'), + 'source_ports': acl_rule_logic_help, + } def clean(self): cleaned_data = super().clean() @@ -161,8 +210,23 @@ class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): required=False, widget=StaticSelectMultiple() ) + source_prefix = forms.ModelMultipleChoiceField( + queryset=Prefix.objects.all(), + required=False, + widget=StaticSelectMultiple() + ) + desintation_prefix = forms.ModelMultipleChoiceField( + queryset=Prefix.objects.all(), + required=False, + widget=StaticSelectMultiple() + ) protocol = forms.MultipleChoiceField( choices=AccessListProtocolChoices, required=False, widget=StaticSelectMultiple() ) + + fieldsets = ( + (None, ('q', 'tag')), + ('Rule Details', ('access_list', 'action', 'source_prefix', 'desintation_prefix', 'protocol')), + ) From 2828a355f26a30cfe60f74688bdfef04a24528db Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 11:49:10 +0000 Subject: [PATCH 12/38] organize template directories --- netbox_access_lists/template_content.py | 2 +- .../access_lists.html} | 2 +- .../{ => device}/assigned_access_lists.html | 0 ...textendedrule.html => aclextendedrule.html} | 0 ...tstandardrule.html => aclstandardrule.html} | 18 ------------------ 5 files changed, 2 insertions(+), 20 deletions(-) rename netbox_access_lists/templates/inc/{device_access_lists.html => device/access_lists.html} (87%) rename netbox_access_lists/templates/inc/{ => device}/assigned_access_lists.html (100%) rename netbox_access_lists/templates/netbox_access_lists/{accesslistextendedrule.html => aclextendedrule.html} (100%) rename netbox_access_lists/templates/netbox_access_lists/{accessliststandardrule.html => aclstandardrule.html} (72%) diff --git a/netbox_access_lists/template_content.py b/netbox_access_lists/template_content.py index 3fb339c..1431bd4 100644 --- a/netbox_access_lists/template_content.py +++ b/netbox_access_lists/template_content.py @@ -17,7 +17,7 @@ class AccessLists(PluginTemplateExtension): #elif ctype.model == 'virtualmachine': # access_lists = AccessList.objects.filter(device=obj.pk) - return self.render('inc/device_access_lists.html', extra_context={ + return self.render('inc/device/access_lists.html', extra_context={ 'access_lists': access_lists, 'type': ctype.model if ctype.model == 'device' else ctype.name.replace(' ', '_'), }) diff --git a/netbox_access_lists/templates/inc/device_access_lists.html b/netbox_access_lists/templates/inc/device/access_lists.html similarity index 87% rename from netbox_access_lists/templates/inc/device_access_lists.html rename to netbox_access_lists/templates/inc/device/access_lists.html index 074d028..7bdb9b9 100644 --- a/netbox_access_lists/templates/inc/device_access_lists.html +++ b/netbox_access_lists/templates/inc/device/access_lists.html @@ -3,7 +3,7 @@ Access Lists
- {% include 'inc/assigned_access_lists.html' %} + {% include 'inc/device/assigned_access_lists.html' %}
diff --git a/netbox_access_lists/templates/inc/assigned_access_lists.html b/netbox_access_lists/templates/inc/device/assigned_access_lists.html similarity index 100% rename from netbox_access_lists/templates/inc/assigned_access_lists.html rename to netbox_access_lists/templates/inc/device/assigned_access_lists.html diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslistextendedrule.html b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html similarity index 100% rename from netbox_access_lists/templates/netbox_access_lists/accesslistextendedrule.html rename to netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html diff --git a/netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html similarity index 72% rename from netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html rename to netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html index ea5e41e..f704727 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accessliststandardrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html @@ -46,24 +46,6 @@ {% endif %} - - Source Ports - {{ object.source_ports|join:", "|placeholder }} - - - Destination Prefix - - {% if object.destination_prefix %} - {{ object.destination_prefix }} - {% else %} - {{ ''|placeholder }} - {% endif %} - - - - Destination Ports - {{ object.destination_ports|join:", "|placeholder }} - Action {{ object.get_action_display }} From 9146af7ce9e01b596bf7895c70d7e6dbc674d4df Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 11:49:48 +0000 Subject: [PATCH 13/38] shorten class names --- netbox_access_lists/api/serializers.py | 26 ++++++------ netbox_access_lists/api/urls.py | 4 +- netbox_access_lists/api/views.py | 18 ++++----- netbox_access_lists/filtersets.py | 10 ++--- netbox_access_lists/forms.py | 53 ++++++++++++++---------- netbox_access_lists/graphql.py | 20 ++++----- netbox_access_lists/models.py | 44 ++++++++++---------- netbox_access_lists/navigation.py | 16 ++++---- netbox_access_lists/tables.py | 14 +++---- netbox_access_lists/urls.py | 28 ++++++------- netbox_access_lists/views.py | 56 +++++++++++++------------- 11 files changed, 150 insertions(+), 139 deletions(-) diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index 2b885e3..178c687 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from ipam.api.serializers import NestedPrefixSerializer from dcim.api.serializers import NestedDeviceSerializer from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer -from ..models import AccessList, AccessListExtendedRule, AccessListStandardRule +from ..models import AccessList, ACLExtendedRule, ACLStandardRule # @@ -20,23 +20,23 @@ class NestedAccessListSerializer(WritableNestedSerializer): fields = ('id', 'url', 'display', 'name', 'device') -class NestedAccessListStandardRuleSerializer(WritableNestedSerializer): +class NestedACLStandardRuleSerializer(WritableNestedSerializer): url = serializers.HyperlinkedIdentityField( - view_name='plugins-api:netbox_access_lists-api:accessliststandardrule-detail' + view_name='plugins-api:netbox_access_lists-api:aclstandardrule-detail' ) class Meta: - model = AccessListStandardRule + model = ACLStandardRule fields = ('id', 'url', 'display', 'index') -class NestedAccessListExtendedRuleSerializer(WritableNestedSerializer): +class NestedACLExtendedRuleSerializer(WritableNestedSerializer): url = serializers.HyperlinkedIdentityField( - view_name='plugins-api:netbox_access_lists-api:accesslistextendedrule-detail' + view_name='plugins-api:netbox_access_lists-api:aclextendedrule-detail' ) class Meta: - model = AccessListExtendedRule + model = ACLExtendedRule fields = ('id', 'url', 'display', 'index') @@ -59,31 +59,31 @@ class AccessListSerializer(NetBoxModelSerializer): ) -class AccessListStandardRuleSerializer(NetBoxModelSerializer): +class ACLStandardRuleSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField( - view_name='plugins-api:netbox_access_lists-api:accessliststandardrule-detail' + view_name='plugins-api:netbox_access_lists-api:aclstandardrule-detail' ) access_list = NestedAccessListSerializer() source_prefix = NestedPrefixSerializer() class Meta: - model = AccessListStandardRule + model = ACLStandardRule fields = ( 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', 'created', 'custom_fields', 'last_updated', 'source_prefix' ) -class AccessListExtendedRuleSerializer(NetBoxModelSerializer): +class ACLExtendedRuleSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField( - view_name='plugins-api:netbox_access_lists-api:accesslistextendedrule-detail' + view_name='plugins-api:netbox_access_lists-api:aclextendedrule-detail' ) access_list = NestedAccessListSerializer() source_prefix = NestedPrefixSerializer() destination_prefix = NestedPrefixSerializer() class Meta: - model = AccessListExtendedRule + model = ACLExtendedRule fields = ( 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', 'created', 'custom_fields', 'last_updated', 'source_prefix', 'source_ports', diff --git a/netbox_access_lists/api/urls.py b/netbox_access_lists/api/urls.py index 411ee89..07eb605 100644 --- a/netbox_access_lists/api/urls.py +++ b/netbox_access_lists/api/urls.py @@ -6,7 +6,7 @@ app_name = 'netbox_access_list' router = NetBoxRouter() router.register('access-lists', views.AccessListViewSet) -router.register('standard-acl-rules', views.AccessListStandardRuleViewSet) -router.register('extended-acl-rules', views.AccessListExtendedRuleViewSet) +router.register('standard-acl-rules', views.ACLStandardRuleViewSet) +router.register('extended-acl-rules', views.ACLExtendedRuleViewSet) urlpatterns = router.urls diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index ead8156..127ecfd 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -3,7 +3,7 @@ from django.db.models import Count from netbox.api.viewsets import NetBoxModelViewSet from .. import filtersets, models -from .serializers import AccessListSerializer, AccessListExtendedRuleSerializer, AccessListStandardRuleSerializer +from .serializers import AccessListSerializer, ACLExtendedRuleSerializer, ACLStandardRuleSerializer class AccessListViewSet(NetBoxModelViewSet): @@ -16,17 +16,17 @@ class AccessListViewSet(NetBoxModelViewSet): filterset_class = filtersets.AccessListFilterSet -class AccessListStandardRuleViewSet(NetBoxModelViewSet): - queryset = models.AccessListStandardRule.objects.prefetch_related( +class ACLStandardRuleViewSet(NetBoxModelViewSet): + queryset = models.ACLStandardRule.objects.prefetch_related( 'access_list', 'tags', 'source_prefix' ) - serializer_class = AccessListStandardRuleSerializer - filterset_class = filtersets.AccessListStandardRuleFilterSet + serializer_class = ACLStandardRuleSerializer + filterset_class = filtersets.ACLStandardRuleFilterSet -class AccessListExtendedRuleViewSet(NetBoxModelViewSet): - queryset = models.AccessListExtendedRule.objects.prefetch_related( +class ACLExtendedRuleViewSet(NetBoxModelViewSet): + queryset = models.ACLExtendedRule.objects.prefetch_related( 'access_list', 'tags', 'source_prefix', 'destination_prefix', ) - serializer_class = AccessListExtendedRuleSerializer - filterset_class = filtersets.AccessListExtendedRuleFilterSet + serializer_class = ACLExtendedRuleSerializer + filterset_class = filtersets.ACLExtendedRuleFilterSet diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index f4bc50d..8549c71 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -1,5 +1,5 @@ from netbox.filtersets import NetBoxModelFilterSet -from .models import AccessList, AccessListExtendedRule, AccessListStandardRule +from .models import AccessList, ACLExtendedRule, ACLStandardRule class AccessListFilterSet(NetBoxModelFilterSet): @@ -11,20 +11,20 @@ class AccessListFilterSet(NetBoxModelFilterSet): return queryset.filter(description__icontains=value) -class AccessListStandardRuleFilterSet(NetBoxModelFilterSet): +class ACLStandardRuleFilterSet(NetBoxModelFilterSet): class Meta: - model = AccessListStandardRule + model = ACLStandardRule fields = ('id', 'access_list', 'index', 'action', 'remark') def search(self, queryset, name, value): return queryset.filter(description__icontains=value) -class AccessListExtendedRuleFilterSet(NetBoxModelFilterSet): +class ACLExtendedRuleFilterSet(NetBoxModelFilterSet): class Meta: - model = AccessListExtendedRule + model = ACLExtendedRule fields = ('id', 'access_list', 'index', 'action', 'remark', 'protocol') def search(self, queryset, name, value): diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index 1c969f7..832ff6f 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -6,7 +6,7 @@ from extras.models import Tag from ipam.models import Prefix from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelectMultiple, TagFilterField -from .models import AccessList, AccessListExtendedRule, AccessListActionChoices, AccessListProtocolChoices, AccessListTypeChoices, AccessListStandardRule +from .models import AccessList, ACLExtendedRule, ACLActionChoices, ACLProtocolChoices, ACLTypeChoices, ACLStandardRule acl_rule_logic_help = mark_safe('*Note: CANNOT be set if remark is set.') @@ -44,14 +44,15 @@ class AccessListForm(NetBoxModelForm): class AccessListFilterForm(NetBoxModelFilterSetForm): model = AccessList type = forms.MultipleChoiceField( - choices=AccessListTypeChoices, + choices=ACLTypeChoices, required=False, widget=StaticSelectMultiple(), ) default_action = forms.MultipleChoiceField( - choices=AccessListActionChoices, + choices=ACLActionChoices, required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), + label='Default Action', ) tag = TagFilterField(model) @@ -61,18 +62,20 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): ) -class AccessListStandardRuleForm(NetBoxModelForm): +class ACLStandardRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), query_params={ 'type': 'standard' }, help_text=mark_safe('*Note: This field will only display Standard ACLs.'), + label='Access-List', ) source_prefix = DynamicModelChoiceField( queryset=Prefix.objects.all(), required=False, help_text=acl_rule_logic_help, + label='Source Prefix', ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), @@ -85,7 +88,7 @@ class AccessListStandardRuleForm(NetBoxModelForm): ) class Meta: - model = AccessListStandardRule + model = ACLStandardRule fields = ( 'access_list', 'index', 'remark', 'action', 'source_prefix', 'tags', @@ -108,36 +111,39 @@ class AccessListStandardRuleForm(NetBoxModelForm): return cleaned_data -class AccessListStandardRuleFilterForm(NetBoxModelFilterSetForm): - model = AccessListStandardRule +class ACLStandardRuleFilterForm(NetBoxModelFilterSetForm): + model = ACLStandardRule access_list = forms.ModelMultipleChoiceField( queryset=AccessList.objects.all(), required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), + label='Access-List', ) tag = TagFilterField(model) source_prefix = forms.ModelMultipleChoiceField( queryset=Prefix.objects.all(), required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), + label='Source Prefix', ) action = forms.MultipleChoiceField( - choices=AccessListActionChoices, + choices=ACLActionChoices, required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), ) fieldsets = ( (None, ('q', 'tag')), ('Rule Details', ('access_list', 'action', 'source_prefix',)), ) -class AccessListExtendedRuleForm(NetBoxModelForm): +class ACLExtendedRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), query_params={ 'type': 'extended' }, help_text=mark_safe('*Note: This field will only display Extended ACLs.'), + label='Access-List', ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), @@ -147,11 +153,13 @@ class AccessListExtendedRuleForm(NetBoxModelForm): queryset=Prefix.objects.all(), required=False, help_text=acl_rule_logic_help, + label='Source Prefix', ) destination_prefix = DynamicModelChoiceField( queryset=Prefix.objects.all(), required=False, help_text=acl_rule_logic_help, + label='Destination Prefix', ) fieldsets = ( ('Access-List Details', ('access_list', 'index', 'tags')), @@ -159,7 +167,7 @@ class AccessListExtendedRuleForm(NetBoxModelForm): ) class Meta: - model = AccessListExtendedRule + model = ACLExtendedRule fields = ( 'access_list', 'index', 'remark', 'action', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol', @@ -194,34 +202,37 @@ class AccessListExtendedRuleForm(NetBoxModelForm): return cleaned_data -class AccessListExtendedRuleFilterForm(NetBoxModelFilterSetForm): - model = AccessListExtendedRule +class ACLExtendedRuleFilterForm(NetBoxModelFilterSetForm): + model = ACLExtendedRule access_list = forms.ModelMultipleChoiceField( queryset=AccessList.objects.all(), required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), + label='Access-List', ) index = forms.IntegerField( required=False ) tag = TagFilterField(model) action = forms.MultipleChoiceField( - choices=AccessListActionChoices, + choices=ACLActionChoices, required=False, widget=StaticSelectMultiple() ) source_prefix = forms.ModelMultipleChoiceField( queryset=Prefix.objects.all(), required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), + label='Source Prefix', ) desintation_prefix = forms.ModelMultipleChoiceField( queryset=Prefix.objects.all(), required=False, - widget=StaticSelectMultiple() + widget=StaticSelectMultiple(), + label='Destination Prefix', ) protocol = forms.MultipleChoiceField( - choices=AccessListProtocolChoices, + choices=ACLProtocolChoices, required=False, widget=StaticSelectMultiple() ) diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index 1a7795f..2d113b0 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -16,20 +16,20 @@ class AccessListType(NetBoxObjectType): filterset_class = filtersets.AccessListFilterSet -class AccessListExtendedRuleType(NetBoxObjectType): +class ACLExtendedRuleType(NetBoxObjectType): class Meta: - model = models.AccessListExtendedRule + model = models.ACLExtendedRule fields = '__all__' - filterset_class = filtersets.AccessListExtendedRuleFilterSet + filterset_class = filtersets.ACLExtendedRuleFilterSet -#class AccessListStandardRuleType(NetBoxObjectType): +#class ACLStandardRuleType(NetBoxObjectType): # # class Meta: -# model = models.AccessListStandardRule +# model = models.ACLStandardRule # fields = '__all__' -# filterset_class = filtersets.AccessListStandardRuleFilterSet +# filterset_class = filtersets.ACLStandardRuleFilterSet # # Queries @@ -39,15 +39,15 @@ class Query(ObjectType): access_list = ObjectField(AccessListType) access_list_list = ObjectListField(AccessListType) - access_list_rule = ObjectField(AccessListExtendedRuleType) - access_list_rule_list = ObjectListField(AccessListExtendedRuleType) + access_list_rule = ObjectField(ACLExtendedRuleType) + access_list_rule_list = ObjectListField(ACLExtendedRuleType) #class Query(ObjectType): # access_list = ObjectField(AccessListType) # access_list_list = ObjectListField(AccessListType) # -# access_list_rule = ObjectField(AccessListStandardRuleType) -# access_list_rule_list = ObjectListField(AccessListStandardRuleType) +# access_list_rule = ObjectField(ACLStandardRuleType) +# access_list_rule_list = ObjectListField(ACLStandardRuleType) schema = Query diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 92fe77f..3ab10a1 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -6,8 +6,8 @@ from netbox.models import NetBoxModel from utilities.choices import ChoiceSet -class AccessListActionChoices(ChoiceSet): - key = 'AccessListExtendedRule.action' +class ACLActionChoices(ChoiceSet): + key = 'ACLExtendedRule.action' ACTION_DENY = 'deny' ACTION_PERMIT = 'permit' ACTION_REJECT = 'reject' @@ -19,7 +19,7 @@ class AccessListActionChoices(ChoiceSet): ] -class AccessListTypeChoices(ChoiceSet): +class ACLTypeChoices(ChoiceSet): CHOICES = [ ('extended', 'Extended', 'purple'), @@ -27,7 +27,7 @@ class AccessListTypeChoices(ChoiceSet): ] -class AccessListProtocolChoices(ChoiceSet): +class ACLProtocolChoices(ChoiceSet): CHOICES = [ ('icmp', 'ICMP', 'purple'), @@ -47,12 +47,12 @@ class AccessList(NetBoxModel): ) type = models.CharField( max_length=30, - choices=AccessListTypeChoices + choices=ACLTypeChoices ) default_action = models.CharField( - default=AccessListActionChoices.ACTION_DENY, + default=ACLActionChoices.ACTION_DENY, max_length=30, - choices=AccessListActionChoices, + choices=ACLActionChoices, verbose_name='Default Action' ) comments = models.TextField( @@ -69,21 +69,21 @@ class AccessList(NetBoxModel): return reverse('plugins:netbox_access_lists:accesslist', args=[self.pk]) def get_default_action_color(self): - return AccessListActionChoices.colors.get(self.default_action) + return ACLActionChoices.colors.get(self.default_action) def get_type_color(self): - return AccessListTypeChoices.colors.get(self.type) + return ACLTypeChoices.colors.get(self.type) -#class AccessListRule(NetBoxModel): +#class ACLRule(NetBoxModel): -class AccessListStandardRule(NetBoxModel): +class ACLStandardRule(NetBoxModel): access_list = models.ForeignKey( on_delete=models.CASCADE, related_name='standard_acl_rules', to=AccessList, - verbose_name='Access List' + verbose_name='Access-List', ) index = models.PositiveIntegerField() remark = models.CharField( @@ -94,7 +94,7 @@ class AccessListStandardRule(NetBoxModel): action = models.CharField( blank=True, null=True, - choices=AccessListActionChoices, + choices=ACLActionChoices, max_length=30, ) source_prefix = models.ForeignKey( @@ -114,18 +114,18 @@ class AccessListStandardRule(NetBoxModel): return f'{self.access_list}: Rule {self.index}' def get_action_color(self): - return AccessListActionChoices.colors.get(self.action) + return ACLActionChoices.colors.get(self.action) def get_absolute_url(self): - return reverse('plugins:netbox_access_lists:accessliststandardrule', args=[self.pk]) + return reverse('plugins:netbox_access_lists:aclstandardrule', args=[self.pk]) -class AccessListExtendedRule(NetBoxModel): +class ACLExtendedRule(NetBoxModel): access_list = models.ForeignKey( on_delete=models.CASCADE, related_name='extended_acl_rules', to=AccessList, - verbose_name='Access List' + verbose_name='Access-List', ) index = models.PositiveIntegerField() remark = models.CharField( @@ -136,7 +136,7 @@ class AccessListExtendedRule(NetBoxModel): action = models.CharField( blank=True, null=True, - choices=AccessListActionChoices, + choices=ACLActionChoices, max_length=30, ) source_prefix = models.ForeignKey( @@ -169,7 +169,7 @@ class AccessListExtendedRule(NetBoxModel): ) protocol = models.CharField( blank=True, - choices=AccessListProtocolChoices, + choices=ACLProtocolChoices, max_length=30, ) @@ -181,10 +181,10 @@ class AccessListExtendedRule(NetBoxModel): return f'{self.access_list}: Rule {self.index}' def get_action_color(self): - return AccessListActionChoices.colors.get(self.action) + return ACLActionChoices.colors.get(self.action) def get_absolute_url(self): - return reverse('plugins:netbox_access_lists:accesslistextendedrule', args=[self.pk]) + return reverse('plugins:netbox_access_lists:aclextendedrule', args=[self.pk]) def get_protocol_color(self): - return AccessListProtocolChoices.colors.get(self.protocol) + return ACLProtocolChoices.colors.get(self.protocol) diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index fc4ed97..b475ca4 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -11,18 +11,18 @@ accesslist_buttons = [ ) ] -accessliststandardrule_butons = [ +aclstandardrule_butons = [ PluginMenuButton( - link='plugins:netbox_access_lists:accessliststandardrule_add', + link='plugins:netbox_access_lists:aclstandardrule_add', title='Add', icon_class='mdi mdi-plus-thick', color=ButtonColorChoices.GREEN ) ] -accesslistextendedrule_butons = [ +aclextendedrule_butons = [ PluginMenuButton( - link='plugins:netbox_access_lists:accesslistextendedrule_add', + link='plugins:netbox_access_lists:aclextendedrule_add', title='Add', icon_class='mdi mdi-plus-thick', color=ButtonColorChoices.GREEN @@ -37,14 +37,14 @@ menu_items = ( ), # Comment out Standard Access List Rule to force creation in the ACL view PluginMenuItem( - link='plugins:netbox_access_lists:accessliststandardrule_list', + link='plugins:netbox_access_lists:aclstandardrule_list', link_text='Standard Access List Rules', - buttons=accessliststandardrule_butons + buttons=aclstandardrule_butons ), # Comment out Extended Access List Rule to force creation in the ACL view PluginMenuItem( - link='plugins:netbox_access_lists:accesslistextendedrule_list', + link='plugins:netbox_access_lists:aclextendedrule_list', link_text='Extended Access List Rules', - buttons=accesslistextendedrule_butons + buttons=aclextendedrule_butons ), ) diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index 5a5bf57..93d741e 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns, ChoiceFieldColumn -from .models import AccessList, AccessListExtendedRule, AccessListStandardRule +from .models import AccessList, ACLExtendedRule, ACLStandardRule class AccessListTable(NetBoxTable): @@ -26,7 +26,7 @@ class AccessListTable(NetBoxTable): default_columns = ('name', 'device', 'type', 'rule_count', 'default_action', 'tags') -class AccessListStandardRuleTable(NetBoxTable): +class ACLStandardRuleTable(NetBoxTable): access_list = tables.Column( linkify=True ) @@ -35,10 +35,10 @@ class AccessListStandardRuleTable(NetBoxTable): ) action = ChoiceFieldColumn() tags = columns.TagColumn( - url_name='plugins:netbox_access_lists:accessliststandardrule_list' + url_name='plugins:netbox_access_lists:aclstandardrule_list' ) class Meta(NetBoxTable.Meta): - model = AccessListStandardRule + model = ACLStandardRule fields = ( 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags' ) @@ -47,7 +47,7 @@ class AccessListStandardRuleTable(NetBoxTable): ) -class AccessListExtendedRuleTable(NetBoxTable): +class ACLExtendedRuleTable(NetBoxTable): access_list = tables.Column( linkify=True ) @@ -56,12 +56,12 @@ class AccessListExtendedRuleTable(NetBoxTable): ) action = ChoiceFieldColumn() tags = columns.TagColumn( - url_name='plugins:netbox_access_lists:accesslistextendedrule_list' + url_name='plugins:netbox_access_lists:aclextendedrule_list' ) protocol = ChoiceFieldColumn() class Meta(NetBoxTable.Meta): - model = AccessListExtendedRule + model = ACLExtendedRule fields = ( 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index 0ade3db..47f2b2a 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -17,23 +17,23 @@ urlpatterns = ( }), # Standard Access list rules - path('standard-rules/', views.AccessListStandardRuleListView.as_view(), name='accessliststandardrule_list'), - path('standard-rules/add/', views.AccessListStandardRuleEditView.as_view(), name='accessliststandardrule_add'), - path('standard-rules//', views.AccessListStandardRuleView.as_view(), name='accessliststandardrule'), - path('standard-rules//edit/', views.AccessListStandardRuleEditView.as_view(), name='accessliststandardrule_edit'), - path('standard-rules//delete/', views.AccessListStandardRuleDeleteView.as_view(), name='accessliststandardrule_delete'), - path('standard-rules//changelog/', ObjectChangeLogView.as_view(), name='accessliststandardrule_changelog', kwargs={ - 'model': models.AccessListStandardRule + path('standard-rules/', views.ACLStandardRuleListView.as_view(), name='aclstandardrule_list'), + path('standard-rules/add/', views.ACLStandardRuleEditView.as_view(), name='aclstandardrule_add'), + path('standard-rules//', views.ACLStandardRuleView.as_view(), name='aclstandardrule'), + path('standard-rules//edit/', views.ACLStandardRuleEditView.as_view(), name='aclstandardrule_edit'), + path('standard-rules//delete/', views.ACLStandardRuleDeleteView.as_view(), name='aclstandardrule_delete'), + path('standard-rules//changelog/', ObjectChangeLogView.as_view(), name='aclstandardrule_changelog', kwargs={ + 'model': models.ACLStandardRule }), # Extended Access list rules - path('extended-rules/', views.AccessListExtendedRuleListView.as_view(), name='accesslistextendedrule_list'), - path('extended-rules/add/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_add'), - path('extended-rules//', views.AccessListExtendedRuleView.as_view(), name='accesslistextendedrule'), - path('extended-rules//edit/', views.AccessListExtendedRuleEditView.as_view(), name='accesslistextendedrule_edit'), - path('extended-rules//delete/', views.AccessListExtendedRuleDeleteView.as_view(), name='accesslistextendedrule_delete'), - path('extended-rules//changelog/', ObjectChangeLogView.as_view(), name='accesslistextendedrule_changelog', kwargs={ - 'model': models.AccessListExtendedRule + path('extended-rules/', views.ACLExtendedRuleListView.as_view(), name='aclextendedrule_list'), + path('extended-rules/add/', views.ACLExtendedRuleEditView.as_view(), name='aclextendedrule_add'), + path('extended-rules//', views.ACLExtendedRuleView.as_view(), name='aclextendedrule'), + path('extended-rules//edit/', views.ACLExtendedRuleEditView.as_view(), name='aclextendedrule_edit'), + path('extended-rules//delete/', views.ACLExtendedRuleDeleteView.as_view(), name='aclextendedrule_delete'), + path('extended-rules//changelog/', ObjectChangeLogView.as_view(), name='aclextendedrule_changelog', kwargs={ + 'model': models.ACLExtendedRule }), ) diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 829760c..e19c3bb 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -13,9 +13,9 @@ class AccessListView(generic.ObjectView): def get_extra_context(self, request, instance): if instance.type == 'extended': - table = tables.AccessListExtendedRuleTable(instance.extended_acl_rules.all()) + table = tables.ACLExtendedRuleTable(instance.extended_acl_rules.all()) elif instance.type == 'standard': - table = tables.AccessListStandardRuleTable(instance.standard_acl_rules.all()) + table = tables.ACLStandardRuleTable(instance.standard_acl_rules.all()) table.configure(request) return { @@ -42,48 +42,48 @@ class AccessListDeleteView(generic.ObjectDeleteView): # -# AccessListStandardRule views +# ACLStandardRule views # -class AccessListStandardRuleView(generic.ObjectView): - queryset = models.AccessListStandardRule.objects.all() +class ACLStandardRuleView(generic.ObjectView): + queryset = models.ACLStandardRule.objects.all() -class AccessListStandardRuleListView(generic.ObjectListView): - queryset = models.AccessListStandardRule.objects.all() - table = tables.AccessListStandardRuleTable - filterset = filtersets.AccessListStandardRuleFilterSet - filterset_form = forms.AccessListStandardRuleFilterForm +class ACLStandardRuleListView(generic.ObjectListView): + queryset = models.ACLStandardRule.objects.all() + table = tables.ACLStandardRuleTable + filterset = filtersets.ACLStandardRuleFilterSet + filterset_form = forms.ACLStandardRuleFilterForm -class AccessListStandardRuleEditView(generic.ObjectEditView): - queryset = models.AccessListStandardRule.objects.all() - form = forms.AccessListStandardRuleForm +class ACLStandardRuleEditView(generic.ObjectEditView): + queryset = models.ACLStandardRule.objects.all() + form = forms.ACLStandardRuleForm -class AccessListStandardRuleDeleteView(generic.ObjectDeleteView): - queryset = models.AccessListStandardRule.objects.all() +class ACLStandardRuleDeleteView(generic.ObjectDeleteView): + queryset = models.ACLStandardRule.objects.all() # -# AccessListExtendedRule views +# ACLExtendedRule views # -class AccessListExtendedRuleView(generic.ObjectView): - queryset = models.AccessListExtendedRule.objects.all() +class ACLExtendedRuleView(generic.ObjectView): + queryset = models.ACLExtendedRule.objects.all() -class AccessListExtendedRuleListView(generic.ObjectListView): - queryset = models.AccessListExtendedRule.objects.all() - table = tables.AccessListExtendedRuleTable - filterset = filtersets.AccessListExtendedRuleFilterSet - filterset_form = forms.AccessListExtendedRuleFilterForm +class ACLExtendedRuleListView(generic.ObjectListView): + queryset = models.ACLExtendedRule.objects.all() + table = tables.ACLExtendedRuleTable + filterset = filtersets.ACLExtendedRuleFilterSet + filterset_form = forms.ACLExtendedRuleFilterForm -class AccessListExtendedRuleEditView(generic.ObjectEditView): - queryset = models.AccessListExtendedRule.objects.all() - form = forms.AccessListExtendedRuleForm +class ACLExtendedRuleEditView(generic.ObjectEditView): + queryset = models.ACLExtendedRule.objects.all() + form = forms.ACLExtendedRuleForm -class AccessListExtendedRuleDeleteView(generic.ObjectDeleteView): - queryset = models.AccessListExtendedRule.objects.all() +class ACLExtendedRuleDeleteView(generic.ObjectDeleteView): + queryset = models.ACLExtendedRule.objects.all() From 0cde871f63d10911279a0b2340b971954b5c15be Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 11:50:06 +0000 Subject: [PATCH 14/38] update migration names --- .../migrations/{0001_accesslist.py => 0001_initial.py} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename netbox_access_lists/migrations/{0001_accesslist.py => 0001_initial.py} (98%) diff --git a/netbox_access_lists/migrations/0001_accesslist.py b/netbox_access_lists/migrations/0001_initial.py similarity index 98% rename from netbox_access_lists/migrations/0001_accesslist.py rename to netbox_access_lists/migrations/0001_initial.py index a2e84c9..6c15888 100644 --- a/netbox_access_lists/migrations/0001_accesslist.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -35,7 +35,7 @@ class Migration(migrations.Migration): }, ), migrations.CreateModel( - name='AccessListStandardRule', + name='ACLStandardRule', fields=[ ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), ('created', models.DateTimeField(auto_now_add=True, null=True)), @@ -54,7 +54,7 @@ class Migration(migrations.Migration): }, ), migrations.CreateModel( - name='AccessListExtendedRule', + name='ACLExtendedRule', fields=[ ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), ('created', models.DateTimeField(auto_now_add=True, null=True)), From cd927ce980982de98fbf0a5f603881b5b4c9c62a Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 14:14:34 +0000 Subject: [PATCH 15/38] abstract ACLRules --- netbox_access_lists/api/views.py | 2 +- netbox_access_lists/graphql.py | 12 ++-- .../migrations/0001_initial.py | 4 +- netbox_access_lists/models.py | 61 +++++-------------- .../netbox_access_lists/accesslist.html | 4 +- netbox_access_lists/views.py | 6 +- 6 files changed, 29 insertions(+), 60 deletions(-) diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index 127ecfd..d1fc505 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -10,7 +10,7 @@ class AccessListViewSet(NetBoxModelViewSet): queryset = models.AccessList.objects.prefetch_related( 'device', 'tags' ).annotate( - rule_count=Count('extended_acl_rules') + Count('standard_acl_rules') + rule_count=Count('aclextendedrules') + Count('aclstandardrules') ) serializer_class = AccessListSerializer filterset_class = filtersets.AccessListFilterSet diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index 2d113b0..eadc310 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -24,12 +24,12 @@ class ACLExtendedRuleType(NetBoxObjectType): filterset_class = filtersets.ACLExtendedRuleFilterSet -#class ACLStandardRuleType(NetBoxObjectType): -# -# class Meta: -# model = models.ACLStandardRule -# fields = '__all__' -# filterset_class = filtersets.ACLStandardRuleFilterSet +class ACLStandardRuleType(NetBoxObjectType): + + class Meta: + model = models.ACLStandardRule + fields = '__all__' + filterset_class = filtersets.ACLStandardRuleFilterSet # # Queries diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index 6c15888..a5cba64 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -43,7 +43,7 @@ class Migration(migrations.Migration): ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ('index', models.PositiveIntegerField()), - ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='standard_acl_rules', to='netbox_access_lists.accesslist')), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclstandardrules', to='netbox_access_lists.accesslist')), ('remark', models.CharField(blank=True, null=True, max_length=500)), ('action', models.CharField(blank=True, null=True, max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), @@ -62,7 +62,7 @@ class Migration(migrations.Migration): ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ('index', models.PositiveIntegerField()), - ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='extended_acl_rules', to='netbox_access_lists.accesslist')), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclextendedrules', to='netbox_access_lists.accesslist')), ('remark', models.CharField(blank=True, null=True, max_length=500)), ('action', models.CharField(blank=True, null=True, max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 3ab10a1..1870ba3 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -75,13 +75,12 @@ class AccessList(NetBoxModel): return ACLTypeChoices.colors.get(self.type) -#class ACLRule(NetBoxModel): - - -class ACLStandardRule(NetBoxModel): +class ACLRule(NetBoxModel): + """ + Abstract model for ACL Rules. + """ access_list = models.ForeignKey( on_delete=models.CASCADE, - related_name='standard_acl_rules', to=AccessList, verbose_name='Access-List', ) @@ -106,47 +105,27 @@ class ACLStandardRule(NetBoxModel): verbose_name='Source Prefix' ) - class Meta: - ordering = ('access_list', 'index') - unique_together = ('access_list', 'index') - def __str__(self): return f'{self.access_list}: Rule {self.index}' def get_action_color(self): return ACLActionChoices.colors.get(self.action) + + class Meta: + abstract = True + default_related_name='%(class)ss' + ordering = ('access_list', 'index') + unique_together = ('access_list', 'index') + + +class ACLStandardRule(ACLRule): + def get_absolute_url(self): return reverse('plugins:netbox_access_lists:aclstandardrule', args=[self.pk]) -class ACLExtendedRule(NetBoxModel): - access_list = models.ForeignKey( - on_delete=models.CASCADE, - related_name='extended_acl_rules', - to=AccessList, - verbose_name='Access-List', - ) - index = models.PositiveIntegerField() - remark = models.CharField( - max_length=200, - blank=True, - null=True - ) - action = models.CharField( - blank=True, - null=True, - choices=ACLActionChoices, - max_length=30, - ) - source_prefix = models.ForeignKey( - blank=True, - null=True, - on_delete=models.PROTECT, - related_name='+', - to='ipam.Prefix', - verbose_name='Source Prefix' - ) +class ACLExtendedRule(ACLRule): source_ports = ArrayField( base_field=models.PositiveIntegerField(), blank=True, @@ -173,16 +152,6 @@ class ACLExtendedRule(NetBoxModel): max_length=30, ) - class Meta: - ordering = ('access_list', 'index') - unique_together = ('access_list', 'index') - - def __str__(self): - return f'{self.access_list}: Rule {self.index}' - - def get_action_color(self): - return ACLActionChoices.colors.get(self.action) - def get_absolute_url(self): return reverse('plugins:netbox_access_lists:aclextendedrule', args=[self.pk]) diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslist.html b/netbox_access_lists/templates/netbox_access_lists/accesslist.html index 9870749..55a4406 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accesslist.html +++ b/netbox_access_lists/templates/netbox_access_lists/accesslist.html @@ -8,9 +8,9 @@
{% if perms.netbox_access_lists.change_policy %} {% if object.type == 'extended' %} - + {% elif object.type == 'standard' %} - + {% endif %} Rule diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index e19c3bb..6a69f94 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -13,9 +13,9 @@ class AccessListView(generic.ObjectView): def get_extra_context(self, request, instance): if instance.type == 'extended': - table = tables.ACLExtendedRuleTable(instance.extended_acl_rules.all()) + table = tables.ACLExtendedRuleTable(instance.aclextendedrules.all()) elif instance.type == 'standard': - table = tables.ACLStandardRuleTable(instance.standard_acl_rules.all()) + table = tables.ACLStandardRuleTable(instance.aclstandardrules.all()) table.configure(request) return { @@ -25,7 +25,7 @@ class AccessListView(generic.ObjectView): class AccessListListView(generic.ObjectListView): queryset = models.AccessList.objects.annotate( - rule_count=Count('extended_acl_rules') + Count('standard_acl_rules') + rule_count=Count('aclextendedrules') + Count('aclstandardrules') ) table = tables.AccessListTable filterset = filtersets.AccessListFilterSet From c6fabbba408607553c864e5cc4d3b6af9debafb5 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 14:21:48 +0000 Subject: [PATCH 16/38] add additional plugins --- .devcontainer/devcontainer.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index a49e525..cee3d2e 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -67,7 +67,8 @@ "codezombiech.gitignore", "Tyriar.sort-lines", "GitHub.vscode-pull-request-github", - "sourcery.sourcery" + "sourcery.sourcery", + "mintlify.document" ] } }, From b877949d76c0489ad835dc8b31d4ab41f5707edd Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 15:04:18 +0000 Subject: [PATCH 17/38] Add site fields & filters to forms --- netbox_access_lists/forms.py | 50 ++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index 832ff6f..6d4d741 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -3,6 +3,7 @@ from django.core.exceptions import ValidationError from django.utils.safestring import mark_safe from extras.models import Tag +from dcim.models import Device, Region, Site, SiteGroup from ipam.models import Prefix from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelectMultiple, TagFilterField @@ -12,6 +13,27 @@ from .models import AccessList, ACLExtendedRule, ACLActionChoices, ACLProtocolCh acl_rule_logic_help = mark_safe('*Note: CANNOT be set if remark is set.') class AccessListForm(NetBoxModelForm): + region = DynamicModelMultipleChoiceField( + queryset=Region.objects.all(), + required=False, + ) + site_group = DynamicModelMultipleChoiceField( + queryset=SiteGroup.objects.all(), + required=False, + label='Site Group' + ) + site = DynamicModelChoiceField( + queryset=Site.objects.all(), + required=False + ) + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + query_params={ + 'region': '$region', + 'group_id': '$site_group', + 'site_id': '$site', + }, + ) comments = CommentField() tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), @@ -19,12 +41,13 @@ class AccessListForm(NetBoxModelForm): ) fieldsets = [ - ('Access-List Details', ('name', 'device', 'type', 'default_action', 'tags')), + ('Host Details', ('region', 'site_group', 'site', 'device')), + ('Access-List Details', ('name', 'type', 'default_action', 'tags')), ] class Meta: model = AccessList - fields = ('name', 'device', 'type', 'default_action', 'comments', 'tags') + fields = ('region', 'site_group', 'site', 'device', 'name', 'type', 'default_action', 'comments', 'tags') help_texts = { 'default_action': 'The default behavior of the ACL.', 'name': 'The name uniqueness per device is case insensitive.', @@ -43,6 +66,28 @@ class AccessListForm(NetBoxModelForm): class AccessListFilterForm(NetBoxModelFilterSetForm): model = AccessList + region = DynamicModelMultipleChoiceField( + queryset=Region.objects.all(), + required=False, + ) + site_group = DynamicModelMultipleChoiceField( + queryset=SiteGroup.objects.all(), + required=False, + label='Site Group' + ) + site = DynamicModelChoiceField( + queryset=Site.objects.all(), + required=False + ) + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + query_params={ + 'region': '$region', + 'group_id': '$site_group', + 'site_id': '$site', + }, + required=False + ) type = forms.MultipleChoiceField( choices=ACLTypeChoices, required=False, @@ -58,6 +103,7 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): fieldsets = ( (None, ('q', 'tag')), + ('Host Details', ('region', 'site_group', 'site', 'device')), ('ACL Details', ('type', 'default_action')), ) From 163287da4fb2eae31a811cbe1bb7cff6d1fa32e0 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 20:05:54 +0000 Subject: [PATCH 18/38] put in logic to prevent ACL type change if it has rules --- netbox_access_lists/forms.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index 6d4d741..a3ee881 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -51,7 +51,7 @@ class AccessListForm(NetBoxModelForm): help_texts = { 'default_action': 'The default behavior of the ACL.', 'name': 'The name uniqueness per device is case insensitive.', - 'type': 'Sets the type of the ACL & its rules.', + 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access-List.'), } def clean(self): @@ -60,8 +60,13 @@ class AccessListForm(NetBoxModelForm): return cleaned_data name = cleaned_data.get('name') device = cleaned_data.get('device') + type = cleaned_data.get('type') if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): raise forms.ValidationError('An ACL with this name (case insensitive) is already associated to this device.') + if type == 'extended' and self.instance.aclstandardrules.exists(): + raise forms.ValidationError('This ACL has Standard ACL rules already associated, CANNOT change ACL type!!') + elif type == 'standard' and self.instance.aclextendedrules.exists(): + raise forms.ValidationError('This ACL has Extended ACL rules already associated, CANNOT change ACL type!!') return cleaned_data class AccessListFilterForm(NetBoxModelFilterSetForm): From e82291708cf90d6d0b76a421a07ea2f9cf1a5d85 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Mon, 18 Jul 2022 20:06:10 +0000 Subject: [PATCH 19/38] correct ACL rule count --- .../templates/inc/device/assigned_access_lists.html | 6 +++++- .../templates/netbox_access_lists/accesslist.html | 10 +++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/netbox_access_lists/templates/inc/device/assigned_access_lists.html b/netbox_access_lists/templates/inc/device/assigned_access_lists.html index 5b0617c..adb99c4 100644 --- a/netbox_access_lists/templates/inc/device/assigned_access_lists.html +++ b/netbox_access_lists/templates/inc/device/assigned_access_lists.html @@ -12,7 +12,11 @@ {{ access_list|linkify }} {{ access_list.type|title }} {{ access_list.default_action|title }} - {{ access_list.rules.count }} + {% if access_list.type == 'standard' %} + {{ access_list.aclstandardrules.count|placeholder }} + {% elif access_list.type == 'extended' %} + {{ access_list.aclextendedrules.count|placeholder }} + {% endif %} {% endfor %} diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslist.html b/netbox_access_lists/templates/netbox_access_lists/accesslist.html index 55a4406..598e09f 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accesslist.html +++ b/netbox_access_lists/templates/netbox_access_lists/accesslist.html @@ -63,7 +63,15 @@ Rules - {{ object.rules.count }} + {% if object.type == 'standard' %} + {{ object.aclstandardrules.count|placeholder }} + {% elif object.type == 'extended' %} + {{ object.aclextendedrules.count|placeholder }} + {% endif %} + + Device + {{ object.device|linkify }} +
From 7971b834eb3bb0d225a8c963e7f0bad0817cdfe8 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 03:00:24 +0000 Subject: [PATCH 20/38] add validation in api --- netbox_access_lists/api/serializers.py | 29 ++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index 178c687..ddb5767 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -58,6 +58,15 @@ class AccessListSerializer(NetBoxModelSerializer): 'last_updated', 'rule_count' ) + def validate(self, data): + + if self.instance.rule_count > 0: + raise serializers.ValidationError({ + 'type': 'This ACL has ACL rules already associated, CANNOT change ACL type!!' + }) + + return super().validate(data) + class ACLStandardRuleSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField( @@ -73,6 +82,16 @@ class ACLStandardRuleSerializer(NetBoxModelSerializer): 'created', 'custom_fields', 'last_updated', 'source_prefix' ) + def validate(self, data): + + access_list = data.get('access_list') + if access_list.type == 'extended': + raise serializers.ValidationError({ + 'access_list': 'CANNOT associated standard ACL rules to an extended ACL!!' + }) + + return super().validate(data) + class ACLExtendedRuleSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField( @@ -89,3 +108,13 @@ class ACLExtendedRuleSerializer(NetBoxModelSerializer): 'created', 'custom_fields', 'last_updated', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' ) + + def validate(self, data): + + access_list = data.get('access_list') + if access_list.type == 'standard': + raise serializers.ValidationError({ + 'access_list': 'CANNOT associated extended ACL rules to a standard ACL!!' + }) + + return super().validate(data) From 9c4ef31b211a80b41a456c5dd88a5acd338bf195 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 12:27:42 +0000 Subject: [PATCH 21/38] update plugin title --- netbox_access_lists/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox_access_lists/__init__.py b/netbox_access_lists/__init__.py index 3d9dc1c..929cc65 100644 --- a/netbox_access_lists/__init__.py +++ b/netbox_access_lists/__init__.py @@ -3,7 +3,7 @@ from extras.plugins import PluginConfig class NetBoxAccessListsConfig(PluginConfig): name = 'netbox_access_lists' - verbose_name = ' NetBox Access Lists' + verbose_name = 'Access-Lists' description = 'Manage simple ACLs in NetBox' version = '0.1' base_url = 'access-lists' From 488768a55ca69cf32c556cc1f1d395181a0d8cf5 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 12:36:20 +0000 Subject: [PATCH 22/38] update naming, comments, and ui --- netbox_access_lists/navigation.py | 6 +++--- .../templates/inc/device/access_lists.html | 4 ++-- .../templates/netbox_access_lists/accesslist.html | 8 ++------ .../templates/netbox_access_lists/aclextendedrule.html | 4 ++-- .../templates/netbox_access_lists/aclstandardrule.html | 4 ++-- netbox_access_lists/urls.py | 6 +++--- 6 files changed, 14 insertions(+), 18 deletions(-) diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index b475ca4..d9759a4 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -32,19 +32,19 @@ aclextendedrule_butons = [ menu_items = ( PluginMenuItem( link='plugins:netbox_access_lists:accesslist_list', - link_text='Access Lists', + link_text='Access-Lists', buttons=accesslist_buttons ), # Comment out Standard Access List Rule to force creation in the ACL view PluginMenuItem( link='plugins:netbox_access_lists:aclstandardrule_list', - link_text='Standard Access List Rules', + link_text='Standard Access-List Rules', buttons=aclstandardrule_butons ), # Comment out Extended Access List Rule to force creation in the ACL view PluginMenuItem( link='plugins:netbox_access_lists:aclextendedrule_list', - link_text='Extended Access List Rules', + link_text='Extended Access-List Rules', buttons=aclextendedrule_butons ), ) diff --git a/netbox_access_lists/templates/inc/device/access_lists.html b/netbox_access_lists/templates/inc/device/access_lists.html index 7bdb9b9..374abba 100644 --- a/netbox_access_lists/templates/inc/device/access_lists.html +++ b/netbox_access_lists/templates/inc/device/access_lists.html @@ -1,13 +1,13 @@
- Access Lists + Access-Lists
{% include 'inc/device/assigned_access_lists.html' %}
- Add Access List + Add Access-List
diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslist.html b/netbox_access_lists/templates/netbox_access_lists/accesslist.html index 598e09f..f8bb721 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accesslist.html +++ b/netbox_access_lists/templates/netbox_access_lists/accesslist.html @@ -2,7 +2,7 @@ {% load render_table from django_tables2 %} {% block breadcrumbs %} -
  • Access Lists
    • +
  • Access-Lists
    • {% endblock %} {% block controls %}
    @@ -46,13 +46,9 @@
    -
    Access List
    +
    Access-List
    - - - - diff --git a/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html index ea5e41e..2448d63 100644 --- a/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html @@ -4,11 +4,11 @@
    -
    Access List Rule
    +
    Extended Access-List Rule
    Name{{ object.name }}
    Type {{ object.get_type_display }}
    - + diff --git a/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html index f704727..1a013e0 100644 --- a/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html @@ -4,11 +4,11 @@
    -
    Access List Rule
    +
    Standard Access-List Rule
    Access ListAccess-List {{ object.access_list }}
    - + diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index 47f2b2a..c6060f2 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -6,7 +6,7 @@ from . import models, views urlpatterns = ( - # Access lists + # Access-Lists path('access-lists/', views.AccessListListView.as_view(), name='accesslist_list'), path('access-lists/add/', views.AccessListEditView.as_view(), name='accesslist_add'), path('access-lists//', views.AccessListView.as_view(), name='accesslist'), @@ -16,7 +16,7 @@ urlpatterns = ( 'model': models.AccessList }), - # Standard Access list rules + # Standard Access-List rules path('standard-rules/', views.ACLStandardRuleListView.as_view(), name='aclstandardrule_list'), path('standard-rules/add/', views.ACLStandardRuleEditView.as_view(), name='aclstandardrule_add'), path('standard-rules//', views.ACLStandardRuleView.as_view(), name='aclstandardrule'), @@ -26,7 +26,7 @@ urlpatterns = ( 'model': models.ACLStandardRule }), - # Extended Access list rules + # Extended Access-List rules path('extended-rules/', views.ACLExtendedRuleListView.as_view(), name='aclextendedrule_list'), path('extended-rules/add/', views.ACLExtendedRuleEditView.as_view(), name='aclextendedrule_add'), path('extended-rules//', views.ACLExtendedRuleView.as_view(), name='aclextendedrule'), From 596b4c8f3970fb4e500f38e66615a1a90b7684a3 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 14:05:34 +0000 Subject: [PATCH 23/38] seperate choices from models --- netbox_access_lists/choices.py | 29 +++++++++++++++++++++++++++++ netbox_access_lists/models.py | 32 +------------------------------- 2 files changed, 30 insertions(+), 31 deletions(-) create mode 100644 netbox_access_lists/choices.py diff --git a/netbox_access_lists/choices.py b/netbox_access_lists/choices.py new file mode 100644 index 0000000..0a5aaa6 --- /dev/null +++ b/netbox_access_lists/choices.py @@ -0,0 +1,29 @@ +from utilities.choices import ChoiceSet + +class ACLActionChoices(ChoiceSet): + ACTION_DENY = 'deny' + ACTION_PERMIT = 'permit' + ACTION_REJECT = 'reject' + + CHOICES = [ + (ACTION_DENY, 'Deny', 'red'), + (ACTION_PERMIT, 'Permit', 'green'), + (ACTION_REJECT, 'Reject (Reset)', 'orange'), + ] + + +class ACLTypeChoices(ChoiceSet): + + CHOICES = [ + ('extended', 'Extended', 'purple'), + ('standard', 'Standard', 'blue'), + ] + + +class ACLProtocolChoices(ChoiceSet): + + CHOICES = [ + ('icmp', 'ICMP', 'purple'), + ('tcp', 'TCP', 'blue'), + ('udp', 'UDP', 'orange'), + ] diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 1870ba3..15b1462 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -3,37 +3,7 @@ from django.db import models from django.urls import reverse from netbox.models import NetBoxModel -from utilities.choices import ChoiceSet - - -class ACLActionChoices(ChoiceSet): - key = 'ACLExtendedRule.action' - ACTION_DENY = 'deny' - ACTION_PERMIT = 'permit' - ACTION_REJECT = 'reject' - - CHOICES = [ - (ACTION_DENY, 'Deny', 'red'), - (ACTION_PERMIT, 'Permit', 'green'), - (ACTION_REJECT, 'Reject (Reset)', 'orange'), - ] - - -class ACLTypeChoices(ChoiceSet): - - CHOICES = [ - ('extended', 'Extended', 'purple'), - ('standard', 'Standard', 'blue'), - ] - - -class ACLProtocolChoices(ChoiceSet): - - CHOICES = [ - ('icmp', 'ICMP', 'purple'), - ('tcp', 'TCP', 'blue'), - ('udp', 'UDP', 'orange'), - ] +from netbox_access_lists.choices import * class AccessList(NetBoxModel): From 84f9cfc8f0bbc6d4dd678d3e7d3e8f015d2d5755 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 14:05:48 +0000 Subject: [PATCH 24/38] update default_action default value --- netbox_access_lists/migrations/0001_initial.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index a5cba64..7ee99cb 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -25,7 +25,7 @@ class Migration(migrations.Migration): ('name', models.CharField(max_length=100)), ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='access_lists', to='dcim.device')), ('type', models.CharField(max_length=100)), - ('default_action', models.CharField(max_length=30)), + ('default_action', models.CharField(default='deny', max_length=30)), ('comments', models.TextField(blank=True)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ], From badf155a42c075c71e3e947104eb61174a3c4477 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 14:06:08 +0000 Subject: [PATCH 25/38] add additional prefixes --- .devcontainer/initializers/prefixes.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.devcontainer/initializers/prefixes.yml b/.devcontainer/initializers/prefixes.yml index 6aea9c5..941f63c 100644 --- a/.devcontainer/initializers/prefixes.yml +++ b/.devcontainer/initializers/prefixes.yml @@ -27,3 +27,11 @@ status: active tenant: tenant2 vlan: vlan2 +- description: prefix3 + prefix: 192.168.1.0/24 + site: AMS 1 + status: active +- description: prefix4 + prefix: 192.168.11.0/24 + site: AMS 2 + status: active From 55d6eaaaa93bad9b7b55b6352bcc0c07fb524485 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 14:29:40 +0000 Subject: [PATCH 26/38] update ACLRule action logic and choices --- netbox_access_lists/choices.py | 10 ++++ netbox_access_lists/filtersets.py | 4 +- netbox_access_lists/forms.py | 52 ++++++++++--------- .../migrations/0001_initial.py | 8 +-- netbox_access_lists/models.py | 6 +-- 5 files changed, 46 insertions(+), 34 deletions(-) diff --git a/netbox_access_lists/choices.py b/netbox_access_lists/choices.py index 0a5aaa6..f765c77 100644 --- a/netbox_access_lists/choices.py +++ b/netbox_access_lists/choices.py @@ -11,6 +11,16 @@ class ACLActionChoices(ChoiceSet): (ACTION_REJECT, 'Reject (Reset)', 'orange'), ] +class ACLRuleActionChoices(ChoiceSet): + ACTION_DENY = 'deny' + ACTION_PERMIT = 'permit' + ACTION_REMARK = 'remark' + + CHOICES = [ + (ACTION_DENY, 'Deny', 'red'), + (ACTION_PERMIT, 'Permit', 'green'), + (ACTION_REMARK, 'Remark', 'blue'), + ] class ACLTypeChoices(ChoiceSet): diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index 8549c71..c2cb69c 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -15,7 +15,7 @@ class ACLStandardRuleFilterSet(NetBoxModelFilterSet): class Meta: model = ACLStandardRule - fields = ('id', 'access_list', 'index', 'action', 'remark') + fields = ('id', 'access_list', 'index', 'action') def search(self, queryset, name, value): return queryset.filter(description__icontains=value) @@ -25,7 +25,7 @@ class ACLExtendedRuleFilterSet(NetBoxModelFilterSet): class Meta: model = ACLExtendedRule - fields = ('id', 'access_list', 'index', 'action', 'remark', 'protocol') + fields = ('id', 'access_list', 'index', 'action', 'protocol') def search(self, queryset, name, value): return queryset.filter(description__icontains=value) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms.py index a3ee881..f9bbe36 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms.py @@ -7,10 +7,10 @@ from dcim.models import Device, Region, Site, SiteGroup from ipam.models import Prefix from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelectMultiple, TagFilterField -from .models import AccessList, ACLExtendedRule, ACLActionChoices, ACLProtocolChoices, ACLTypeChoices, ACLStandardRule +from .models import AccessList, ACLExtendedRule, ACLActionChoices, ACLRuleActionChoices, ACLProtocolChoices, ACLTypeChoices, ACLStandardRule -acl_rule_logic_help = mark_safe('*Note: CANNOT be set if remark is set.') +acl_rule_logic_help = mark_safe('*Note: CANNOT be set if action is set to remark.') class AccessListForm(NetBoxModelForm): region = DynamicModelMultipleChoiceField( @@ -134,29 +134,31 @@ class ACLStandardRuleForm(NetBoxModelForm): ) fieldsets = ( - ('Access-List Details', ('access_list', 'index', 'tags')), - ('Rule Logic', ('remark', 'action', 'source_prefix')), + ('Access-List Details', ('access_list', 'tags')), + ('Rule Definition', ('index', 'action', 'remark', 'source_prefix')), ) class Meta: model = ACLStandardRule fields = ( - 'access_list', 'index', 'remark', 'action', 'source_prefix', + 'access_list', 'index', 'action', 'remark', 'source_prefix', 'tags', ) help_texts = { - 'action': acl_rule_logic_help, 'index': 'Determines the order of the rule in the ACL processing.', 'remark': mark_safe('*Note: CANNOT be set if source prefix OR action is set.'), } def clean(self): cleaned_data = super().clean() - if cleaned_data.get('remark'): - if cleaned_data.get('action'): - raise forms.ValidationError('Cannot input a remark AND an action. Remove one.') + if cleaned_data.get('action') == 'remark': + if cleaned_data.get('remark') is None: + raise forms.ValidationError('Action Remark is set, MUST set a remark') if cleaned_data.get('source_prefix'): raise forms.ValidationError('Cannot input a remark AND a source prefix. Remove one.') + else: + if cleaned_data.get('remark'): + raise forms.ValidationError('CANNOT set a remark without the action set to remark also.') #if cleaned_data.get('access_list_type') == 'standard' and (source_ports or destination_prefix or destination_ports): # raise forms.ValidationError('Standard Access-Lists only allow a source_prefix or remark') return cleaned_data @@ -178,7 +180,7 @@ class ACLStandardRuleFilterForm(NetBoxModelFilterSetForm): label='Source Prefix', ) action = forms.MultipleChoiceField( - choices=ACLActionChoices, + choices=ACLRuleActionChoices, required=False, widget=StaticSelectMultiple(), ) @@ -213,41 +215,43 @@ class ACLExtendedRuleForm(NetBoxModelForm): label='Destination Prefix', ) fieldsets = ( - ('Access-List Details', ('access_list', 'index', 'tags')), - ('Rule Details', ('remark', 'action', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol',)), + ('Access-List Details', ('access_list', 'tags')), + ('Rule Definition', ('index', 'action', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol',)), ) class Meta: model = ACLExtendedRule fields = ( - 'access_list', 'index', 'remark', 'action', 'source_prefix', + 'access_list', 'index', 'action', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol', 'tags' ) help_texts = { - 'action': acl_rule_logic_help, 'destination_ports': acl_rule_logic_help, 'index': 'Determines the order of the rule in the ACL processing.', 'protocol': acl_rule_logic_help, - 'remark': mark_safe('*Note: CANNOT be set if a prefix, port, OR action is set.'), + 'remark': mark_safe('*Note: CANNOT be set if action is not set to remark.'), 'source_ports': acl_rule_logic_help, } def clean(self): cleaned_data = super().clean() - if cleaned_data.get('remark'): - if cleaned_data.get('action'): - raise forms.ValidationError('Cannot input a remark AND an action. Remove one.') + if cleaned_data.get('action') == 'remark': + if cleaned_data.get('remark') is None: + raise forms.ValidationError('Action Remark is set, MUST set a remark') if cleaned_data.get('source_prefix'): - raise forms.ValidationError('Cannot input a remark AND a source prefix. Remove one.') + raise forms.ValidationError('CANNOT set an action of remark AND a source prefix.') if cleaned_data.get('source_ports'): - raise forms.ValidationError('Cannot input a remark AND source ports. Remove one.') + raise forms.ValidationError('CANNOT set an action of remark AND source ports.') if cleaned_data.get('destination_prefix'): - raise forms.ValidationError('Cannot input a remark AND a destination prefix. Remove one.') + raise forms.ValidationError('CANNOT set an action of remark AND a destination prefix.') if cleaned_data.get('destination_ports'): - raise forms.ValidationError('Cannot input a remark AND destination ports. Remove one.') + raise forms.ValidationError('CANNOT set an action of remark AND destination ports.') if cleaned_data.get('protocol'): - raise forms.ValidationError('Cannot input a remark AND a protocol. Remove one.') + raise forms.ValidationError('CANNOT set an action of remark AND a protocol.') + else: + if cleaned_data.get('remark'): + raise forms.ValidationError('CANNOT set a remark without the action set to remark also.') #if cleaned_data.get('access_list_type') == 'standard' and (source_ports or destination_prefix or destination_ports): # raise forms.ValidationError('Standard Access-Lists only allow a source_prefix or remark') return cleaned_data @@ -266,7 +270,7 @@ class ACLExtendedRuleFilterForm(NetBoxModelFilterSetForm): ) tag = TagFilterField(model) action = forms.MultipleChoiceField( - choices=ACLActionChoices, + choices=ACLRuleActionChoices, required=False, widget=StaticSelectMultiple() ) diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index 7ee99cb..84f623f 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -42,10 +42,10 @@ class Migration(migrations.Migration): ('last_updated', models.DateTimeField(auto_now=True, null=True)), ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), - ('index', models.PositiveIntegerField()), ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclstandardrules', to='netbox_access_lists.accesslist')), + ('index', models.PositiveIntegerField()), + ('action', models.CharField(max_length=30)), ('remark', models.CharField(blank=True, null=True, max_length=500)), - ('action', models.CharField(blank=True, null=True, max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), ], options={ @@ -61,10 +61,10 @@ class Migration(migrations.Migration): ('last_updated', models.DateTimeField(auto_now=True, null=True)), ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), + ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclstandardrules', to='netbox_access_lists.accesslist')), ('index', models.PositiveIntegerField()), - ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclextendedrules', to='netbox_access_lists.accesslist')), + ('action', models.CharField(max_length=30)), ('remark', models.CharField(blank=True, null=True, max_length=500)), - ('action', models.CharField(blank=True, null=True, max_length=30)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), ('source_ports', django.contrib.postgres.fields.ArrayField(base_field=models.PositiveIntegerField(), blank=True, null=True, size=None)), ('destination_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 15b1462..4e325e1 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -61,9 +61,7 @@ class ACLRule(NetBoxModel): null=True ) action = models.CharField( - blank=True, - null=True, - choices=ACLActionChoices, + choices=ACLRuleActionChoices, max_length=30, ) source_prefix = models.ForeignKey( @@ -79,7 +77,7 @@ class ACLRule(NetBoxModel): return f'{self.access_list}: Rule {self.index}' def get_action_color(self): - return ACLActionChoices.colors.get(self.action) + return ACLRuleActionChoices.colors.get(self.action) class Meta: From 3680ca92e2cd967fe2a59d05cb1f178460324893 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 19:40:20 +0000 Subject: [PATCH 27/38] split forms --- netbox_access_lists/forms/__init__.py | 9 + netbox_access_lists/forms/bulk_edit.py | 89 ++++++++ netbox_access_lists/forms/filtersets.py | 128 +++++++++++ .../{forms.py => forms/models.py} | 202 ++++++++---------- 4 files changed, 315 insertions(+), 113 deletions(-) create mode 100644 netbox_access_lists/forms/__init__.py create mode 100644 netbox_access_lists/forms/bulk_edit.py create mode 100644 netbox_access_lists/forms/filtersets.py rename netbox_access_lists/{forms.py => forms/models.py} (67%) diff --git a/netbox_access_lists/forms/__init__.py b/netbox_access_lists/forms/__init__.py new file mode 100644 index 0000000..e6825ee --- /dev/null +++ b/netbox_access_lists/forms/__init__.py @@ -0,0 +1,9 @@ +from .models import * +from .filtersets import * +#from .object_create import * +#from .object_import import * +#from .bulk_create import * +from .bulk_edit import * +#from .bulk_import import * +#from .connections import * +#from .formsets import * diff --git a/netbox_access_lists/forms/bulk_edit.py b/netbox_access_lists/forms/bulk_edit.py new file mode 100644 index 0000000..eb3079e --- /dev/null +++ b/netbox_access_lists/forms/bulk_edit.py @@ -0,0 +1,89 @@ +from dcim.models import Device, Region, Site, SiteGroup +from django import forms +from django.core.exceptions import ValidationError +from django.utils.safestring import mark_safe +from extras.models import Tag +from ipam.models import Prefix +from netbox.forms import (NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, + NetBoxModelForm) +from utilities.forms import (ChoiceField, CommentField, + DynamicModelChoiceField, + DynamicModelMultipleChoiceField, + MultipleChoiceField, StaticSelect, + StaticSelectMultiple, TagFilterField, + add_blank_choice) + +from netbox_access_lists.models import (AccessList, ACLActionChoices, ACLExtendedRule, + ACLProtocolChoices, ACLRuleActionChoices, ACLStandardRule, + ACLTypeChoices) + +#__all__ = ( +# 'AccessListBulkEditForm', +#) + + +#class AccessListBulkEditForm(NetBoxModelBulkEditForm): +# model = AccessList +# +# region = DynamicModelChoiceField( +# queryset=Region.objects.all(), +# required=False, +# ) +# site_group = DynamicModelChoiceField( +# queryset=SiteGroup.objects.all(), +# required=False, +# label='Site Group' +# ) +# site = DynamicModelChoiceField( +# queryset=Site.objects.all(), +# required=False +# ) +# device = DynamicModelChoiceField( +# queryset=Device.objects.all(), +# query_params={ +# 'region': '$region', +# 'group_id': '$site_group', +# 'site_id': '$site', +# }, +# required=False, +# ) +# type = ChoiceField( +# choices=add_blank_choice(ACLTypeChoices), +# required=False, +# widget=StaticSelect(), +# ) +# default_action = ChoiceField( +# choices=add_blank_choice(ACLActionChoices), +# required=False, +# widget=StaticSelect(), +# label='Default Action', +# ) +# +# fieldsets = [ +# ('Host Details', ('region', 'site_group', 'site', 'device')), +# ('Access-List Details', ('type', 'default_action', 'add_tags', 'remove_tags')), +# ] +# +# class Meta: +# model = AccessList +# fields = ('region', 'site_group', 'site', 'device', 'type', 'default_action', 'add_tags', 'remove_tags') +# help_texts = { +# 'default_action': 'The default behavior of the ACL.', +# 'name': 'The name uniqueness per device is case insensitive.', +# 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access-List.'), +# } +# +# def clean(self): # Not working given you are bulkd editing multiple forms +# cleaned_data = super().clean() +# if self.errors.get('name'): +# return cleaned_data +# name = cleaned_data.get('name') +# device = cleaned_data.get('device') +# type = cleaned_data.get('type') +# if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): +# raise forms.ValidationError('An ACL with this name (case insensitive) is already associated to this device.') +# if type == 'extended' and self.cleaned_data['aclstandardrules'].exists(): +# raise forms.ValidationError('This ACL has Standard ACL rules already associated, CANNOT change ACL type!!') +# elif type == 'standard' and self.cleaned_data['aclextendedrules'].exists(): +# raise forms.ValidationError('This ACL has Extended ACL rules already associated, CANNOT change ACL type!!') +# return cleaned_data diff --git a/netbox_access_lists/forms/filtersets.py b/netbox_access_lists/forms/filtersets.py new file mode 100644 index 0000000..606bff7 --- /dev/null +++ b/netbox_access_lists/forms/filtersets.py @@ -0,0 +1,128 @@ +from dcim.models import Device, Region, Site, SiteGroup +from django import forms +from django.core.exceptions import ValidationError +from django.utils.safestring import mark_safe +from extras.models import Tag +from ipam.models import Prefix +from netbox.forms import (NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, + NetBoxModelForm) +from utilities.forms import (ChoiceField, CommentField, + DynamicModelChoiceField, + DynamicModelMultipleChoiceField, + MultipleChoiceField, StaticSelect, + StaticSelectMultiple, TagFilterField, + add_blank_choice) + +from netbox_access_lists.models import (AccessList, ACLActionChoices, ACLExtendedRule, + ACLProtocolChoices, ACLRuleActionChoices, ACLStandardRule, + ACLTypeChoices) + +__all__ = ( + 'AccessListFilterForm', + 'ACLStandardRuleFilterForm', + 'ACLExtendedRuleFilterForm', +) + + +class AccessListFilterForm(NetBoxModelFilterSetForm): + model = AccessList + region = DynamicModelChoiceField( + queryset=Region.objects.all(), + required=False, + ) + site_group = DynamicModelChoiceField( + queryset=SiteGroup.objects.all(), + required=False, + label='Site Group' + ) + site = DynamicModelChoiceField( + queryset=Site.objects.all(), + required=False + ) + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + query_params={ + 'region': '$region', + 'group_id': '$site_group', + 'site_id': '$site', + }, + required=False + ) + type = ChoiceField( + choices=add_blank_choice(ACLTypeChoices), + required=False, + initial='', + widget=StaticSelect(), + ) + default_action = ChoiceField( + choices=add_blank_choice(ACLActionChoices), + required=False, + initial='', + widget=StaticSelect(), + label='Default Action', + ) + tag = TagFilterField(model) + + fieldsets = ( + (None, ('q', 'tag')), + ('Host Details', ('region', 'site_group', 'site', 'device')), + ('ACL Details', ('type', 'default_action')), + ) + + +class ACLStandardRuleFilterForm(NetBoxModelFilterSetForm): + model = ACLStandardRule + tag = TagFilterField(model) + source_prefix = forms.ModelMultipleChoiceField( + queryset=Prefix.objects.all(), + required=False, + widget=StaticSelectMultiple(), + label='Source Prefix', + ) + action = forms.ChoiceField( + choices=add_blank_choice(ACLRuleActionChoices), + required=False, + initial='', + widget=StaticSelect(), + ) + fieldsets = ( + (None, ('q', 'tag')), + ('Rule Details', ('action', 'source_prefix',)), + ) + + +class ACLExtendedRuleFilterForm(NetBoxModelFilterSetForm): + model = ACLExtendedRule + index = forms.IntegerField( + required=False + ) + tag = TagFilterField(model) + action = forms.ChoiceField( + choices=add_blank_choice(ACLRuleActionChoices), + required=False, + widget=StaticSelect(), + initial='', + ) + source_prefix = forms.ModelMultipleChoiceField( + queryset=Prefix.objects.all(), + required=False, + widget=StaticSelectMultiple(), + label='Source Prefix', + ) + desintation_prefix = forms.ModelMultipleChoiceField( + queryset=Prefix.objects.all(), + required=False, + widget=StaticSelectMultiple(), + label='Destination Prefix', + ) + protocol = ChoiceField( + choices=add_blank_choice(ACLProtocolChoices), + required=False, + widget=StaticSelect(), + initial='', + ) + + fieldsets = ( + (None, ('q', 'tag')), + ('Rule Details', ('action', 'source_prefix', 'desintation_prefix', 'protocol')), + ) diff --git a/netbox_access_lists/forms.py b/netbox_access_lists/forms/models.py similarity index 67% rename from netbox_access_lists/forms.py rename to netbox_access_lists/forms/models.py index f9bbe36..0c48029 100644 --- a/netbox_access_lists/forms.py +++ b/netbox_access_lists/forms/models.py @@ -1,23 +1,37 @@ +from dcim.models import Device, Region, Site, SiteGroup from django import forms from django.core.exceptions import ValidationError from django.utils.safestring import mark_safe - from extras.models import Tag -from dcim.models import Device, Region, Site, SiteGroup from ipam.models import Prefix -from netbox.forms import NetBoxModelForm, NetBoxModelFilterSetForm -from utilities.forms import CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelectMultiple, TagFilterField -from .models import AccessList, ACLExtendedRule, ACLActionChoices, ACLRuleActionChoices, ACLProtocolChoices, ACLTypeChoices, ACLStandardRule +from netbox.forms import (NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, + NetBoxModelForm) +from utilities.forms import (ChoiceField, CommentField, + DynamicModelChoiceField, + DynamicModelMultipleChoiceField, + MultipleChoiceField, StaticSelect, + StaticSelectMultiple, TagFilterField, + add_blank_choice) +from netbox_access_lists.models import (AccessList, ACLActionChoices, ACLExtendedRule, + ACLProtocolChoices, ACLRuleActionChoices, ACLStandardRule, + ACLTypeChoices) + +__all__ = ( + 'AccessListForm', + 'ACLStandardRuleForm', + 'ACLExtendedRuleForm', +) acl_rule_logic_help = mark_safe('*Note: CANNOT be set if action is set to remark.') + class AccessListForm(NetBoxModelForm): - region = DynamicModelMultipleChoiceField( + region = DynamicModelChoiceField( queryset=Region.objects.all(), required=False, ) - site_group = DynamicModelMultipleChoiceField( + site_group = DynamicModelChoiceField( queryset=SiteGroup.objects.all(), required=False, label='Site Group' @@ -69,49 +83,6 @@ class AccessListForm(NetBoxModelForm): raise forms.ValidationError('This ACL has Extended ACL rules already associated, CANNOT change ACL type!!') return cleaned_data -class AccessListFilterForm(NetBoxModelFilterSetForm): - model = AccessList - region = DynamicModelMultipleChoiceField( - queryset=Region.objects.all(), - required=False, - ) - site_group = DynamicModelMultipleChoiceField( - queryset=SiteGroup.objects.all(), - required=False, - label='Site Group' - ) - site = DynamicModelChoiceField( - queryset=Site.objects.all(), - required=False - ) - device = DynamicModelChoiceField( - queryset=Device.objects.all(), - query_params={ - 'region': '$region', - 'group_id': '$site_group', - 'site_id': '$site', - }, - required=False - ) - type = forms.MultipleChoiceField( - choices=ACLTypeChoices, - required=False, - widget=StaticSelectMultiple(), - ) - default_action = forms.MultipleChoiceField( - choices=ACLActionChoices, - required=False, - widget=StaticSelectMultiple(), - label='Default Action', - ) - tag = TagFilterField(model) - - fieldsets = ( - (None, ('q', 'tag')), - ('Host Details', ('region', 'site_group', 'site', 'device')), - ('ACL Details', ('type', 'default_action')), - ) - class ACLStandardRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( @@ -164,31 +135,6 @@ class ACLStandardRuleForm(NetBoxModelForm): return cleaned_data -class ACLStandardRuleFilterForm(NetBoxModelFilterSetForm): - model = ACLStandardRule - access_list = forms.ModelMultipleChoiceField( - queryset=AccessList.objects.all(), - required=False, - widget=StaticSelectMultiple(), - label='Access-List', - ) - tag = TagFilterField(model) - source_prefix = forms.ModelMultipleChoiceField( - queryset=Prefix.objects.all(), - required=False, - widget=StaticSelectMultiple(), - label='Source Prefix', - ) - action = forms.MultipleChoiceField( - choices=ACLRuleActionChoices, - required=False, - widget=StaticSelectMultiple(), - ) - fieldsets = ( - (None, ('q', 'tag')), - ('Rule Details', ('access_list', 'action', 'source_prefix',)), - ) - class ACLExtendedRuleForm(NetBoxModelForm): access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), @@ -257,42 +203,72 @@ class ACLExtendedRuleForm(NetBoxModelForm): return cleaned_data -class ACLExtendedRuleFilterForm(NetBoxModelFilterSetForm): - model = ACLExtendedRule - access_list = forms.ModelMultipleChoiceField( - queryset=AccessList.objects.all(), - required=False, - widget=StaticSelectMultiple(), - label='Access-List', - ) - index = forms.IntegerField( - required=False - ) - tag = TagFilterField(model) - action = forms.MultipleChoiceField( - choices=ACLRuleActionChoices, - required=False, - widget=StaticSelectMultiple() - ) - source_prefix = forms.ModelMultipleChoiceField( - queryset=Prefix.objects.all(), - required=False, - widget=StaticSelectMultiple(), - label='Source Prefix', - ) - desintation_prefix = forms.ModelMultipleChoiceField( - queryset=Prefix.objects.all(), - required=False, - widget=StaticSelectMultiple(), - label='Destination Prefix', - ) - protocol = forms.MultipleChoiceField( - choices=ACLProtocolChoices, - required=False, - widget=StaticSelectMultiple() - ) +# +# Bulk Edit Forms +# - fieldsets = ( - (None, ('q', 'tag')), - ('Rule Details', ('access_list', 'action', 'source_prefix', 'desintation_prefix', 'protocol')), - ) +#class AccessListBulkEditForm(NetBoxModelBulkEditForm): +# model = AccessList +# +# region = DynamicModelChoiceField( +# queryset=Region.objects.all(), +# required=False, +# ) +# site_group = DynamicModelChoiceField( +# queryset=SiteGroup.objects.all(), +# required=False, +# label='Site Group' +# ) +# site = DynamicModelChoiceField( +# queryset=Site.objects.all(), +# required=False +# ) +# device = DynamicModelChoiceField( +# queryset=Device.objects.all(), +# query_params={ +# 'region': '$region', +# 'group_id': '$site_group', +# 'site_id': '$site', +# }, +# required=False, +# ) +# type = ChoiceField( +# choices=add_blank_choice(ACLTypeChoices), +# required=False, +# widget=StaticSelect(), +# ) +# default_action = ChoiceField( +# choices=add_blank_choice(ACLActionChoices), +# required=False, +# widget=StaticSelect(), +# label='Default Action', +# ) +# +# fieldsets = [ +# ('Host Details', ('region', 'site_group', 'site', 'device')), +# ('Access-List Details', ('type', 'default_action', 'add_tags', 'remove_tags')), +# ] +# +# class Meta: +# model = AccessList +# fields = ('region', 'site_group', 'site', 'device', 'type', 'default_action', 'add_tags', 'remove_tags') +# help_texts = { +# 'default_action': 'The default behavior of the ACL.', +# 'name': 'The name uniqueness per device is case insensitive.', +# 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access-List.'), +# } +# +# def clean(self): # Not working given you are bulkd editing multiple forms +# cleaned_data = super().clean() +# if self.errors.get('name'): +# return cleaned_data +# name = cleaned_data.get('name') +# device = cleaned_data.get('device') +# type = cleaned_data.get('type') +# if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): +# raise forms.ValidationError('An ACL with this name (case insensitive) is already associated to this device.') +# if type == 'extended' and self.cleaned_data['aclstandardrules'].exists(): +# raise forms.ValidationError('This ACL has Standard ACL rules already associated, CANNOT change ACL type!!') +# elif type == 'standard' and self.cleaned_data['aclextendedrules'].exists(): +# raise forms.ValidationError('This ACL has Extended ACL rules already associated, CANNOT change ACL type!!') +# return cleaned_data From 240326b5c1344ddf072689435e0789111803670f Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 19:40:30 +0000 Subject: [PATCH 28/38] bulkedit draft --- netbox_access_lists/urls.py | 1 + netbox_access_lists/views.py | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index c6060f2..475e906 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -9,6 +9,7 @@ urlpatterns = ( # Access-Lists path('access-lists/', views.AccessListListView.as_view(), name='accesslist_list'), path('access-lists/add/', views.AccessListEditView.as_view(), name='accesslist_add'), + #path('access-lists/edit/', views.AccessListBulkEditView.as_view(), name='accesslist_bulk_edit'), path('access-lists//', views.AccessListView.as_view(), name='accesslist'), path('access-lists//edit/', views.AccessListEditView.as_view(), name='accesslist_edit'), path('access-lists//delete/', views.AccessListDeleteView.as_view(), name='accesslist_delete'), diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 6a69f94..391f1d3 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -87,3 +87,12 @@ class ACLExtendedRuleEditView(generic.ObjectEditView): class ACLExtendedRuleDeleteView(generic.ObjectDeleteView): queryset = models.ACLExtendedRule.objects.all() + + +#class AccessListBulkEditView(generic.BulkEditView): +# queryset = models.AccessList.objects.annotate( +# rule_count=Count('aclextendedrules') + Count('aclstandardrules') +# ) +# table = tables.AccessListTable +# filterset = filtersets.AccessListFilterSet +# form = forms.AccessListBulkEditForm From 92d7c609cb581dff132aefab32f7cf9a37dc3cab Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 19:40:42 +0000 Subject: [PATCH 29/38] fix dev container --- .devcontainer/devcontainer.json | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index cee3d2e..00b3d59 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -37,20 +37,23 @@ "/opt/netbox/", "/opt/netbox/netbox" ], - "python.defaultInterpreterPath": "/opt/netbox/venv/bin/python", - "python.formatting.autopep8Path": "/opt/netbox/venv/lib/python3.9/site-packages/autopep8", - "python.formatting.blackPath": "/opt/netbox/venv/lib/python3.9/site-packages/black", + "python.defaultInterpreterPath": "/opt/netbox/venv/bin/python3", + "python.formatting.autopep8Path": "/opt/netbox/venv/bin/autopep8", + "python.formatting.blackPath": "/opt/netbox/venv/bin/black", "python.formatting.provider": "black", - "python.formatting.yapfPath": "/opt/netbox/venv/lib/python3.9/site-packages/yapf", - "python.linting.banditPath": "/opt/netbox/venv/lib/python3.9/site-packages/bandit", + "python.formatting.yapfPath": "/opt/netbox/venv/bin/yapf", + "python.linting.banditPath": "/opt/netbox/venv/bin/bandit", "python.linting.enabled": true, - "python.linting.flake8Path": "/opt/netbox/venv/lib/python3.9/site-packages/flake8", - "python.linting.mypyPath": "/opt/netbox/venv/lib/python3.9/site-packages/mypy", - "python.linting.pycodestylePath": "/opt/netbox/venv/lib/python3.9/site-packages/pycodestyle", - "python.linting.pydocstylePath": "/opt/netbox/venv/lib/python3.9/site-packages/pydocstyle", + "python.linting.flake8Path": "/opt/netbox/venv/bin/flake8", + "python.linting.mypyPath": "//opt/netbox/venv/bin/mypy", + "python.linting.pycodestylePath": "/opt/netbox/venv/bin/pycodestyle", + "python.linting.pydocstylePath": "/opt/netbox/venv/bin/pydocstyle", + "python.linting.pylintArgs": [ + "--enable=W0614" + ], "python.linting.pylintEnabled": true, - "python.linting.pylintPath": "/opt/netbox/venv/lib/python3.9/site-packages/pylint", - "python.pythonPath": "/opt/netbox/venv/bin/python", + "python.linting.pylintPath": "/opt/netbox/venv/bin/pylint", + "python.pythonPath": "/opt/netbox/venv/bin/python3", "python.terminal.activateEnvironment": true, "python.venvPath": "/opt/netbox/" }, @@ -68,7 +71,8 @@ "Tyriar.sort-lines", "GitHub.vscode-pull-request-github", "sourcery.sourcery", - "mintlify.document" + "mintlify.document", + "batisteo.vscode-django" ] } }, From c3abe828fcf9d0b899bf3a2f20d2abb0348fdb5b Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Tue, 19 Jul 2022 22:35:49 +0000 Subject: [PATCH 30/38] cleanup --- .devcontainer/devcontainer.json | 12 ++- .devcontainer/requirements-dev.txt | 1 + netbox_access_lists/forms/bulk_edit.py | 19 ++-- netbox_access_lists/forms/filtersets.py | 22 ++--- netbox_access_lists/forms/models.py | 118 ++++++------------------ pyproject.toml => pyproject.old | 26 ++++++ 6 files changed, 75 insertions(+), 123 deletions(-) rename pyproject.toml => pyproject.old (56%) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 00b3d59..536b56a 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -27,15 +27,17 @@ //"python.sortImports.args": [ // "--profile=black" //], - //"python.sortImports.path": "/opt/netbox/venv/bin/isort", + "python.sortImports.path": "/opt/netbox/venv/bin/isort", "python.analysis.typeCheckingMode": "strict", "python.analysis.extraPaths": [ "/opt/netbox/", "/opt/netbox/netbox" ], "python.autoComplete.extraPaths": [ - "/opt/netbox/", - "/opt/netbox/netbox" + "/opt/netbox/netbox/", + "/opt/netbox/netbox/**", + "/opt/netbox/netbox/**/**" + ], "python.defaultInterpreterPath": "/opt/netbox/venv/bin/python3", "python.formatting.autopep8Path": "/opt/netbox/venv/bin/autopep8", @@ -49,7 +51,9 @@ "python.linting.pycodestylePath": "/opt/netbox/venv/bin/pycodestyle", "python.linting.pydocstylePath": "/opt/netbox/venv/bin/pydocstyle", "python.linting.pylintArgs": [ - "--enable=W0614" + "--django-settings-module=/opt/netbox/netbox/netbox/netbox.settings", + "--enable=W0602,W0611,W0612,W0613,W0614", + "--load-plugins=pylint_django" ], "python.linting.pylintEnabled": true, "python.linting.pylintPath": "/opt/netbox/venv/bin/pylint", diff --git a/.devcontainer/requirements-dev.txt b/.devcontainer/requirements-dev.txt index 9f60b96..093cf52 100644 --- a/.devcontainer/requirements-dev.txt +++ b/.devcontainer/requirements-dev.txt @@ -8,4 +8,5 @@ pre-commit pycodestyle pydocstyle pylint +pylint-django yapf diff --git a/netbox_access_lists/forms/bulk_edit.py b/netbox_access_lists/forms/bulk_edit.py index eb3079e..1a3d1e2 100644 --- a/netbox_access_lists/forms/bulk_edit.py +++ b/netbox_access_lists/forms/bulk_edit.py @@ -2,20 +2,13 @@ from dcim.models import Device, Region, Site, SiteGroup from django import forms from django.core.exceptions import ValidationError from django.utils.safestring import mark_safe -from extras.models import Tag -from ipam.models import Prefix -from netbox.forms import (NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, - NetBoxModelForm) -from utilities.forms import (ChoiceField, CommentField, - DynamicModelChoiceField, - DynamicModelMultipleChoiceField, - MultipleChoiceField, StaticSelect, - StaticSelectMultiple, TagFilterField, - add_blank_choice) +from netbox.forms import NetBoxModelBulkEditForm +from utilities.forms import (ChoiceField, + DynamicModelChoiceField, StaticSelect, + add_blank_choice) -from netbox_access_lists.models import (AccessList, ACLActionChoices, ACLExtendedRule, - ACLProtocolChoices, ACLRuleActionChoices, ACLStandardRule, - ACLTypeChoices) +from netbox_access_lists.models import (AccessList, ACLActionChoices, + ACLTypeChoices) #__all__ = ( # 'AccessListBulkEditForm', diff --git a/netbox_access_lists/forms/filtersets.py b/netbox_access_lists/forms/filtersets.py index 606bff7..e33f7ef 100644 --- a/netbox_access_lists/forms/filtersets.py +++ b/netbox_access_lists/forms/filtersets.py @@ -1,21 +1,15 @@ from dcim.models import Device, Region, Site, SiteGroup from django import forms -from django.core.exceptions import ValidationError -from django.utils.safestring import mark_safe -from extras.models import Tag from ipam.models import Prefix -from netbox.forms import (NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, - NetBoxModelForm) -from utilities.forms import (ChoiceField, CommentField, - DynamicModelChoiceField, - DynamicModelMultipleChoiceField, - MultipleChoiceField, StaticSelect, - StaticSelectMultiple, TagFilterField, - add_blank_choice) +from netbox.forms import NetBoxModelFilterSetForm +from utilities.forms import (ChoiceField, DynamicModelChoiceField, + StaticSelect, StaticSelectMultiple, + TagFilterField, add_blank_choice) -from netbox_access_lists.models import (AccessList, ACLActionChoices, ACLExtendedRule, - ACLProtocolChoices, ACLRuleActionChoices, ACLStandardRule, - ACLTypeChoices) +from netbox_access_lists.models import (AccessList, ACLActionChoices, + ACLExtendedRule, ACLProtocolChoices, + ACLRuleActionChoices, ACLStandardRule, + ACLTypeChoices) __all__ = ( 'AccessListFilterForm', diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index 0c48029..615d806 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -1,21 +1,12 @@ from dcim.models import Device, Region, Site, SiteGroup from django import forms -from django.core.exceptions import ValidationError from django.utils.safestring import mark_safe from extras.models import Tag from ipam.models import Prefix -from netbox.forms import (NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, - NetBoxModelForm) -from utilities.forms import (ChoiceField, CommentField, - DynamicModelChoiceField, - DynamicModelMultipleChoiceField, - MultipleChoiceField, StaticSelect, - StaticSelectMultiple, TagFilterField, - add_blank_choice) +from netbox.forms import NetBoxModelForm +from utilities.forms import (CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField) -from netbox_access_lists.models import (AccessList, ACLActionChoices, ACLExtendedRule, - ACLProtocolChoices, ACLRuleActionChoices, ACLStandardRule, - ACLTypeChoices) +from netbox_access_lists.models import (AccessList, ACLExtendedRule, ACLStandardRule) __all__ = ( 'AccessListForm', @@ -76,11 +67,16 @@ class AccessListForm(NetBoxModelForm): device = cleaned_data.get('device') type = cleaned_data.get('type') if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): - raise forms.ValidationError('An ACL with this name (case insensitive) is already associated to this device.') + raise forms.ValidationError( + { + 'device': ['An ACL with this name (case insensitive) is already associated to this device.'], + 'name': ['An ACL with this name (case insensitive) is already associated to this device.'], + } + ) if type == 'extended' and self.instance.aclstandardrules.exists(): - raise forms.ValidationError('This ACL has Standard ACL rules already associated, CANNOT change ACL type!!') + raise forms.ValidationError({'type': ['This ACL has Standard ACL rules already associated, CANNOT change ACL type!!']}) elif type == 'standard' and self.instance.aclextendedrules.exists(): - raise forms.ValidationError('This ACL has Extended ACL rules already associated, CANNOT change ACL type!!') + raise forms.ValidationError({'type': ['This ACL has Extended ACL rules already associated, CANNOT change ACL type!!']}) return cleaned_data @@ -124,7 +120,12 @@ class ACLStandardRuleForm(NetBoxModelForm): cleaned_data = super().clean() if cleaned_data.get('action') == 'remark': if cleaned_data.get('remark') is None: - raise forms.ValidationError('Action Remark is set, MUST set a remark') + raise forms.ValidationError( + { + 'action': ['Action Remark is set, MUST add a remark.'], + 'remark': ['Action Remark is set, MUST add a remark.'], + } + ) if cleaned_data.get('source_prefix'): raise forms.ValidationError('Cannot input a remark AND a source prefix. Remove one.') else: @@ -183,6 +184,13 @@ class ACLExtendedRuleForm(NetBoxModelForm): def clean(self): cleaned_data = super().clean() if cleaned_data.get('action') == 'remark': + if cleaned_data.get('remark') is None: + raise forms.ValidationError( + { + 'action': ['Action Remark is set, MUST add a remark.'], + 'remark': ['Action Remark is set, MUST add a remark.'], + } + ) if cleaned_data.get('remark') is None: raise forms.ValidationError('Action Remark is set, MUST set a remark') if cleaned_data.get('source_prefix'): @@ -195,80 +203,6 @@ class ACLExtendedRuleForm(NetBoxModelForm): raise forms.ValidationError('CANNOT set an action of remark AND destination ports.') if cleaned_data.get('protocol'): raise forms.ValidationError('CANNOT set an action of remark AND a protocol.') - else: - if cleaned_data.get('remark'): - raise forms.ValidationError('CANNOT set a remark without the action set to remark also.') - #if cleaned_data.get('access_list_type') == 'standard' and (source_ports or destination_prefix or destination_ports): - # raise forms.ValidationError('Standard Access-Lists only allow a source_prefix or remark') + elif cleaned_data.get('remark'): + raise forms.ValidationError('CANNOT set a remark without the action set to remark also.') return cleaned_data - - -# -# Bulk Edit Forms -# - -#class AccessListBulkEditForm(NetBoxModelBulkEditForm): -# model = AccessList -# -# region = DynamicModelChoiceField( -# queryset=Region.objects.all(), -# required=False, -# ) -# site_group = DynamicModelChoiceField( -# queryset=SiteGroup.objects.all(), -# required=False, -# label='Site Group' -# ) -# site = DynamicModelChoiceField( -# queryset=Site.objects.all(), -# required=False -# ) -# device = DynamicModelChoiceField( -# queryset=Device.objects.all(), -# query_params={ -# 'region': '$region', -# 'group_id': '$site_group', -# 'site_id': '$site', -# }, -# required=False, -# ) -# type = ChoiceField( -# choices=add_blank_choice(ACLTypeChoices), -# required=False, -# widget=StaticSelect(), -# ) -# default_action = ChoiceField( -# choices=add_blank_choice(ACLActionChoices), -# required=False, -# widget=StaticSelect(), -# label='Default Action', -# ) -# -# fieldsets = [ -# ('Host Details', ('region', 'site_group', 'site', 'device')), -# ('Access-List Details', ('type', 'default_action', 'add_tags', 'remove_tags')), -# ] -# -# class Meta: -# model = AccessList -# fields = ('region', 'site_group', 'site', 'device', 'type', 'default_action', 'add_tags', 'remove_tags') -# help_texts = { -# 'default_action': 'The default behavior of the ACL.', -# 'name': 'The name uniqueness per device is case insensitive.', -# 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access-List.'), -# } -# -# def clean(self): # Not working given you are bulkd editing multiple forms -# cleaned_data = super().clean() -# if self.errors.get('name'): -# return cleaned_data -# name = cleaned_data.get('name') -# device = cleaned_data.get('device') -# type = cleaned_data.get('type') -# if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): -# raise forms.ValidationError('An ACL with this name (case insensitive) is already associated to this device.') -# if type == 'extended' and self.cleaned_data['aclstandardrules'].exists(): -# raise forms.ValidationError('This ACL has Standard ACL rules already associated, CANNOT change ACL type!!') -# elif type == 'standard' and self.cleaned_data['aclextendedrules'].exists(): -# raise forms.ValidationError('This ACL has Extended ACL rules already associated, CANNOT change ACL type!!') -# return cleaned_data diff --git a/pyproject.toml b/pyproject.old similarity index 56% rename from pyproject.toml rename to pyproject.old index d3e69f4..4203794 100644 --- a/pyproject.toml +++ b/pyproject.old @@ -1,3 +1,7 @@ +[MASTER] +load-plugins=pylint_django +django-settings-module=/opt/netbox/netbox/netbox/netbox.settings + [tool.black] line-length = 100 @@ -25,5 +29,27 @@ disable = [ "unsubscriptable-object", ] enable = [ + "expression-not-assigned", + "global-variable-not-assigned", + "possibly-unused-variable", + "reimported", + "unused-argument", + "unused-import", + "unused-variable", + "unused-wildcard-import", + "useless-else-on-loop", + "useless-import-alias", + "useless-object-inheritance", + "useless-parent-delegation", + "useless-return", "useless-suppression", # Identify unneeded pylint disable statements ] + +[tool.isort] +force_grid_wrap = 0 +include_trailing_comma = true +line_length = 79 +multi_line_output = 1 +overwrite_in_place = true +use_parentheses = true +verbose = true From 7346fd18d024610f930648e4750b0115a5e7c0bc Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 04:48:43 +0000 Subject: [PATCH 31/38] docstrings --- netbox_access_lists/__init__.py | 5 +- netbox_access_lists/api/serializers.py | 61 +++++++++++-- netbox_access_lists/api/urls.py | 4 + netbox_access_lists/api/views.py | 15 ++++ netbox_access_lists/choices.py | 21 ++++- netbox_access_lists/filtersets.py | 34 +++++++ netbox_access_lists/forms/__init__.py | 4 + netbox_access_lists/forms/bulk_edit.py | 5 ++ netbox_access_lists/forms/models.py | 89 ++++++++++++------- netbox_access_lists/graphql.py | 45 +++++++--- .../migrations/0001_initial.py | 7 ++ netbox_access_lists/models.py | 34 ++++++- netbox_access_lists/navigation.py | 15 +++- netbox_access_lists/tables.py | 20 +++++ netbox_access_lists/urls.py | 4 + netbox_access_lists/version.py | 2 +- netbox_access_lists/views.py | 67 +++++++++++--- 17 files changed, 369 insertions(+), 63 deletions(-) diff --git a/netbox_access_lists/__init__.py b/netbox_access_lists/__init__.py index 929cc65..7d4ea90 100644 --- a/netbox_access_lists/__init__.py +++ b/netbox_access_lists/__init__.py @@ -1,3 +1,7 @@ +""" +Define the NetBox Plugin +""" + from extras.plugins import PluginConfig @@ -8,5 +12,4 @@ class NetBoxAccessListsConfig(PluginConfig): version = '0.1' base_url = 'access-lists' - config = NetBoxAccessListsConfig diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index ddb5767..8253d19 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -1,50 +1,78 @@ +""" +Serializers control the translation of client data to and from Python objects, +while Django itself handles the database abstraction. +""" + from rest_framework import serializers from ipam.api.serializers import NestedPrefixSerializer from dcim.api.serializers import NestedDeviceSerializer -from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer +from netbox.api.# A module that is part of the Django REST Framework. +# A module that is part of the Django REST Framework. +serializers import NetBoxModelSerializer, WritableNestedSerializer from ..models import AccessList, ACLExtendedRule, ACLStandardRule - # # Nested serializers # + class NestedAccessListSerializer(WritableNestedSerializer): + """ + Defines the nested serializer for the django AccessList model & associates it to a view. + """ url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:accesslist-detail' ) class Meta: + """ + Associates the django model ACLStandardRule & fields to the nested serializer. + """ model = AccessList fields = ('id', 'url', 'display', 'name', 'device') class NestedACLStandardRuleSerializer(WritableNestedSerializer): + """ + Defines the nested serializer for the django ACLStandardRule model & associates it to a view. + """ url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:aclstandardrule-detail' ) class Meta: + """ + Associates the django model ACLStandardRule & fields to the nested serializer. + """ model = ACLStandardRule fields = ('id', 'url', 'display', 'index') class NestedACLExtendedRuleSerializer(WritableNestedSerializer): + """ + Defines the nested serializer for the django ACLExtendedRule model & associates it to a view. + """ url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:aclextendedrule-detail' ) class Meta: + """ + Associates the django model ACLExtendedRule & fields to the nested serializer. + """ model = ACLExtendedRule fields = ('id', 'url', 'display', 'index') - # # Regular serializers # + class AccessListSerializer(NetBoxModelSerializer): + """ + Defines the serializer for the django AccessList model & associates it to a view. + """ url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:accesslist-detail' ) @@ -52,6 +80,9 @@ class AccessListSerializer(NetBoxModelSerializer): device = NestedDeviceSerializer() class Meta: + """ + Associates the django model AccessList & fields to the serializer. + """ model = AccessList fields = ( 'id', 'url', 'display', 'name', 'device', 'type', 'default_action', 'comments', 'tags', 'custom_fields', 'created', @@ -59,7 +90,9 @@ class AccessListSerializer(NetBoxModelSerializer): ) def validate(self, data): - + """ + Validate the AccessList django model model's inputs before allowing it to update the instance. + """ if self.instance.rule_count > 0: raise serializers.ValidationError({ 'type': 'This ACL has ACL rules already associated, CANNOT change ACL type!!' @@ -69,6 +102,9 @@ class AccessListSerializer(NetBoxModelSerializer): class ACLStandardRuleSerializer(NetBoxModelSerializer): + """ + Defines the serializer for the django ACLStandardRule model & associates it to a view. + """ url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:aclstandardrule-detail' ) @@ -76,6 +112,9 @@ class ACLStandardRuleSerializer(NetBoxModelSerializer): source_prefix = NestedPrefixSerializer() class Meta: + """ + Associates the django model ACLStandardRule & fields to the serializer. + """ model = ACLStandardRule fields = ( 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', @@ -83,7 +122,9 @@ class ACLStandardRuleSerializer(NetBoxModelSerializer): ) def validate(self, data): - + """ + Validate the ACLStandardRule django model model's inputs before allowing it to update the instance. + """ access_list = data.get('access_list') if access_list.type == 'extended': raise serializers.ValidationError({ @@ -94,6 +135,9 @@ class ACLStandardRuleSerializer(NetBoxModelSerializer): class ACLExtendedRuleSerializer(NetBoxModelSerializer): + """ + Defines the serializer for the django ACLExtendedRule model & associates it to a view. + """ url = serializers.HyperlinkedIdentityField( view_name='plugins-api:netbox_access_lists-api:aclextendedrule-detail' ) @@ -102,6 +146,9 @@ class ACLExtendedRuleSerializer(NetBoxModelSerializer): destination_prefix = NestedPrefixSerializer() class Meta: + """ + Associates the django model ACLExtendedRule & fields to the serializer. + """ model = ACLExtendedRule fields = ( 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', @@ -110,7 +157,9 @@ class ACLExtendedRuleSerializer(NetBoxModelSerializer): ) def validate(self, data): - + """ + Validate the ACLExtendedRule django model model's inputs before allowing it to update the instance. + """ access_list = data.get('access_list') if access_list.type == 'standard': raise serializers.ValidationError({ diff --git a/netbox_access_lists/api/urls.py b/netbox_access_lists/api/urls.py index 07eb605..43a2af7 100644 --- a/netbox_access_lists/api/urls.py +++ b/netbox_access_lists/api/urls.py @@ -1,3 +1,7 @@ +""" +Creates API endpoint URLs for the plugin. +""" + from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index d1fc505..b808400 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -1,3 +1,9 @@ +""" +Create views to handle the API logic. +A view set is a single class that can handle the view, add, change, +and delete operations which each require dedicated views under the UI. +""" + from django.db.models import Count from netbox.api.viewsets import NetBoxModelViewSet @@ -7,6 +13,9 @@ from .serializers import AccessListSerializer, ACLExtendedRuleSerializer, ACLSta class AccessListViewSet(NetBoxModelViewSet): + """ + Defines the view set for the django AccessList model & associates it to a view. + """ queryset = models.AccessList.objects.prefetch_related( 'device', 'tags' ).annotate( @@ -17,6 +26,9 @@ class AccessListViewSet(NetBoxModelViewSet): class ACLStandardRuleViewSet(NetBoxModelViewSet): + """ + Defines the view set for the django ACLStandardRule model & associates it to a view. + """ queryset = models.ACLStandardRule.objects.prefetch_related( 'access_list', 'tags', 'source_prefix' ) @@ -25,6 +37,9 @@ class ACLStandardRuleViewSet(NetBoxModelViewSet): class ACLExtendedRuleViewSet(NetBoxModelViewSet): + """ + Defines the view set for the django ACLExtendedRule model & associates it to a view. + """ queryset = models.ACLExtendedRule.objects.prefetch_related( 'access_list', 'tags', 'source_prefix', 'destination_prefix', ) diff --git a/netbox_access_lists/choices.py b/netbox_access_lists/choices.py index f765c77..2dc03d4 100644 --- a/netbox_access_lists/choices.py +++ b/netbox_access_lists/choices.py @@ -1,6 +1,14 @@ +""" +Defines the various choices to be used by the models, forms, and other plugin specifics. +""" + from utilities.choices import ChoiceSet + class ACLActionChoices(ChoiceSet): + """ + Defines the choices availble for the Access-List plugin specific to ACL default_action. + """ ACTION_DENY = 'deny' ACTION_PERMIT = 'permit' ACTION_REJECT = 'reject' @@ -11,7 +19,11 @@ class ACLActionChoices(ChoiceSet): (ACTION_REJECT, 'Reject (Reset)', 'orange'), ] + class ACLRuleActionChoices(ChoiceSet): + """ + Defines the choices availble for the Access-List plugin specific to ACL rule actions. + """ ACTION_DENY = 'deny' ACTION_PERMIT = 'permit' ACTION_REMARK = 'remark' @@ -22,8 +34,11 @@ class ACLRuleActionChoices(ChoiceSet): (ACTION_REMARK, 'Remark', 'blue'), ] -class ACLTypeChoices(ChoiceSet): +class ACLTypeChoices(ChoiceSet): + """ + Defines the choices availble for the Access-List plugin specific to ACL type. + """ CHOICES = [ ('extended', 'Extended', 'purple'), ('standard', 'Standard', 'blue'), @@ -31,7 +46,9 @@ class ACLTypeChoices(ChoiceSet): class ACLProtocolChoices(ChoiceSet): - + """ + Defines the choices availble for the Access-List plugin specific to ACL Rule protocol. + """ CHOICES = [ ('icmp', 'ICMP', 'purple'), ('tcp', 'TCP', 'blue'), diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index c2cb69c..144f94c 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -1,31 +1,65 @@ +""" +Filters enable users to request only a specific subset of objects matching a query; +when filtering the sites list by status or region, for instance. +""" + from netbox.filtersets import NetBoxModelFilterSet from .models import AccessList, ACLExtendedRule, ACLStandardRule class AccessListFilterSet(NetBoxModelFilterSet): + """ + Define the filter set for the django model AccessList. + """ + class Meta: + """ + Associates the django model ACLStandardRule & fields to the filter set. + """ + model = ACLStandardRule model = AccessList fields = ('id', 'name', 'device', 'type', 'default_action', 'comments') def search(self, queryset, name, value): + """ + Override the default search behavior for the django model. + """ return queryset.filter(description__icontains=value) class ACLStandardRuleFilterSet(NetBoxModelFilterSet): + """ + Define the filter set for the django model ACLStandardRule. + """ class Meta: + """ + Associates the django model ACLStandardRule & fields to the filter set. + """ model = ACLStandardRule fields = ('id', 'access_list', 'index', 'action') def search(self, queryset, name, value): + """ + Override the default search behavior for the django model. + """ return queryset.filter(description__icontains=value) class ACLExtendedRuleFilterSet(NetBoxModelFilterSet): + """ + Define the filter set for the django model ACLExtendedRule. + """ class Meta: + """ + Associates the django model ACLExtendedRule & fields to the filter set. + """ model = ACLExtendedRule fields = ('id', 'access_list', 'index', 'action', 'protocol') def search(self, queryset, name, value): + """ + Override the default search behavior for the django model. + """ return queryset.filter(description__icontains=value) diff --git a/netbox_access_lists/forms/__init__.py b/netbox_access_lists/forms/__init__.py index e6825ee..4ca4f22 100644 --- a/netbox_access_lists/forms/__init__.py +++ b/netbox_access_lists/forms/__init__.py @@ -1,3 +1,7 @@ +""" +Import each of the directory's files +""" + from .models import * from .filtersets import * #from .object_create import * diff --git a/netbox_access_lists/forms/bulk_edit.py b/netbox_access_lists/forms/bulk_edit.py index 1a3d1e2..5d32ee8 100644 --- a/netbox_access_lists/forms/bulk_edit.py +++ b/netbox_access_lists/forms/bulk_edit.py @@ -1,3 +1,7 @@ +""" +Draft for a possible BulkEditForm, but may not be worth wile. +""" + from dcim.models import Device, Region, Site, SiteGroup from django import forms from django.core.exceptions import ValidationError @@ -57,6 +61,7 @@ from netbox_access_lists.models import (AccessList, ACLActionChoices, # ('Access-List Details', ('type', 'default_action', 'add_tags', 'remove_tags')), # ] # +# # class Meta: # model = AccessList # fields = ('region', 'site_group', 'site', 'device', 'type', 'default_action', 'add_tags', 'remove_tags') diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index 615d806..8fbe20f 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -1,3 +1,7 @@ +""" +Defines each django model's GUI form to add or edit objects for each django model +""" + from dcim.models import Device, Region, Site, SiteGroup from django import forms from django.utils.safestring import mark_safe @@ -14,10 +18,15 @@ __all__ = ( 'ACLExtendedRuleForm', ) +# Sets a standard mark_save help_text value to be used by the various classes acl_rule_logic_help = mark_safe('*Note: CANNOT be set if action is set to remark.') class AccessListForm(NetBoxModelForm): + """ + GUI form to add or edit an Access-List. + Requires a device, a name, a type, and a default_action. + """ region = DynamicModelChoiceField( queryset=Region.objects.all(), required=False, @@ -60,27 +69,39 @@ class AccessListForm(NetBoxModelForm): } def clean(self): + """ + Validates form inputs before submitting. + """ cleaned_data = super().clean() + error_message = {} if self.errors.get('name'): return cleaned_data name = cleaned_data.get('name') device = cleaned_data.get('device') type = cleaned_data.get('type') if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): - raise forms.ValidationError( + error_message.update( { 'device': ['An ACL with this name (case insensitive) is already associated to this device.'], - 'name': ['An ACL with this name (case insensitive) is already associated to this device.'], + 'name': ['An ACL with this name (case insensitive) is already associated to this device.'] } ) if type == 'extended' and self.instance.aclstandardrules.exists(): - raise forms.ValidationError({'type': ['This ACL has Standard ACL rules already associated, CANNOT change ACL type!!']}) + error_message.update({'type': ['This ACL has Standard ACL rules already associated, CANNOT change ACL type!!']}) elif type == 'standard' and self.instance.aclextendedrules.exists(): - raise forms.ValidationError({'type': ['This ACL has Extended ACL rules already associated, CANNOT change ACL type!!']}) + error_message.update({'type': ['This ACL has Extended ACL rules already associated, CANNOT change ACL type!!']}) + if len(error_message) > 0: + raise forms.ValidationError(error_message) + return cleaned_data class ACLStandardRuleForm(NetBoxModelForm): + """ + GUI form to add or edit Standard Access-List. + Requires an access_list, an index, and ACL rule type. + See the clean function for logic on other field requirements. + """ access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), query_params={ @@ -117,26 +138,32 @@ class ACLStandardRuleForm(NetBoxModelForm): } def clean(self): + """ + Validates form inputs before submitting. + If action is set to remark, remark needs to be set. + If action is set to remark, source_prefix cannot be set. + If action is not set to remark, remark cannot be set. + """ cleaned_data = super().clean() + error_message = {} if cleaned_data.get('action') == 'remark': if cleaned_data.get('remark') is None: - raise forms.ValidationError( - { - 'action': ['Action Remark is set, MUST add a remark.'], - 'remark': ['Action Remark is set, MUST add a remark.'], - } - ) + error_message.update({'remark': ['Action is set to remark, you MUST add a remark.']}) if cleaned_data.get('source_prefix'): - raise forms.ValidationError('Cannot input a remark AND a source prefix. Remove one.') - else: - if cleaned_data.get('remark'): - raise forms.ValidationError('CANNOT set a remark without the action set to remark also.') - #if cleaned_data.get('access_list_type') == 'standard' and (source_ports or destination_prefix or destination_ports): - # raise forms.ValidationError('Standard Access-Lists only allow a source_prefix or remark') + error_message.update({'source_prefix': ['Action is set to remark, Source Prefix CANNOT be set.']}) + elif cleaned_data.get('remark'): + error_message.update({'remark': ['CANNOT set remark unless action is set to remark, .']}) + if len(error_message) > 0: + raise forms.ValidationError(error_message) return cleaned_data class ACLExtendedRuleForm(NetBoxModelForm): + """ + GUI form to add or edit Extended Access-List. + Requires an access_list, an index, and ACL rule type. + See the clean function for logic on other field requirements. + """ access_list = DynamicModelChoiceField( queryset=AccessList.objects.all(), query_params={ @@ -182,27 +209,29 @@ class ACLExtendedRuleForm(NetBoxModelForm): } def clean(self): + """ + Validates form inputs before submitting. + If action is set to remark, remark needs to be set. + If action is set to remark, source_prefix, source_ports, desintation_prefix, destination_ports, or protocol cannot be set. + If action is not set to remark, remark cannot be set. + """ cleaned_data = super().clean() + error_message = {} if cleaned_data.get('action') == 'remark': if cleaned_data.get('remark') is None: - raise forms.ValidationError( - { - 'action': ['Action Remark is set, MUST add a remark.'], - 'remark': ['Action Remark is set, MUST add a remark.'], - } - ) - if cleaned_data.get('remark') is None: - raise forms.ValidationError('Action Remark is set, MUST set a remark') + error_message.update({'remark': ['Action is set to remark, you MUST add a remark.']}) if cleaned_data.get('source_prefix'): - raise forms.ValidationError('CANNOT set an action of remark AND a source prefix.') + error_message.update({'source_prefix': ['Action is set to remark, Source Prefix CANNOT be set.']}) if cleaned_data.get('source_ports'): - raise forms.ValidationError('CANNOT set an action of remark AND source ports.') + error_message.update({'source_ports': ['Action is set to remark, Source Ports CANNOT be set.']}) if cleaned_data.get('destination_prefix'): - raise forms.ValidationError('CANNOT set an action of remark AND a destination prefix.') + error_message.update({'destination_prefix': ['Action is set to remark, Destination Prefix CANNOT be set.']}) if cleaned_data.get('destination_ports'): - raise forms.ValidationError('CANNOT set an action of remark AND destination ports.') + error_message.update({'destination_ports': ['Action is set to remark, Destination Ports CANNOT be set.']}) if cleaned_data.get('protocol'): - raise forms.ValidationError('CANNOT set an action of remark AND a protocol.') + error_message.update({'protocol': ['Action is set to remark, Protocol CANNOT be set.']}) elif cleaned_data.get('remark'): - raise forms.ValidationError('CANNOT set a remark without the action set to remark also.') + error_message.update({'remark': ['CANNOT set remark unless action is set to remark, .']}) + if len(error_message) > 0: + raise forms.ValidationError(error_message) return cleaned_data diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index eadc310..d952a4d 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -1,32 +1,54 @@ +""" +Define the object types and queries availble via the graphql api. +""" + from graphene import ObjectType from netbox.graphql.types import NetBoxObjectType from netbox.graphql.fields import ObjectField, ObjectListField from . import filtersets, models - # # Object types # + class AccessListType(NetBoxObjectType): + """ + Defines the object type for the django model AccessList. + """ class Meta: + """ + Associates the filterset, fields, and model for the django model AccessList. + """ model = models.AccessList fields = '__all__' filterset_class = filtersets.AccessListFilterSet class ACLExtendedRuleType(NetBoxObjectType): + """ + Defines the object type for the django model ACLExtendedRule. + """ class Meta: + """ + Associates the filterset, fields, and model for the django model ACLExtendedRule. + """ model = models.ACLExtendedRule fields = '__all__' filterset_class = filtersets.ACLExtendedRuleFilterSet class ACLStandardRuleType(NetBoxObjectType): + """ + Defines the object type for the django model ACLStandardRule. + """ class Meta: + """ + Associates the filterset, fields, and model for the django model ACLStandardRule. + """ model = models.ACLStandardRule fields = '__all__' filterset_class = filtersets.ACLStandardRuleFilterSet @@ -35,19 +57,22 @@ class ACLStandardRuleType(NetBoxObjectType): # Queries # + class Query(ObjectType): + """ + Defines the queries availible to this plugin via the graphql api. + """ + access_list = ObjectField(AccessListType) + access_lists = ObjectListField(AccessListType) access_list_list = ObjectListField(AccessListType) - access_list_rule = ObjectField(ACLExtendedRuleType) - access_list_rule_list = ObjectListField(ACLExtendedRuleType) + acl_extended_rule = ObjectField(ACLExtendedRuleType) + acl_extended_rules = ObjectListField(ACLExtendedRuleType) + acl_extended_rule_list = ObjectListField(ACLExtendedRuleType) - -#class Query(ObjectType): -# access_list = ObjectField(AccessListType) -# access_list_list = ObjectListField(AccessListType) -# -# access_list_rule = ObjectField(ACLStandardRuleType) -# access_list_rule_list = ObjectListField(ACLStandardRuleType) + acl_standard_rule = ObjectField(ACLStandardRuleType) + acl_standard_rules = ObjectListField(ACLStandardRuleType) + acl_standard_rule_list = ObjectListField(ACLStandardRuleType) schema = Query diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index 84f623f..9f040fe 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -1,3 +1,7 @@ +""" +Defines the migrations for propogating django models into the database schemea. +""" + import django.contrib.postgres.fields import django.core.serializers.json from django.db import migrations, models @@ -6,6 +10,9 @@ import taggit.managers class Migration(migrations.Migration): + """ + Defines the migrations required for the initial setup of the access-list plugin and its associated django models. + """ initial = True diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 4e325e1..21ece64 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -1,3 +1,7 @@ +""" +Define the django models for this plugin. +""" + from django.contrib.postgres.fields import ArrayField from django.db import models from django.urls import reverse @@ -5,8 +9,17 @@ from django.urls import reverse from netbox.models import NetBoxModel from netbox_access_lists.choices import * +__all__ = ( + 'AccessList', + 'ACLStandardRule', + 'ACLExtendedRule', +) + class AccessList(NetBoxModel): + """ + Model defintion for Access-Lists. + """ name = models.CharField( max_length=100 ) @@ -36,6 +49,10 @@ class AccessList(NetBoxModel): return self.name def get_absolute_url(self): + """ + The method is a Django convention; although not strictly required, + it conveniently returns the absolute URL for any particular object. + """ return reverse('plugins:netbox_access_lists:accesslist', args=[self.pk]) def get_default_action_color(self): @@ -48,6 +65,7 @@ class AccessList(NetBoxModel): class ACLRule(NetBoxModel): """ Abstract model for ACL Rules. + Inherrited by both ACLStandardRule and ACLExtendedRule. """ access_list = models.ForeignKey( on_delete=models.CASCADE, @@ -79,7 +97,6 @@ class ACLRule(NetBoxModel): def get_action_color(self): return ACLRuleActionChoices.colors.get(self.action) - class Meta: abstract = True default_related_name='%(class)ss' @@ -88,12 +105,23 @@ class ACLRule(NetBoxModel): class ACLStandardRule(ACLRule): + """ + Inherits ACLRule. + """ def get_absolute_url(self): + """ + The method is a Django convention; although not strictly required, + it conveniently returns the absolute URL for any particular object. + """ return reverse('plugins:netbox_access_lists:aclstandardrule', args=[self.pk]) class ACLExtendedRule(ACLRule): + """ + Inherits ACLRule. + Add ACLExtendedRule specific fields: source_ports, desintation_prefix, destination_ports, and protocol + """ source_ports = ArrayField( base_field=models.PositiveIntegerField(), blank=True, @@ -121,6 +149,10 @@ class ACLExtendedRule(ACLRule): ) def get_absolute_url(self): + """ + The method is a Django convention; although not strictly required, + it conveniently returns the absolute URL for any particular object. + """ return reverse('plugins:netbox_access_lists:aclextendedrule', args=[self.pk]) def get_protocol_color(self): diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index d9759a4..4d6f5f1 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -1,6 +1,13 @@ +""" +Define the plugin menu buttons & the plugin navigation bar enteries. +""" + from extras.plugins import PluginMenuButton, PluginMenuItem from utilities.choices import ButtonColorChoices +# +# Define plugin menu buttons +# accesslist_buttons = [ PluginMenuButton( @@ -29,19 +36,23 @@ aclextendedrule_butons = [ ) ] +# +# Define navigation bar links including the above buttons defined. +# + menu_items = ( PluginMenuItem( link='plugins:netbox_access_lists:accesslist_list', link_text='Access-Lists', buttons=accesslist_buttons ), - # Comment out Standard Access List Rule to force creation in the ACL view + # Comment out Standard Access-List rule to force creation in the ACL view PluginMenuItem( link='plugins:netbox_access_lists:aclstandardrule_list', link_text='Standard Access-List Rules', buttons=aclstandardrule_butons ), - # Comment out Extended Access List Rule to force creation in the ACL view + # Comment out Extended Access-List rule to force creation in the ACL view PluginMenuItem( link='plugins:netbox_access_lists:aclextendedrule_list', link_text='Extended Access-List Rules', diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index 93d741e..d2f14b2 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -1,10 +1,23 @@ +""" +Define the object lists / table view for each of the plugin models. +""" + import django_tables2 as tables from netbox.tables import NetBoxTable, columns, ChoiceFieldColumn from .models import AccessList, ACLExtendedRule, ACLStandardRule +__all__ = ( + 'AccessListTable', + 'ACLStandardRuleTable', + 'ACLExtendedRuleTable', +) + class AccessListTable(NetBoxTable): + """ + Defines the table view for the AccessList model. + """ name = tables.Column( linkify=True ) @@ -27,6 +40,9 @@ class AccessListTable(NetBoxTable): class ACLStandardRuleTable(NetBoxTable): + """ + Defines the table view for the ACLStandardRule model. + """ access_list = tables.Column( linkify=True ) @@ -37,6 +53,7 @@ class ACLStandardRuleTable(NetBoxTable): tags = columns.TagColumn( url_name='plugins:netbox_access_lists:aclstandardrule_list' ) + class Meta(NetBoxTable.Meta): model = ACLStandardRule fields = ( @@ -48,6 +65,9 @@ class ACLStandardRuleTable(NetBoxTable): class ACLExtendedRuleTable(NetBoxTable): + """ + Defines the table view for the ACLExtendedRule model. + """ access_list = tables.Column( linkify=True ) diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index 475e906..11e9451 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -1,3 +1,7 @@ +""" +Map Views to URLs. +""" + from django.urls import path from netbox.views.generic import ObjectChangeLogView diff --git a/netbox_access_lists/version.py b/netbox_access_lists/version.py index 6c8e6b9..5becc17 100644 --- a/netbox_access_lists/version.py +++ b/netbox_access_lists/version.py @@ -1 +1 @@ -__version__ = "0.0.0" +__version__ = "1.0.0" diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 391f1d3..9e6a7b1 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -1,3 +1,8 @@ +""" +Defines the business logic for the plugin. +Specifically, all the various interactions with a client. +""" + from django.db.models import Count from netbox.views import generic @@ -9,9 +14,15 @@ from . import filtersets, forms, models, tables # class AccessListView(generic.ObjectView): + """ + Defines the view for the AccessLists django model. + """ queryset = models.AccessList.objects.all() def get_extra_context(self, request, instance): + """ + Depending on the Access-List type, the list view will return the required ACL Rule using the previous defined tables in tables.py. + """ if instance.type == 'extended': table = tables.ACLExtendedRuleTable(instance.aclextendedrules.all()) elif instance.type == 'standard': @@ -24,6 +35,9 @@ class AccessListView(generic.ObjectView): class AccessListListView(generic.ObjectListView): + """ + Defines the list view for the AccessLists django model. + """ queryset = models.AccessList.objects.annotate( rule_count=Count('aclextendedrules') + Count('aclstandardrules') ) @@ -33,23 +47,47 @@ class AccessListListView(generic.ObjectListView): class AccessListEditView(generic.ObjectEditView): + """ + Defines the edit view for the AccessLists django model. + """ queryset = models.AccessList.objects.all() form = forms.AccessListForm class AccessListDeleteView(generic.ObjectDeleteView): + """ + Defines the delete view for the AccessLists django model. + """ queryset = models.AccessList.objects.all() +#class AccessListBulkEditView(generic.BulkEditView): +# """ +# Defines the bulk edit view for the AccessList django model. +# """ +# queryset = models.AccessList.objects.annotate( +# rule_count=Count('aclextendedrules') + Count('aclstandardrules') +# ) +# table = tables.AccessListTable +# filterset = filtersets.AccessListFilterSet +# form = forms.AccessListBulkEditForm + # # ACLStandardRule views # + class ACLStandardRuleView(generic.ObjectView): + """ + Defines the view for the ACLStandardRule django model. + """ queryset = models.ACLStandardRule.objects.all() class ACLStandardRuleListView(generic.ObjectListView): + """ + Defines the list view for the ACLStandardRule django model. + """ queryset = models.ACLStandardRule.objects.all() table = tables.ACLStandardRuleTable filterset = filtersets.ACLStandardRuleFilterSet @@ -57,23 +95,35 @@ class ACLStandardRuleListView(generic.ObjectListView): class ACLStandardRuleEditView(generic.ObjectEditView): + """ + Defines the edit view for the ACLStandardRule django model. + """ queryset = models.ACLStandardRule.objects.all() form = forms.ACLStandardRuleForm class ACLStandardRuleDeleteView(generic.ObjectDeleteView): + """ + Defines the delete view for the ACLStandardRules django model. + """ queryset = models.ACLStandardRule.objects.all() - # # ACLExtendedRule views # + class ACLExtendedRuleView(generic.ObjectView): + """ + Defines the view for the ACLExtendedRule django model. + """ queryset = models.ACLExtendedRule.objects.all() class ACLExtendedRuleListView(generic.ObjectListView): + """ + Defines the list view for the ACLExtendedRule django model. + """ queryset = models.ACLExtendedRule.objects.all() table = tables.ACLExtendedRuleTable filterset = filtersets.ACLExtendedRuleFilterSet @@ -81,18 +131,15 @@ class ACLExtendedRuleListView(generic.ObjectListView): class ACLExtendedRuleEditView(generic.ObjectEditView): + """ + Defines the edit view for the ACLExtendedRule django model. + """ queryset = models.ACLExtendedRule.objects.all() form = forms.ACLExtendedRuleForm class ACLExtendedRuleDeleteView(generic.ObjectDeleteView): + """ + Defines the delete view for the ACLExtendedRules django model. + """ queryset = models.ACLExtendedRule.objects.all() - - -#class AccessListBulkEditView(generic.BulkEditView): -# queryset = models.AccessList.objects.annotate( -# rule_count=Count('aclextendedrules') + Count('aclstandardrules') -# ) -# table = tables.AccessListTable -# filterset = filtersets.AccessListFilterSet -# form = forms.AccessListBulkEditForm From be67f7e9ce036bc092bef9ef7ebab84949aac0aa Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 04:49:03 +0000 Subject: [PATCH 32/38] update devcontainer --- .devcontainer/devcontainer.json | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 536b56a..437c4a2 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -51,9 +51,12 @@ "python.linting.pycodestylePath": "/opt/netbox/venv/bin/pycodestyle", "python.linting.pydocstylePath": "/opt/netbox/venv/bin/pydocstyle", "python.linting.pylintArgs": [ + "--load-plugins", + "pylint_django", + "--errors-only", + "--load-plugins=pylint_django", "--django-settings-module=/opt/netbox/netbox/netbox/netbox.settings", - "--enable=W0602,W0611,W0612,W0613,W0614", - "--load-plugins=pylint_django" + "--enable=W0602,W0611,W0612,W0613,W0614" ], "python.linting.pylintEnabled": true, "python.linting.pylintPath": "/opt/netbox/venv/bin/pylint", From b8d9994f08ef79b7551a86b1f37c1bd65b019c15 Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 05:05:26 +0000 Subject: [PATCH 33/38] correct api serializer import mistake --- netbox_access_lists/api/serializers.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index 8253d19..da21dc9 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -5,11 +5,9 @@ while Django itself handles the database abstraction. from rest_framework import serializers +from dcim.api.nested_serializers import NestedDeviceSerializer from ipam.api.serializers import NestedPrefixSerializer -from dcim.api.serializers import NestedDeviceSerializer -from netbox.api.# A module that is part of the Django REST Framework. -# A module that is part of the Django REST Framework. -serializers import NetBoxModelSerializer, WritableNestedSerializer +from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer from ..models import AccessList, ACLExtendedRule, ACLStandardRule # From 0a9260bfc4f33c10b5a292015db74f73699efd1d Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 05:10:05 +0000 Subject: [PATCH 34/38] add ACL rule description back --- netbox_access_lists/api/serializers.py | 4 ++-- netbox_access_lists/forms/models.py | 8 ++++---- netbox_access_lists/migrations/0001_initial.py | 2 ++ netbox_access_lists/models.py | 4 ++++ netbox_access_lists/tables.py | 4 ++-- .../templates/netbox_access_lists/aclextendedrule.html | 4 ++++ .../templates/netbox_access_lists/aclstandardrule.html | 4 ++++ 7 files changed, 22 insertions(+), 8 deletions(-) diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index da21dc9..3d262fc 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -115,7 +115,7 @@ class ACLStandardRuleSerializer(NetBoxModelSerializer): """ model = ACLStandardRule fields = ( - 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', + 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', 'description', 'created', 'custom_fields', 'last_updated', 'source_prefix' ) @@ -149,7 +149,7 @@ class ACLExtendedRuleSerializer(NetBoxModelSerializer): """ model = ACLExtendedRule fields = ( - 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', + 'id', 'url', 'display', 'access_list', 'index', 'action', 'tags', 'description', 'created', 'custom_fields', 'last_updated', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' ) diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index 8fbe20f..5867b54 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -122,7 +122,7 @@ class ACLStandardRuleForm(NetBoxModelForm): ) fieldsets = ( - ('Access-List Details', ('access_list', 'tags')), + ('Access-List Details', ('access_list', 'description', 'tags')), ('Rule Definition', ('index', 'action', 'remark', 'source_prefix')), ) @@ -130,7 +130,7 @@ class ACLStandardRuleForm(NetBoxModelForm): model = ACLStandardRule fields = ( 'access_list', 'index', 'action', 'remark', 'source_prefix', - 'tags', + 'tags', 'description' ) help_texts = { 'index': 'Determines the order of the rule in the ACL processing.', @@ -189,7 +189,7 @@ class ACLExtendedRuleForm(NetBoxModelForm): label='Destination Prefix', ) fieldsets = ( - ('Access-List Details', ('access_list', 'tags')), + ('Access-List Details', ('access_list', 'description', 'tags')), ('Rule Definition', ('index', 'action', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol',)), ) @@ -198,7 +198,7 @@ class ACLExtendedRuleForm(NetBoxModelForm): fields = ( 'access_list', 'index', 'action', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol', - 'tags' + 'tags', 'description' ) help_texts = { 'destination_ports': acl_rule_logic_help, diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index 9f040fe..52179da 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -51,6 +51,7 @@ class Migration(migrations.Migration): ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclstandardrules', to='netbox_access_lists.accesslist')), ('index', models.PositiveIntegerField()), + ('description', models.CharField(blank=True, max_length=500)), ('action', models.CharField(max_length=30)), ('remark', models.CharField(blank=True, null=True, max_length=500)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), @@ -70,6 +71,7 @@ class Migration(migrations.Migration): ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ('access_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='aclstandardrules', to='netbox_access_lists.accesslist')), ('index', models.PositiveIntegerField()), + ('description', models.CharField(blank=True, max_length=500)), ('action', models.CharField(max_length=30)), ('remark', models.CharField(blank=True, null=True, max_length=500)), ('source_prefix', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='ipam.prefix')), diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 21ece64..9efbecb 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -78,6 +78,10 @@ class ACLRule(NetBoxModel): blank=True, null=True ) + description = models.CharField( + max_length=500, + blank=True + ) action = models.CharField( choices=ACLRuleActionChoices, max_length=30, diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index d2f14b2..e2b670f 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -57,7 +57,7 @@ class ACLStandardRuleTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = ACLStandardRule fields = ( - 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags' + 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags', 'description', ) default_columns = ( 'access_list', 'index', 'action', 'actions', 'remark', 'tags' @@ -83,7 +83,7 @@ class ACLExtendedRuleTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = ACLExtendedRule fields = ( - 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags', + 'pk', 'id', 'access_list', 'index', 'action', 'actions', 'remark', 'tags', 'description', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol' ) default_columns = ( diff --git a/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html index 2448d63..fc3b3c9 100644 --- a/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html @@ -13,6 +13,10 @@ {{ object.access_list }} + + + + diff --git a/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html index 1a013e0..41a13bb 100644 --- a/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html @@ -17,6 +17,10 @@ + + + +
    Access ListAccess-List {{ object.access_list }}
    Description{{ object.description|placeholder }}
    Index {{ object.index }}Index {{ object.index }}
    Description{{ object.description|placeholder }}
    From 1e9a86cc8b2f714021f6e2583b64a566d2c5131f Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 12:18:00 +0000 Subject: [PATCH 35/38] add missing docstrings & add all --- netbox_access_lists/choices.py | 6 ++++++ netbox_access_lists/filtersets.py | 6 ++++++ netbox_access_lists/forms/__init__.py | 2 +- netbox_access_lists/forms/filtersets.py | 13 +++++++++++++ netbox_access_lists/forms/models.py | 4 ++-- netbox_access_lists/graphql.py | 6 ++++++ netbox_access_lists/migrations/0001_initial.py | 3 +++ netbox_access_lists/models.py | 1 + netbox_access_lists/template_content.py | 5 +++++ netbox_access_lists/views.py | 14 ++++++++++++++ 10 files changed, 57 insertions(+), 3 deletions(-) diff --git a/netbox_access_lists/choices.py b/netbox_access_lists/choices.py index 2dc03d4..b3bf133 100644 --- a/netbox_access_lists/choices.py +++ b/netbox_access_lists/choices.py @@ -4,6 +4,12 @@ Defines the various choices to be used by the models, forms, and other plugin sp from utilities.choices import ChoiceSet +__all__ = ( + 'ACLActionChoices', + 'ACLRuleActionChoices', + 'ACLTypeChoices', +) + class ACLActionChoices(ChoiceSet): """ diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index 144f94c..5f28060 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -6,6 +6,12 @@ when filtering the sites list by status or region, for instance. from netbox.filtersets import NetBoxModelFilterSet from .models import AccessList, ACLExtendedRule, ACLStandardRule +__all__ = ( + 'AccessListFilterSet', + 'ACLStandardRuleFilterSet', + 'ACLExtendedRuleFilterSet', +) + class AccessListFilterSet(NetBoxModelFilterSet): """ diff --git a/netbox_access_lists/forms/__init__.py b/netbox_access_lists/forms/__init__.py index 4ca4f22..2d732f3 100644 --- a/netbox_access_lists/forms/__init__.py +++ b/netbox_access_lists/forms/__init__.py @@ -1,5 +1,5 @@ """ -Import each of the directory's files +Import each of the directory's scripts. """ from .models import * diff --git a/netbox_access_lists/forms/filtersets.py b/netbox_access_lists/forms/filtersets.py index e33f7ef..eb9381a 100644 --- a/netbox_access_lists/forms/filtersets.py +++ b/netbox_access_lists/forms/filtersets.py @@ -1,3 +1,7 @@ +""" +Defines each django model's GUI filter/search options. +""" + from dcim.models import Device, Region, Site, SiteGroup from django import forms from ipam.models import Prefix @@ -19,6 +23,9 @@ __all__ = ( class AccessListFilterForm(NetBoxModelFilterSetForm): + """ + GUI filter form to search the django AccessList model. + """ model = AccessList region = DynamicModelChoiceField( queryset=Region.objects.all(), @@ -65,6 +72,9 @@ class AccessListFilterForm(NetBoxModelFilterSetForm): class ACLStandardRuleFilterForm(NetBoxModelFilterSetForm): + """ + GUI filter form to search the django ACLStandardRule model. + """ model = ACLStandardRule tag = TagFilterField(model) source_prefix = forms.ModelMultipleChoiceField( @@ -86,6 +96,9 @@ class ACLStandardRuleFilterForm(NetBoxModelFilterSetForm): class ACLExtendedRuleFilterForm(NetBoxModelFilterSetForm): + """ + GUI filter form to search the django ACLExtendedRule model. + """ model = ACLExtendedRule index = forms.IntegerField( required=False diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index 5867b54..934e56f 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -1,5 +1,5 @@ """ -Defines each django model's GUI form to add or edit objects for each django model +Defines each django model's GUI form to add or edit objects for each django model. """ from dcim.models import Device, Region, Site, SiteGroup @@ -24,7 +24,7 @@ acl_rule_logic_help = mark_safe('*Note: CANNOT be set if action is set to class AccessListForm(NetBoxModelForm): """ - GUI form to add or edit an Access-List. + GUI form to add or edit an AccessList. Requires a device, a name, a type, and a default_action. """ region = DynamicModelChoiceField( diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index d952a4d..a679801 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -7,6 +7,12 @@ from netbox.graphql.types import NetBoxObjectType from netbox.graphql.fields import ObjectField, ObjectListField from . import filtersets, models +__all__ = ( + 'AccessListType', + 'ACLExtendedRuleType', + 'ACLStandardRuleType', +) + # # Object types # diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index 52179da..5ff82ce 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -8,6 +8,9 @@ from django.db import migrations, models import django.db.models.deletion import taggit.managers +__all__ = ( + 'Migration', +) class Migration(migrations.Migration): """ diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models.py index 9efbecb..61875de 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models.py @@ -11,6 +11,7 @@ from netbox_access_lists.choices import * __all__ = ( 'AccessList', + 'ACLRule', 'ACLStandardRule', 'ACLExtendedRule', ) diff --git a/netbox_access_lists/template_content.py b/netbox_access_lists/template_content.py index 1431bd4..47ab718 100644 --- a/netbox_access_lists/template_content.py +++ b/netbox_access_lists/template_content.py @@ -4,6 +4,11 @@ from django.contrib.contenttypes.models import ContentType from extras.plugins import PluginTemplateExtension from .models import AccessList +__all__ = ( + 'AccessLists', + 'DeviceAccessLists', +) + class AccessLists(PluginTemplateExtension): diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 9e6a7b1..508570c 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -8,6 +8,20 @@ from django.db.models import Count from netbox.views import generic from . import filtersets, forms, models, tables +__all__ = ( + 'AccessListView', + 'AccessListListView', + 'AccessListEditView', + 'ACLStandardRuleView', + 'ACLStandardRuleListView', + 'ACLStandardRuleEditView', + 'ACLStandardRuleDeleteView', + 'ACLExtendedRuleView', + 'ACLExtendedRuleListView', + 'ACLExtendedRuleEditView', + 'ACLExtendedRuleDeleteView', +) + # # AccessList views From 82631f454462eac101989a6efb7e079e8a37506d Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 14:21:25 +0000 Subject: [PATCH 36/38] import sort & move models to a directory --- .devcontainer/configuration/plugins.py | 2 +- netbox_access_lists/api/serializers.py | 7 ++- netbox_access_lists/api/urls.py | 2 +- netbox_access_lists/api/views.py | 4 +- netbox_access_lists/choices.py | 1 + netbox_access_lists/filtersets.py | 6 +- netbox_access_lists/forms/__init__.py | 8 +-- netbox_access_lists/forms/bulk_edit.py | 9 ++- netbox_access_lists/forms/filtersets.py | 7 +-- netbox_access_lists/forms/models.py | 5 +- netbox_access_lists/graphql.py | 3 +- .../migrations/0001_initial.py | 2 +- netbox_access_lists/models/__init__.py | 6 ++ .../access_list_rules.py} | 52 +--------------- netbox_access_lists/models/access_lists.py | 59 +++++++++++++++++++ netbox_access_lists/tables.py | 2 +- netbox_access_lists/template_content.py | 2 +- netbox_access_lists/urls.py | 3 +- netbox_access_lists/views.py | 2 +- setup.py | 2 +- 20 files changed, 102 insertions(+), 82 deletions(-) create mode 100644 netbox_access_lists/models/__init__.py rename netbox_access_lists/{models.py => models/access_list_rules.py} (70%) create mode 100644 netbox_access_lists/models/access_lists.py diff --git a/.devcontainer/configuration/plugins.py b/.devcontainer/configuration/plugins.py index 67b1017..a92555c 100644 --- a/.devcontainer/configuration/plugins.py +++ b/.devcontainer/configuration/plugins.py @@ -6,7 +6,7 @@ PLUGINS = [ "netbox_access_lists", - #"netbox_secretstore" + "netbox_secretstore" ] PLUGINS_CONFIG = { diff --git a/netbox_access_lists/api/serializers.py b/netbox_access_lists/api/serializers.py index 3d262fc..c34d193 100644 --- a/netbox_access_lists/api/serializers.py +++ b/netbox_access_lists/api/serializers.py @@ -3,11 +3,12 @@ Serializers control the translation of client data to and from Python objects, while Django itself handles the database abstraction. """ -from rest_framework import serializers - from dcim.api.nested_serializers import NestedDeviceSerializer from ipam.api.serializers import NestedPrefixSerializer -from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer +from netbox.api.serializers import (NetBoxModelSerializer, + WritableNestedSerializer) +from rest_framework import serializers + from ..models import AccessList, ACLExtendedRule, ACLStandardRule # diff --git a/netbox_access_lists/api/urls.py b/netbox_access_lists/api/urls.py index 43a2af7..20fb28b 100644 --- a/netbox_access_lists/api/urls.py +++ b/netbox_access_lists/api/urls.py @@ -3,8 +3,8 @@ Creates API endpoint URLs for the plugin. """ from netbox.api.routers import NetBoxRouter -from . import views +from . import views app_name = 'netbox_access_list' diff --git a/netbox_access_lists/api/views.py b/netbox_access_lists/api/views.py index b808400..9617d1d 100644 --- a/netbox_access_lists/api/views.py +++ b/netbox_access_lists/api/views.py @@ -5,11 +5,11 @@ and delete operations which each require dedicated views under the UI. """ from django.db.models import Count - from netbox.api.viewsets import NetBoxModelViewSet from .. import filtersets, models -from .serializers import AccessListSerializer, ACLExtendedRuleSerializer, ACLStandardRuleSerializer +from .serializers import (AccessListSerializer, ACLExtendedRuleSerializer, + ACLStandardRuleSerializer) class AccessListViewSet(NetBoxModelViewSet): diff --git a/netbox_access_lists/choices.py b/netbox_access_lists/choices.py index b3bf133..71a4b7e 100644 --- a/netbox_access_lists/choices.py +++ b/netbox_access_lists/choices.py @@ -8,6 +8,7 @@ __all__ = ( 'ACLActionChoices', 'ACLRuleActionChoices', 'ACLTypeChoices', + 'ACLProtocolChoices', ) diff --git a/netbox_access_lists/filtersets.py b/netbox_access_lists/filtersets.py index 5f28060..5254349 100644 --- a/netbox_access_lists/filtersets.py +++ b/netbox_access_lists/filtersets.py @@ -4,7 +4,8 @@ when filtering the sites list by status or region, for instance. """ from netbox.filtersets import NetBoxModelFilterSet -from .models import AccessList, ACLExtendedRule, ACLStandardRule + +from .models import * __all__ = ( 'AccessListFilterSet', @@ -20,9 +21,8 @@ class AccessListFilterSet(NetBoxModelFilterSet): class Meta: """ - Associates the django model ACLStandardRule & fields to the filter set. + Associates the django model AccessList & fields to the filter set. """ - model = ACLStandardRule model = AccessList fields = ('id', 'name', 'device', 'type', 'default_action', 'comments') diff --git a/netbox_access_lists/forms/__init__.py b/netbox_access_lists/forms/__init__.py index 2d732f3..01f1bbd 100644 --- a/netbox_access_lists/forms/__init__.py +++ b/netbox_access_lists/forms/__init__.py @@ -2,12 +2,12 @@ Import each of the directory's scripts. """ -from .models import * -from .filtersets import * -#from .object_create import * -#from .object_import import * #from .bulk_create import * from .bulk_edit import * #from .bulk_import import * #from .connections import * +from .filtersets import * #from .formsets import * +from .models import * +#from .object_create import * +#from .object_import import * diff --git a/netbox_access_lists/forms/bulk_edit.py b/netbox_access_lists/forms/bulk_edit.py index 5d32ee8..d984e46 100644 --- a/netbox_access_lists/forms/bulk_edit.py +++ b/netbox_access_lists/forms/bulk_edit.py @@ -7,12 +7,11 @@ from django import forms from django.core.exceptions import ValidationError from django.utils.safestring import mark_safe from netbox.forms import NetBoxModelBulkEditForm -from utilities.forms import (ChoiceField, - DynamicModelChoiceField, StaticSelect, - add_blank_choice) +from utilities.forms import (ChoiceField, DynamicModelChoiceField, + StaticSelect, add_blank_choice) -from netbox_access_lists.models import (AccessList, ACLActionChoices, - ACLTypeChoices) +from ..choices import ACLActionChoices, ACLTypeChoices +from ..models import AccessList #__all__ = ( # 'AccessListBulkEditForm', diff --git a/netbox_access_lists/forms/filtersets.py b/netbox_access_lists/forms/filtersets.py index eb9381a..78d88d0 100644 --- a/netbox_access_lists/forms/filtersets.py +++ b/netbox_access_lists/forms/filtersets.py @@ -10,10 +10,9 @@ from utilities.forms import (ChoiceField, DynamicModelChoiceField, StaticSelect, StaticSelectMultiple, TagFilterField, add_blank_choice) -from netbox_access_lists.models import (AccessList, ACLActionChoices, - ACLExtendedRule, ACLProtocolChoices, - ACLRuleActionChoices, ACLStandardRule, - ACLTypeChoices) +from ..choices import (ACLActionChoices, ACLProtocolChoices, + ACLRuleActionChoices, ACLTypeChoices) +from ..models import AccessList, ACLExtendedRule, ACLStandardRule __all__ = ( 'AccessListFilterForm', diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index 934e56f..95ec45f 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -8,9 +8,10 @@ from django.utils.safestring import mark_safe from extras.models import Tag from ipam.models import Prefix from netbox.forms import NetBoxModelForm -from utilities.forms import (CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField) +from utilities.forms import (CommentField, DynamicModelChoiceField, + DynamicModelMultipleChoiceField) -from netbox_access_lists.models import (AccessList, ACLExtendedRule, ACLStandardRule) +from ..models import AccessList, ACLExtendedRule, ACLStandardRule __all__ = ( 'AccessListForm', diff --git a/netbox_access_lists/graphql.py b/netbox_access_lists/graphql.py index a679801..7295323 100644 --- a/netbox_access_lists/graphql.py +++ b/netbox_access_lists/graphql.py @@ -3,8 +3,9 @@ Define the object types and queries availble via the graphql api. """ from graphene import ObjectType -from netbox.graphql.types import NetBoxObjectType from netbox.graphql.fields import ObjectField, ObjectListField +from netbox.graphql.types import NetBoxObjectType + from . import filtersets, models __all__ = ( diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index 5ff82ce..a1d4a58 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -4,9 +4,9 @@ Defines the migrations for propogating django models into the database schemea. import django.contrib.postgres.fields import django.core.serializers.json -from django.db import migrations, models import django.db.models.deletion import taggit.managers +from django.db import migrations, models __all__ = ( 'Migration', diff --git a/netbox_access_lists/models/__init__.py b/netbox_access_lists/models/__init__.py new file mode 100644 index 0000000..99d911d --- /dev/null +++ b/netbox_access_lists/models/__init__.py @@ -0,0 +1,6 @@ +""" +Import each of the directory's scripts. +""" + +from .access_list_rules import * +from .access_lists import * diff --git a/netbox_access_lists/models.py b/netbox_access_lists/models/access_list_rules.py similarity index 70% rename from netbox_access_lists/models.py rename to netbox_access_lists/models/access_list_rules.py index 61875de..e5e6fb4 100644 --- a/netbox_access_lists/models.py +++ b/netbox_access_lists/models/access_list_rules.py @@ -5,64 +5,18 @@ Define the django models for this plugin. from django.contrib.postgres.fields import ArrayField from django.db import models from django.urls import reverse - from netbox.models import NetBoxModel -from netbox_access_lists.choices import * + +from ..choices import * +from .access_lists import AccessList __all__ = ( - 'AccessList', 'ACLRule', 'ACLStandardRule', 'ACLExtendedRule', ) -class AccessList(NetBoxModel): - """ - Model defintion for Access-Lists. - """ - name = models.CharField( - max_length=100 - ) - device = models.ForeignKey( - to='dcim.Device', - on_delete=models.CASCADE, - related_name='access_lists' - ) - type = models.CharField( - max_length=30, - choices=ACLTypeChoices - ) - default_action = models.CharField( - default=ACLActionChoices.ACTION_DENY, - max_length=30, - choices=ACLActionChoices, - verbose_name='Default Action' - ) - comments = models.TextField( - blank=True - ) - - class Meta: - ordering = ('name', 'device') - - def __str__(self): - return self.name - - def get_absolute_url(self): - """ - The method is a Django convention; although not strictly required, - it conveniently returns the absolute URL for any particular object. - """ - return reverse('plugins:netbox_access_lists:accesslist', args=[self.pk]) - - def get_default_action_color(self): - return ACLActionChoices.colors.get(self.default_action) - - def get_type_color(self): - return ACLTypeChoices.colors.get(self.type) - - class ACLRule(NetBoxModel): """ Abstract model for ACL Rules. diff --git a/netbox_access_lists/models/access_lists.py b/netbox_access_lists/models/access_lists.py new file mode 100644 index 0000000..db9ecd4 --- /dev/null +++ b/netbox_access_lists/models/access_lists.py @@ -0,0 +1,59 @@ +""" +Define the django models for this plugin. +""" + +from django.db import models +from django.urls import reverse +from netbox.models import NetBoxModel + +from ..choices import * + +__all__ = ( + 'AccessList', +) + + +class AccessList(NetBoxModel): + """ + Model defintion for Access-Lists. + """ + name = models.CharField( + max_length=100 + ) + device = models.ForeignKey( + to='dcim.Device', + on_delete=models.CASCADE, + related_name='access_lists' + ) + type = models.CharField( + max_length=30, + choices=ACLTypeChoices + ) + default_action = models.CharField( + default=ACLActionChoices.ACTION_DENY, + max_length=30, + choices=ACLActionChoices, + verbose_name='Default Action' + ) + comments = models.TextField( + blank=True + ) + + class Meta: + ordering = ('name', 'device') + + def __str__(self): + return self.name + + def get_absolute_url(self): + """ + The method is a Django convention; although not strictly required, + it conveniently returns the absolute URL for any particular object. + """ + return reverse('plugins:netbox_access_lists:accesslist', args=[self.pk]) + + def get_default_action_color(self): + return ACLActionChoices.colors.get(self.default_action) + + def get_type_color(self): + return ACLTypeChoices.colors.get(self.type) diff --git a/netbox_access_lists/tables.py b/netbox_access_lists/tables.py index e2b670f..f9e8e18 100644 --- a/netbox_access_lists/tables.py +++ b/netbox_access_lists/tables.py @@ -3,8 +3,8 @@ Define the object lists / table view for each of the plugin models. """ import django_tables2 as tables +from netbox.tables import ChoiceFieldColumn, NetBoxTable, columns -from netbox.tables import NetBoxTable, columns, ChoiceFieldColumn from .models import AccessList, ACLExtendedRule, ACLStandardRule __all__ = ( diff --git a/netbox_access_lists/template_content.py b/netbox_access_lists/template_content.py index 47ab718..1f3bd7f 100644 --- a/netbox_access_lists/template_content.py +++ b/netbox_access_lists/template_content.py @@ -1,7 +1,7 @@ from django.contrib.contenttypes.models import ContentType - from extras.plugins import PluginTemplateExtension + from .models import AccessList __all__ = ( diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index 11e9451..bf89314 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -3,10 +3,9 @@ Map Views to URLs. """ from django.urls import path - from netbox.views.generic import ObjectChangeLogView -from . import models, views +from . import models, views urlpatterns = ( diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 508570c..465f72f 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -4,8 +4,8 @@ Specifically, all the various interactions with a client. """ from django.db.models import Count - from netbox.views import generic + from . import filtersets, forms, models, tables __all__ = ( diff --git a/setup.py b/setup.py index 9af2d7e..dc35cc1 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ #import os.path # from setuptools import find_packages, setup -# + # #with open("README.md", "r") as fh: # long_description = fh.read() From 069ca92c0cbd2e6781dd6f473c39a23f4ca1e24d Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 14:59:11 +0000 Subject: [PATCH 37/38] add unique together with model AccessList --- netbox_access_lists/forms/models.py | 9 --------- netbox_access_lists/models/access_lists.py | 1 + 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index 95ec45f..ddec355 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -77,16 +77,7 @@ class AccessListForm(NetBoxModelForm): error_message = {} if self.errors.get('name'): return cleaned_data - name = cleaned_data.get('name') - device = cleaned_data.get('device') type = cleaned_data.get('type') - if ('name' in self.changed_data or 'device' in self.changed_data) and AccessList.objects.filter(name__iexact=name, device=device).exists(): - error_message.update( - { - 'device': ['An ACL with this name (case insensitive) is already associated to this device.'], - 'name': ['An ACL with this name (case insensitive) is already associated to this device.'] - } - ) if type == 'extended' and self.instance.aclstandardrules.exists(): error_message.update({'type': ['This ACL has Standard ACL rules already associated, CANNOT change ACL type!!']}) elif type == 'standard' and self.instance.aclextendedrules.exists(): diff --git a/netbox_access_lists/models/access_lists.py b/netbox_access_lists/models/access_lists.py index db9ecd4..bc3c7e2 100644 --- a/netbox_access_lists/models/access_lists.py +++ b/netbox_access_lists/models/access_lists.py @@ -41,6 +41,7 @@ class AccessList(NetBoxModel): class Meta: ordering = ('name', 'device') + unique_together = ('name', 'device') def __str__(self): return self.name From cd3b7287041daa93acda28e8e9e7337de89875ae Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Wed, 20 Jul 2022 19:17:44 +0000 Subject: [PATCH 38/38] update verbose name to use 'Access List' --- .../ISSUE_TEMPLATE/documentation_change.yaml | 2 +- README.md | 2 +- netbox_access_lists/__init__.py | 2 +- netbox_access_lists/choices.py | 8 ++--- netbox_access_lists/forms/bulk_edit.py | 4 +-- netbox_access_lists/forms/models.py | 16 +++++----- .../migrations/0001_initial.py | 5 +++- .../models/access_list_rules.py | 30 +++++++++++++++++-- netbox_access_lists/models/access_lists.py | 5 +++- netbox_access_lists/navigation.py | 10 +++---- .../templates/inc/device/access_lists.html | 4 +-- .../netbox_access_lists/accesslist.html | 4 +-- .../netbox_access_lists/aclextendedrule.html | 4 +-- .../netbox_access_lists/aclstandardrule.html | 4 +-- netbox_access_lists/urls.py | 6 ++-- netbox_access_lists/views.py | 2 +- setup.py | 2 +- 17 files changed, 71 insertions(+), 39 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_change.yaml b/.github/ISSUE_TEMPLATE/documentation_change.yaml index 84ded74..2f8656e 100644 --- a/.github/ISSUE_TEMPLATE/documentation_change.yaml +++ b/.github/ISSUE_TEMPLATE/documentation_change.yaml @@ -1,6 +1,6 @@ --- name: 📖 Documentation Change -description: Suggest an addition or modification to the NetBox access-list plugin documentation +description: Suggest an addition or modification to the NetBox Access Lists plugin documentation title: "[Docs]: " labels: ["documentation"] body: diff --git a/README.md b/README.md index 093cd9f..daaa042 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # netbox-access-lists -A NetBox plugin for Access-List management +A NetBox plugin for Access List management ## Origin diff --git a/netbox_access_lists/__init__.py b/netbox_access_lists/__init__.py index 7d4ea90..3b49054 100644 --- a/netbox_access_lists/__init__.py +++ b/netbox_access_lists/__init__.py @@ -7,7 +7,7 @@ from extras.plugins import PluginConfig class NetBoxAccessListsConfig(PluginConfig): name = 'netbox_access_lists' - verbose_name = 'Access-Lists' + verbose_name = 'Access Lists' description = 'Manage simple ACLs in NetBox' version = '0.1' base_url = 'access-lists' diff --git a/netbox_access_lists/choices.py b/netbox_access_lists/choices.py index 71a4b7e..086c665 100644 --- a/netbox_access_lists/choices.py +++ b/netbox_access_lists/choices.py @@ -14,7 +14,7 @@ __all__ = ( class ACLActionChoices(ChoiceSet): """ - Defines the choices availble for the Access-List plugin specific to ACL default_action. + Defines the choices availble for the Access Lists plugin specific to ACL default_action. """ ACTION_DENY = 'deny' ACTION_PERMIT = 'permit' @@ -29,7 +29,7 @@ class ACLActionChoices(ChoiceSet): class ACLRuleActionChoices(ChoiceSet): """ - Defines the choices availble for the Access-List plugin specific to ACL rule actions. + Defines the choices availble for the Access Lists plugin specific to ACL rule actions. """ ACTION_DENY = 'deny' ACTION_PERMIT = 'permit' @@ -44,7 +44,7 @@ class ACLRuleActionChoices(ChoiceSet): class ACLTypeChoices(ChoiceSet): """ - Defines the choices availble for the Access-List plugin specific to ACL type. + Defines the choices availble for the Access Lists plugin specific to ACL type. """ CHOICES = [ ('extended', 'Extended', 'purple'), @@ -54,7 +54,7 @@ class ACLTypeChoices(ChoiceSet): class ACLProtocolChoices(ChoiceSet): """ - Defines the choices availble for the Access-List plugin specific to ACL Rule protocol. + Defines the choices availble for the Access Lists plugin specific to ACL Rule protocol. """ CHOICES = [ ('icmp', 'ICMP', 'purple'), diff --git a/netbox_access_lists/forms/bulk_edit.py b/netbox_access_lists/forms/bulk_edit.py index d984e46..56c1f34 100644 --- a/netbox_access_lists/forms/bulk_edit.py +++ b/netbox_access_lists/forms/bulk_edit.py @@ -57,7 +57,7 @@ from ..models import AccessList # # fieldsets = [ # ('Host Details', ('region', 'site_group', 'site', 'device')), -# ('Access-List Details', ('type', 'default_action', 'add_tags', 'remove_tags')), +# ('Access List Details', ('type', 'default_action', 'add_tags', 'remove_tags')), # ] # # @@ -67,7 +67,7 @@ from ..models import AccessList # help_texts = { # 'default_action': 'The default behavior of the ACL.', # 'name': 'The name uniqueness per device is case insensitive.', -# 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access-List.'), +# 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access List.'), # } # # def clean(self): # Not working given you are bulkd editing multiple forms diff --git a/netbox_access_lists/forms/models.py b/netbox_access_lists/forms/models.py index ddec355..c2e645d 100644 --- a/netbox_access_lists/forms/models.py +++ b/netbox_access_lists/forms/models.py @@ -57,7 +57,7 @@ class AccessListForm(NetBoxModelForm): fieldsets = [ ('Host Details', ('region', 'site_group', 'site', 'device')), - ('Access-List Details', ('name', 'type', 'default_action', 'tags')), + ('Access List Details', ('name', 'type', 'default_action', 'tags')), ] class Meta: @@ -66,7 +66,7 @@ class AccessListForm(NetBoxModelForm): help_texts = { 'default_action': 'The default behavior of the ACL.', 'name': 'The name uniqueness per device is case insensitive.', - 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access-List.'), + 'type': mark_safe('*Note: CANNOT be changed if ACL Rules are assoicated to this Access List.'), } def clean(self): @@ -90,7 +90,7 @@ class AccessListForm(NetBoxModelForm): class ACLStandardRuleForm(NetBoxModelForm): """ - GUI form to add or edit Standard Access-List. + GUI form to add or edit Standard Access List. Requires an access_list, an index, and ACL rule type. See the clean function for logic on other field requirements. """ @@ -100,7 +100,7 @@ class ACLStandardRuleForm(NetBoxModelForm): 'type': 'standard' }, help_text=mark_safe('*Note: This field will only display Standard ACLs.'), - label='Access-List', + label='Access List', ) source_prefix = DynamicModelChoiceField( queryset=Prefix.objects.all(), @@ -114,7 +114,7 @@ class ACLStandardRuleForm(NetBoxModelForm): ) fieldsets = ( - ('Access-List Details', ('access_list', 'description', 'tags')), + ('Access List Details', ('access_list', 'description', 'tags')), ('Rule Definition', ('index', 'action', 'remark', 'source_prefix')), ) @@ -152,7 +152,7 @@ class ACLStandardRuleForm(NetBoxModelForm): class ACLExtendedRuleForm(NetBoxModelForm): """ - GUI form to add or edit Extended Access-List. + GUI form to add or edit Extended Access List. Requires an access_list, an index, and ACL rule type. See the clean function for logic on other field requirements. """ @@ -162,7 +162,7 @@ class ACLExtendedRuleForm(NetBoxModelForm): 'type': 'extended' }, help_text=mark_safe('*Note: This field will only display Extended ACLs.'), - label='Access-List', + label='Access List', ) tags = DynamicModelMultipleChoiceField( queryset=Tag.objects.all(), @@ -181,7 +181,7 @@ class ACLExtendedRuleForm(NetBoxModelForm): label='Destination Prefix', ) fieldsets = ( - ('Access-List Details', ('access_list', 'description', 'tags')), + ('Access List Details', ('access_list', 'description', 'tags')), ('Rule Definition', ('index', 'action', 'remark', 'source_prefix', 'source_ports', 'destination_prefix', 'destination_ports', 'protocol',)), ) diff --git a/netbox_access_lists/migrations/0001_initial.py b/netbox_access_lists/migrations/0001_initial.py index a1d4a58..e95f69f 100644 --- a/netbox_access_lists/migrations/0001_initial.py +++ b/netbox_access_lists/migrations/0001_initial.py @@ -14,7 +14,7 @@ __all__ = ( class Migration(migrations.Migration): """ - Defines the migrations required for the initial setup of the access-list plugin and its associated django models. + Defines the migrations required for the initial setup of the access lists plugin and its associated django models. """ initial = True @@ -42,6 +42,7 @@ class Migration(migrations.Migration): options={ 'ordering': ('name', 'device'), 'unique_together': {('name', 'device')}, + 'verbose_name': 'Access List', }, ), migrations.CreateModel( @@ -62,6 +63,7 @@ class Migration(migrations.Migration): options={ 'ordering': ('access_list', 'index'), 'unique_together': {('access_list', 'index')}, + 'verbose_name': 'ACL Standard Rule', }, ), migrations.CreateModel( @@ -86,6 +88,7 @@ class Migration(migrations.Migration): options={ 'ordering': ('access_list', 'index'), 'unique_together': {('access_list', 'index')}, + 'verbose_name': 'ACL Extended Rule', }, ), ] diff --git a/netbox_access_lists/models/access_list_rules.py b/netbox_access_lists/models/access_list_rules.py index e5e6fb4..417f720 100644 --- a/netbox_access_lists/models/access_list_rules.py +++ b/netbox_access_lists/models/access_list_rules.py @@ -25,7 +25,7 @@ class ACLRule(NetBoxModel): access_list = models.ForeignKey( on_delete=models.CASCADE, to=AccessList, - verbose_name='Access-List', + verbose_name='Access List', ) index = models.PositiveIntegerField() remark = models.CharField( @@ -57,8 +57,13 @@ class ACLRule(NetBoxModel): return ACLRuleActionChoices.colors.get(self.action) class Meta: + """ + Define the common model properties: + - as an abstract model + - ordering + - unique together + """ abstract = True - default_related_name='%(class)ss' ordering = ('access_list', 'index') unique_together = ('access_list', 'index') @@ -75,6 +80,16 @@ class ACLStandardRule(ACLRule): """ return reverse('plugins:netbox_access_lists:aclstandardrule', args=[self.pk]) + class Meta(ACLRule.Meta): + """ + Define the model properties adding to or overriding the inherited class: + - default_related_name for any FK relationships + - verbose name (for displaying in the GUI) + - verbose name plural (for displaying in the GUI) + """ + default_related_name='aclstandardrules' + verbose_name='ACL Standard Rule' + verbose_name_plural='ACL Standard Rules' class ACLExtendedRule(ACLRule): """ @@ -116,3 +131,14 @@ class ACLExtendedRule(ACLRule): def get_protocol_color(self): return ACLProtocolChoices.colors.get(self.protocol) + + class Meta(ACLRule.Meta): + """ + Define the model properties adding to or overriding the inherited class: + - default_related_name for any FK relationships + - verbose name (for displaying in the GUI) + - verbose name plural (for displaying in the GUI) + """ + default_related_name='aclextendedrules' + verbose_name='ACL Extended Rule' + verbose_name_plural='ACL Extended Rules' diff --git a/netbox_access_lists/models/access_lists.py b/netbox_access_lists/models/access_lists.py index bc3c7e2..6572600 100644 --- a/netbox_access_lists/models/access_lists.py +++ b/netbox_access_lists/models/access_lists.py @@ -15,7 +15,7 @@ __all__ = ( class AccessList(NetBoxModel): """ - Model defintion for Access-Lists. + Model defintion for Access Lists. """ name = models.CharField( max_length=100 @@ -42,6 +42,9 @@ class AccessList(NetBoxModel): class Meta: ordering = ('name', 'device') unique_together = ('name', 'device') + default_related_name='accesslists' + verbose_name='Access List' + verbose_name_plural='Access Lists' def __str__(self): return self.name diff --git a/netbox_access_lists/navigation.py b/netbox_access_lists/navigation.py index 4d6f5f1..0ba5610 100644 --- a/netbox_access_lists/navigation.py +++ b/netbox_access_lists/navigation.py @@ -43,19 +43,19 @@ aclextendedrule_butons = [ menu_items = ( PluginMenuItem( link='plugins:netbox_access_lists:accesslist_list', - link_text='Access-Lists', + link_text='Access Lists', buttons=accesslist_buttons ), - # Comment out Standard Access-List rule to force creation in the ACL view + # Comment out Standard Access List rule to force creation in the ACL view PluginMenuItem( link='plugins:netbox_access_lists:aclstandardrule_list', - link_text='Standard Access-List Rules', + link_text='ACL Standard Rule', buttons=aclstandardrule_butons ), - # Comment out Extended Access-List rule to force creation in the ACL view + # Comment out Extended Access List rule to force creation in the ACL view PluginMenuItem( link='plugins:netbox_access_lists:aclextendedrule_list', - link_text='Extended Access-List Rules', + link_text='ACL Extended Rules', buttons=aclextendedrule_butons ), ) diff --git a/netbox_access_lists/templates/inc/device/access_lists.html b/netbox_access_lists/templates/inc/device/access_lists.html index 374abba..7bdb9b9 100644 --- a/netbox_access_lists/templates/inc/device/access_lists.html +++ b/netbox_access_lists/templates/inc/device/access_lists.html @@ -1,13 +1,13 @@
    - Access-Lists + Access Lists
    {% include 'inc/device/assigned_access_lists.html' %}
    - Add Access-List + Add Access List
    diff --git a/netbox_access_lists/templates/netbox_access_lists/accesslist.html b/netbox_access_lists/templates/netbox_access_lists/accesslist.html index f8bb721..b608a86 100644 --- a/netbox_access_lists/templates/netbox_access_lists/accesslist.html +++ b/netbox_access_lists/templates/netbox_access_lists/accesslist.html @@ -2,7 +2,7 @@ {% load render_table from django_tables2 %} {% block breadcrumbs %} -
  • Access-Lists
    • +
  • Access Lists
    • {% endblock %} {% block controls %}
    @@ -46,7 +46,7 @@
    -
    Access-List
    +
    Access List
    diff --git a/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html index fc3b3c9..0f06229 100644 --- a/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclextendedrule.html @@ -4,11 +4,11 @@
    -
    Extended Access-List Rule
    +
    ACL Extended Rule
    - + diff --git a/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html index 41a13bb..a6cf25d 100644 --- a/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html +++ b/netbox_access_lists/templates/netbox_access_lists/aclstandardrule.html @@ -4,11 +4,11 @@
    -
    Standard Access-List Rule
    +
    ACL Standard Rule
    Access-ListAccess List {{ object.access_list }}
    - + diff --git a/netbox_access_lists/urls.py b/netbox_access_lists/urls.py index bf89314..32966c2 100644 --- a/netbox_access_lists/urls.py +++ b/netbox_access_lists/urls.py @@ -9,7 +9,7 @@ from . import models, views urlpatterns = ( - # Access-Lists + # Access Lists path('access-lists/', views.AccessListListView.as_view(), name='accesslist_list'), path('access-lists/add/', views.AccessListEditView.as_view(), name='accesslist_add'), #path('access-lists/edit/', views.AccessListBulkEditView.as_view(), name='accesslist_bulk_edit'), @@ -20,7 +20,7 @@ urlpatterns = ( 'model': models.AccessList }), - # Standard Access-List rules + # Standard Access List rules path('standard-rules/', views.ACLStandardRuleListView.as_view(), name='aclstandardrule_list'), path('standard-rules/add/', views.ACLStandardRuleEditView.as_view(), name='aclstandardrule_add'), path('standard-rules//', views.ACLStandardRuleView.as_view(), name='aclstandardrule'), @@ -30,7 +30,7 @@ urlpatterns = ( 'model': models.ACLStandardRule }), - # Extended Access-List rules + # Extended Access List rules path('extended-rules/', views.ACLExtendedRuleListView.as_view(), name='aclextendedrule_list'), path('extended-rules/add/', views.ACLExtendedRuleEditView.as_view(), name='aclextendedrule_add'), path('extended-rules//', views.ACLExtendedRuleView.as_view(), name='aclextendedrule'), diff --git a/netbox_access_lists/views.py b/netbox_access_lists/views.py index 465f72f..b58071a 100644 --- a/netbox_access_lists/views.py +++ b/netbox_access_lists/views.py @@ -35,7 +35,7 @@ class AccessListView(generic.ObjectView): def get_extra_context(self, request, instance): """ - Depending on the Access-List type, the list view will return the required ACL Rule using the previous defined tables in tables.py. + Depending on the Access List type, the list view will return the required ACL Rule using the previous defined tables in tables.py. """ if instance.type == 'extended': table = tables.ACLExtendedRuleTable(instance.aclextendedrules.all()) diff --git a/setup.py b/setup.py index dc35cc1..4dc7fdc 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,7 @@ setup( name='netbox-access-lists', version='0.1.0', #version=get_version('netbox_access_lists/version.py'), - description='A NetBox plugin for Access-List management', + description='A NetBox plugin for Access List management', #long_description=long_description, long_description_content_type="text/markdown", url='https://github.com/ryanmerolle/netbox-access-lists',
    Access-ListAccess List {{ object.access_list }}