Add NetBox's changelog model to OnboardingTask

Author: mzbroch

netbox_onboarding/admin.py

@@ -32,5 +32,5 @@ class OnboardingTaskAdmin(admin.ModelAdmin):
         "failed_reason",
         "port",
         "timeout",
-        "created_on",
+        "created",
     )

netbox_onboarding/migrations/0003_onboardingtask_change_logging_model.py

@@ -0,0 +1,19 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_onboarding", "0002_onboardingdevice"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="onboardingtask", name="created", field=models.DateField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="onboardingtask", name="last_updated", field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AlterModelOptions(name="onboardingtask", options={},),
+        migrations.RemoveField(model_name="onboardingtask", name="created_on",),
+    ]

netbox_onboarding/models.py

@@ -19,8 +19,15 @@
 from .choices import OnboardingStatusChoices, OnboardingFailChoices
 from .release import NETBOX_RELEASE_CURRENT, NETBOX_RELEASE_29
 
+# Support NetBox 2.8
+if NETBOX_RELEASE_CURRENT < NETBOX_RELEASE_29:
+    from utilities.models import ChangeLoggedModel  # pylint: disable=no-name-in-module, import-error
+# Support NetBox 2.9
+else:
+    from extras.models import ChangeLoggedModel  # pylint: disable=no-name-in-module, import-error
 
-class OnboardingTask(models.Model):
+
+class OnboardingTask(ChangeLoggedModel):
     """The status of each onboarding Task is tracked in the OnboardingTask table."""
 
     created_device = models.ForeignKey(to="dcim.Device", on_delete=models.SET_NULL, blank=True, null=True)
@@ -50,11 +57,6 @@ class OnboardingTask(models.Model):
         help_text="Timeout period in sec to wait while connecting to the device", default=30
     )
 
-    created_on = models.DateTimeField(auto_now_add=True)
-
-    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}"
@@ -78,40 +80,67 @@ class OnboardingDevice(models.Model):
     @property
     def last_check_attempt_date(self):
         """Date of last onboarding attempt for a device."""
-        try:
-            return OnboardingTask.objects.filter(created_device=self.device).latest("created_on").created_on
-        except ValueError:
+        if self.device.primary_ip4:
+            try:
+                return (
+                    OnboardingTask.objects.filter(
+                        ip_address=self.device.primary_ip4.address.ip.format()  # pylint: disable=no-member
+                    )
+                    .latest("last_updated")
+                    .created
+                )
+            except OnboardingTask.DoesNotExist:
+                return "unknown"
+        else:
             return "unknown"
 
     @property
     def last_check_successful_date(self):
         """Date of last successful onboarding for a device."""
