Updates to support name resolution; Updates form; Updates readme

Author: Josh VanDeraa

README.md

@@ -48,10 +48,15 @@ The plugin behavior can be controlled with the following list of settings
 - `default_management_prefix_length` integer ( default 0), length of the prefix that will be used for the management IP address, if the IP can't be found.
 
 ## Usage
+
 ### Preparation
 
-To work properly the plugin needs to know the Site, Platform, Device Type, Device Role of each device as well as its primary IP address.
-It's recommended to create these objects in NetBox ahead of time and to provide them when you want to start the onboarding process.
+To work properly the plugin needs to know the Site, Platform, Device Type, Device Role of each
+device as well as its primary IP address or DNS Name. It's recommended to create these objects in
+NetBox ahead of time and to provide them when you want to start the onboarding process.
+
+> For DNS Name Resolution to work, the instance of NetBox must be able to resolve the name of the
+> device to IP address.
 
 If `Platform`, `Device Type` and/or `Device Role` are not provided, the plugin will try to identify these information automatically and, based on the settings, it can create them in NetBox as needed.
 > If the Platform is provided, it must contains a valid Napalm driver available to the worker in Python

netbox_onboarding/forms.py

@@ -29,7 +29,7 @@
 class OnboardingTaskForm(BootstrapMixin, forms.ModelForm):
     """Form for creating a new OnboardingTask instance."""
 
-    ip_address = forms.CharField(required=True, label="IP address", help_text="IP address of the device to onboard")
+    ip_address = forms.CharField(required=True, label="IP address", help_text="IP Address/DNS Name of the device to onboard")
 
     site = forms.ModelChoiceField(required=True, queryset=Site.objects.all(), to_field_name="slug")
 

netbox_onboarding/onboard.py

@@ -213,24 +213,23 @@ def check_ip(self):
 
         """
         # Assign checked_ip to None for error handling
-        checked_ip = None
         try:
             # If successful, this is an IP address and can pass
             checked_ip = netaddr.IPNetwork(self.ot.ip_address)
             return True
+        # An AddrFormatError exception means that there is not an IP address in the field, and should continue on
         except AddrFormatError:
             pass
 
         # An IP address was not detected in the IP address field, attempt to find DNS
-        if checked_ip is None:
-            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
+            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
 
     def get_required_info(
         self,

netbox_onboarding/tests/test_onboard.py

@@ -11,6 +11,8 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+from socket import gaierror
+from unittest import mock
 from django.test import TestCase
 from django.utils.text import slugify
 
@@ -40,6 +42,13 @@ def setUp(self):
         self.onboarding_task3 = OnboardingTask.objects.create(
             ip_address="192.168.1.2", site=self.site1, role=self.device_role1, platform=self.platform1
         )
+        self.onboarding_task4 = OnboardingTask.objects.create(
+            ip_address="ntc123.local", site=self.site1, role=self.device_role1, platform=self.platform1
+        )
+
+        self.onboarding_task5 = OnboardingTask.objects.create(
+            ip_address="bad.local", site=self.site1, role=self.device_role1, platform=self.platform1
+        )
 
         self.ndk1 = NetdevKeeper(self.onboarding_task1)
         self.ndk1.hostname = "device1"
@@ -182,3 +191,29 @@ def test_ensure_primary_ip_not_exist(self):
         nbk.ensure_primary_ip()
         self.assertIsInstance(nbk.primary_ip, IPAddress)
         self.assertEqual(nbk.primary_ip.interface, nbk.interface)
+
+    @mock.patch("netbox_onboarding.onboard.socket.gethostbyname")
+    def test_check_ip(self, mock_get_hostbyname):
+        """Check DNS to IP address."""
+        # Look up response value
+        mock_get_hostbyname.return_value = "192.0.2.1"
+
+        # Create a Device Keeper object of the device
+        ndk4 = NetdevKeeper(self.onboarding_task4)
+
+        # Check that the IP address is returned
+        self.assertTrue(ndk4.check_ip())
+        
+        # Run the check to change the IP address
+        ndk4.check_ip()
+        self.assertEqual(ndk4.ot.ip_address, "192.0.2.1")
+
+    @mock.patch("netbox_onboarding.onboard.socket.gethostbyname")
+    def test_failed_check_ip(self, mock_get_hostbyname):
+        """Check DNS to IP address failing."""
+        # Look up a failed response
+        mock_get_hostbyname.side_effect = gaierror(8)
+        ndk5 = NetdevKeeper(self.onboarding_task5)
+
+        self.assertFalse(ndk5.check_ip())
+