Adds exceptions; reorders check_ip

Author: Josh VanDeraa

netbox_onboarding/__init__.py

@@ -38,6 +38,7 @@ class OnboardingConfig(PluginConfig):
         "default_management_interface": "PLACEHOLDER",
         "default_management_prefix_length": 0,
         "default_device_status": "active",
+        "create_management_interface_if_missing": True,
     }
     caching_config = {}
 

netbox_onboarding/onboard.py

@@ -212,27 +212,28 @@ def check_ip(self):
                     False if unable to find a device IP (error)
 
         """
-        # Assign checked_ip to None for error handling
         try:
+            # Assign checked_ip to None for error handling
             # If successful, this is an IP address and can pass
-            checked_ip = netaddr.IPNetwork(self.ot.ip_address)
+            checked_ip = netaddr.IPAddress(self.ot.ip_address)
             return True
+        # Catch when someone has put in a prefix address, raise an exception
+        except ValueError:
+            raise OnboardException(
+                reason="fail-prefix", message=f"ERROR appears a prefix was entered: {self.ot.ip_address}"
+            )
         # An AddrFormatError exception means that there is not an IP address in the field, and should continue on
         except AddrFormatError:
-            pass
-        # Catch when someone has put in a prefix address
-        except ValueError:
-            pass
-
-        # An IP address was not detected in the IP address field, attempt to find DNS
-        try:
-            # Do a lookup of name
-            checked_ip = socket.gethostbyname(self.ot.ip_address)
-            self.ot.ip_address = checked_ip
-            return True
-        except socket.gaierror:
-            # DNS Lookup has failed, not a DNS, do not do anything
-            return False
+            try:
+                # Do a lookup of name to get the IP address to connect to
+                checked_ip = socket.gethostbyname(self.ot.ip_address)
+                self.ot.ip_address = checked_ip
+                return True
+            except socket.gaierror:
+                # DNS Lookup has failed, Raise an exception for unable to complete DNS lookup
+                raise OnboardException(
+                    reason="fail-dns", message=f"ERROR failed to complete DNS lookup: {self.ot.ip_address}"
+                )
 
     def get_required_info(
         self,
@@ -512,5 +513,6 @@ def ensure_device(self):
         self.ensure_device_type()
         self.ensure_device_role()
         self.ensure_device_instance()
-        self.ensure_interface()
-        self.ensure_primary_ip()
+        if PLUGIN_SETTINGS["create_management_interface_if_missing"]:
+            self.ensure_interface()
+            self.ensure_primary_ip()

netbox_onboarding/tests/test_onboard.py

@@ -49,6 +49,9 @@ def setUp(self):
         self.onboarding_task5 = OnboardingTask.objects.create(
             ip_address="bad.local", site=self.site1, role=self.device_role1, platform=self.platform1
         )
+        self.onboarding_task7 = OnboardingTask.objects.create(
+            ip_address="192.0.2.1/32", site=self.site1, role=self.device_role1, platform=self.platform1
+        )
 
         self.ndk1 = NetdevKeeper(self.onboarding_task1)
         self.ndk1.hostname = "device1"
@@ -181,7 +184,7 @@ def test_ensure_interface_exist(self):
         self.assertEqual(nbk.interface, intf)
 
     def test_ensure_primary_ip_not_exist(self):
-        """Verify ensure_primary_ip function when the Ip address do not already exist."""
+        """Verify ensure_primary_ip function when the IP address do not already exist."""
         nbk = NetboxKeeper(self.ndk2)
         nbk.device_type = self.device_type1
         nbk.netdev.ot = self.onboarding_task3
@@ -213,6 +216,16 @@ def test_failed_check_ip(self, mock_get_hostbyname):
         # Look up a failed response
         mock_get_hostbyname.side_effect = gaierror(8)
         ndk5 = NetdevKeeper(self.onboarding_task5)
+        ndk7 = NetdevKeeper(self.onboarding_task7)
+
+        # Check for bad.local raising an exception
+        with self.assertRaises(OnboardException) as exc_info:
+            ndk5.check_ip()
+            self.assertEqual(exc_info.exception.message, "ERROR failed to complete DNS lookup: bad.local")
+            self.assertEqual(exc_info.exception.reason, "fail-dns")
 
-        self.assertFalse(ndk5.check_ip())
-        self.assertEqual(ndk5.ot.ip_address, "bad.local")
+        # Check for exception with prefix address entered
+        with self.assertRaises(OnboardException) as exc_info:
+            ndk7.check_ip()
+            self.assertEqual(exc_info.exception.reason, "fail-prefix")
+            self.assertEqual(exc_info.exception.message, "ERROR appears a prefix was entered: 192.0.2.1/32")