-        try:
-            return (
-                OnboardingTask.objects.filter(
-                    created_device=self.device, status=OnboardingStatusChoices.STATUS_SUCCEEDED
+        if self.device.primary_ip4:
+            try:
+                return (
+                    OnboardingTask.objects.filter(
+                        ip_address=self.device.primary_ip4.address.ip.format(),  # pylint: disable=no-member
+                        status=OnboardingStatusChoices.STATUS_SUCCEEDED,
+                    )
+                    .latest("last_updated")
+                    .created
                 )
-                .latest("created_on")
-                .created_on
-            )
-        except ValueError:
+            except OnboardingTask.DoesNotExist:
+                return "unknown"
+        else:
             return "unknown"
 
     @property
     def status(self):
         """Last onboarding status."""
-        try:
-            return OnboardingTask.objects.filter(created_device=self.device).latest("created_on").status
-        except ValueError:
+        if self.device.primary_ip4:
+            try:
+                return (
+                    OnboardingTask.objects.filter(
+                        ip_address=self.device.primary_ip4.address.ip.format()  # pylint: disable=no-member
+                    )
+                    .latest("last_updated")
+                    .status
+                )
+            except OnboardingTask.DoesNotExist:
+                return "unknown"
+        else:
             return "unknown"
 
     @property
     def last_ot(self):
         """Last onboarding task."""
-        try:
-            return OnboardingTask.objects.filter(created_device=self.device).latest("created_on")
-        except ValueError:
-            return None
+        if self.device.primary_ip4:
+            try:
+                return OnboardingTask.objects.filter(
+                    ip_address=self.device.primary_ip4.address.ip.format()  # pylint: disable=no-member
+                ).latest("last_updated")
+            except OnboardingTask.DoesNotExist:
+                return "unknown"
+        else:
+            return "unknown"
 
 
 @receiver(post_save, sender=Device)

netbox_onboarding/tables.py

@@ -30,7 +30,7 @@ class Meta(BaseTable.Meta):  # noqa: D106 "Missing docstring in public nested cl
         fields = (
             "pk",
             "id",
-            "created_on",
+            "created",
             "ip_address",
             "site",
             "platform",
@@ -50,7 +50,7 @@ class Meta(BaseTable.Meta):  # noqa: D106 "Missing docstring in public nested cl
         model = OnboardingTask
         fields = (
             "id",
-            "created_on",
+            "created",
             "site",
             "platform",
             "ip_address",

netbox_onboarding/templates/netbox_onboarding/onboardingtask.html

@@ -18,6 +18,11 @@ <h1>{% block title %}Device: {{ onboardingtask.ip_address }}{% endblock %}</h1>
         <li role="presentation"{% if not active_tab %} class="active"{% endif %}>
             <a href="{{ onboardingtask.get_absolute_url }}">Onboarding Task</a>
         </li>
+        {% if perms.extras.view_objectchange %}
+            <li role="presentation"{% if active_tab == 'changelog' %} class="active"{% endif %}>
+                <a href="{% url 'plugins:netbox_onboarding:onboardingtask_changelog' pk=onboardingtask.pk %}">Change Log</a>
+            </li>
+        {% endif %}
     </ul>
 {% endblock %}
 
@@ -74,8 +79,8 @@ <h1>{% block title %}Device: {{ onboardingtask.ip_address }}{% endblock %}</h1>
                     <td>{{ onboardingtask.message|placeholder }}</td>
                 </tr>
                 <tr>
-                    <td>Created On</td>
-                    <td>{{ onboardingtask.created_on|placeholder }}</td>
+                    <td>Created</td>
+                    <td>{{ onboardingtask.created|placeholder }}</td>
                 </tr>
             </table>
         </div>

netbox_onboarding/tests/test_models.py

@@ -13,7 +13,8 @@
 """
 from django.test import TestCase
 
-from dcim.models import Site, DeviceRole, DeviceType, Manufacturer, Device
+from dcim.models import Site, DeviceRole, DeviceType, Manufacturer, Device, Interface
+from ipam.models import IPAddress
 
 from netbox_onboarding.models import OnboardingTask
 from netbox_onboarding.models import OnboardingDevice
@@ -31,9 +32,17 @@ def setUp(self):
         device_type = DeviceType.objects.create(slug="srx3600", model="SRX3600", manufacturer=manufacturer)
 
         self.device = Device.objects.create(
-            device_type=device_type, name="device1", device_role=device_role, site=self.site
+            device_type=device_type, name="device1", device_role=device_role, site=self.site,
         )
 
+        intf = Interface.objects.create(name="test_intf", device=self.device)
+
+        primary_ip = IPAddress.objects.create(address="10.10.10.10/32")
+        intf.ip_addresses.add(primary_ip)
+
+        self.device.primary_ip4 = primary_ip
+        self.device.save()
+
         self.succeeded_task1 = OnboardingTask.objects.create(
             ip_address="10.10.10.10",
             site=self.site,
@@ -70,12 +79,12 @@ def test_onboardingdevice_autocreated(self):
     def test_last_check_attempt_date(self):
         """Verify OnboardingDevice last attempt."""
         onboarding_device = OnboardingDevice.objects.get(device=self.device)
-        self.assertEqual(onboarding_device.last_check_attempt_date, self.failed_task2.created_on)
+        self.assertEqual(onboarding_device.last_check_attempt_date, self.failed_task2.created)
 
     def test_last_check_successful_date(self):
         """Verify OnboardingDevice last success."""
         onboarding_device = OnboardingDevice.objects.get(device=self.device)
-        self.assertEqual(onboarding_device.last_check_successful_date, self.succeeded_task2.created_on)
+        self.assertEqual(onboarding_device.last_check_successful_date, self.succeeded_task2.created)
 
     def test_status(self):
         """Verify OnboardingDevice status."""

netbox_onboarding/urls.py

@@ -12,7 +12,9 @@
 limitations under the License.
 """
 from django.urls import path
+from extras.views import ObjectChangeLogView
 
+from .models import OnboardingTask
 from .views import (
     OnboardingTaskView,
     OnboardingTaskListView,
@@ -27,4 +29,10 @@
     path("add/", OnboardingTaskCreateView.as_view(), name="onboardingtask_add"),
     path("delete/", OnboardingTaskBulkDeleteView.as_view(), name="onboardingtask_bulk_delete"),
     path("import/", OnboardingTaskFeedBulkImportView.as_view(), name="onboardingtask_import"),
+    path(
+        "<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="onboardingtask_changelog",
+        kwargs={"model": OnboardingTask},
+    ),
 ]