Remove credentials from OnboardingTask model entirely; capture them at form save time instead

Author: glennmatthews

netbox_onboarding/forms.py

@@ -13,13 +13,15 @@
 """
 
 from django import forms
+from django_rq import get_queue
 
 from utilities.forms import BootstrapMixin
 from dcim.models import Site, Platform, DeviceRole
 from extras.forms import CustomFieldModelCSVForm
 
 from .models import OnboardingTask
 from .choices import OnboardingStatusChoices, OnboardingFailChoices
+from .utils.credentials import Credentials
 
 BLANK_CHOICE = (("", "---------"),)
 
@@ -39,7 +41,26 @@ class OnboardingTaskForm(BootstrapMixin, forms.ModelForm):
 
     class Meta:  # noqa: D106 "Missing docstring in public nested class"
         model = OnboardingTask
-        fields = ["ip_address", "site", "username", "password", "secret", "role", "device_type", "platform", "port", "timeout"]
+        fields = [
+            "ip_address",
+            "site",
+            "username",
+            "password",
+            "secret",
+            "role",
+            "device_type",
+            "platform",
+            "port",
+            "timeout",
+        ]
+
+    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"])
+            get_queue("default").enqueue("netbox_onboarding.worker.onboard_device", model.pk, credentials)
+        return model
 
 
 class OnboardingTaskFilterForm(BootstrapMixin, forms.ModelForm):
@@ -63,7 +84,7 @@ class Meta:  # noqa: D106 "Missing docstring in public nested class"
 
 
 class OnboardingTaskFeedCSVForm(CustomFieldModelCSVForm):
-    """TODO document me."""
+    """Form for entering CSV to bulk-import OnboardingTask entries."""
 
     site = forms.ModelChoiceField(
         queryset=Site.objects.all(),
@@ -98,3 +119,11 @@ class OnboardingTaskFeedCSVForm(CustomFieldModelCSVForm):
     class Meta:  # noqa: D106 "Missing docstring in public nested class"
         model = OnboardingTask
         fields = OnboardingTask.csv_headers
+
+    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.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,4 +1,4 @@
-# Generated by Django 3.0.6 on 2020-05-12 10:21
+# Generated by Django 3.0.6 on 2020-05-18 13:04
 
 from django.conf import settings
 from django.db import migrations, models
@@ -21,9 +21,6 @@ class Migration(migrations.Migration):
                 ("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)),
-                ("username", models.CharField(blank=True, max_length=255)),
-                ("password", models.CharField(blank=True, max_length=255)),
-                ("secret", models.CharField(blank=True, max_length=255)),
                 ("device_type", models.CharField(max_length=255, null=True)),
                 ("status", models.CharField(max_length=255)),
                 ("failed_reason", models.CharField(max_length=255, null=True)),

netbox_onboarding/models.py

@@ -31,12 +31,6 @@ class OnboardingTask(models.Model):
 
     site = models.ForeignKey(to="dcim.Site", on_delete=models.SET_NULL, blank=True, null=True)
 
-    username = models.CharField(max_length=255, help_text="Device Username (optional)", blank=True)
-
-    password = models.CharField(max_length=255, help_text="Device Password (optional)", blank=True)
-
-    secret = models.CharField(max_length=255, help_text="Device Secret Password (optional)", blank=True)
-
     role = models.ForeignKey(to="dcim.DeviceRole", on_delete=models.SET_NULL, blank=True, null=True)
 
     device_type = models.CharField(
@@ -63,9 +57,6 @@ class OnboardingTask(models.Model):
     csv_headers = [
         "site",
         "ip_address",
-        "username",
-        "password",
-        "secret",
         "port",
         "timeout",
         "platform",

netbox_onboarding/views.py

@@ -12,15 +12,9 @@
 limitations under the License.
 """
 import logging
-from django.contrib import messages
 from django.contrib.auth.mixins import PermissionRequiredMixin
-from django.core.exceptions import ValidationError
-from django.db import transaction
-from django.shortcuts import render
-from django_rq import get_queue
 from utilities.views import BulkImportView, ObjectEditView, ObjectListView
 
-from netbox_onboarding.utils.credentials import Credentials
 from .filters import OnboardingTaskFilter
 from .forms import OnboardingTaskForm, OnboardingTaskFilterForm, OnboardingTaskFeedCSVForm
 from .models import OnboardingTask
@@ -41,19 +35,6 @@ class OnboardingTaskListView(PermissionRequiredMixin, ObjectListView):
     template_name = "netbox_onboarding/onboarding_tasks_list.html"
 
 
