Allow editing of class_name and module_path on ScriptInstance

Author: kkthxbye-code

CHANGELOG.md

@@ -64,4 +64,8 @@
 
 # 0.3.11
 
-* Omit logging empty strings. Prevents exception when logging a blank value or None.
+* Omit logging empty strings. Prevents exception when logging a blank value or None.
+
+# 0.4.0
+
+* Allow editing of class_name and module_path on ScriptInstance to allow the preservation of ScriptExecutions if the script is moved/renamed.

netbox_script_manager/api/serializers.py

@@ -36,7 +36,6 @@ class ScriptInstanceSerializer(NetBoxModelSerializer):
     tenant = NestedTenantSerializer(required=False, allow_null=True)
 
     class Meta:
-        read_only_fields = ["module_path", "class_name"]
         model = ScriptInstance
         fields = (
             "id",
@@ -60,7 +59,6 @@ class NestedScriptInstanceSerializer(NetBoxModelSerializer):
     name = serializers.CharField(required=True)
 
     class Meta:
-        read_only_fields = ["module_path", "class_name"]
         model = ScriptInstance
         fields = (
             "id",

netbox_script_manager/forms.py

@@ -23,10 +23,18 @@ class ScriptInstanceForm(NetBoxModelForm):
             "group_id": "$tenant_group",
         },
     )
+    module_path = forms.CharField(
+        required=True,
+        help_text="The path to the python module. Can be changed if the script has been moved.",
+    )
+    class_name = forms.CharField(
+        required=True,
+        help_text="The name of the CustomScript class. Can be changed if the script class has been renamed.",
+    )
 
     class Meta:
         model = ScriptInstance
-        fields = ("name", "group", "weight", "description", "task_queues", "comments", "tenant", "tags")
+        fields = ("name", "module_path", "class_name", "group", "weight", "description", "task_queues", "comments", "tenant", "tags")
 
         widgets = {
             "description": forms.Textarea(attrs={"rows": 3}),

netbox_script_manager/templates/netbox_script_manager/scriptinstance.html

@@ -76,6 +76,14 @@ <h5 class="card-header">Script Instance</h5>
               <th scope="row">Name</th>
               <td>{{ object.name }}</td>
             </tr>
+            <tr>
+              <th scope="row">Module Path</th>
+              <td>{{ object.module_path }}</td>
+            </tr>
+            <tr>
+              <th scope="row">Class Name</th>
+              <td>{{ object.class_name }}</td>
+            </tr>
             <tr>
               <th scope="row">Description</th>
               <td>{{ object.description|placeholder }}</td>