[fix] Update docs, filter class and tests

Author: dee077

docs/user/rest-api.rst

@@ -864,9 +864,10 @@ List Indoor Coordinates of a Location
 
 .. note::
 
-    this endpoint returns device coordinates from the lowest positive
-    floor by default. If no positive floor exists, it returns coordinates
-    from the highest negative floor instead.
+    this endpoint returns device coordinates from the first floor above
+    ground (lowest non-negative floors) by default. If a location only has
+    negative floors (e.g. underground parking lot), then it will return
+    the closest floor to the ground (maximum negative floor).
 
 .. code-block:: text
 

openwisp_controller/geo/api/views.py

@@ -1,6 +1,7 @@
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.db.models import Count
 from django.http import Http404
+from django.utils.translation import gettext_lazy as _
 from django_filters import rest_framework as filters
 from rest_framework import generics, pagination, status
 from rest_framework.exceptions import NotFound, PermissionDenied
@@ -52,31 +53,35 @@ class Meta(OrganizationManagedFilter.Meta):
         model = FloorPlan
 
 
-class IndoorCoordinatesFilter(OrganizationManagedFilter):
-    floor = filters.NumberFilter(field_name="floorplan__floor")
-    organization = filters.UUIDFilter(field_name="content_object__organization")
+class IndoorCoordinatesFilter(filters.FilterSet):
+    floor = filters.NumberFilter(label=_("Floor"), method="filter_by_floor")
 
-    def filter_queryset(self, queryset):
+    @property
+    def qs(self):
+        qs = super().qs
+        if "floor" not in self.data:
+            qs = self.filter_by_floor(qs, "floor", None)
+        return qs
+
+    def filter_by_floor(self, queryset, name, value):
         """
         If no floor parameter is provided:
-        Return data for the first available positive floor
-        If no positive floor exists, return data for the highest negative floor
-        If a valid floor parameter is provided, return data for that specific floor.
+        - Return data for the first available non-negative floor.
+        - If no non-negative floor exists, return data for the maximum negative floor.
         """
-        organization_managed_qs = OrganizationManagedFilter.filter_queryset(
-            self, queryset
-        )
-        qs = filters.FilterSet.filter_queryset(self, organization_managed_qs)
-        if "floor" not in self.data:
-            floors = list(qs.values_list("floorplan__floor", flat=True).distinct())
-            positives = [f for f in floors if f >= 0]
-            default_floor = min(positives) if positives else max(floors)
-            qs = qs.filter(floorplan__floor=default_floor)
-        return qs
+        if value is not None:
+            return queryset.filter(floorplan__floor=value)
+        # No floor parameter provided
+        floors = list(queryset.values_list("floorplan__floor", flat=True).distinct())
+        if not floors:
+            return queryset.none()
+        non_negative_floors = [f for f in floors if f >= 0]
+        default_floor = min(non_negative_floors) if non_negative_floors else max(floors)
+        return queryset.filter(floorplan__floor=default_floor)
 
     class Meta(OrganizationManagedFilter.Meta):
         model = DeviceLocation
-        fields = OrganizationManagedFilter.Meta.fields + ["floor"]
+        fields = ["floor"]
 
 
 class ListViewPagination(pagination.PageNumberPagination):
@@ -279,6 +284,17 @@ def get_queryset(self):
         qs = Device.objects.filter(devicelocation__location_id=self.kwargs["pk"])
         return qs
 
+    def get_has_floorplan(self, qs):
+        qs = qs.filter(devicelocation__floorplan__isnull=False).exists()
+        return qs
+
+    def list(self, request, *args, **kwargs):
+        has_floorplan = self.get_has_floorplan(self.get_queryset())
+        response = super().list(self, request, *args, **kwargs)
+        if response.status_code == 200:
+            response.data["has_floorplan"] = has_floorplan
+        return response
+
 
 class FloorPlanListCreateView(ProtectedAPIMixin, generics.ListCreateAPIView):
     serializer_class = FloorPlanSerializer

openwisp_controller/geo/tests/test_api.py

@@ -29,7 +29,7 @@
 User = get_user_model()
 
 
-class TestApi(TestGeoMixin, CreateDeviceMixin, TestCase):
+class TestApi(TestGeoMixin, TestCase):
     url_name = "geo_api:device_coordinates"
     object_location_model = DeviceLocation
     location_model = Location
