[enhancement] Added management command for clearing last IP

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

Author: DragnEmperor

docs/user/whois.rst

@@ -45,6 +45,17 @@ met:
 - There is **no existing WHOIS record** for that IP.
 - WHOIS lookup is **enabled** for the device's organization.
 
+Handling Existing Devices
+-------------------------
+
+For creating WHOIS records for existing devices, run the ``clear_last_ip``
+management command, to clear the last IP address of **all active devices
+across organizations**. Active devices will update their last IP address,
+triggering the WHOIS lookup automatically.
+
+It accepts an optional flag ``--whois-related`` to exclude devices with
+WHOIS records.
+
 Managing WHOIS Records
 ----------------------
 

openwisp_controller/config/management/__init__.py

@@ -0,0 +1,63 @@
+from django.core.management.base import BaseCommand, CommandError
+from django.db.models import OuterRef, Subquery
+from swapper import load_model
+
+from openwisp_controller.config import settings as app_settings
+
+
+class Command(BaseCommand):
+    help = "Clear the last IP address, if set, of active devices of all organizations."
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--noinput",
+            "--no-input",
+            action="store_false",
+            dest="interactive",
+            help="Do NOT prompt the user for input of any kind.",
+        )
+        parser.add_argument(
+            "--whois-related",
+            action="store_true",
+            help="Clear only those IPs having no WHOIS information.",
+        )
+        return super().add_arguments(parser)
+
+    def handle(self, *args, **options):
+        Device = load_model("config", "Device")
+        WHOISInfo = load_model("config", "WHOISInfo")
+
+        if options["interactive"]:
+            message = ["\n"]
+            message.append(
+                "This will clear last IP of all active devices across organizations!\n"
+            )
+            message.append(
+                "Are you sure you want to do this?\n\n"
+                "Type 'yes' to continue, or 'no' to cancel: "
+            )
+            if input("".join(message)) != "yes":
+                raise CommandError("Operation cancelled by user.")
+
+        devices = Device.objects.filter(_is_deactivated=False).exclude(last_ip=None)
+        devices = devices.only("last_ip")
+        if options["whois_related"]:
+            if not app_settings.WHOIS_CONFIGURED:
+                self.stdout.write("WHOIS must be configured to use this option.")
+                return
+            # Filter devices that have no WHOIS information for their last IP
+            devices = devices.exclude(
+                last_ip__in=Subquery(
+                    WHOISInfo.objects.filter(ip_address=OuterRef("last_ip")).values(
+                        "ip_address"
+                    )
+                )
+            )
+
+        updated_devices = devices.update(last_ip=None)
+        if updated_devices:
+            self.stdout.write(
+                f"Cleared last IP addresses for {updated_devices} active device(s)."
+            )
+        else:
+            self.stdout.write("No active devices with last IP to clear.")

openwisp_controller/config/management/commands/__init__.py

@@ -1,9 +1,11 @@
 import importlib
+from io import StringIO
 from unittest import mock
 
 from django.contrib.gis.geos import Point
 from django.contrib.staticfiles.testing import StaticLiveServerTestCase
 from django.core.exceptions import ImproperlyConfigured, ValidationError
+from django.core.management import call_command
 from django.db.models.signals import post_delete, post_save
 from django.test import TestCase, TransactionTestCase, override_settings, tag
 from django.urls import reverse
@@ -265,6 +267,42 @@ def test_whois_details_device_api(self):
                 self.assertEqual(response.status_code, 200)
                 self.assertNotIn("whois_info", response.data)
 
+    @mock.patch.object(app_settings, "WHOIS_CONFIGURED", True)
+    def test_last_ip_management_command(self):
+        out = StringIO()
+        device = self._create_device(last_ip="172.217.22.11")
+        args = ["--noinput"]
+        call_command("clear_last_ip", *args, stdout=out, stderr=StringIO())
+        self.assertIn(
+            "Cleared last IP addresses for 1 active device(s).", out.getvalue()
+        )
+        device.refresh_from_db()
+        self.assertIsNone(device.last_ip)
+
+        device.last_ip = "172.217.22.11"
+        device.save()
+        self._create_whois_info(ip_address=device.last_ip)
+        device2 = self._create_device(
+            name="11:22:33:44:55:66",
+            mac_address="11:22:33:44:55:66",
+            last_ip="172.217.22.12",
+        )
+        args.append("--whois-related")
+        call_command("clear_last_ip", *args, stdout=out, stderr=StringIO())
+        self.assertIn(
+            "Cleared last IP addresses for 1 active device(s).", out.getvalue()
+        )
+        device.refresh_from_db()
+        device2.refresh_from_db()
+        self.assertIsNotNone(device.last_ip)
+        self.assertIsNone(device2.last_ip)
+
+        device.last_ip = None
+        WHOISInfo.objects.all().delete()
+        device.save()
+        call_command("clear_last_ip", *args, stdout=out, stderr=StringIO())
+        self.assertIn("No active devices with last IP to clear.", out.getvalue())
+
 
 class TestWHOISInfoModel(CreateWHOISMixin, TestCase):
     def test_whois_model_fields_validation(self):