Add message support for bulk import/update

Author: jeremystretch

netbox/netbox/forms/mixins.py

@@ -15,6 +15,9 @@
 
 
 class ChangeLoggingMixin(forms.Form):
+    """
+    Adds an optional field for recording a message on the resulting changelog record(s).
+    """
     changelog_message = forms.CharField(
         required=False,
         max_length=200

netbox/netbox/views/generic/bulk_views.py

@@ -424,7 +424,6 @@ def create_and_update_objects(self, form, request):
         } if prefetch_ids else {}
 
         for i, record in enumerate(records, start=1):
-            instance = None
             object_id = int(record.pop('id')) if record.get('id') else None
 
             # Determine whether this object is being created or updated
@@ -440,6 +439,8 @@ def create_and_update_objects(self, form, request):
                     instance.snapshot()
 
             else:
+                instance = self.queryset.model()
+
                 # For newly created objects, apply any default custom field values
                 custom_fields = CustomField.objects.filter(
                     object_types=ContentType.objects.get_for_model(self.queryset.model),
@@ -450,6 +451,9 @@ def create_and_update_objects(self, form, request):
                     if field_name not in record:
                         record[field_name] = cf.default
 
+            # Record changelog message (if any)
+            instance._changelog_message = form.cleaned_data.pop('changelog_message', '')
+
             # Instantiate the model form for the object
             model_form_kwargs = {
                 'data': record,

netbox/templates/generic/bulk_import.html

@@ -42,32 +42,31 @@
 
   {# Data Import Form #}
   <div class="tab-pane show active" id="import-form" role="tabpanel" aria-labelledby="import-form-tab">
-    <div class="row">
-      <div class="col col-md-12 col-lg-10 offset-lg-1">
-        <form action="" method="post" enctype="multipart/form-data" class="form">
-          {% csrf_token %}
-          <input type="hidden" name="import_method" value="direct" />
-
-          {# Form fields #}
-          {% render_field form.data %}
-          {% render_field form.format %}
-          {% render_field form.csv_delimiter %}
-
-          {# Meta fields #}
-          <div class="bg-primary-subtle border border-primary rounded-1 pt-3 mb-3">
-            {% render_field form.background_job %}
-          </div>
+    <div class="col col-md-12 col-lg-10 offset-lg-1">
+      <form action="" method="post" enctype="multipart/form-data" class="form">
+        {% csrf_token %}
+        <input type="hidden" name="import_method" value="direct" />
+
+        {# Form fields #}
+        {% render_field form.data %}
+        {% render_field form.format %}
+        {% render_field form.csv_delimiter %}
+
+        {# Meta fields #}
+        <div class="bg-primary-subtle border border-primary rounded-1 pt-3 mb-3">
+          {% render_field form.changelog_message %}
+          {% render_field form.background_job %}
+        </div>
 
-          <div class="form-group">
-            <div class="col col-md-12 text-end">
-              {% if return_url %}
-                <a href="{{ return_url }}" class="btn btn-outline-secondary">{% trans "Cancel" %}</a>
-              {% endif %}
-              <button type="submit" name="data_submit" class="btn btn-primary">{% trans "Submit" %}</button>
-            </div>
+        <div class="form-group">
+          <div class="col col-md-12 text-end">
+            {% if return_url %}
+              <a href="{{ return_url }}" class="btn btn-outline-secondary">{% trans "Cancel" %}</a>
+            {% endif %}
+            <button type="submit" name="data_submit" class="btn btn-primary">{% trans "Submit" %}</button>
           </div>
-        </form>
-      </div>
+        </div>
+      </form>
     </div>
   </div>
 
@@ -83,6 +82,11 @@
         {% render_field form.format %}
         {% render_field form.csv_delimiter %}
 
+        {# Meta fields #}
+        <div class="bg-primary-subtle border border-primary rounded-1 pt-3 mb-3">
+          {% render_field form.changelog_message %}
+        </div>
+
         <div class="form-group">
           <div class="col col-md-12 text-end">
             {% if return_url %}
@@ -110,6 +114,7 @@
 
         {# Meta fields #}
         <div class="bg-primary-subtle border border-primary rounded-1 pt-3 mb-3">
+          {% render_field form.changelog_message %}
           {% render_field form.background_job %}
         </div>
 

netbox/utilities/forms/bulk_import.py

@@ -8,12 +8,13 @@
 
 from core.forms.mixins import SyncedDataMixin
 from netbox.choices import CSVDelimiterChoices, ImportFormatChoices, ImportMethodChoices
+from netbox.forms.mixins import ChangeLoggingMixin
 from utilities.constants import CSV_DELIMITERS
 from utilities.forms.mixins import BackgroundJobMixin
 from utilities.forms.utils import parse_csv
 
 
-class BulkImportForm(BackgroundJobMixin, SyncedDataMixin, forms.Form):
+class BulkImportForm(ChangeLoggingMixin, BackgroundJobMixin, SyncedDataMixin, forms.Form):
     import_method = forms.ChoiceField(
         choices=ImportMethodChoices,
         required=False