[feature] Easier filtering of relation between subnet and vpn #705

pandafy · nemesifier · nemesifier · commit 3d3fefa66b43 · 2022-11-22T20:21:24.000-03:00
- Added VPN server autocomplete filter in Subnet list - Added subnet and ip columns in VPN list - Added possibility to filter by subnet in VPN list Closes #705 Co-authored-by: Federico Capoano <f.capoano@openwisp.io>
diff --git a/openwisp_controller/config/admin.py b/openwisp_controller/config/admin.py
@@ -35,11 +35,11 @@
     TimeReadonlyAdminMixin,
     UUIDAdmin,
 )
-from openwisp_utils.admin_theme.filters import AutocompleteFilter
 
 from ..admin import MultitenantAdminMixin
 from . import settings as app_settings
 from .base.vpn import AbstractVpn
+from .filters import DeviceGroupFilter, GroupFilter, SubnetFilter, TemplatesFilter
 from .utils import send_file
 from .widgets import DeviceGroupJsonSchemaWidget, JsonSchemaWidget
 
@@ -443,19 +443,6 @@ class ChangeDeviceGroupForm(forms.Form):
     )
 
 
-class TemplatesFilter(AutocompleteFilter):
-    title = _('template')
-    field_name = 'templates'
-    parameter_name = 'config__templates'
-    rel_model = Config
-
-
-class GroupFilter(AutocompleteFilter):
-    title = _('group')
-    field_name = 'group'
-    parameter_name = 'group_id'
-
-
 class DeviceAdmin(MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin):
     recover_form_template = 'admin/config/device_recover_form.html'
     list_display = [
@@ -916,8 +903,22 @@ class VpnAdmin(
     MultitenantAdminMixin, BaseConfigAdmin, UUIDAdmin, SystemDefinedVariableMixin
 ):
     form = VpnForm
-    list_display = ['name', 'organization', 'backend', 'created', 'modified']
-    list_filter = [('organization', MultitenantOrgFilter), 'backend', 'created']
+    list_display = [
+        'name',
+        'organization',
+        'backend',
+        'subnet',
+        'ip',
+        'created',
+        'modified',
+    ]
+    list_select_related = ['subnet', 'ip']
+    list_filter = [
+        ('organization', MultitenantOrgFilter),
+        'backend',
+        SubnetFilter,
+        'created',
+    ]
     search_fields = ['id', 'name', 'host', 'key']
     readonly_fields = ['id', 'uuid', 'system_context']
     multitenant_shared_relations = ('ca', 'cert', 'subnet')
@@ -978,22 +979,6 @@ class Meta(BaseForm.Meta):
         }
 
 
-class DeviceGroupFilter(admin.SimpleListFilter):
-    title = _('has devices?')
-    parameter_name = 'empty'
-
-    def lookups(self, request, model_admin):
-        return (
-            ('true', _('No')),
-            ('false', _('Yes')),
-        )
-
-    def queryset(self, request, queryset):
-        if self.value():
-            return queryset.filter(device__isnull=self.value() == 'true').distinct()
-        return queryset
-
-
 class DeviceGroupAdmin(MultitenantAdminMixin, BaseAdmin):
     change_form_template = 'admin/device_group/change_form.html'
     form = DeviceGroupForm
diff --git a/openwisp_controller/config/filters.py b/openwisp_controller/config/filters.py
@@ -0,0 +1,42 @@
+from django.contrib import admin
+from django.utils.translation import gettext_lazy as _
+from swapper import load_model
+
+from openwisp_utils.admin_theme.filters import AutocompleteFilter
+
+Config = load_model('config', 'Config')
+
+
+class TemplatesFilter(AutocompleteFilter):
+    title = _('template')
+    field_name = 'templates'
+    parameter_name = 'config__templates'
+    rel_model = Config
+
+
+class GroupFilter(AutocompleteFilter):
+    title = _('group')
+    field_name = 'group'
+    parameter_name = 'group_id'
+
+
+class DeviceGroupFilter(admin.SimpleListFilter):
+    title = _('has devices?')
+    parameter_name = 'empty'
+
+    def lookups(self, request, model_admin):
+        return (
+            ('true', _('No')),
+            ('false', _('Yes')),
+        )
+
+    def queryset(self, request, queryset):
+        if self.value():
+            return queryset.filter(device__isnull=self.value() == 'true').distinct()
+        return queryset
+
+
+class SubnetFilter(AutocompleteFilter):
+    title = _('Subnet')
+    field_name = 'subnet'
+    parameter_name = 'subnet_id'
diff --git a/openwisp_controller/subnet_division/admin.py b/openwisp_controller/subnet_division/admin.py
@@ -16,6 +16,7 @@
     SubnetDivisionRuleFilter,
     SubnetFilter,
     SubnetListFilter,
+    VpnFilter,
 )
 
 SubnetDivisionRule = load_model('subnet_division', 'SubnetDivisionRule')
