[changes] Rename 'fuzzy' field, updated tests

Signed-off-by: DragnEmperor <[email protected]>

Author: DragnEmperor

openwisp_controller/config/whois/tasks.py

@@ -181,8 +181,15 @@ def manage_fuzzy_locations(
     """
     Creates/updates fuzzy location for a device based on the latitude and longitude
     or attaches an existing location if `add_existing` is True.
-    Existing location here means a location of a device whose last_ip matches
+    Existing location here means a location of another device whose last_ip matches
     the given ip_address.
+
+    - If attaching existing location and current device has no location then the
+    existing location is attached to the current device as well.
+    - If attaching existing location and current device already has location, then
+    current device's location is deleted and set same as existing device's location.
+    - If not attaching existing then new location is created if no location exists for
+    current device, or existing one is updated if it is approximate(fuzzy).
     """
     Device = load_model("config", "Device")
     Location = load_model("geo", "Location")
@@ -199,9 +206,8 @@ def manage_fuzzy_locations(
 
     # if attaching an existing location, the current device should not have
     # a location already set.
-    # TODO: Do we do this if device location exists but is marked fuzzy?
     current_location = device_location.location
-    if add_existing and (not current_location or current_location.fuzzy):
+    if add_existing and (not current_location or current_location.is_approximate):
         existing_device_location = (
             Device.objects.select_related("devicelocation")
             .filter(last_ip=ip_address, devicelocation__location__isnull=False)
@@ -223,23 +229,31 @@ def manage_fuzzy_locations(
         coords = Point(longitude, latitude, srid=4326)
         # Create/update the device location mapping, updating existing location
         # if exists else create a new location
+        location_name = (
+            " ".join(address.split(",")[:2])
+            if address
+            else f"Approximate Location {ip_address}"
+        )
         location_defaults = {
-            "name": f"{device.name} Location",
+            "name": location_name,
             "type": "outdoor",
             "organization_id": device.organization_id,
             "is_mobile": False,
             "geometry": coords,
             "address": address,
         }
-        if device_location.location and device_location.location.fuzzy:
+        if device_location.location and device_location.location.is_approximate:
             for attr, value in location_defaults.items():
                 setattr(device_location.location, attr, value)
             device_location.location.full_clean()
             device_location.location.save()
         elif not device_location.location:
-            location = Location(**location_defaults, fuzzy=True)
+            location = Location(**location_defaults, is_approximate=True)
             location.full_clean()
             location.save()
             device_location.location = location
             device_location.full_clean()
             device_location.save()
+    logger.info(
+        f"Fuzzy location saved successfully for {device_pk} for IP: {ip_address}"
+    )

openwisp_controller/config/whois/test_whois.py

@@ -306,7 +306,7 @@ def _task_called(self, mocked_task, task_name="WHOIS lookup"):
         mocked_task.reset_mock()
 
         with self.subTest(
-            f"{task_name} task called via DeviceChecksumView when a device has no WHOIS record"
+            f"{task_name} task called via DeviceChecksumView for no WHOIS record"
         ):
             WHOISInfo.objects.all().delete()
             response = self.client.get(
@@ -325,7 +325,9 @@ def test_whois_task_called(self, mocked_lookup_task):
 
         Device.objects.all().delete()  # Clear existing devices
         device = self._create_device()
-        with self.subTest("WHOIS lookup task not called when last_ip has related WhoIsInfo"):
+        with self.subTest(
+            "WHOIS lookup task not called when last_ip has related WhoIsInfo"
+        ):
             device.last_ip = "172.217.22.14"
             self._create_whois_info(ip_address=device.last_ip)
             device.save()
@@ -460,7 +462,7 @@ def _verify_whois_details(instance, ip_address):
 
         with self.subTest("Test WHOIS create when device is created"):
             device = self._create_device(last_ip="172.217.22.14")
-            self.assertEqual(mock_info.call_count, 1)
+            self.assertEqual(mock_info.call_count, 2)
             mock_info.reset_mock()
             device.refresh_from_db()
 
@@ -474,7 +476,7 @@ def _verify_whois_details(instance, ip_address):
             old_ip_address = device.last_ip
             device.last_ip = "172.217.22.10"
             device.save()
-            self.assertEqual(mock_info.call_count, 1)
+            self.assertEqual(mock_info.call_count, 2)
             mock_info.reset_mock()
             device.refresh_from_db()
 
@@ -528,7 +530,7 @@ def _verify_location_details(device, mocked_response):
             device = self._create_device(last_ip="172.217.22.14")
 
             location = device.devicelocation.location
-            self.assertEqual(location.fuzzy, True)
+            self.assertEqual(location.is_approximate, True)
             self.assertEqual(location.is_mobile, False)
             self.assertEqual(location.type, "outdoor")
             _verify_location_details(device, mocked_response)
@@ -543,29 +545,29 @@ def _verify_location_details(device, mocked_response):
             device.refresh_from_db()
 
             location = device.devicelocation.location
-            self.assertEqual(location.fuzzy, True)
+            self.assertEqual(location.is_approximate, True)
             self.assertEqual(location.is_mobile, False)
             self.assertEqual(location.type, "outdoor")
             _verify_location_details(device, mocked_response)
 
         with self.subTest(
-            "Test Location not updated if it is not fuzzy when last ip is updated"
+            "Test Location not updated if it is not approximate when last ip is updated"
         ):
             device.last_ip = "172.217.22.11"
-            device.devicelocation.location.fuzzy = False
+            device.devicelocation.location.is_approximate = False
             mock_client.return_value.city.return_value = self._mocked_client_response()
             device.devicelocation.location.save()
             device.save()
             device.refresh_from_db()
 
             location = device.devicelocation.location
-            self.assertEqual(location.fuzzy, False)
+            self.assertEqual(location.is_approximate, False)
             self.assertEqual(location.is_mobile, False)
             self.assertEqual(location.type, "outdoor")
             _verify_location_details(device, mocked_response)
 
         with self.subTest(
-            "Test Location shared among devices with same last_ip when new device's location does not exist"
+            "Test shared location for same IP when new device's location does not exist"
         ):
             Device.objects.all().delete()
             device1 = self._create_device(last_ip="172.217.22.10")
@@ -580,7 +582,7 @@ def _verify_location_details(device, mocked_response):
             )
 
         with self.subTest(
-            "Test Location shared among devices with same last_ip when new device's location exist"
+            "Test shared location for same IP when new device's location exist"
         ):
             Device.objects.all().delete()
             device1 = self._create_device(last_ip="172.217.22.10")

openwisp_controller/geo/admin.py

@@ -98,6 +98,7 @@ class LocationAdmin(MultitenantAdminMixin, AbstractLocationAdmin):
     form = LocationForm
     inlines = [FloorPlanInline]
     list_select_related = ("organization",)
+    readonly_fields = ("is_approximate",)
 
 
 LocationAdmin.list_display.insert(1, "organization")

openwisp_controller/geo/base/models.py

@@ -11,12 +11,9 @@
 
 
 class BaseLocation(OrgMixin, AbstractLocation):
-    fuzzy = models.BooleanField(
+    is_approximate = models.BooleanField(
         default=False,
-        help_text=_(
-            "If true, the location is considered fuzzy and "
-            "may not have precise coordinates."
-        ),
+        help_text=_("Whether the location's coordinates are approximate."),
     )
 
     class Meta(AbstractLocation.Meta):

openwisp_controller/geo/migrations/0004_location_fuzzy.py renamed to openwisp_controller/geo/migrations/0004_location_is_approximate.py

@@ -12,13 +12,10 @@ class Migration(migrations.Migration):
     operations = [
         migrations.AddField(
             model_name="location",
-            name="fuzzy",
+            name="is_approximate",
             field=models.BooleanField(
                 default=False,
-                help_text=(
-                    "If true, the location is considered fuzzy and "
-                    "may not have precise coordinates."
-                ),
+                help_text=("Whether the location's coordinates are approximate."),
             ),
         ),
     ]

openwisp_controller/geo/tests/test_admin.py

@@ -137,6 +137,16 @@ def test_admin_menu_groups(self):
                 html=True,
             )
 
+    def test_location_readonly_fields(self):
+        location = self._create_location(
+            name="location1org", type="indoor", organization=self._get_org()
+        )
+        self._create_admin()
+        self._login()
+        url = reverse(f"admin:{self.app_label}_location_change", args=[location.pk])
+        response = self.client.get(url)
+        self.assertNotContains(response, '<input type="checkbox" name="is_approximate"')
+
 
 class TestDeviceAdmin(
     TestImportExportMixin, TestAdminMixin, TestGeoMixin, TestOrganizationMixin, TestCase

tests/openwisp2/sample_geo/migrations/0004_location_is_approximate.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.2.1 on 2025-07-01 19:18
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("sample_geo", "0003_alter_devicelocation_floorplan_location"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="location",
+            name="is_approximate",
+            field=models.BooleanField(
+                default=False,
+                help_text="Whether the location's coordinates are approximate.",
+            ),
+        ),
+    ]