Added optional tenant field to ScriptInstance

Author: kkthxbye-code

netbox_script_manager/api/serializers.py

@@ -4,6 +4,7 @@
 from netbox.api.serializers import NetBoxModelSerializer
 from netbox.config import get_config
 from rest_framework import serializers
+from tenancy.api.nested_serializers import NestedTenantSerializer
 from utilities.templatetags.builtins.filters import render_markdown
 
 from netbox_script_manager.models import ScriptArtifact, ScriptExecution, ScriptInstance, ScriptLogLine
@@ -30,6 +31,7 @@ def to_representation(self, value):
 class ScriptInstanceSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(view_name="plugins-api:netbox_script_manager-api:scriptinstance-detail")
     name = serializers.CharField(required=True)
+    tenant = NestedTenantSerializer(required=False, allow_null=True)
 
     class Meta:
         read_only_fields = ["module_path", "class_name"]
@@ -44,6 +46,7 @@ class Meta:
             "class_name",
             "display",
             "task_queues",
+            "tenant",
             "tags",
             "created",
             "last_updated",

netbox_script_manager/filtersets.py

@@ -1,12 +1,25 @@
 import django_filters
 from django.db.models import Q
+from django.utils.translation import gettext as _
 from netbox.filtersets import BaseFilterSet, NetBoxModelFilterSet
+from tenancy.models import Tenant
 
 from .choices import LogLevelChoices, ScriptExecutionStatusChoices
 from .models import ScriptArtifact, ScriptExecution, ScriptInstance, ScriptLogLine
 
 
 class ScriptInstanceFilterSet(NetBoxModelFilterSet):
+    tenant_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Tenant.objects.all(),
+        label=_("Tenant (ID)"),
+    )
+    tenant = django_filters.ModelMultipleChoiceFilter(
+        queryset=Tenant.objects.all(),
+        field_name="tenant__slug",
+        to_field_name="slug",
+        label=_("Tenant (slug)"),
+    )
+
     class Meta:
         model = ScriptInstance
         fields = ["name", "description", "group", "weight"]

netbox_script_manager/forms.py

@@ -4,8 +4,9 @@
 from extras.choices import DurationChoices
 from extras.forms.mixins import SavedFiltersMixin
 from netbox.forms import NetBoxModelFilterSetForm, NetBoxModelForm
+from tenancy.models import Tenant
 from utilities.forms import BootstrapMixin, FilterForm
-from utilities.forms.fields import DynamicModelMultipleChoiceField, TagFilterField
+from utilities.forms.fields import DynamicModelChoiceField, DynamicModelMultipleChoiceField, TagFilterField
 from utilities.forms.widgets import APISelectMultiple, DateTimePicker, NumberWithOptions
 from utilities.utils import local_now
 
@@ -14,9 +15,18 @@
 
 
 class ScriptInstanceForm(NetBoxModelForm):
+    tenant = DynamicModelChoiceField(
+        label=_("Tenant"),
+        queryset=Tenant.objects.all(),
+        required=False,
+        query_params={
+            "group_id": "$tenant_group",
+        },
+    )
+
     class Meta:
         model = ScriptInstance
-        fields = ("name", "group", "weight", "description", "task_queues", "comments", "tags")
+        fields = ("name", "group", "weight", "description", "task_queues", "comments", "tenant", "tags")
 
         widgets = {
             "description": forms.Textarea(attrs={"rows": 3}),
@@ -28,6 +38,13 @@ class ScriptInstanceFilterForm(NetBoxModelFilterSetForm):
     name = forms.CharField(required=False)
     group = forms.CharField(required=False)
     tag = TagFilterField(model)
+    tenant_id = DynamicModelMultipleChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+        null_option="None",
+        query_params={"group_id": "$tenant_group_id"},
+        label=_("Tenant"),
+    )
 
 
 class ScriptExecutionFilterForm(SavedFiltersMixin, FilterForm):

netbox_script_manager/migrations/0003_scriptinstance_tenant.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.4 on 2023-10-09 05:36
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tenancy", "0011_contactassignment_tags"),
+        ("netbox_script_manager", "0002_scriptexecution_last_updated"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="scriptinstance",
+            name="tenant",
+            field=models.ForeignKey(
+                blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name="+", to="tenancy.tenant"
+            ),
+        ),
+    ]

netbox_script_manager/models.py

@@ -207,6 +207,13 @@ class ScriptInstance(PrimaryModel):
         default=list,
         help_text="Comma separated list of available task queues for the script",
     )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
 
     @cached_property
     def script(self):

netbox_script_manager/tables.py

@@ -1,6 +1,8 @@
 import django_tables2 as tables
+from django.utils.translation import gettext_lazy as _
 from django_tables2.tables import Accessor
 from netbox.tables import NetBoxTable, columns
+from tenancy.tables.columns import TenantColumn
 
 from .models import ScriptArtifact, ScriptExecution, ScriptInstance, ScriptLogLine
 
@@ -9,6 +11,9 @@ class ScriptInstanceTable(NetBoxTable):
     name = tables.Column(linkify=True)
     group = tables.Column(order_by=("group", "weight", "name"))
     tags = columns.TagColumn(url_name="plugins:netbox_script_manager:scriptinstance_list")
+    tenant = TenantColumn(
+        verbose_name=_("Tenant"),
+    )
 
     class Meta(NetBoxTable.Meta):
         model = ScriptInstance

netbox_script_manager/templates/netbox_script_manager/scriptinstance.html

@@ -78,7 +78,24 @@ <h5 class="card-header">Script Instance</h5>
             </tr>
             <tr>
               <th scope="row">Description</th>
-              <td>{{ object.description }}</td>
+              <td>{{ object.description|placeholder }}</td>
+            </tr>
+            <tr>
+              <th scope="row">Weight</th>
+              <td>{{ object.weight|placeholder }}</td>
+            </tr>
+            <tr>
+              <th scope="row">Group</th>
+              <td>{{ object.Group|placeholder }}</td>
+            </tr>
+            <tr>
+              <th scope="row">Tenant</th>
+              <td>
+                {% if object.tenant.group %}
+                  {{ object.tenant.group|linkify }} /
+                {% endif %}
+                {{ object.tenant|linkify|placeholder }}
+              </td>
             </tr>
           </table>
         </div>