Merge pull request #3647 from Uninett/feat/3149-support-description-in-search

Support search by description in search providers

Author: Simrayz

changelog.d/3149.changed.md

@@ -0,0 +1 @@
+Add support for searching by description in main info search

python/nav/web/info/netboxgroup/views.py

@@ -66,8 +66,11 @@ def index(request):
             query = request.GET['query']
             id_filter = Q(pk__icontains=query)
             netbox_filter = Q(netboxes__sysname__icontains=query)
+            description_filter = Q(description__icontains=query)
             groups = (
-                NetboxGroup.objects.filter(id_filter | netbox_filter)
+                NetboxGroup.objects.filter(
+                    id_filter | netbox_filter | description_filter
+                )
                 .distinct()
                 .order_by('id')
             )

python/nav/web/info/searchproviders.py

@@ -84,7 +84,9 @@ class RoomSearchProvider(SearchProvider):
     link = 'Roomid'
 
     def fetch_results(self):
-        results = Room.objects.filter(id__icontains=self.query).order_by("id")
+        results = Room.objects.filter(
+            Q(id__icontains=self.query) | Q(description__icontains=self.query)
+        ).order_by("id")
         for result in results:
             self.results.append(
                 SearchResult(reverse('room-info', kwargs={'roomid': result.id}), result)
@@ -99,7 +101,9 @@ class LocationSearchProvider(SearchProvider):
     link = 'Locationid'
 
     def fetch_results(self):
-        results = Location.objects.filter(id__icontains=self.query).order_by("id")
+        results = Location.objects.filter(
+            Q(id__icontains=self.query) | Q(description__icontains=self.query)
+        ).order_by("id")
         for result in results:
             self.results.append(
                 SearchResult(
@@ -211,6 +215,7 @@ def fetch_results(self):
                 Q(vlan__contains=self.query)
                 | Q(net_ident__icontains=self.query)
                 | Q(net_type__description__icontains=self.query)
+                | Q(description__icontains=self.query)
             )
             .order_by('vlan')
         )
@@ -273,9 +278,11 @@ class DevicegroupSearchProvider(SearchProvider):
     link = 'Device Group'
 
     def fetch_results(self):
-        self.results = [
-            SearchResult(g.get_absolute_url(), g)
-            for g in NetboxGroup.objects.filter(id__icontains=self.query)
+        query_result = (
+            NetboxGroup.objects.filter(
+                Q(id__icontains=self.query) | Q(description__icontains=self.query)
+            )
             .order_by('id')
             .annotate(num_netboxes=Count('netboxes'))
-        ]
+        )
+        self.results = [SearchResult(g.get_absolute_url(), g) for g in query_result]

tests/integration/web/info/search_test.py

@@ -1,7 +1,10 @@
 # -*- coding: utf-8 -*-
+from django.db import models
 from django.urls import reverse
 
-from nav.models.manage import Interface
+from nav.models.manage import Interface, Location, NetType, Room, Vlan, NetboxGroup
+from nav.web.info.forms import SearchForm
+from nav.web.info.views import process_form
 
 
 def test_search_for_ip_devices_should_not_crash(client):
@@ -40,6 +43,67 @@ def test_search_for_device_groups_should_not_crash(client):
     assert response.status_code == 200
 
 
+class TestProcessFormDescriptionSearch:
+    """Tests for process_form view searching by description."""
+
+    def test_location_search_by_description_should_return_results(self, db):
+        location = Location.objects.create(
+            id="testlocation", description="test location description"
+        )
+
+        self.assert_search_provider_result(
+            instance=location,
+            provider_name='Locations',
+        )
+
+    def test_room_search_by_description_should_return_results(self, db):
+        room = Room.objects.create(
+            id="testroom", description="test room description", location_id="mylocation"
+        )
+
+        self.assert_search_provider_result(
+            instance=room,
+            provider_name='Rooms',
+        )
+
+    def test_vlan_search_by_description_should_return_results(self, db):
+        nettype = NetType.objects.create(description="testdescription")
+        vlan = Vlan.objects.create(
+            vlan="20", description="test vlan description", net_type=nettype
+        )
+        self.assert_search_provider_result(
+            instance=vlan,
+            provider_name='Vlans',
+        )
+
+    def test_devicegroup_search_by_description_should_return_results(
+        self, db, localhost
+    ):
+        device_group = NetboxGroup.objects.create(
+            id='test-group-001', description='Core network switches group'
+        )
+        self.assert_search_provider_result(
+            instance=device_group,
+            provider_name='Device groups',
+        )
+
+    @staticmethod
+    def assert_search_provider_result(instance: models.Model, provider_name: str):
+        """
+        Helper method to assert that a search by description returns
+        the expected instance.
+        """
+
+        form = SearchForm({'query': instance.description}, auto_id=False)
+        form.is_valid()
+        providers, _ = process_form(form)
+
+        provider = next((p for p in providers if p.name == provider_name), None)
+        assert provider is not None
+        assert len(provider.results) == 1
+        assert provider.results[0].inst.id == instance.id
+
+
 class TestIndexSearchPreviewView:
     """Tests for the search preview feature."""