[feature] Added filter by location (name/UUID), floorplan (UUID) to device list API #1158

Added new filters to the device list REST API endpoint:

- search by location name
- filter by exact location UUID
- filter by exact floorplan UUID

Closes #1158

---------

Co-authored-by: Federico Capoano <f.capoano@openwisp.io>

Author: Srinath0916

openwisp_controller/geo/api/filters.py

@@ -10,18 +10,34 @@ class DeviceListFilter(BaseDeviceListFilter):
     # Using filter query param name `with_geo`
     # which is similar to admin filter
     with_geo = filters.BooleanFilter(
-        field_name="devicelocation", method="filter_devicelocation"
+        field_name="devicelocation",
+        method="filter_devicelocation",
+        label=_("Has geographic location set?"),
+    )
+    location__name = filters.CharFilter(
+        field_name="devicelocation__location__name",
+        lookup_expr="icontains",
+        label=_("Location name"),
+    )
+    location = filters.UUIDFilter(
+        field_name="devicelocation__location", label=_("Location UUID")
+    )
+    floorplan = filters.UUIDFilter(
+        field_name="devicelocation__floorplan", label=_("Floor plan UUID")
     )
-
-    def _set_valid_filterform_lables(self):
-        super()._set_valid_filterform_lables()
-        self.filters["with_geo"].label = _("Has geographic location set?")
 
     def filter_devicelocation(self, queryset, name, value):
         # Returns list of device that have devicelocation objects
         return queryset.exclude(devicelocation__isnull=value)
 
     class Meta:
         model = BaseDeviceListFilter.Meta.model
-        fields = BaseDeviceListFilter.Meta.fields[:]
-        fields.insert(fields.index("created"), "with_geo")
+        geo_fields = [
+            "with_geo",
+            "location__name",
+            "location",
+            "floorplan",
+        ]
+        fields = BaseDeviceListFilter.Meta.fields
+        index_created = fields.index("created")
+        fields[index_created:index_created] = geo_fields

openwisp_controller/geo/tests/test_api.py

@@ -1003,6 +1003,65 @@ def _assert_device_list_with_geo_filter(response=None, device=None):
             r2 = self.client.get(f"{path}?with_geo=true")
             _assert_device_list_with_geo_filter(response=r2, device=device_b)
 
+    def test_filter_devices_by_location(self):
+        org = self._create_org()
+        device_1 = self._create_device(
+            name="device-1", mac_address="00:11:22:33:44:55", organization=org
+        )
+        device_2 = self._create_device(
+            name="device-2", mac_address="00:11:22:33:44:66", organization=org
+        )
+        location_1 = self._create_location(name="location-1 findme", organization=org)
+        location_2 = self._create_location(name="location-2", organization=org)
+        self._create_device_location(content_object=device_1, location=location_1)
+        self._create_device_location(content_object=device_2, location=location_2)
+        path = reverse("config_api:device_list")
+        with self.subTest("filter by location UUID"):
+            response = self.client.get(f"{path}?location={location_1.pk}")
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.data["count"], 1)
+            self.assertEqual(response.data["results"][0]["id"], str(device_1.pk))
+        with self.subTest("filter by location name"):
+            response = self.client.get(f"{path}?location__name=FIND")
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.data["count"], 1)
+            self.assertEqual(response.data["results"][0]["id"], str(device_1.pk))
+        with self.subTest("filter by wrong location name, expect zero results"):
+            response = self.client.get(f"{path}?location__name=WRONG")
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.data["count"], 0)
+
+    def test_filter_devices_by_floorplan_uuid(self):
+        org = self._create_org()
+        device_1 = self._create_device(
+            name="device-1", mac_address="00:11:22:33:44:55", organization=org
+        )
+        device_2 = self._create_device(
+            name="device-2", mac_address="00:11:22:33:44:66", organization=org
+        )
+        location = self._create_location(
+            name="location", type="indoor", organization=org
+        )
+        floorplan_1 = self._create_floorplan(location=location, floor=1)
+        floorplan_2 = self._create_floorplan(location=location, floor=2)
+        self._create_device_location(
+            content_object=device_1,
+            location=location,
+            floorplan=floorplan_1,
+            indoor="-1,-2",
+        )
+        self._create_device_location(
+            content_object=device_2,
+            location=location,
+            floorplan=floorplan_2,
+            indoor="-3,-4",
+        )
+        path = reverse("config_api:device_list")
+        response = self.client.get(f"{path}?floorplan={floorplan_1.pk}")
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], 1)
+        self.assertEqual(response.data["results"][0]["id"], str(device_1.pk))
+
     def test_deactivated_device(self):
         floorplan = self._create_floorplan()
         device_location = self._create_object_location(