Improve error handling of script loading

* WIP script sync

Author: kkthxbye-code

netbox_script_manager/api/views.py

@@ -50,7 +50,7 @@ def load(self, request):
         if not request.user.has_perm(permission):
             raise PermissionDenied(f"Missing permission: {permission}")
 
-        scripts = util.load_scripts()
+        scripts, _ = util.load_scripts()
         script_instances = {script_instance.script_path: script_instance for script_instance in ScriptInstance.objects.all()}
         loaded_scripts = []
 

netbox_script_manager/urls.py

@@ -19,6 +19,7 @@
     ),
     path("script-instances/delete/", views.ScriptInstanceBulkDeleteView.as_view(), name="scriptinstance_bulk_delete"),
     path("script-instances/load/", views.ScriptInstanceLoadView.as_view(), name="scriptinstance_load"),
+    path("script-instances/sync/", views.ScriptInstanceSyncView.as_view(), name="scriptinstance_sync"),
     # ScriptExecution
     path("script-executions/", views.ScriptExecutionListView.as_view(), name="scriptexecution_list"),
     path("script-executions/<int:pk>/", views.ScriptExecutionView.as_view(), name="scriptexecution"),

netbox_script_manager/util.py

@@ -1,11 +1,14 @@
 import inspect
+import logging
 import pkgutil
 import sys
 import threading
 
 from django.conf import settings
 from utilities.utils import normalize_querydict
 
+logger = logging.getLogger("netbox.plugins.netbox_script_manager")
+
 # Fields not included when saving script input
 EXCLUDED_POST_FIELDS = ["csrfmiddlewaretoken", "_schedule_at", "_interval", "_run"]
 
@@ -56,6 +59,7 @@ def load_scripts():
 
         scripts = {}
         modules = list(pkgutil.iter_modules([custom_script_root]))
+        failed_modules = {}
 
         # Iterate over all modules in the custom script root
         for importer, module_name, _ in modules:
@@ -66,17 +70,16 @@ def load_scripts():
                 # Manually load the module
                 module = importer.find_module(module_name).load_module(module_name)
             except Exception as e:
-                # TODO: Error handling
-                print(f"Failed to load module {module_name}: {e}")
-                import traceback
-
-                traceback.print_exc()
+                failed_modules[module_name] = e
+                logger.warning(f"Failed to load module {module_name}: {e}")
+                logger.exception(e)
+                continue
 
             # Find all CustomScript members
             for name, cls in inspect.getmembers(module, is_script):
                 scripts[f"{module.__name__}.{name}"] = cls
 
-        return scripts
+        return scripts, failed_modules
 
 
 def clear_module_cache():

netbox_script_manager/views.py

@@ -1,3 +1,4 @@
+import io
 import json
 import uuid
 
@@ -7,6 +8,7 @@
 from django.contrib.contenttypes.models import ContentType
 from django.http import HttpResponse
 from django.shortcuts import redirect, render
+from django.utils.safestring import mark_safe
 from django.views.generic import View
 from extras.filtersets import ObjectChangeFilterSet
 from extras.models import ObjectChange
@@ -20,6 +22,7 @@
 from .choices import ScriptExecutionStatusChoices
 from .models import ScriptExecution
 from .scripts import run_script
+from .templatetags.scriptmanager import format_exception
 
 plugin_config = settings.PLUGINS_CONFIG.get("netbox_script_manager")
 
@@ -129,7 +132,7 @@ def get_required_permission(self):
     def get(self, request):
         scripts_found = False
 
-        scripts = util.load_scripts()
+        scripts, failed_modules = util.load_scripts()
         script_instances = {script_instance.script_path: script_instance for script_instance in models.ScriptInstance.objects.all()}
 
         for script_path, script in scripts.items():
@@ -153,12 +156,45 @@ def get(self, request):
 
                 messages.success(request, f'Script "{script_name}" loaded')
 
+        for module_name, exception in failed_modules.items():
+            # This is hackish but it works. Toast messages are kinda limited in netbox.
+            messages.error(
+                request,
+                mark_safe(
+                    f'Failed to load module {module_name}: <pre style="overflow-x: scroll; width: 350px;">{format_exception(exception)}</pre>'
+                ),
+            )
+
         if not scripts_found:
             messages.info(request, "No new scripts found")
 
         return redirect("plugins:netbox_script_manager:scriptinstance_list")
 
 
+class ScriptInstanceSyncView(ContentTypePermissionRequiredMixin, View):
+    def get_required_permission(self):
+        return "netbox_script_manager.sync_scriptinstance"
+
+    def get(self, request):
+        try:
+            from dulwich import porcelain
+        except ImportError:
+            messages.error(request, "Dulwich is not installed")
+            return redirect("plugins:netbox_script_manager:scriptinstance_list")
+
+        script_root = plugin_config.get("SCRIPT_ROOT")
+
+        output_io = io.StringIO()
+        output = porcelain.pull(script_root, outstream=output_io)
+        message = [f"Pulled git repository: {script_root} {output_io.getvalue()}"]
+
+        if output_io:
+            message.append(output_io.getvalue())
+
+        messages.info(request, "\n".join(message))
+        return redirect("plugins:netbox_script_manager:scriptinstance_list")
+
+
 @register_model_view(models.ScriptInstance, "execution")
 class ScriptInstanceScriptExecutionsView(generic.ObjectChildrenView):
     queryset = models.ScriptInstance.objects.all()