diff --git a/netbox/tenancy/api/serializers.py b/netbox/tenancy/api/serializers.py index 7599029c5..ec5e60a34 100644 --- a/netbox/tenancy/api/serializers.py +++ b/netbox/tenancy/api/serializers.py @@ -12,11 +12,12 @@ from .nested_serializers import * # class TenantGroupSerializer(ValidatedModelSerializer): + parent = NestedTenantGroupSerializer(required=False, allow_null=True) tenant_count = serializers.IntegerField(read_only=True) class Meta: model = TenantGroup - fields = ['id', 'name', 'slug', 'tenant_count'] + fields = ['id', 'name', 'slug', 'parent', 'tenant_count'] class TenantSerializer(TaggitSerializer, CustomFieldModelSerializer): diff --git a/netbox/tenancy/filters.py b/netbox/tenancy/filters.py index dc1635392..12e852879 100644 --- a/netbox/tenancy/filters.py +++ b/netbox/tenancy/filters.py @@ -2,7 +2,7 @@ import django_filters from django.db.models import Q from extras.filters import CustomFieldFilterSet, CreatedUpdatedFilterSet -from utilities.filters import BaseFilterSet, NameSlugSearchFilterSet, TagFilter +from utilities.filters import BaseFilterSet, NameSlugSearchFilterSet, TagFilter, TreeNodeMultipleChoiceFilter from .models import Tenant, TenantGroup @@ -14,6 +14,16 @@ __all__ = ( class TenantGroupFilterSet(BaseFilterSet, NameSlugSearchFilterSet): + parent_id = django_filters.ModelMultipleChoiceFilter( + queryset=TenantGroup.objects.all(), + label='Tenant group (ID)', + ) + parent = django_filters.ModelMultipleChoiceFilter( + field_name='parent__slug', + queryset=TenantGroup.objects.all(), + to_field_name='slug', + label='Tenant group group (slug)', + ) class Meta: model = TenantGroup @@ -25,15 +35,18 @@ class TenantFilterSet(BaseFilterSet, CustomFieldFilterSet, CreatedUpdatedFilterS method='search', label='Search', ) - group_id = django_filters.ModelMultipleChoiceFilter( + group_id = TreeNodeMultipleChoiceFilter( queryset=TenantGroup.objects.all(), - label='Group (ID)', + field_name='group', + lookup_expr='in', + label='Tenant group (ID)', ) - group = django_filters.ModelMultipleChoiceFilter( - field_name='group__slug', + group = TreeNodeMultipleChoiceFilter( queryset=TenantGroup.objects.all(), + field_name='group', + lookup_expr='in', to_field_name='slug', - label='Group (slug)', + label='Tenant group (slug)', ) tag = TagFilter() @@ -56,16 +69,17 @@ class TenancyFilterSet(django_filters.FilterSet): """ An inheritable FilterSet for models which support Tenant assignment. """ - tenant_group_id = django_filters.ModelMultipleChoiceFilter( - field_name='tenant__group__id', + tenant_group_id = TreeNodeMultipleChoiceFilter( queryset=TenantGroup.objects.all(), - to_field_name='id', + field_name='tenant__group', + lookup_expr='in', label='Tenant Group (ID)', ) - tenant_group = django_filters.ModelMultipleChoiceFilter( - field_name='tenant__group__slug', + tenant_group = TreeNodeMultipleChoiceFilter( queryset=TenantGroup.objects.all(), + field_name='tenant__group', to_field_name='slug', + lookup_expr='in', label='Tenant Group (slug)', ) tenant_id = django_filters.ModelMultipleChoiceFilter( @@ -73,8 +87,8 @@ class TenancyFilterSet(django_filters.FilterSet): label='Tenant (ID)', ) tenant = django_filters.ModelMultipleChoiceFilter( - field_name='tenant__slug', queryset=Tenant.objects.all(), + field_name='tenant__slug', to_field_name='slug', label='Tenant (slug)', ) diff --git a/netbox/tenancy/forms.py b/netbox/tenancy/forms.py index 5b828b661..9b8fc59da 100644 --- a/netbox/tenancy/forms.py +++ b/netbox/tenancy/forms.py @@ -16,16 +16,32 @@ from .models import Tenant, TenantGroup # class TenantGroupForm(BootstrapMixin, forms.ModelForm): + parent = DynamicModelChoiceField( + queryset=TenantGroup.objects.all(), + required=False, + widget=APISelect( + api_url="/api/tenancy/tenant-groups/" + ) + ) slug = SlugField() class Meta: model = TenantGroup fields = [ - 'name', 'slug', + 'parent', 'name', 'slug', ] class TenantGroupCSVForm(forms.ModelForm): + parent = forms.ModelChoiceField( + queryset=TenantGroup.objects.all(), + required=False, + to_field_name='name', + help_text='Name of parent tenant group', + error_messages={ + 'invalid_choice': 'Tenant group not found.', + } + ) slug = SlugField() class Meta: diff --git a/netbox/tenancy/migrations/0007_nested_tenantgroups.py b/netbox/tenancy/migrations/0007_nested_tenantgroups.py new file mode 100644 index 000000000..4278b3409 --- /dev/null +++ b/netbox/tenancy/migrations/0007_nested_tenantgroups.py @@ -0,0 +1,43 @@ +from django.db import migrations, models +import django.db.models.deletion +import mptt.fields + + +class Migration(migrations.Migration): + + dependencies = [ + ('tenancy', '0006_custom_tag_models'), + ] + + operations = [ + migrations.AddField( + model_name='tenantgroup', + name='parent', + field=mptt.fields.TreeForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='children', to='tenancy.TenantGroup'), + ), + migrations.AddField( + model_name='tenantgroup', + name='level', + field=models.PositiveIntegerField(default=0, editable=False), + preserve_default=False, + ), + migrations.AddField( + model_name='tenantgroup', + name='lft', + field=models.PositiveIntegerField(default=1, editable=False), + preserve_default=False, + ), + migrations.AddField( + model_name='tenantgroup', + name='rght', + field=models.PositiveIntegerField(default=2, editable=False), + preserve_default=False, + ), + # tree_id will be set to a valid value during the following migration (which needs to be a separate migration) + migrations.AddField( + model_name='tenantgroup', + name='tree_id', + field=models.PositiveIntegerField(db_index=True, default=0, editable=False), + preserve_default=False, + ), + ] diff --git a/netbox/tenancy/migrations/0008_nested_tenantgroups_rebuild.py b/netbox/tenancy/migrations/0008_nested_tenantgroups_rebuild.py new file mode 100644 index 000000000..e31a75d36 --- /dev/null +++ b/netbox/tenancy/migrations/0008_nested_tenantgroups_rebuild.py @@ -0,0 +1,21 @@ +from django.db import migrations + + +def rebuild_mptt(apps, schema_editor): + TenantGroup = apps.get_model('tenancy', 'TenantGroup') + for i, tenantgroup in enumerate(TenantGroup.objects.all(), start=1): + TenantGroup.objects.filter(pk=tenantgroup.pk).update(tree_id=i) + + +class Migration(migrations.Migration): + + dependencies = [ + ('tenancy', '0007_nested_tenantgroups'), + ] + + operations = [ + migrations.RunPython( + code=rebuild_mptt, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/tenancy/models.py b/netbox/tenancy/models.py index 9fa7f23ea..1a02184cd 100644 --- a/netbox/tenancy/models.py +++ b/netbox/tenancy/models.py @@ -1,10 +1,12 @@ from django.contrib.contenttypes.fields import GenericRelation from django.db import models from django.urls import reverse +from mptt.models import MPTTModel, TreeForeignKey from taggit.managers import TaggableManager -from extras.models import CustomFieldModel, TaggedItem +from extras.models import CustomFieldModel, ObjectChange, TaggedItem from utilities.models import ChangeLoggedModel +from utilities.utils import serialize_object __all__ = ( @@ -13,7 +15,7 @@ __all__ = ( ) -class TenantGroup(ChangeLoggedModel): +class TenantGroup(MPTTModel, ChangeLoggedModel): """ An arbitrary collection of Tenants. """ @@ -24,12 +26,23 @@ class TenantGroup(ChangeLoggedModel): slug = models.SlugField( unique=True ) + parent = TreeForeignKey( + to='self', + on_delete=models.CASCADE, + related_name='children', + blank=True, + null=True, + db_index=True + ) - csv_headers = ['name', 'slug'] + csv_headers = ['name', 'slug', 'parent'] class Meta: ordering = ['name'] + class MPTTMeta: + order_insertion_by = ['name'] + def __str__(self): return self.name @@ -40,6 +53,16 @@ class TenantGroup(ChangeLoggedModel): return ( self.name, self.slug, + self.parent.name if self.parent else '', + ) + + def to_objectchange(self, action): + # Remove MPTT-internal fields + return ObjectChange( + changed_object=self, + object_repr=str(self), + action=action, + object_data=serialize_object(self, exclude=['level', 'lft', 'rght', 'tree_id']) ) diff --git a/netbox/tenancy/tables.py b/netbox/tenancy/tables.py index af4fb34c0..adf73dc41 100644 --- a/netbox/tenancy/tables.py +++ b/netbox/tenancy/tables.py @@ -3,6 +3,16 @@ import django_tables2 as tables from utilities.tables import BaseTable, ToggleColumn from .models import Tenant, TenantGroup +MPTT_LINK = """ +{% if record.get_children %} + +{% else %} + +{% endif %} + {{ record.name }} + +""" + TENANTGROUP_ACTIONS = """ @@ -27,11 +37,18 @@ COL_TENANT = """ class TenantGroupTable(BaseTable): pk = ToggleColumn() - name = tables.LinkColumn(verbose_name='Name') - tenant_count = tables.Column(verbose_name='Tenants') - slug = tables.Column(verbose_name='Slug') + name = tables.TemplateColumn( + template_code=MPTT_LINK, + orderable=False + ) + tenant_count = tables.Column( + verbose_name='Tenants' + ) + slug = tables.Column() actions = tables.TemplateColumn( - template_code=TENANTGROUP_ACTIONS, attrs={'td': {'class': 'text-right noprint'}}, verbose_name='' + template_code=TENANTGROUP_ACTIONS, + attrs={'td': {'class': 'text-right noprint'}}, + verbose_name='' ) class Meta(BaseTable.Meta): diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index 0319a20b0..afc363cd6 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -20,7 +20,13 @@ from .models import Tenant, TenantGroup class TenantGroupListView(PermissionRequiredMixin, ObjectListView): permission_required = 'tenancy.view_tenantgroup' - queryset = TenantGroup.objects.annotate(tenant_count=Count('tenants')) + queryset = TenantGroup.objects.add_related_count( + TenantGroup.objects.all(), + Tenant, + 'group', + 'tenant_count', + cumulative=True + ) table = tables.TenantGroupTable