Merge pull request #27 from networktocode/gfm-default-interface

Handle mgmt-interface-not-found plus other fixes

Author: dgarros

netbox_onboarding/__init__.py

@@ -33,6 +33,8 @@ class OnboardingConfig(PluginConfig):
         "create_device_type_if_missing": True,
         "create_device_role_if_missing": True,
         "default_device_role": "network",
+        "default_management_interface": "PLACEHOLDER",
+        "default_management_prefix_length": 0,
     }
     caching_config = {}
 

netbox_onboarding/admin.py

@@ -0,0 +1,38 @@
+"""Administrative capabilities for netbox_onboarding plugin.
+
+(c) 2020 Network To Code
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+  http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+from django.contrib import admin
+from .models import OnboardingTask
+
+
+@admin.register(OnboardingTask)
+class OnboardingTaskAdmin(admin.ModelAdmin):
+    """Administrative view for managing OnboardingTask instances."""
+
+    list_display = (
+        "pk",
+        "group_id",
+        "owner",
+        "created_device",
+        "ip_address",
+        "site",
+        "role",
+        "device_type",
+        "platform",
+        "status",
+        "message",
+        "failed_reason",
+        "port",
+        "timeout",
+        "created_on",
+    )

netbox_onboarding/onboard.py

@@ -17,7 +17,6 @@
 import re
 import socket
 
-from first import first
 from napalm import get_network_driver
 from napalm.base.exceptions import ConnectionException, CommandErrorException
 
@@ -196,7 +195,11 @@ def get_platform_object_from_netbox(platform_slug):
 
         return platform
 
-    def get_required_info(self):
+    def get_required_info(
+        self,
+        default_mgmt_if=PLUGIN_SETTINGS["default_management_interface"],
+        default_mgmt_pfxlen=PLUGIN_SETTINGS["default_management_prefix_length"],
+    ):
         """Gather information from the network device that is needed to onboard the device into the NetBox system.
 
         Raises:
@@ -217,6 +220,9 @@ def get_required_info(self):
         try:
             platform_slug = self.get_platform_slug()
             platform_object = self.get_platform_object_from_netbox(platform_slug=platform_slug)
+            if self.ot.platform != platform_object:
+                self.ot.platform = platform_object
+                self.ot.save()
 
             driver_name = platform_object.napalm_driver
 
@@ -248,17 +254,18 @@ def get_required_info(self):
         # locate the interface assigned with the mgmt_ipaddr value and retain
         # the interface name and IP prefix-length so that we can use it later
         # when creating the IPAM IP-Address instance.
+        # Note that in some cases (e.g., NAT) the mgmt_ipaddr may differ than
+        # the interface addresses present on the device. We need to handle this.
 
-        try:
-            mgmt_ifname, mgmt_pflen = first(
-                (if_name, if_addr_data["prefix_length"])
-                for if_name, if_data in ip_ifs.items()
-                for if_addr, if_addr_data in if_data["ipv4"].items()
-                if if_addr == mgmt_ipaddr
-            )
+        def get_mgmt_info():
+            """Get the interface name and prefix length for the management interface."""
+            for if_name, if_data in ip_ifs.items():
+                for if_addr, if_addr_data in if_data["ipv4"].items():
+                    if if_addr == mgmt_ipaddr:
+                        return (if_name, if_addr_data["prefix_length"])
+            return (default_mgmt_if, default_mgmt_pfxlen)
 
-        except Exception as exc:
-            raise OnboardException(reason="fail-general", message=str(exc))
+        mgmt_ifname, mgmt_pflen = get_mgmt_info()
 
         # retain the attributes that will be later used by NetBox processing.
 
