[REVIEW] v1.4.0 Code Review

development/docker-compose.build.yml

@@ -14,7 +14,5 @@ services:
         - "curl"
         - "-fk"
         - "https://localhost:8443/health/"
-  worker:
-    image: "networktocode/nautobot-py${PYTHON_VER}:local"
   celery_worker:
     image: "networktocode/nautobot-py${PYTHON_VER}:local"

development/docker-compose.debug.yml

@@ -7,7 +7,7 @@ services:
     volumes:
       - ./nautobot_config.py:/opt/nautobot/nautobot_config.py
       - ../:/source
-  worker:
+  celery_worker:
     volumes:
       - ./nautobot_config.py:/opt/nautobot/nautobot_config.py
       - ../:/source

development/docker-compose.dev.yml

@@ -9,10 +9,6 @@ services:
     volumes:
       - ./nautobot_config.py:/opt/nautobot/nautobot_config.py
       - ../:/source
-  worker:
-    volumes:
-      - ./nautobot_config.py:/opt/nautobot/nautobot_config.py
-      - ../:/source
   celery_worker:
     volumes:
       - ./nautobot_config.py:/opt/nautobot/nautobot_config.py

development/docker-compose.mysql.yml

@@ -4,9 +4,6 @@ services:
   nautobot:
     environment:
       - "NAUTOBOT_DB_ENGINE=django.db.backends.mysql"
-  worker:
-    environment:
-      - "NAUTOBOT_DB_ENGINE=django.db.backends.mysql"
   celery_worker:
     environment:
       - "NAUTOBOT_DB_ENGINE=django.db.backends.mysql"

development/docker-compose.yml

@@ -28,20 +28,6 @@ services:
         - "curl"
         - "-f"
         - "http://localhost:8080/health/"
-  worker:
-    image: "networktocode/nautobot-dev-py${PYTHON_VER}:local"
-    entrypoint: "nautobot-server rqworker"
-    healthcheck:
-      interval: 60s
-      timeout: 30s
-      start_period: 5s
-      retries: 3
-      test: ["CMD", "nautobot-server", "health_check"]
-    depends_on:
-      - nautobot
-    env_file:
-      - ./dev.env
-    tty: true
   celery_worker:
     image: "networktocode/nautobot-dev-py${PYTHON_VER}:local"
     entrypoint: "nautobot-server celery worker -l INFO"
@@ -89,6 +75,7 @@ services:
     image: selenium/standalone-firefox:4.1.2
     ports:
         - "4444:4444"
+        - "15900:5900"
     shm_size: 2g
   mkdocs:
     profiles:
@@ -99,4 +86,4 @@ services:
       disable: true
     tty: true
     ports:
-      - "8001:8001"
+      - "8001:8001"

development/nautobot_config.py

@@ -88,10 +88,6 @@
                 "handlers": ["verbose_console" if DEBUG else "normal_console"],
                 "level": LOG_LEVEL,
             },
-            "rq.worker": {
-                "handlers": ["verbose_console" if DEBUG else "normal_console"],
-                "level": LOG_LEVEL,
-            },
         },
     }
 

docker/nautobot_config.append.py

@@ -25,9 +25,5 @@
             "handlers": ["normal_console"],
             "level": LOG_LEVEL,
         },
-        "rq.worker": {
-            "handlers": ["normal_console"],
-            "level": LOG_LEVEL,
-        },
     },
 }

examples/example_plugin/example_plugin/api/serializers.py

@@ -1,11 +1,12 @@
 from rest_framework import serializers
 
-from nautobot.core.api import ValidatedModelSerializer, WritableNestedSerializer
+from nautobot.core.api import WritableNestedSerializer
+from nautobot.extras.api.serializers import NautobotModelSerializer
 
 from example_plugin.models import ExampleModel
 
 
-class ExampleModelSerializer(ValidatedModelSerializer):
+class ExampleModelSerializer(NautobotModelSerializer):
     """Used for normal CRUD operations."""
 
     url = serializers.HyperlinkedIdentityField(view_name="plugins-api:example_plugin-api:examplemodel-detail")

examples/example_plugin/example_plugin/api/views.py

@@ -7,14 +7,14 @@
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from nautobot.core.api.views import ModelViewSet
+from nautobot.extras.api.views import NautobotModelViewSet
 
 from example_plugin.api.serializers import ExampleModelSerializer
 from example_plugin.filters import ExampleModelFilterSet
 from example_plugin.models import ExampleModel
 
 
-class ExampleModelViewSet(ModelViewSet):
+class ExampleModelViewSet(NautobotModelViewSet):
     queryset = ExampleModel.objects.all()
     serializer_class = ExampleModelSerializer
     filterset_class = ExampleModelFilterSet

