Merge pull request #30 from networktocode/gfm-misc-cleanup

Various cleanup and enhancements

Author: glennmatthews

netbox_onboarding/__init__.py

@@ -21,7 +21,7 @@ class OnboardingConfig(PluginConfig):
     """Plugin configuration for the netbox_onboarding plugin."""
 
     name = "netbox_onboarding"
-    verbose_name = "A plugin to easily onboard new devices."
+    verbose_name = "Device Onboarding"
     version = __version__
     author = "Network to Code"
     description = "A plugin for NetBox to easily onboard new devices."

netbox_onboarding/admin.py

@@ -21,8 +21,6 @@ class OnboardingTaskAdmin(admin.ModelAdmin):
 
     list_display = (
         "pk",
-        "group_id",
-        "owner",
         "created_device",
         "ip_address",
         "site",

netbox_onboarding/api/serializers.py

@@ -24,7 +24,14 @@
 class OnboardingTaskSerializer(serializers.ModelSerializer):
     """Serializer for the OnboardingTask model."""
 
-    device = serializers.CharField(required=False, help_text="Planned device name",)
+    site = serializers.SlugRelatedField(
+        many=False,
+        read_only=False,
+        queryset=Site.objects.all(),
+        slug_field="slug",
+        required=True,
+        help_text="NetBox site 'slug' value",
+    )
 
     ip_address = serializers.CharField(required=True, help_text="IP Address to reach device",)
 
@@ -34,14 +41,9 @@ class OnboardingTaskSerializer(serializers.ModelSerializer):
 
     secret = serializers.CharField(required=False, write_only=True, help_text="Device secret password",)
 
-    site = serializers.SlugRelatedField(
-        many=False,
-        read_only=False,
-        queryset=Site.objects.all(),
-        slug_field="slug",
-        required=True,
-        help_text="NetBox site 'slug' value",
-    )
+    port = serializers.IntegerField(required=False, help_text="Device PORT to check for online")
+
+    timeout = serializers.IntegerField(required=False, help_text="Timeout (sec) for device connect")
 
     role = serializers.SlugRelatedField(
         many=False,
@@ -63,34 +65,32 @@ class OnboardingTaskSerializer(serializers.ModelSerializer):
         help_text="NetBox Platform 'slug' value",
     )
 
-    status = serializers.CharField(required=False, help_text="Onboarding Status")
-
-    failed_raison = serializers.CharField(required=False, help_text="Failure reason")
+    created_device = serializers.CharField(required=False, read_only=True, help_text="Created device name",)
 
-    message = serializers.CharField(required=False, help_text="Status message")
+    status = serializers.CharField(required=False, read_only=True, help_text="Onboarding Status")
 
-    port = serializers.IntegerField(required=False, help_text="Device PORT to check for online")
+    failed_reason = serializers.CharField(required=False, read_only=True, help_text="Failure reason")
 
-    timeout = serializers.IntegerField(required=False, help_text="Timeout (sec) for device connect")
+    message = serializers.CharField(required=False, read_only=True, help_text="Status message")
 
     class Meta:  # noqa: D106 "Missing docstring in public nested class"
         model = OnboardingTask
         fields = [
             "id",
-            "device",
+            "site",
             "ip_address",
             "username",
             "password",
             "secret",
-            "site",
+            "port",
+            "timeout",
             "role",
             "device_type",
             "platform",
+            "created_device",
             "status",
-            "failed_raison",
+            "failed_reason",
             "message",
-            "port",
-            "timeout",
         ]
 
     def create(self, validated_data):

netbox_onboarding/forms.py

@@ -79,7 +79,7 @@ def save(self, commit=True, **kwargs):
         """Save the model, and add it and the associated credentials to the onboarding worker queue."""
         model = super().save(commit=commit, **kwargs)
         if commit:
-            credentials = Credentials(self.data["username"], self.data["password"], self.data["secret"])
+            credentials = Credentials(self.data.get("username"), self.data.get("password"), self.data.get("secret"))
             get_queue("default").enqueue("netbox_onboarding.worker.onboard_device", model.pk, credentials)
         return model
 

netbox_onboarding/migrations/0001_initial.py

@@ -1,6 +1,5 @@
-# Generated by Django 3.0.6 on 2020-05-18 13:04
+# Generated by Django 3.0.6 on 2020-05-18 21:58
 
-from django.conf import settings
 from django.db import migrations, models
 import django.db.models.deletion
 
@@ -11,15 +10,13 @@ class Migration(migrations.Migration):
 
     dependencies = [
         ("dcim", "0105_interface_name_collation"),
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
         migrations.CreateModel(
             name="OnboardingTask",
             fields=[
                 ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False)),
-                ("group_id", models.CharField(blank=True, max_length=255)),
                 ("ip_address", models.CharField(max_length=255, null=True)),
                 ("device_type", models.CharField(max_length=255, null=True)),
                 ("status", models.CharField(max_length=255)),
@@ -34,12 +31,6 @@ class Migration(migrations.Migration):
                         blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to="dcim.Device"
                     ),
                 ),