@@ -322,14 +329,14 @@ def ensure_device_type(
         # instance.
 
         try:
-            self.manufacturer = Manufacturer.objects.get(slug=self.netdev.vendor)
+            self.manufacturer = Manufacturer.objects.get(slug=self.netdev.vendor.lower())
         except Manufacturer.DoesNotExist:
             if not create_manufacturer:
                 raise OnboardException(
                     reason="fail-config", message=f"ERROR manufacturer not found: {self.netdev.vendor}"
                 )
 
-            self.manufacturer = Manufacturer.objects.create(name=self.netdev.vendor, slug=self.netdev.vendor)
+            self.manufacturer = Manufacturer.objects.create(name=self.netdev.vendor, slug=self.netdev.vendor.lower())
             self.manufacturer.save()
 
         # Now see if the device type (slug) already exists,
@@ -343,7 +350,9 @@ def ensure_device_type(
             logging.warning("device model is now: %s", self.netdev.model)
 
         try:
-            self.device_type = DeviceType.objects.get(slug=self.netdev.model)
+            self.device_type = DeviceType.objects.get(slug=self.netdev.model.lower())
+            self.netdev.ot.device_type = self.device_type.slug
+            self.netdev.ot.save()
         except DeviceType.DoesNotExist:
             if not create_device_type:
                 raise OnboardException(
@@ -352,9 +361,11 @@ def ensure_device_type(
 
             logging.info("CREATE: device-type: %s", self.netdev.model)
             self.device_type = DeviceType.objects.create(
-                slug=self.netdev.model, model=self.netdev.model.upper(), manufacturer=self.manufacturer
+                slug=self.netdev.model.lower(), model=self.netdev.model.upper(), manufacturer=self.manufacturer
             )
             self.device_type.save()
+            self.netdev.ot.device_type = self.device_type.slug
+            self.netdev.ot.save()
             return
 
         if self.device_type.manufacturer.id != self.manufacturer.id:
@@ -398,6 +409,7 @@ def ensure_device_role(
 
     def ensure_device_instance(self):
         """Ensure that the device instance exists in NetBox and is assigned the provided device role or DEFAULT_ROLE."""
+        # TODO: this can create duplicate entries in NetBox...
         device, _ = Device.objects.get_or_create(
             name=self.netdev.hostname,
             device_type=self.device_type,
@@ -409,7 +421,7 @@ def ensure_device_instance(self):
         device.serial = self.netdev.serial_number
         device.save()
 
-        self.netdev.ot.device = device
+        self.netdev.ot.created_device = device
         self.netdev.ot.save()
 
         self.device = device

netbox_onboarding/tables.py

@@ -20,10 +20,22 @@ class OnboardingTaskTable(BaseTable):
     """Table for displaying OnboardingTask instances."""
 
     site = tables.LinkColumn()
+    platform = tables.LinkColumn()
+    created_device = tables.LinkColumn()
 
     class Meta(BaseTable.Meta):  # noqa: D106 "Missing docstring in public nested class"
         model = OnboardingTask
-        fields = ("pk", "created_on", "ip_address", "site", "platform", "device", "status", "failed_reason", "message")
+        fields = (
+            "pk",
+            "created_on",
+            "ip_address",
+            "site",
+            "platform",
+            "created_device",
+            "status",
+            "failed_reason",
+            "message",
+        )
 
 
 class OnboardingTaskFeedBulkTable(BaseTable):

netbox_onboarding/tests/test_onboard.py

@@ -117,7 +117,7 @@ def test_ensure_device_instance_not_exist(self):
 
         nbk.ensure_device_instance()
         self.assertIsInstance(nbk.device, Device)
-        self.assertEqual(nbk.device, nbk.netdev.ot.device)
+        self.assertEqual(nbk.device, nbk.netdev.ot.created_device)
         self.assertEqual(nbk.device.serial, "123456")
 
     def test_ensure_interface_not_exist(self):

netbox_onboarding/worker.py

@@ -12,6 +12,7 @@
 limitations under the License.
 """
 import logging
+import time
 
 from django_rq import job
 
@@ -29,7 +30,12 @@ def onboard_device(task_id, credentials):
     username = credentials.username
     password = credentials.password
 
-    ot = OnboardingTask.objects.get(id=task_id)
+    try:
+        ot = OnboardingTask.objects.get(id=task_id)
+    except OnboardingTask.DoesNotExist:
+        # TODO: maybe we started before the DB was done writing it, or maybe it was deleted out from under us?
+        time.sleep(1)
+        ot = OnboardingTask.objects.get(id=task_id)
 
     logging.info("START: onboard device")
 
@@ -54,6 +60,7 @@ def onboard_device(task_id, credentials):
     except Exception as exc:
         ot.status = OnboardingStatusChoices.STATUS_FAILED
         ot.failed_reason = OnboardingFailChoices.FAIL_GENERAL
+        ot.message = str(exc)
         ot.save()
         raise
 

poetry.lock

@@ -10,7 +10,6 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.6 || ^3.7 || ^3.8"
 invoke = "^1.4.1"
-first = "^2.0.2"
 napalm = "^2.5.0"
 
 [tool.poetry.dev-dependencies]