NPL-379 Add bulk import to Custom Object

Author: arthanson

netbox_custom_objects/templates/netbox_custom_objects/custom_object_list.html

@@ -7,7 +7,7 @@
     {% plugin_list_buttons model %}
     {% block extra_controls %}{% endblock %}
     {% custom_object_add_button model custom_object_type %}
-    {% custom_object_import_button model %}
+    {% custom_object_import_button model custom_object_type %}
     {% custom_object_export_button model %}
   </div>
 {% endblock controls %}

netbox_custom_objects/templatetags/custom_object_buttons.py

@@ -203,9 +203,12 @@ def custom_object_add_button(model, custom_object_type, action="add"):
 
 
 @register.inclusion_tag("buttons/import.html")
-def custom_object_import_button(model, action="bulk_import"):
+def custom_object_import_button(model, custom_object_type, action="bulk_import"):
     try:
-        url = reverse(get_viewname(model, action))
+        viewname = get_viewname(model, action)
+        url = reverse(
+            viewname, kwargs={"custom_object_type": custom_object_type.name.lower()}
+        )
     except NoReverseMatch:
         url = None
 

netbox_custom_objects/urls.py

@@ -42,6 +42,11 @@
         views.CustomObjectBulkDeleteView.as_view(),
         name="customobject_bulk_delete",
     ),
+    path(
+        "<str:custom_object_type>/bulk-import/",
+        views.CustomObjectBulkImportView.as_view(),
+        name="customobject_bulk_import",
+    ),
     path(
         "<str:custom_object_type>/<int:pk>/",
         views.CustomObjectView.as_view(),

netbox_custom_objects/views.py

@@ -5,7 +5,7 @@
 from django.urls import reverse
 from extras.choices import CustomFieldUIVisibleChoices
 from netbox.filtersets import BaseFilterSet
-from netbox.forms import NetBoxModelBulkEditForm, NetBoxModelFilterSetForm
+from netbox.forms import NetBoxModelBulkEditForm, NetBoxModelFilterSetForm, NetBoxModelImportForm
 from netbox.views import generic
 from netbox.views.generic.mixins import TableMixin
 from utilities.forms import ConfirmationForm
@@ -462,8 +462,17 @@ def get_queryset(self, request):
         return model.objects.all()
 
     def get_form(self, queryset):
+        meta = type(
+            "Meta",
+            (),
+            {
+                "model": queryset.model,
+                "fields": "__all__",
+            },
+        )
+
         attrs = {
-            "model": queryset.model,
+            "Meta": meta,
             "__module__": "database.forms",
         }
 
@@ -504,3 +513,58 @@ def get_queryset(self, request):
         )
         model = self.custom_object_type.get_model()
         return model.objects.all()
+
+
+@register_model_view(CustomObject, 'bulk_import', path='import', detail=False)
+class CustomObjectBulkImportView(generic.BulkImportView):
+    queryset = None
+    model_form = None
+
+    def get(self, request, custom_object_type):
+        # Necessary because get() in BulkImportView only takes request and no **kwargs
+        return super().get(request)
+
+    def setup(self, request, *args, **kwargs):
+        super().setup(request, *args, **kwargs)
+        self.queryset = self.get_queryset(request)
+        self.model_form = self.get_model_form(self.queryset)
+
+    def get_queryset(self, request):
+        if self.queryset:
+            return self.queryset
+        custom_object_type = self.kwargs.get("custom_object_type", None)
+        self.custom_object_type = CustomObjectType.objects.get(
+            name__iexact=custom_object_type
+        )
+        model = self.custom_object_type.get_model()
+        return model.objects.all()
+
+    def get_model_form(self, queryset):
+        meta = type(
+            "Meta",
+            (),
+            {
+                "model": queryset.model,
+                "fields": "__all__",
+            },
+        )
+
+        attrs = {
+            "Meta": meta,
+            "__module__": "database.forms",
+        }
+
+        for field in self.custom_object_type.fields.all():
+            field_type = field_types.FIELD_TYPE_CLASS[field.type]()
+            try:
+                attrs[field.name] = field_type.get_annotated_form_field(field)
+            except NotImplementedError:
+                print(f"bulk import form: {field.name} field is not supported")
+
+        form = type(
+            f"{queryset.model._meta.object_name}BulkImportForm",
+            (NetBoxModelImportForm,),
+            attrs,
+        )
+
+        return form