examples/example_plugin/example_plugin/jobs.py

@@ -1,12 +1,17 @@
 import time
 
-from nautobot.extras.jobs import IntegerVar, Job
+from nautobot.extras.choices import ObjectChangeActionChoices
+from nautobot.extras.jobs import IntegerVar, Job, JobHookReceiver
 
 
 name = "ExamplePlugin jobs"
 
 
 class ExampleJob(Job):
+
+    # specify template_name to override the default job scheduling template
+    template_name = "example_plugin/example_with_custom_template.html"
+
     class Meta:
         name = "Example job, does nothing"
         description = """
@@ -40,4 +45,37 @@ def run(self, data, commit):
         return f"Ran for {interval} seconds"
 
 
-jobs = (ExampleJob, ExampleHiddenJob, ExampleLoggingJob)
+class ExampleJobHookReceiver(JobHookReceiver):
+    class Meta:
+        name = "Example job hook receiver"
+        description = "Validate changes to object serial field"
+
+    def receive_job_hook(self, change, action, changed_object):
+        # return on delete action
+        if action == ObjectChangeActionChoices.ACTION_DELETE:
+            return
+
+        # log diff output
+        snapshots = change.get_snapshots()
+        self.log_info(f"DIFF: {snapshots['differences']}")
+
+        # validate changes to serial field
+        if "serial" in snapshots["differences"]["added"]:
+            old_serial = snapshots["differences"]["removed"]["serial"]
+            new_serial = snapshots["differences"]["added"]["serial"]
+            self.log_info(f"{changed_object} serial has been changed from {old_serial} to {new_serial}")
+
+            # Check the new serial is valid and revert if necessary
+            if not self.validate_serial(new_serial):
+                changed_object.serial = old_serial
+                changed_object.save()
+                self.log_info(f"{changed_object} serial {new_serial} was not valid. Reverted to {old_serial}")
+
+            self.log_success(message=f"Serial validation completed for {changed_object}")
+
+    def validate_serial(self, serial):
+        # add business logic to validate serial
+        return False
+
+
+jobs = (ExampleJob, ExampleHiddenJob, ExampleLoggingJob, ExampleJobHookReceiver)

examples/example_plugin/example_plugin/signals.py

@@ -28,7 +28,8 @@ def nautobot_database_ready_callback(sender, *, apps, **kwargs):
     from nautobot.extras.choices import CustomFieldTypeChoices
 
     field, _ = CustomField.objects.update_or_create(
-        name="example-plugin-auto-custom-field",
+        name="example_plugin_auto_custom_field",  # Effectively a slug, will go away in a future Nautobot release
+        slug="example_plugin_auto_custom_field",  # Note underscores rather than dashes!
         defaults={
             "type": CustomFieldTypeChoices.TYPE_TEXT,
             "label": "Example Plugin Automatically Added Custom Field",

examples/example_plugin/example_plugin/template_content.py

@@ -1,6 +1,62 @@
+from django.urls import reverse
+
 from nautobot.extras.plugins import PluginTemplateExtension
 
 
+class CircuitContent(PluginTemplateExtension):
+    model = "circuits.circuit"
+
+    def detail_tabs(self):
+        """
+        You may define extra tabs to render on a model's detail page by utilizing this method.
+        Each tab is defined as a dict in a list of dicts.
+
+        For each of the tabs defined:
+        - The <title> key's value will become the tab link's title.
+        - The <url> key's value is used to render the HTML link for the tab.
+
+        Since the `model` attribute of this class is set as "circuits.circuit",
+        these tabs will be added to the Circuit model's detail page.
+
+        This example demonstrates defining one tab.
+        """
+        return [
+            {
+                "title": "Plugin Tab",
+                "url": reverse("plugins:example_plugin:circuit_detail_tab", kwargs={"pk": self.context["object"].pk}),
+            },
+        ]
+
+
+class DeviceContent(PluginTemplateExtension):
+    model = "dcim.device"
+
+    def detail_tabs(self):
+        """
+        You may define extra tabs to render on a model's detail page by utilizing this method.
+        Each tab is defined as a dict in a list of dicts.
+
+        For each of the tabs defined:
+        - The <title> key's value will become the tab link's title.
+        - The <url> key's value is used to render the HTML link for the tab
+
+        Since the `model` attribute of this class is set as "dcim.device",
+        these tabs will be added to the Device model's detail page.
+
+        This example demonstrates defining two tabs. The tabs will be ordered by their position in list.
+        """
+        return [
+            {
+                "title": "Plugin Tab 1",
+                "url": reverse("plugins:example_plugin:device_detail_tab_1", kwargs={"pk": self.context["object"].pk}),
+            },
+            {
+                "title": "Plugin Tab 2",
+                "url": reverse("plugins:example_plugin:device_detail_tab_2", kwargs={"pk": self.context["object"].pk}),
+            },
+        ]
+
+
 class SiteContent(PluginTemplateExtension):
     model = "dcim.site"
 
@@ -64,4 +120,4 @@ def buttons(self):
 
 
 # Don't forget to register your template extensions!
-template_extensions = [ExampleModelContent, SiteContent]
+template_extensions = [ExampleModelContent, SiteContent, CircuitContent, DeviceContent]

examples/example_plugin/example_plugin/templates/example_plugin/example_with_custom_template.html

@@ -0,0 +1,15 @@
+{% extends 'extras/job.html' %}
+{% block content %}
+    <div class="row">
+        <div class="col-md-12">
+        This is custom content injected by this specific plugin-provided Job
+        </div>
+    </div>
+    {{ block.super }}
+{% endblock content %}
+{% block javascript %}
+    {{ block.super }}
+    <script>
+        console.log("This job from the example_plugin is injecting custom JavaScript");
+    </script>
+{% endblock javascript %}

examples/example_plugin/example_plugin/templates/example_plugin/tab_circuit_detail.html

@@ -0,0 +1,6 @@
+{% extends 'circuits/circuit.html' %}
+
+{% block content %}
+    <h2>Circuit Plugin Tab</h2>
+    <p>I am some content for the example plugin's circuit ({{ object.pk }}) detail tab.</p>
+{% endblock %}

examples/example_plugin/example_plugin/templates/example_plugin/tab_device_detail_1.html

@@ -0,0 +1,6 @@
+{% extends 'dcim/device.html' %}
+
+{% block content %}
+    <h2>Device Plugin Tab 1</h2>
+    <p>I am some content for the example plugin's device ({{ object.pk }}) detail tab 1.</p>
+{% endblock %}

examples/example_plugin/example_plugin/templates/example_plugin/tab_device_detail_2.html

@@ -0,0 +1,6 @@
+{% extends 'dcim/device.html' %}
+
+{% block content %}
+    <h2>Device Plugin Tab 2</h2>
+    <p>I am some content for the example plugin's device ({{ object.pk }}) detail tab 2.</p>
+{% endblock %}

examples/example_plugin/example_plugin/urls.py

@@ -2,7 +2,7 @@
 from django.urls import path
 from django.views.generic import RedirectView
 
-from nautobot.extras.views import ObjectChangeLogView
+from nautobot.extras.views import ObjectChangeLogView, ObjectNotesView
 
 from example_plugin import views
 from example_plugin.models import AnotherExampleModel, ExampleModel
@@ -47,6 +47,12 @@
         name="examplemodel_changelog",
         kwargs={"model": ExampleModel},
     ),
+    path(
+        "models/<uuid:pk>/notes/",
+        ObjectNotesView.as_view(),
+        name="examplemodel_notes",
+        kwargs={"model": ExampleModel},
+    ),
     path("other-models/", views.AnotherExampleModelListView.as_view(), name="anotherexamplemodel_list"),
     path("other-models/add/", views.AnotherExampleModelEditView.as_view(), name="anotherexamplemodel_add"),
     path(
@@ -76,9 +82,31 @@
         name="anotherexamplemodel_changelog",
         kwargs={"model": AnotherExampleModel},
     ),
+    path(
+        "other-models/<uuid:pk>/notes/",
+        ObjectNotesView.as_view(),
+        name="anotherexamplemodel_notes",
+        kwargs={"model": AnotherExampleModel},
+    ),
     path(
         "docs/",
         RedirectView.as_view(url=static("example_plugin/docs/index.html")),
         name="docs",
     ),
+    path(
+        "circuits/<uuid:pk>/example-plugin-tab/", views.CircuitDetailPluginTabView.as_view(), name="circuit_detail_tab"
+    ),
+    path(
+        "devices/<uuid:pk>/example-plugin-tab-1/",
+        views.DeviceDetailPluginTabOneView.as_view(),
+        name="device_detail_tab_1",
+    ),
+    path(
+        "devices/<uuid:pk>/example-plugin-tab-2/",
+        views.DeviceDetailPluginTabTwoView.as_view(),
+        name="device_detail_tab_2",
+    ),
+    # This URL definition is here in order to test the override_views functionality which is defined
+    # in examples.plugin_with_view_override.plugin_with_view_override.views
+    path("override-target/", views.ViewToBeOverridden.as_view(), name="view_to_be_overridden"),
 ]