@@ -130,7 +130,17 @@ def test_bearer_authentication(self):
             username="admin", password="password", is_staff=True, is_superuser=True
         )
         token = Token.objects.create(user=user).key
-        device = self._create_object_location().device
+        device = self._create_object()
+        location = self._create_location(
+            organization=device.organization, type="indoor"
+        )
+        floor = self._create_floorplan(floor=1, location=location)
+        self._create_object_location(
+            content_object=device,
+            location=location,
+            floorplan=floor,
+            organization=device.organization,
+        )
 
         with self.subTest("Test DeviceLocationView"):
             response = self.client.get(
@@ -150,7 +160,6 @@ def test_bearer_authentication(self):
             self.assertEqual(response.status_code, 200)
 
         with self.subTest("Test LocationDeviceList"):
-            location = self._create_location(organization=device.organization)
             response = self.client.get(
                 reverse("geo_api:location_device_list", args=[location.id]),
                 content_type="application/json",
@@ -159,16 +168,6 @@ def test_bearer_authentication(self):
             self.assertEqual(response.status_code, 200)
 
         with self.subTest("Test IndoorCoordinatesList"):
-            org = self._get_org()
-            location = self._create_location(organization=org, type="indoor")
-            floor = self._create_floorplan(floor=1, location=location)
-            d = self._create_device()
-            self._create_object_location(
-                content_object=d,
-                location=location,
-                floorplan=floor,
-                organization=org,
-            )
             response = self.client.get(
                 reverse("geo_api:indoor_coordinates_list", args=[location.id]),
                 content_type="application/json",
@@ -335,7 +334,7 @@ def test_indoor_coodinate_list(self):
             r = self.client.get(reverse(url, args=[location_b.id]))
             self.assertEqual(r.status_code, 404)
 
-        with self.subTest("Test indoor coordinate list for org superuser"):
+        with self.subTest("Test indoor coordinate list for superuser"):
             self.client.login(username="admin", password="tester")
             r = self.client.get(reverse(url, args=[location_a.id]))
             self.assertContains(r, str(device_a.id))
@@ -1110,24 +1109,24 @@ def test_deactivated_device(self):
     def test_indoor_coordinates_list_api(self):
         org = self._create_org(name="Test org")
         location = self._create_location(type="indoor", organization=org)
-        f1 = self._create_floorplan(floor=1, location=location)
-        f2 = self._create_floorplan(floor=2, location=location)
-        d1 = self._create_device(
+        floor1 = self._create_floorplan(floor=1, location=location)
+        floor2 = self._create_floorplan(floor=2, location=location)
+        device1 = self._create_device(
             name="device1", mac_address="00:00:00:00:00:01", organization=org
         )
-        d2 = self._create_device(
+        device2 = self._create_device(
             name="device2", mac_address="00:00:00:00:00:02", organization=org
         )
         self._create_object_location(
-            content_object=d1,
+            content_object=device1,
             location=location,
-            floorplan=f1,
+            floorplan=floor1,
             organization=org,
         )
         self._create_object_location(
-            content_object=d2,
+            content_object=device2,
             location=location,
-            floorplan=f2,
+            floorplan=floor2,
             organization=org,
         )
         path = reverse("geo_api:indoor_coordinates_list", args=[location.id])
@@ -1146,34 +1145,34 @@ def test_indoor_coordinates_list_api(self):
 
         with self.subTest("Test default floor with all positve floor"):
             location2 = self._create_location(type="indoor", organization=org)
-            f0 = self._create_floorplan(floor=0, location=location2)
-            f5 = self._create_floorplan(floor=5, location=location2)
-            f9 = self._create_floorplan(floor=9, location=location2)
-            d0 = self._create_device(
+            floor0 = self._create_floorplan(floor=0, location=location2)
+            floor5 = self._create_floorplan(floor=5, location=location2)
+            floor9 = self._create_floorplan(floor=9, location=location2)
+            device0 = self._create_device(
                 name="device", mac_address="00:00:00:00:00:00", organization=org
             )
-            d5 = self._create_device(
+            device5 = self._create_device(
                 name="device5", mac_address="00:00:00:00:00:05", organization=org
             )
-            d9 = self._create_device(
+            device9 = self._create_device(
                 name="device9", mac_address="00:00:00:00:00:09", organization=org
             )
             self._create_object_location(
-                content_object=d0,
+                content_object=device0,
                 location=location2,
-                floorplan=f0,
+                floorplan=floor0,
                 organization=org,
             )
             self._create_object_location(
-                content_object=d5,
+                content_object=device5,
                 location=location2,
-                floorplan=f5,
+                floorplan=floor5,
                 organization=org,
             )
             self._create_object_location(
-                content_object=d9,
+                content_object=device9,
                 location=location2,
-                floorplan=f9,
+                floorplan=floor9,
                 organization=org,
             )
             path = reverse("geo_api:indoor_coordinates_list", args=[location2.id])
@@ -1185,34 +1184,34 @@ def test_indoor_coordinates_list_api(self):
 
         with self.subTest("Test default floor with all negative floor"):
             location3 = self._create_location(type="indoor", organization=org)
-            f_1 = self._create_floorplan(floor=-1, location=location3)
-            f_2 = self._create_floorplan(floor=-2, location=location3)
-            f_3 = self._create_floorplan(floor=-3, location=location3)
-            d_1 = self._create_device(
+            floor_1 = self._create_floorplan(floor=-1, location=location3)
+            floor_2 = self._create_floorplan(floor=-2, location=location3)
+            floor_3 = self._create_floorplan(floor=-3, location=location3)
+            device_1 = self._create_device(
                 name="device-1", mac_address="00:00:00:00:10:01", organization=org
             )
-            d_2 = self._create_device(
+            device_2 = self._create_device(
                 name="device-2", mac_address="00:00:00:00:10:02", organization=org
             )
-            d_3 = self._create_device(
+            device_3 = self._create_device(
                 name="device-3", mac_address="00:00:00:00:10:03", organization=org
             )
             self._create_object_location(
-                content_object=d_1,
+                content_object=device_1,
                 location=location3,
-                floorplan=f_1,
+                floorplan=floor_1,
                 organization=org,
             )
             self._create_object_location(
-                content_object=d_2,
+                content_object=device_2,
                 location=location3,
-                floorplan=f_2,
+                floorplan=floor_2,
                 organization=org,
             )
             self._create_object_location(
-                content_object=d_3,
+                content_object=device_3,
                 location=location3,
-                floorplan=f_3,
+                floorplan=floor_3,
                 organization=org,
             )
             path = reverse("geo_api:indoor_coordinates_list", args=[location3.id])
@@ -1224,34 +1223,34 @@ def test_indoor_coordinates_list_api(self):
 
         with self.subTest("Test default floor with positive and negative floor"):
             location4 = self._create_location(type="indoor", organization=org)
-            f_4 = self._create_floorplan(floor=-4, location=location4)
-            f0 = self._create_floorplan(floor=0, location=location4)
-            f22 = self._create_floorplan(floor=22, location=location4)
-            d_3 = self._create_device(
+            floor_4 = self._create_floorplan(floor=-4, location=location4)
+            floor0 = self._create_floorplan(floor=0, location=location4)
+            floor22 = self._create_floorplan(floor=22, location=location4)
+            device_3 = self._create_device(
                 name="device-4", mac_address="00:00:00:10:10:03", organization=org
             )
-            d0 = self._create_device(
+            device0 = self._create_device(
                 name="device-0", mac_address="00:00:00:00:10:00", organization=org
             )
-            d22 = self._create_device(
+            device22 = self._create_device(
                 name="device22", mac_address="00:00:00:00:10:22", organization=org
             )
             self._create_object_location(
-                content_object=d_3,
+                content_object=device_3,
                 location=location4,
-                floorplan=f_4,
+                floorplan=floor_4,
                 organization=org,
             )
             self._create_object_location(
-                content_object=d0,
+                content_object=device0,
                 location=location4,
-                floorplan=f0,
+                floorplan=floor0,
                 organization=org,
             )
             self._create_object_location(
-                content_object=d22,
+                content_object=device22,
                 location=location4,
-                floorplan=f22,
+                floorplan=floor22,
                 organization=org,
             )
             path = reverse("geo_api:indoor_coordinates_list", args=[location4.id])