-def handle_created_onboarding_task(task, owner):
-    """Sanitize the OnboardingTask and hand it off to the worker queue."""
-    credentials = Credentials(username=task.username, password=task.password, secret=task.secret)
-
-    task.username = ""
-    task.password = ""
-    task.secret = ""
-    task.owner = owner
-    task.save()
-
-    get_queue("default").enqueue("netbox_onboarding.worker.onboard_device", task.pk, credentials)
-
-
 class OnboardingTaskCreateView(PermissionRequiredMixin, ObjectEditView):
     """View for creating a new OnboardingTask."""
 
@@ -64,19 +45,6 @@ class OnboardingTaskCreateView(PermissionRequiredMixin, ObjectEditView):
     template_name = "netbox_onboarding/onboarding_task_edit.html"
     default_return_url = "plugins:netbox_onboarding:onboarding_task_list"
 
-    def post(self, request):
-        """Process an HTTP POST request."""
-        form = self.model_form(request.POST)
-
-        if form.is_valid():
-            obj = form.save()
-            handle_created_onboarding_task(obj, self.request.user)
-
-        return render(
-            request,
-            self.template_name,
-            {"form": form}
-        )
 
 class OnboardingTaskFeedBulkImportView(PermissionRequiredMixin, BulkImportView):
     """View for bulk-importing a CSV file to create OnboardingTasks."""
@@ -85,50 +53,3 @@ class OnboardingTaskFeedBulkImportView(PermissionRequiredMixin, BulkImportView):
     model_form = OnboardingTaskFeedCSVForm
     table = OnboardingTaskFeedBulkTable
     default_return_url = "plugins:netbox_onboarding:onboarding_task_list"
-
-    def post(self, request):
-        """Process an HTTP POST request."""
-        new_objs = []
-        form = self._import_form(request.POST)
-
-        if form.is_valid():
-            try:
-                # Iterate through CSV data and bind each row to a new model form instance.
-                with transaction.atomic():
-                    headers, records = form.cleaned_data["csv"]
-                    for row, data in enumerate(records, start=1):
-                        obj_form = self.model_form(data, headers=headers)
-                        if obj_form.is_valid():
-                            obj = self._save_obj(obj_form, request)
-                            new_objs.append(obj)
-                        else:
-                            for field, err in obj_form.errors.items():
-                                form.add_error("csv", "Row {} {}: {}".format(row, field, err[0]))
-                            raise ValidationError("")
-
-                for ot in new_objs:
-                    handle_created_onboarding_task(ot, self.request.user)
-
-                if new_objs:
-                    msg = "Imported {} {}".format(len(new_objs), new_objs[0]._meta.verbose_name_plural)
-                    messages.success(request, msg)
-
-                    return render(
-                        request,
-                        "import_success.html",
-                        {"table": self.table(new_objs), "return_url": self.get_return_url(request),},
-                    )
-
-            except ValidationError:
-                pass
-
-        return render(
-            request,
-            self.template_name,
-            {
-                "form": form,
-                "fields": self.model_form().fields,
-                "obj_type": self.model_form._meta.model._meta.verbose_name,  # pylint:disable=no-member
-                "return_url": self.get_return_url(request),
-            },
-        )

tasks.py

@@ -167,11 +167,12 @@ def create_user(context, user="admin", netbox_ver=NETBOX_VER, python_ver=PYTHON_
 
 
 @task
-def makemigrations(context, netbox_ver=NETBOX_VER, python_ver=PYTHON_VER):
+def makemigrations(context, name="", netbox_ver=NETBOX_VER, python_ver=PYTHON_VER):
     """Run Make Migration in Django.
 
     Args:
         context (obj): Used to run specific commands
+        name (str): Name of the migration to be created
         netbox_ver (str): NetBox version to use to build the container
         python_ver (str): Will use the Python version docker image to build from
     """
@@ -180,10 +181,16 @@ def makemigrations(context, netbox_ver=NETBOX_VER, python_ver=PYTHON_VER):
         env={"NETBOX_VER": netbox_ver, "PYTHON_VER": python_ver},
     )
 
-    context.run(
-        f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run netbox python manage.py makemigrations",
-        env={"NETBOX_VER": netbox_ver, "PYTHON_VER": python_ver},
-    )
+    if name:
+        context.run(
+            f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run netbox python manage.py makemigrations --name {name}",
+            env={"NETBOX_VER": netbox_ver, "PYTHON_VER": python_ver},
+        )
+    else:
+        context.run(
+            f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run netbox python manage.py makemigrations",
+            env={"NETBOX_VER": netbox_ver, "PYTHON_VER": python_ver},
+        )
 
     context.run(
         f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} down",