Brings in changes for name lookup

Author: Josh VanDeraa

netbox_onboarding/onboard.py

@@ -18,6 +18,8 @@
 
 from napalm import get_network_driver
 from napalm.base.exceptions import ConnectionException, CommandErrorException
+import netaddr
+from netaddr.core import AddrFormatError
 
 from django.conf import settings
 from django.utils.text import slugify
@@ -236,6 +238,46 @@ def get_platform_object_from_netbox(
 
         return platform
 
+    def check_ip(self):
+        """Method to check if the IP address form field was an IP address.
+
+        If it is a DNS name, attempt to resolve the DNS address and assign the IP address to the
+        name.
+
+        Returns:
+            (bool): True if the IP address is an IP address, or a DNS entry was found and
+                    reassignment of the ot.ip_address was done.
+                    False if unable to find a device IP (error)
+
+        Raises:
+          OnboardException("fail-general"):
+            When a prefix was entered for an IP address
+          OnboardException("fail-dns"):
+            When a Name lookup via DNS fails to resolve an IP address
+        """
+        try:
+            # Assign checked_ip to None for error handling
+            # If successful, this is an IP address and can pass
+            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-general", 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:
+            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,
         default_mgmt_if=PLUGIN_SETTINGS["default_management_interface"],

netbox_onboarding/tests/test_netbox_keeper.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