-                (
-                    "owner",
-                    models.ForeignKey(
-                        blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL
-                    ),
-                ),
                 (
                     "platform",
                     models.ForeignKey(

netbox_onboarding/models.py

@@ -12,19 +12,12 @@
 limitations under the License.
 """
 from django.db import models
-from django.contrib.auth.models import User
 from .choices import OnboardingStatusChoices, OnboardingFailChoices
 
 
 class OnboardingTask(models.Model):
     """The status of each onboarding Task is tracked in the OnboardingTask table."""
 
-    group_id = models.CharField(max_length=255, help_text="CSV Bulk Import Group ID (optional)", blank=True)
-
-    owner = models.ForeignKey(
-        to=User, on_delete=models.SET_NULL, help_text="CSV Bulk Task Owner (optional)", blank=True, null=True
-    )
-
     created_device = models.ForeignKey(to="dcim.Device", on_delete=models.SET_NULL, blank=True, null=True)
 
     ip_address = models.CharField(max_length=255, help_text="primary ip address for the device", null=True)
@@ -65,3 +58,7 @@ class OnboardingTask(models.Model):
 
     class Meta:  # noqa: D106 "missing docstring in public nested class"
         ordering = ["created_on"]
+
+    def __str__(self):
+        """String representation of an OnboardingTask."""
+        return f"{self.site} : {self.ip_address}"

netbox_onboarding/navigation.py

@@ -19,19 +19,21 @@
     PluginMenuItem(
         link="plugins:netbox_onboarding:onboarding_task_list",
         link_text="Onboarding Tasks",
-        permissions=[],
+        permissions=["netbox_onboarding.view_onboardingtask"],
         buttons=(
             PluginMenuButton(
                 link="plugins:netbox_onboarding:onboarding_task_add",
                 title="Onboard",
                 icon_class="fa fa-plus",
                 color=ButtonColorChoices.GREEN,
+                permissions=["netbox_onboarding.add_onboardingtask"],
             ),
             PluginMenuButton(
                 link="plugins:netbox_onboarding:onboarding_task_import",
                 title="Bulk Onboard",
                 icon_class="fa fa-download",
                 color=ButtonColorChoices.BLUE,
+                permissions=["netbox_onboarding.add_onboardingtask"],
             ),
         ),
     ),

netbox_onboarding/onboard.py

@@ -13,7 +13,6 @@
 """
 
 import logging
-import os
 import re
 import socket
 
@@ -70,13 +69,14 @@ def __str__(self):
 class NetdevKeeper:
     """Used to maintain information about the network device during the onboarding process."""
 
-    def __init__(self, onboarding_task, username=None, password=None):
+    def __init__(self, onboarding_task, username=None, password=None, secret=None):
         """Initialize the network device keeper instance and ensure the required configuration parameters are provided.
 
         Args:
           onboarding_task (OnboardingTask): Task being processed
-          username (str): Device username (if unspecified, NAPALM_USERNAME environment variable will be used)
-          password (str): Device password (if unspecified, NAPALM_PASSWORD environment variable will be used)
+          username (str): Device username (if unspecified, NAPALM_USERNAME settings variable will be used)
+          password (str): Device password (if unspecified, NAPALM_PASSWORD settings variable will be used)
+          secret (str): Device secret password (if unspecified, NAPALM_ARGS["secret"] settings variable will be used)
 
         Raises:
           OnboardException('fail-config'):
@@ -92,8 +92,9 @@ def __init__(self, onboarding_task, username=None, password=None):
         self.serial_number = None
         self.mgmt_ifname = None
         self.mgmt_pflen = None
-        self.username = username or os.environ.get("NAPALM_USERNAME", None)
-        self.password = password or os.environ.get("NAPALM_PASSWORD", None)
+        self.username = username or settings.NAPALM_USERNAME
+        self.password = password or settings.NAPALM_PASSWORD
+        self.secret = secret or settings.NAPALM_ARGS.get("secret", None)
 
     def check_reachability(self):
         """Ensure that the device at the mgmt-ipaddr provided is reachable.
@@ -129,6 +130,7 @@ def guess_netmiko_device_type(**kwargs):
             "host": kwargs.get("host"),
             "username": kwargs.get("username"),
             "password": kwargs.get("password"),
+            "secret": kwargs.get("secret"),
         }
 
         try:
@@ -159,7 +161,7 @@ def get_platform_slug(self):
             platform_slug = self.ot.platform.slug
         else:
             platform_slug = self.guess_netmiko_device_type(
-                host=self.ot.ip_address, username=self.username, password=self.password
+                host=self.ot.ip_address, username=self.username, password=self.password, secret=self.secret,
             )
 
         logging.info("PLATFORM NAME is %s", platform_slug)
@@ -233,7 +235,15 @@ def get_required_info(
                 )
 
             driver = get_network_driver(driver_name)
-            dev = driver(hostname=mgmt_ipaddr, username=self.username, password=self.password, timeout=self.ot.timeout)
+            optional_args = settings.NAPALM_ARGS.copy()
+            optional_args["secret"] = self.secret
+            dev = driver(
+                hostname=mgmt_ipaddr,
+                username=self.username,
+                password=self.password,
+                timeout=self.ot.timeout,
+                optional_args=optional_args,
+            )
 
             dev.open()
             logging.info("COLLECT: device facts")
@@ -265,16 +275,13 @@ def get_mgmt_info():
                         return (if_name, if_addr_data["prefix_length"])
             return (default_mgmt_if, default_mgmt_pfxlen)
 
-        mgmt_ifname, mgmt_pflen = get_mgmt_info()
-
         # retain the attributes that will be later used by NetBox processing.
 
         self.hostname = facts["hostname"]
         self.vendor = facts["vendor"].title()
         self.model = facts["model"].lower()
         self.serial_number = facts["serial_number"]
-        self.mgmt_ifname = mgmt_ifname
-        self.mgmt_pflen = mgmt_pflen
+        self.mgmt_ifname, self.mgmt_pflen = get_mgmt_info()
 
 
 # -----------------------------------------------------------------------------

netbox_onboarding/tables.py

@@ -12,13 +12,14 @@
 limitations under the License.
 """
 import django_tables2 as tables
-from utilities.tables import BaseTable
+from utilities.tables import BaseTable, ToggleColumn
 from .models import OnboardingTask
 
 
 class OnboardingTaskTable(BaseTable):
     """Table for displaying OnboardingTask instances."""
 
+    pk = ToggleColumn()
     site = tables.LinkColumn()
     platform = tables.LinkColumn()
     created_device = tables.LinkColumn()
@@ -47,7 +48,6 @@ class Meta(BaseTable.Meta):  # noqa: D106 "Missing docstring in public nested cl
         model = OnboardingTask
         fields = (
             "id",
-            "owner",
             "created_on",
             "site",
             "platform",

netbox_onboarding/templates/netbox_onboarding/onboarding_tasks_list.html

@@ -2,10 +2,16 @@
 {% load buttons %}
 
 {% block content %}
+<div class="pull-right noprint">
+    {% if permissions.add %}
+        {% add_button 'plugins:netbox_onboarding:onboarding_task_add' %}
+        {% import_button 'plugins:netbox_onboarding:onboarding_task_import' %}
+    {% endif %}
+</div>
 <h1>{% block title %}Onboarding Tasks{% endblock %}</h1>
 <div class="row">
 	<div class="col-md-9">
-        {% include 'utilities/obj_table.html' %}
+        {% include 'utilities/obj_table.html' with bulk_delete_url="plugins:netbox_onboarding:onboarding_task_bulk_delete" %}
     </div>
 	<div class="col-md-3 noprint">
 		{% include 'inc/search_panel.html' %}