@@ -59,8 +60,9 @@ class Media:
 @admin.register(Subnet)
 class SubnetAdmin(BaseSubnetAdmin):
     list_filter = BaseSubnetAdmin.list_filter + [
-        DeviceFilter,
         SubnetDivisionRuleFilter,
+        VpnFilter,
+        DeviceFilter,
     ]
     inlines = [SubnetDivisionRuleInlineAdmin] + BaseSubnetAdmin.inlines
     list_display = BaseSubnetAdmin.list_display
diff --git a/openwisp_controller/subnet_division/filters.py b/openwisp_controller/subnet_division/filters.py
@@ -3,13 +3,14 @@
 from django.utils.translation import gettext_lazy as _
 from swapper import load_model
 
-from openwisp_utils.admin_theme.filters import SimpleInputFilter
+from openwisp_utils.admin_theme.filters import AutocompleteFilter, SimpleInputFilter
 
 from . import settings as app_settings
 
 SubnetDivisionIndex = load_model('subnet_division', 'SubnetDivisionIndex')
 SubnetDivisionRule = load_model('subnet_division', 'SubnetDivisionRule')
 Subnet = load_model('openwisp_ipam', 'Subnet')
+Vpn = load_model('config', 'Vpn')
 
 
 class SubnetDivisionRuleFilter(admin.SimpleListFilter):
@@ -61,6 +62,17 @@ def queryset(self, request, queryset):
             )
 
 
+class VpnFilter(AutocompleteFilter):
+    """
+    Filters Subnet by VPN
+    autocomplete on inverse relation
+    """
+
+    title = _('VPN Server')
+    field_name = 'vpn'
+    parameter_name = 'vpn'
+
+
 class SubnetListFilter(admin.RelatedFieldListFilter):
     def field_choices(self, field, request, model_admin):
         if app_settings.HIDE_GENERATED_SUBNETS and field.name == 'subnet':
diff --git a/openwisp_controller/subnet_division/tests/test_admin.py b/openwisp_controller/subnet_division/tests/test_admin.py
@@ -4,6 +4,7 @@
 from django.urls import reverse
 from swapper import load_model
 
+from openwisp_controller.config.tests.utils import TestWireguardVpnMixin
 from openwisp_users.tests.utils import TestMultitenantAdminMixin
 
 from .helpers import SubnetDivisionAdminTestMixin
@@ -13,7 +14,10 @@
 
 
 class TestSubnetAdmin(
-    SubnetDivisionAdminTestMixin, TestMultitenantAdminMixin, TestCase
+    SubnetDivisionAdminTestMixin,
+    TestWireguardVpnMixin,
+    TestMultitenantAdminMixin,
+    TestCase,
 ):
     ipam_label = 'openwisp_ipam'
     config_label = 'config'
@@ -78,6 +82,50 @@ def test_device_filter_mutitenancy(self):
         self.assertNotContains(response, self.config.device.name)
         self.assertContains(response, config2.device.name)
 
+    def test_vpn_filter(self):
+        subnet_changelist = reverse(f'admin:{self.ipam_label}_subnet_changelist')
+        org = self._get_org()
+        subnet1 = self._create_subnet(
+            name='Subnet 1', subnet='172.16.0.0/24', organization=org
+        )
+        subnet2 = self._create_subnet(
+            name='Subnet 2', subnet='172.16.1.0/24', organization=org
+        )
+        vpn = self._create_wireguard_vpn(subnet=subnet1, organization=org)
+        url = f'{subnet_changelist}?vpn={vpn.id}'
+        response = self.client.get(url)
+        self.assertContains(
+            response,
+            subnet1.name,
+        )
+        self.assertNotContains(response, self.master_subnet.name)
+        self.assertNotContains(response, subnet2.name)
+
+    def test_vpn_filter_mutitenancy(self):
+        subnet_changelist = reverse(f'admin:{self.ipam_label}_subnet_changelist')
+        org1 = self._create_org(name='org1')
+        org2 = self._create_org(name='org2')
+        subnet1 = self._create_subnet(
+            name='Subnet 1', subnet='172.16.0.0/24', organization=org1
+        )
+        subnet2 = self._create_subnet(
+            name='Subnet 2', subnet='172.16.1.0/24', organization=org2
+        )
+        vpn1 = self._create_wireguard_vpn(subnet=subnet1, organization=org1)
+        administrator = self._create_administrator([org2])
+        self.client.logout()
+        self.client.force_login(administrator)
+        url = f'{subnet_changelist}?vpn={vpn1.id}'
+        response = self.client.get(url)
+        self.assertNotContains(
+            response,
+            subnet1.name,
+        )
+        self.assertNotContains(
+            response,
+            subnet2.name,
+        )
+
     @patch('openwisp_controller.subnet_division.settings.HIDE_GENERATED_SUBNETS', True)
     def test_hide_generated_subnets(self):
         with self.subTest('Test SubnetAdmin'):
