From 1b8849a43b8e485c1857aeeb69b0da995c9c6d09 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 25 Jan 2024 15:18:58 -0800
Subject: [PATCH 01/32] 12510 move reports to use BaseScript

---
 netbox/extras/reports.py | 187 ++-------------------------------------
 netbox/extras/scripts.py | 147 ++++++++++++++++++++++++++----
 2 files changed, 134 insertions(+), 200 deletions(-)

diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py
index 90641cc84a1..64f7d50a56f 100644
--- a/netbox/extras/reports.py
+++ b/netbox/extras/reports.py
@@ -11,6 +11,7 @@
 from core.models import Job
 from .choices import LogLevelChoices
 from .models import ReportModule
+from .scripts import BaseScript
 
 __all__ = (
     'Report',
@@ -58,191 +59,15 @@ def run_report(job, *args, **kwargs):
             )
 
 
-class Report(object):
-    """
-    NetBox users can extend this object to write custom reports to be used for validating data within NetBox. Each
-    report must have one or more test methods named `test_*`.
-
-    The `_results` attribute of a completed report will take the following form:
-
-    {
-        'test_bar': {
-            'failures': 42,
-            'log': [
-                (<datetime>, <level>, <object>, <message>),
-                ...
-            ]
-        },
-        'test_foo': {
-            'failures': 0,
-            'log': [
-                (<datetime>, <level>, <object>, <message>),
-                ...
-            ]
-        }
-    }
-    """
-    description = None
-    scheduling_enabled = True
-    job_timeout = None
-
-    def __init__(self):
-
-        self._results = {}
-        self.active_test = None
-        self.failed = False
-
-        self.logger = logging.getLogger(f"netbox.reports.{self.__module__}.{self.__class__.__name__}")
-
-        # Compile test methods and initialize results skeleton
-        test_methods = []
-        for method in dir(self):
-            if method.startswith('test_') and callable(getattr(self, method)):
-                test_methods.append(method)
-                self._results[method] = {
-                    'success': 0,
-                    'info': 0,
-                    'warning': 0,
-                    'failure': 0,
-                    'log': [],
-                }
-        self.test_methods = test_methods
-
-    @classproperty
-    def module(self):
-        return self.__module__
-
-    @classproperty
-    def class_name(self):
-        return self.__name__
-
-    @classproperty
-    def full_name(self):
-        return f'{self.module}.{self.class_name}'
-
-    @property
-    def name(self):
-        """
-        Override this attribute to set a custom display name.
-        """
-        return self.class_name
-
-    @property
-    def filename(self):
-        return inspect.getfile(self.__class__)
-
-    @property
-    def source(self):
-        return inspect.getsource(self.__class__)
-
-    @property
-    def is_valid(self):
-        """
-        Indicates whether the report can be run.
-        """
-        return bool(self.test_methods)
-
-    #
-    # Logging methods
-    #
-
-    def _log(self, obj, message, level=LogLevelChoices.LOG_DEFAULT):
-        """
-        Log a message from a test method. Do not call this method directly; use one of the log_* wrappers below.
-        """
-        if level not in LogLevelChoices.values():
-            raise Exception(f"Unknown logging level: {level}")
-        self._results[self.active_test]['log'].append((
-            timezone.now().isoformat(),
-            level,
-            str(obj) if obj else None,
-            obj.get_absolute_url() if hasattr(obj, 'get_absolute_url') else None,
-            message,
-        ))
-
-    def log(self, message):
-        """
-        Log a message which is not associated with a particular object.
-        """
-        self._log(None, message, level=LogLevelChoices.LOG_DEFAULT)
-        self.logger.info(message)
-
+class Report(BaseScript):
     def log_success(self, obj, message=None):
-        """
-        Record a successful test against an object. Logging a message is optional.
-        """
-        if message:
-            self._log(obj, message, level=LogLevelChoices.LOG_SUCCESS)
-        self._results[self.active_test]['success'] += 1
-        self.logger.info(f"Success | {obj}: {message}")
+        super().log_success(message, obj)
 
     def log_info(self, obj, message):
-        """
-        Log an informational message.
-        """
-        self._log(obj, message, level=LogLevelChoices.LOG_INFO)
-        self._results[self.active_test]['info'] += 1
-        self.logger.info(f"Info | {obj}: {message}")
+        super().log_info(message, obj)
 
     def log_warning(self, obj, message):
-        """
-        Log a warning.
-        """
-        self._log(obj, message, level=LogLevelChoices.LOG_WARNING)
-        self._results[self.active_test]['warning'] += 1
-        self.logger.info(f"Warning | {obj}: {message}")
+        super().log_warning(message, obj)
 
     def log_failure(self, obj, message):
-        """
-        Log a failure. Calling this method will automatically mark the report as failed.
-        """
-        self._log(obj, message, level=LogLevelChoices.LOG_FAILURE)
-        self._results[self.active_test]['failure'] += 1
-        self.logger.info(f"Failure | {obj}: {message}")
-        self.failed = True
-
-    #
-    # Run methods
-    #
-
-    def run(self, job):
-        """
-        Run the report and save its results. Each test method will be executed in order.
-        """
-        self.logger.info(f"Running report")
-
-        # Perform any post-run tasks
-        self.pre_run()
-
-        try:
-            for method_name in self.test_methods:
-                self.active_test = method_name
-                test_method = getattr(self, method_name)
-                test_method()
-            job.data = self._results
-            if self.failed:
-                self.logger.warning("Report failed")
-                job.terminate(status=JobStatusChoices.STATUS_FAILED)
-            else:
-                self.logger.info("Report completed successfully")
-                job.terminate()
-        except Exception as e:
-            stacktrace = traceback.format_exc()
-            self.log_failure(None, f"An exception occurred: {type(e).__name__}: {e} <pre>{stacktrace}</pre>")
-            logger.error(f"Exception raised during report execution: {e}")
-            job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
-
-        # Perform any post-run tasks
-        self.post_run()
-
-    def pre_run(self):
-        """
-        Extend this method to include any tasks which should execute *before* the report is run.
-        """
-        pass
-
-    def post_run(self):
-        """
-        Extend this method to include any tasks which should execute *after* the report is run.
-        """
-        pass
+        super().log_failure(message, obj)
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index f28465547be..0994bc66f37 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -10,6 +10,7 @@
 from django.conf import settings
 from django.core.validators import RegexValidator
 from django.db import transaction
+from django.utils import timezone
 from django.utils.functional import classproperty
 
 from core.choices import JobStatusChoices
@@ -257,7 +258,7 @@ def __init__(self, min_prefix_length=None, max_prefix_length=None, *args, **kwar
 # Scripts
 #
 
-class BaseScript:
+class BaseScript(object):
     """
     Base model for custom scripts. User classes should inherit from this model if they want to extend Script
     functionality for use in other subclasses.
@@ -270,6 +271,9 @@ class Meta:
         pass
 
     def __init__(self):
+        self._results = {}
+        self.failed = False
+        self._current_method = 'main'
 
         # Initiate the log
         self.logger = logging.getLogger(f"netbox.scripts.{self.__module__}.{self.__class__.__name__}")
@@ -278,9 +282,26 @@ def __init__(self):
         # Declare the placeholder for the current request
         self.request = None
 
-        # Grab some info about the script
-        self.filename = inspect.getfile(self.__class__)
-        self.source = inspect.getsource(self.__class__)
+        # Compile test methods and initialize results skeleton
+        self._results['main'] = {
+            'success': 0,
+            'info': 0,
+            'warning': 0,
+            'failure': 0,
+            'log': [],
+        }
+        test_methods = []
+        for method in dir(self):
+            if method.startswith('test_') and callable(getattr(self, method)):
+                test_methods.append(method)
+                self._results[method] = {
+                    'success': 0,
+                    'info': 0,
+                    'warning': 0,
+                    'failure': 0,
+                    'log': [],
+                }
+        self.test_methods = test_methods
 
     def __str__(self):
         return self.name
@@ -331,6 +352,21 @@ def job_timeout(self):
     def scheduling_enabled(self):
         return getattr(self.Meta, 'scheduling_enabled', True)
 
+    @property
+    def filename(self):
+        return inspect.getfile(self.__class__)
+
+    @property
+    def source(self):
+        return inspect.getsource(self.__class__)
+
+    @property
+    def is_valid(self):
+        """
+        Indicates whether the report can be run.
+        """
+        return bool(self.test_methods)
+
     @classmethod
     def _get_vars(cls):
         vars = {}
@@ -399,25 +435,53 @@ def as_form(self, data=None, files=None, initial=None):
 
     # Logging
 
-    def log_debug(self, message):
-        self.logger.log(logging.DEBUG, message)
-        self.log.append((LogLevelChoices.LOG_DEFAULT, str(message)))
+    def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.INFO):
+        """
+        Log a message from a test method. Do not call this method directly; use one of the log_* wrappers below.
+        """
+        if log_level not in LogLevelChoices.values():
+            raise Exception(f"Unknown logging level: {log_level}")
+
+        if message:
+            self._results[self._current_method]['log'].append((
+                timezone.now().isoformat(),
+                log_level,
+                str(obj) if obj else None,
+                obj.get_absolute_url() if hasattr(obj, 'get_absolute_url') else None,
+                message,
+            ))
+
+        if log_level != LogLevelChoices.LOG_DEFAULT:
+            self._results[self._current_method][log_level] += 1
+
+            if self._current_method != 'main':
+                self._results['main'][log_level] += 1
+
+        if obj:
+            self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
+        else:
+            self.logger.log(level, message)  # No syslog equivalent for SUCCESS
+
+    def log(self, message):
+        """
+        Log a message which is not associated with a particular object.
+        """
+        self._log(str(message), None, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.INFO)
+
+    def log_debug(self, message, obj=None):
+        self._log(str(message), obj, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.DEBUG)
 
-    def log_success(self, message):
-        self.logger.log(logging.INFO, message)  # No syslog equivalent for SUCCESS
-        self.log.append((LogLevelChoices.LOG_SUCCESS, str(message)))
+    def log_success(self, message=None, obj=None):
+        self._log(str(message), obj, log_level=LogLevelChoices.LOG_SUCCESS, level=logging.INFO)
 
-    def log_info(self, message):
-        self.logger.log(logging.INFO, message)
-        self.log.append((LogLevelChoices.LOG_INFO, str(message)))
+    def log_info(self, message, obj=None):
+        self._log(str(message), obj, log_level=LogLevelChoices.LOG_INFO, level=logging.INFO)
 
-    def log_warning(self, message):
-        self.logger.log(logging.WARNING, message)
-        self.log.append((LogLevelChoices.LOG_WARNING, str(message)))
+    def log_warning(self, message, obj=None):
+        self._log(str(message), obj, log_level=LogLevelChoices.LOG_WARNING, level=logging.WARNING)
 
-    def log_failure(self, message):
-        self.logger.log(logging.ERROR, message)
-        self.log.append((LogLevelChoices.LOG_FAILURE, str(message)))
+    def log_failure(self, message, obj=None):
+        self._log(str(message), obj, log_level=LogLevelChoices.LOG_FAILURE, level=logging.ERROR)
 
     # Convenience functions
 
@@ -446,6 +510,51 @@ def load_json(self, filename):
 
         return data
 
+    def run_test_scripts(self, job):
+        """
+        Run the report and save its results. Each test method will be executed in order.
+        """
+        self.logger.info(f"Running report")
+
+        # Perform any post-run tasks
+        self.pre_run()
+
+        try:
+            for method_name in self.test_methods:
+                self._current_method = method_name
+                test_method = getattr(self, method_name)
+                test_method()
+            job.data = self._results
+            if self.failed:
+                self.logger.warning("Report failed")
+                job.terminate(status=JobStatusChoices.STATUS_FAILED)
+            else:
+                self.logger.info("Report completed successfully")
+                job.terminate()
+        except Exception as e:
+            stacktrace = traceback.format_exc()
+            self.log_failure(None, f"An exception occurred: {type(e).__name__}: {e} <pre>{stacktrace}</pre>")
+            logger.error(f"Exception raised during report execution: {e}")
+            job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
+
+        # Perform any post-run tasks
+        self.post_run()
+
+    def run(self, job):
+        self.run_test_scripts(job)
+
+    def pre_run(self):
+        """
+        Extend this method to include any tasks which should execute *before* the report is run.
+        """
+        pass
+
+    def post_run(self):
+        """
+        Extend this method to include any tasks which should execute *after* the report is run.
+        """
+        pass
+
 
 class Script(BaseScript):
     """

From c69205535ea6180bc12b60bcaefa8cec6632fdeb Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 26 Jan 2024 09:31:27 -0800
Subject: [PATCH 02/32] 12510 merge report into script view

---
 netbox/extras/models/scripts.py |  8 +++++---
 netbox/extras/utils.py          | 12 ++++++++++++
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/netbox/extras/models/scripts.py b/netbox/extras/models/scripts.py
index 93275acdab0..55576421f5d 100644
--- a/netbox/extras/models/scripts.py
+++ b/netbox/extras/models/scripts.py
@@ -3,12 +3,13 @@
 from functools import cached_property
 
 from django.db import models
+from django.db.models import Q
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 
 from core.choices import ManagedFileRootPathChoices
 from core.models import ManagedFile
-from extras.utils import is_script
+from extras.utils import is_script_or_report
 from netbox.models.features import JobsMixin, EventRulesMixin
 from utilities.querysets import RestrictedQuerySet
 from .mixins import PythonModuleMixin
@@ -32,7 +33,8 @@ class Meta:
 class ScriptModuleManager(models.Manager.from_queryset(RestrictedQuerySet)):
 
     def get_queryset(self):
-        return super().get_queryset().filter(file_root=ManagedFileRootPathChoices.SCRIPTS)
+        return super().get_queryset().filter(
+            Q(file_root=ManagedFileRootPathChoices.SCRIPTS) | Q(file_root=ManagedFileRootPathChoices.REPORTS))
 
 
 class ScriptModule(PythonModuleMixin, JobsMixin, ManagedFile):
@@ -70,7 +72,7 @@ def _get_name(cls):
 
         for cls in ordered:
             scripts[_get_name(cls)] = cls
-        for name, cls in inspect.getmembers(module, is_script):
+        for name, cls in inspect.getmembers(module, is_script_or_report):
             if cls not in ordered:
                 scripts[_get_name(cls)] = cls
 
diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index c6b2de18838..563770f73b3 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -67,3 +67,15 @@ def is_report(obj):
         return issubclass(obj, Report) and obj != Report
     except TypeError:
         return False
+
+
+def is_script_or_report(obj):
+    """
+    Returns True if the given object is a Report.
+    """
+    from .reports import Report
+    from .scripts import Script
+    try:
+        return ((issubclass(obj, Report) and obj != Report) or (issubclass(obj, Script) and obj != Script))
+    except TypeError:
+        return False

From ab14a8a71c78e76db29f2520eeec6ee079c280f3 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 26 Jan 2024 10:20:42 -0800
Subject: [PATCH 03/32] 12510 add migration for job report to script

---
 .../migrations/0011_job_report_to_script.py   | 27 +++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 netbox/core/migrations/0011_job_report_to_script.py

diff --git a/netbox/core/migrations/0011_job_report_to_script.py b/netbox/core/migrations/0011_job_report_to_script.py
new file mode 100644
index 00000000000..4273475ef50
--- /dev/null
+++ b/netbox/core/migrations/0011_job_report_to_script.py
@@ -0,0 +1,27 @@
+# Generated by Django 5.0.1 on 2024-01-26 18:11
+
+from django.db import migrations
+
+
+def migrate_report_jobs(apps, schema_editor):
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    Job = apps.get_model('core', 'Job')
+
+    # Delete the new ContentType effected by the introduction of core.ConfigRevision
+    report_content_type = ContentType.objects.get(app_label='extras', model='reportmodule')
+    script_content_type = ContentType.objects.get(app_label='extras', model='scriptmodule')
+    jobs = Job.objects.filter(object_type_id=report_content_type.id).update(object_type_id=script_content_type.id)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0010_gfk_indexes'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=migrate_report_jobs,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

From 8a990d7372544c6ce21403a2512cbee6a48e31a3 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 26 Jan 2024 10:36:34 -0800
Subject: [PATCH 04/32] 12510 update templates

---
 netbox/extras/scripts.py                      |   8 +-
 .../templates/extras/htmx/script_result.html  |  77 ++++++++-----
 netbox/templates/extras/script_list.html      | 104 ++++++++++++------
 3 files changed, 121 insertions(+), 68 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 0994bc66f37..6aed2d03241 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -273,7 +273,7 @@ class Meta:
     def __init__(self):
         self._results = {}
         self.failed = False
-        self._current_method = 'main'
+        self._current_method = 'total'
 
         # Initiate the log
         self.logger = logging.getLogger(f"netbox.scripts.{self.__module__}.{self.__class__.__name__}")
@@ -283,7 +283,7 @@ def __init__(self):
         self.request = None
 
         # Compile test methods and initialize results skeleton
-        self._results['main'] = {
+        self._results['total'] = {
             'success': 0,
             'info': 0,
             'warning': 0,
@@ -454,8 +454,8 @@ def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=l
         if log_level != LogLevelChoices.LOG_DEFAULT:
             self._results[self._current_method][log_level] += 1
 
-            if self._current_method != 'main':
-                self._results['main'][log_level] += 1
+            if self._current_method != 'total':
+                self._results['total'][log_level] += 1
 
         if obj:
             self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
diff --git a/netbox/templates/extras/htmx/script_result.html b/netbox/templates/extras/htmx/script_result.html
index 2fb0de46809..f79fb8e483e 100644
--- a/netbox/templates/extras/htmx/script_result.html
+++ b/netbox/templates/extras/htmx/script_result.html
@@ -1,6 +1,5 @@
 {% load humanize %}
 {% load helpers %}
-{% load log_levels %}
 {% load i18n %}
 
 <p>
@@ -17,40 +16,62 @@
   <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
 </p>
 {% if job.completed %}
-  <div class="card mb-3">
-    <h5 class="card-header">{% trans "Script Log" %}</h5>
+  <div class="card">
+    <h5 class="card-header">{% trans "Script Methods" %}</h5>
     <table class="table table-hover">
-      <tr>
-        <th>{% trans "Line" %}</th>
-        <th>{% trans "Level" %}</th>
-        <th>{% trans "Message" %}</th>
-      </tr>
-      {% for log in job.data.log %}
+      {% for method, data in job.data.items %}
         <tr>
-          <td>{{ forloop.counter }}</td>
-          <td>{% log_level log.status %}</td>
-          <td class="rendered-markdown">{{ log.message|markdown }}</td>
-        </tr>
-      {% empty %}
-        <tr>
-          <td colspan="3" class="text-center text-muted">
-            {% trans "No log output" %}
+          <td class="font-monospace"><a href="#{{ method }}">{{ method }}</a></td>
+          <td class="text-end script-stats">
+            <span class="badge text-bg-success">{{ data.success }}</span>
+            <span class="badge text-bg-info">{{ data.info }}</span>
+            <span class="badge text-bg-warning">{{ data.warning }}</span>
+            <span class="badge text-bg-danger">{{ data.failure }}</span>
           </td>
         </tr>
       {% endfor %}
     </table>
-    {% if execution_time %}
-      <div class="card-footer text-end text-muted">
-        <small>{% trans "Exec Time" %}: {{ execution_time|floatformat:3 }} {% trans "seconds" context "Unit of time" %}</small>
-      </div>
-    {% endif %}
   </div>
-  <h4>{% trans "Output" %}</h4>
-  {% if job.data.output %}
-    <pre class="block">{{ job.data.output }}</pre>
-  {% else %}
-    <p class="text-muted">{% trans "None" %}</p>
-  {% endif %}
+  <div class="card">
+    <h5 class="card-header">{% trans "Script Results" %}</h5>
+    <table class="table table-hover script">
+      <thead>
+        <tr>
+          <th>{% trans "Time" %}</th>
+          <th>{% trans "Level" %}</th>
+          <th>{% trans "Object" %}</th>
+          <th>{% trans "Message" %}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for method, data in job.data.items %}
+          <tr>
+            <th colspan="4" style="font-family: monospace">
+              <a name="{{ method }}"></a>{{ method }}
+            </th>
+          </tr>
+          {% for time, level, obj, url, message in data.log %}
+            <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
+              <td>{{ time }}</td>
+              <td>
+                <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
+              </td>
+              <td>
+                {% if obj and url %}
+                  <a href="{{ url }}">{{ obj }}</a>
+                {% elif obj %}
+                  {{ obj }}
+                {% else %}
+                  {{ ''|placeholder }}
+                {% endif %}
+              </td>
+              <td class="rendered-markdown">{{ message|markdown }}</td>
+            </tr>
+          {% endfor %}
+        {% endfor %}
+      </tbody>
+    </table>
+  </div>
 {% elif job.started %}
   {% include 'extras/inc/result_pending.html' %}
 {% endif %}
diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
index bb91f75222b..afc4e588825 100644
--- a/netbox/templates/extras/script_list.html
+++ b/netbox/templates/extras/script_list.html
@@ -1,14 +1,11 @@
 {% extends 'generic/_base.html' %}
 {% load buttons %}
 {% load helpers %}
+{% load perms %}
 {% load i18n %}
 
 {% block title %}{% trans "Scripts" %}{% endblock %}
 
-{% block controls %}
-  {% add_button model %}
-{% endblock controls %}
-
 {% block tabs %}
   <ul class="nav nav-tabs">
     <li class="nav-item" role="presentation">
@@ -17,6 +14,10 @@
   </ul>
 {% endblock tabs %}
 
+{% block controls %}
+  {% add_button model %}
+{% endblock controls %}
+
 {% block content %}
   {% for module in script_modules %}
     <div class="card">
@@ -25,65 +26,96 @@ <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
           <i class="mdi mdi-file-document-outline"></i> {{ module }}
         </div>
         {% if perms.extras.delete_scriptmodule %}
-          <div class="float-end">
-            <a href="{% url 'extras:scriptmodule_delete' pk=module.pk %}" class="btn btn-danger btn-sm">
-              <i class="mdi mdi-trash-can-outline" aria-hidden="true"></i> {% trans "Delete" %}
-            </a>
-          </div>
+          <a href="{% url 'extras:scriptmodule_delete' pk=module.pk %}" class="btn btn-danger btn-sm">
+            <i class="mdi mdi-trash-can-outline" aria-hidden="true"></i> {% trans "Delete" %}
+          </a>
         {% endif %}
       </h5>
       <div class="card-body">
         {% include 'inc/sync_warning.html' with object=module %}
-        {% if not module.scripts %}
-          <div class="alert alert-warning d-flex align-items-center" role="alert">
-            <i class="mdi mdi-alert"></i>
-            {% blocktrans trimmed with file_path=module.full_path %}
-              Script file at <code class="mx-1">{{ file_path }}</code> could not be loaded.
-            {% endblocktrans %}
-          </div>
-        {% else %}
-          <table class="table table-hover reports">
+        {% if module.scripts %}
+          <table class="table table-hover scripts">
             <thead>
               <tr>
                 <th width="250">{% trans "Name" %}</th>
                 <th>{% trans "Description" %}</th>
                 <th>{% trans "Last Run" %}</th>
-                <th class="text-end">{% trans "Status" %}</th>
+                <th>{% trans "Status" %}</th>
+                <th width="120"></th>
               </tr>
             </thead>
             <tbody>
               {% with jobs=module.get_latest_jobs %}
-                {% for script_name, script_class in module.scripts.items %}
-                  <tr>
-                    <td>
-                      <a href="{% url 'extras:script' module=module.python_name name=script_name %}" name="script.{{ script_name }}">{{ script_class.name }}</a>
-                    </td>
-                    <td>
-                      {{ script_class.Meta.description|markdown|placeholder }}
-                    </td>
-                    {% with last_result=jobs|get_key:script_class.class_name %}
-                      {% if last_result %}
+                {% for script_name, script in module.scripts.items %}
+                  {% with last_job=jobs|get_key:script.class_name %}
+                    <tr>
+                      <td>
+                        <a href="{% url 'extras:script' module=module.python_name name=script.class_name %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.name }}</a>
+                      </td>
+                      <td>{{ script.description|markdown|placeholder }}</td>
+                      {% if last_job %}
                         <td>
-                          <a href="{% url 'extras:script_result' job_pk=last_result.pk %}">{{ last_result.created|annotated_date }}</a>
+                          <a href="{% url 'extras:script_result' job_pk=last_job.pk %}">{{ last_job.created|annotated_date }}</a>
                         </td>
-                        <td class="text-end">
-                          {% badge last_result.get_status_display last_result.get_status_color %}
+                        <td>
+                          {% badge last_job.get_status_display last_job.get_status_color %}
                         </td>
                       {% else %}
                         <td class="text-muted">{% trans "Never" %}</td>
-                        <td class="text-end">{{ ''|placeholder }}</td>
+                        <td>
+                          {% if script.is_valid %}
+                            {{ ''|placeholder }}
+                          {% else %}
+                            <span class="badge text-bg-danger" title="{% trans "Script has no methods" %}">
+                              {% trans "Invalid" %}
+                            </span>
+                          {% endif %}
+                        </td>
                       {% endif %}
-                    {% endwith %}
-                  </tr>
+                      <td>
+                        {% if perms.extras.run_script and script.is_valid %}
+                          <div class="float-end d-print-none">
+                            <form action="{% url 'extras:script' module=script.module name=script.class_name %}" method="post">
+                              {% csrf_token %}
+                              <button type="submit" name="_run" class="btn btn-primary" style="width: 110px">
+                                {% if last_job %}
+                                  <i class="mdi mdi-replay"></i> {% trans "Run Again" %}
+                                {% else %}
+                                  <i class="mdi mdi-play"></i> {% trans "Run Script" %}
+                                {% endif %}
+                              </button>
+                            </form>
+                          </div>
+                        {% endif %}
+                      </td>
+                    </tr>
+                    {% for method, stats in last_job.data.items %}
+                      <tr>
+                        <td colspan="4" class="method">
+                          <span class="ps-3">{{ method }}</span>
+                        </td>
+                        <td class="text-end text-nowrap script-stats">
+                          <span class="badge text-bg-success">{{ stats.success }}</span>
+                          <span class="badge text-bg-info">{{ stats.info }}</span>
+                          <span class="badge text-bg-warning">{{ stats.warning }}</span>
+                          <span class="badge text-bg-danger">{{ stats.failure }}</span>
+                        </td>
+                      </tr>
+                    {% endfor %}
+                  {% endwith %}
                 {% endfor %}
               {% endwith %}
             </tbody>
           </table>
+        {% else %}
+          <div class="alert alert-warning" role="alert">
+            <i class="mdi mdi-alert"></i> Could not load scripts from {{ module.name }}
+          </div>
         {% endif %}
       </div>
     </div>
   {% empty %}
-    <div class="alert alert-info">
+    <div class="alert alert-info" role="alert">
       <h4 class="alert-heading">{% trans "No Scripts Found" %}</h4>
       {% if perms.extras.add_scriptmodule %}
         {% url 'extras:scriptmodule_add' as create_script_url %}

From 73190fa99651a58310b2ab39c9ea4f1039310cd9 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 26 Jan 2024 14:23:30 -0800
Subject: [PATCH 05/32] 12510 remove reports

---
 netbox/extras/api/serializers.py              |  17 --
 netbox/extras/api/urls.py                     |   1 -
 netbox/extras/api/views.py                    | 106 -----------
 .../0106_delete_report_delete_reportmodule.py |  20 ++
 netbox/extras/models/__init__.py              |   1 -
 netbox/extras/models/reports.py               |  80 --------
 netbox/extras/reports.py                      |  62 +-----
 netbox/extras/scripts.py                      |  86 +++++++--
 netbox/extras/urls.py                         |   9 -
 netbox/extras/views.py                        | 180 ------------------
 netbox/netbox/navigation/menu.py              |   8 +-
 .../templates/extras/htmx/report_result.html  |  77 --------
 .../templates/extras/htmx/script_result.html  |  50 ++---
 netbox/templates/extras/report.html           |  43 -----
 netbox/templates/extras/report_list.html      | 128 -------------
 netbox/templates/extras/report_result.html    |  17 --
 netbox/templates/extras/script_list.html      |   2 +-
 17 files changed, 121 insertions(+), 766 deletions(-)
 create mode 100644 netbox/extras/migrations/0106_delete_report_delete_reportmodule.py
 delete mode 100644 netbox/extras/models/reports.py
 delete mode 100644 netbox/templates/extras/htmx/report_result.html
 delete mode 100644 netbox/templates/extras/report.html
 delete mode 100644 netbox/templates/extras/report_list.html
 delete mode 100644 netbox/templates/extras/report_result.html

diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py
index 60a30aed210..7cbea55a08b 100644
--- a/netbox/extras/api/serializers.py
+++ b/netbox/extras/api/serializers.py
@@ -50,7 +50,6 @@
     'ScriptDetailSerializer',
     'ScriptInputSerializer',
     'ScriptLogMessageSerializer',
-    'ScriptOutputSerializer',
     'ScriptSerializer',
     'TagSerializer',
     'WebhookSerializer',
@@ -593,22 +592,6 @@ def validate_interval(self, value):
         return value
 
 
-class ScriptLogMessageSerializer(serializers.Serializer):
-    status = serializers.SerializerMethodField(read_only=True)
-    message = serializers.SerializerMethodField(read_only=True)
-
-    def get_status(self, instance):
-        return instance[0]
-
-    def get_message(self, instance):
-        return instance[1]
-
-
-class ScriptOutputSerializer(serializers.Serializer):
-    log = ScriptLogMessageSerializer(many=True, read_only=True)
-    output = serializers.CharField(read_only=True)
-
-
 #
 # Change logging
 #
diff --git a/netbox/extras/api/urls.py b/netbox/extras/api/urls.py
index 1616b85549e..68b4488bc89 100644
--- a/netbox/extras/api/urls.py
+++ b/netbox/extras/api/urls.py
@@ -20,7 +20,6 @@
 router.register('journal-entries', views.JournalEntryViewSet)
 router.register('config-contexts', views.ConfigContextViewSet)
 router.register('config-templates', views.ConfigTemplateViewSet)
-router.register('reports', views.ReportViewSet, basename='report')
 router.register('scripts', views.ScriptViewSet, basename='script')
 router.register('object-changes', views.ObjectChangeViewSet)
 router.register('content-types', views.ContentTypeViewSet)
diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py
index e0fca86177f..8f5841da15f 100644
--- a/netbox/extras/api/views.py
+++ b/netbox/extras/api/views.py
@@ -16,7 +16,6 @@
 from core.models import Job
 from extras import filtersets
 from extras.models import *
-from extras.reports import get_module_and_report, run_report
 from extras.scripts import get_module_and_script, run_script
 from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired
 from netbox.api.features import SyncedDataMixin
@@ -211,111 +210,6 @@ def render(self, request, pk):
         return self.render_configtemplate(request, configtemplate, context)
 
 
-#
-# Reports
-#
-
-class ReportViewSet(ViewSet):
-    permission_classes = [IsAuthenticatedOrLoginNotRequired]
-    _ignore_model_permissions = True
-    schema = None
-    lookup_value_regex = '[^/]+'  # Allow dots
-
-    def _get_report(self, pk):
-        try:
-            module_name, report_name = pk.split('.', maxsplit=1)
-        except ValueError:
-            raise Http404
-
-        module, report = get_module_and_report(module_name, report_name)
-        if report is None:
-            raise Http404
-
-        return module, report
-
-    def list(self, request):
-        """
-        Compile all reports and their related results (if any). Result data is deferred in the list view.
-        """
-        results = {
-            job.name: job
-            for job in Job.objects.filter(
-                object_type=ContentType.objects.get(app_label='extras', model='reportmodule'),
-                status__in=JobStatusChoices.TERMINAL_STATE_CHOICES
-            ).order_by('name', '-created').distinct('name').defer('data')
-        }
-
-        report_list = []
-        for report_module in ReportModule.objects.restrict(request.user):
-            report_list.extend([report() for report in report_module.reports.values()])
-
-        # Attach Job objects to each report (if any)
-        for report in report_list:
-            report.result = results.get(report.name, None)
-
-        serializer = serializers.ReportSerializer(report_list, many=True, context={
-            'request': request,
-        })
-
-        return Response({'count': len(report_list), 'results': serializer.data})
-
-    def retrieve(self, request, pk):
-        """
-        Retrieve a single Report identified as "<module>.<report>".
-        """
-        module, report = self._get_report(pk)
-
-        # Retrieve the Report and Job, if any.
-        object_type = ContentType.objects.get(app_label='extras', model='reportmodule')
-        report.result = Job.objects.filter(
-            object_type=object_type,
-            name=report.name,
-            status__in=JobStatusChoices.TERMINAL_STATE_CHOICES
-        ).first()
-
-        serializer = serializers.ReportDetailSerializer(report, context={
-            'request': request
-        })
-
-        return Response(serializer.data)
-
-    @action(detail=True, methods=['post'])
-    def run(self, request, pk):
-        """
-        Run a Report identified as "<module>.<script>" and return the pending Job as the result
-        """
-        # Check that the user has permission to run reports.
-        if not request.user.has_perm('extras.run_report'):
-            raise PermissionDenied("This user does not have permission to run reports.")
-
-        # Check that at least one RQ worker is running
-        if not Worker.count(get_connection('default')):
-            raise RQWorkerNotRunningException()
-
-        # Retrieve and run the Report. This will create a new Job.
-        module, report_cls = self._get_report(pk)
-        report = report_cls
-        input_serializer = serializers.ReportInputSerializer(
-            data=request.data,
-            context={'report': report}
-        )
-
-        if input_serializer.is_valid():
-            report.result = Job.enqueue(
-                run_report,
-                instance=module,
-                name=report.class_name,
-                user=request.user,
-                job_timeout=report.job_timeout,
-                schedule_at=input_serializer.validated_data.get('schedule_at'),
-                interval=input_serializer.validated_data.get('interval')
-            )
-            serializer = serializers.ReportDetailSerializer(report, context={'request': request})
-
-            return Response(serializer.data)
-        return Response(input_serializer.errors, status=status.HTTP_400_BAD_REQUEST)
-
-
 #
 # Scripts
 #
diff --git a/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py b/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py
new file mode 100644
index 00000000000..3eb98d56f5f
--- /dev/null
+++ b/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py
@@ -0,0 +1,20 @@
+# Generated by Django 5.0.1 on 2024-01-26 22:22
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0105_customfield_min_max_values'),
+        ('core', '0011_job_report_to_script'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='Report',
+        ),
+        migrations.DeleteModel(
+            name='ReportModule',
+        ),
+    ]
diff --git a/netbox/extras/models/__init__.py b/netbox/extras/models/__init__.py
index 399f01005c6..ebed3b1fbb7 100644
--- a/netbox/extras/models/__init__.py
+++ b/netbox/extras/models/__init__.py
@@ -3,7 +3,6 @@
 from .customfields import *
 from .dashboard import *
 from .models import *
-from .reports import *
 from .scripts import *
 from .search import *
 from .staging import *
diff --git a/netbox/extras/models/reports.py b/netbox/extras/models/reports.py
deleted file mode 100644
index f6228ef24a7..00000000000
--- a/netbox/extras/models/reports.py
+++ /dev/null
@@ -1,80 +0,0 @@
-import inspect
-import logging
-from functools import cached_property
-
-from django.db import models
-from django.urls import reverse
-from django.utils.translation import gettext_lazy as _
-
-from core.choices import ManagedFileRootPathChoices
-from core.models import ManagedFile
-from extras.utils import is_report
-from netbox.models.features import JobsMixin, EventRulesMixin
-from utilities.querysets import RestrictedQuerySet
-from .mixins import PythonModuleMixin
-
-logger = logging.getLogger('netbox.reports')
-
-__all__ = (
-    'Report',
-    'ReportModule',
-)
-
-
-class Report(EventRulesMixin, models.Model):
-    """
-    Dummy model used to generate permissions for reports. Does not exist in the database.
-    """
-    class Meta:
-        managed = False
-
-
-class ReportModuleManager(models.Manager.from_queryset(RestrictedQuerySet)):
-
-    def get_queryset(self):
-        return super().get_queryset().filter(file_root=ManagedFileRootPathChoices.REPORTS)
-
-
-class ReportModule(PythonModuleMixin, JobsMixin, ManagedFile):
-    """
-    Proxy model for report module files.
-    """
-    objects = ReportModuleManager()
-
-    class Meta:
-        proxy = True
-        verbose_name = _('report module')
-        verbose_name_plural = _('report modules')
-
-    def get_absolute_url(self):
-        return reverse('extras:report_list')
-
-    def __str__(self):
-        return self.python_name
-
-    @cached_property
-    def reports(self):
-
-        def _get_name(cls):
-            # For child objects in submodules use the full import path w/o the root module as the name
-            return cls.full_name.split(".", maxsplit=1)[1]
-
-        try:
-            module = self.get_module()
-        except (ImportError, SyntaxError) as e:
-            logger.error(f"Unable to load report module {self.name}, exception: {e}")
-            return {}
-        reports = {}
-        ordered = getattr(module, 'report_order', [])
-
-        for cls in ordered:
-            reports[_get_name(cls)] = cls
-        for name, cls in inspect.getmembers(module, is_report):
-            if cls not in ordered:
-                reports[_get_name(cls)] = cls
-
-        return reports
-
-    def save(self, *args, **kwargs):
-        self.file_root = ManagedFileRootPathChoices.REPORTS
-        return super().save(*args, **kwargs)
diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py
index 64f7d50a56f..54f80b0c4ef 100644
--- a/netbox/extras/reports.py
+++ b/netbox/extras/reports.py
@@ -1,73 +1,19 @@
-import inspect
-import logging
-import traceback
-from datetime import timedelta
-
-from django.utils import timezone
-from django.utils.functional import classproperty
-from django_rq import job
-
-from core.choices import JobStatusChoices
-from core.models import Job
-from .choices import LogLevelChoices
-from .models import ReportModule
 from .scripts import BaseScript
 
 __all__ = (
     'Report',
-    'get_module_and_report',
-    'run_report',
 )
 
-logger = logging.getLogger(__name__)
-
-
-def get_module_and_report(module_name, report_name):
-    module = ReportModule.objects.get(file_path=f'{module_name}.py')
-    report = module.reports.get(report_name)()
-    return module, report
-
-
-@job('default')
-def run_report(job, *args, **kwargs):
-    """
-    Helper function to call the run method on a report. This is needed to get around the inability to pickle an instance
-    method for queueing into the background processor.
-    """
-    job.start()
-
-    module = ReportModule.objects.get(pk=job.object_id)
-    report = module.reports.get(job.name)()
-
-    try:
-        report.run(job)
-    except Exception as e:
-        job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
-        logging.error(f"Error during execution of report {job.name}")
-    finally:
-        # Schedule the next job if an interval has been set
-        if job.interval:
-            new_scheduled_time = job.scheduled + timedelta(minutes=job.interval)
-            Job.enqueue(
-                run_report,
-                instance=job.object,
-                name=job.name,
-                user=job.user,
-                job_timeout=report.job_timeout,
-                schedule_at=new_scheduled_time,
-                interval=job.interval
-            )
-
 
 class Report(BaseScript):
-    def log_success(self, obj, message=None):
+    def log_success(self, obj=None, message=None):
         super().log_success(message, obj)
 
-    def log_info(self, obj, message):
+    def log_info(self, obj=None, message=None):
         super().log_info(message, obj)
 
-    def log_warning(self, obj, message):
+    def log_warning(self, obj=None, message=None):
         super().log_warning(message, obj)
 
-    def log_failure(self, obj, message):
+    def log_failure(self, obj=None, message=None):
         super().log_failure(message, obj)
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 6aed2d03241..318a617dbff 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -15,7 +15,6 @@
 
 from core.choices import JobStatusChoices
 from core.models import Job
-from extras.api.serializers import ScriptOutputSerializer
 from extras.choices import LogLevelChoices
 from extras.models import ScriptModule
 from extras.signals import clear_events
@@ -271,9 +270,10 @@ class Meta:
         pass
 
     def __init__(self):
-        self._results = {}
+        self._logs = {}
         self.failed = False
         self._current_method = 'total'
+        self._output = ''
 
         # Initiate the log
         self.logger = logging.getLogger(f"netbox.scripts.{self.__module__}.{self.__class__.__name__}")
@@ -283,7 +283,7 @@ def __init__(self):
         self.request = None
 
         # Compile test methods and initialize results skeleton
-        self._results['total'] = {
+        self._logs['total'] = {
             'success': 0,
             'info': 0,
             'warning': 0,
@@ -294,7 +294,7 @@ def __init__(self):
         for method in dir(self):
             if method.startswith('test_') and callable(getattr(self, method)):
                 test_methods.append(method)
-                self._results[method] = {
+                self._logs[method] = {
                     'success': 0,
                     'info': 0,
                     'warning': 0,
@@ -443,7 +443,7 @@ def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=l
             raise Exception(f"Unknown logging level: {log_level}")
 
         if message:
-            self._results[self._current_method]['log'].append((
+            self._logs[self._current_method]['log'].append((
                 timezone.now().isoformat(),
                 log_level,
                 str(obj) if obj else None,
@@ -452,10 +452,10 @@ def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=l
             ))
 
         if log_level != LogLevelChoices.LOG_DEFAULT:
-            self._results[self._current_method][log_level] += 1
+            self._logs[self._current_method][log_level] += 1
 
             if self._current_method != 'total':
-                self._results['total'][log_level] += 1
+                self._logs['total'][log_level] += 1
 
         if obj:
             self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
@@ -471,7 +471,7 @@ def log(self, message):
     def log_debug(self, message, obj=None):
         self._log(str(message), obj, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.DEBUG)
 
-    def log_success(self, message=None, obj=None):
+    def log_success(self, message, obj=None):
         self._log(str(message), obj, log_level=LogLevelChoices.LOG_SUCCESS, level=logging.INFO)
 
     def log_info(self, message, obj=None):
@@ -524,7 +524,6 @@ def run_test_scripts(self, job):
                 self._current_method = method_name
                 test_method = getattr(self, method_name)
                 test_method()
-            job.data = self._results
             if self.failed:
                 self.logger.warning("Report failed")
                 job.terminate(status=JobStatusChoices.STATUS_FAILED)
@@ -540,7 +539,7 @@ def run_test_scripts(self, job):
         # Perform any post-run tasks
         self.post_run()
 
-    def run(self, job):
+    def run(self, data, commit, job):
         self.run_test_scripts(job)
 
     def pre_run(self):
@@ -609,6 +608,53 @@ def run_script(data, job, request=None, commit=True, **kwargs):
     # Add the current request as a property of the script
     script.request = request
 
+    def signature(fn):
+        """
+        Taken from django.tables2 (https://github.com/jieter/django-tables2/blob/master/django_tables2/utils.py)
+        Returns:
+            tuple: Returns a (arguments, kwarg_name)-tuple:
+                 - the arguments (positional or keyword)
+                 - the name of the ** kwarg catch all.
+
+        The self-argument for methods is always removed.
+        """
+
+        signature = inspect.signature(fn)
+
+        args = []
+        keywords = None
+        for arg in signature.parameters.values():
+            if arg.kind == arg.VAR_KEYWORD:
+                keywords = arg.name
+            elif arg.kind == arg.VAR_POSITIONAL:
+                continue  # skip *args catch-all
+            else:
+                args.append(arg.name)
+
+        return tuple(args), keywords
+
+    def call_with_appropriate(fn, kwargs):
+        """
+        Taken from django.tables2 (https://github.com/jieter/django-tables2/blob/master/django_tables2/utils.py)
+        Calls the function ``fn`` with the keyword arguments from ``kwargs`` it expects
+
+        If the kwargs argument is defined, pass all arguments, else provide exactly
+        the arguments wanted.
+
+        If one of the arguments of ``fn`` are not contained in kwargs, ``fn`` will not
+        be called and ``None`` will be returned.
+        """
+        args, kwargs_name = signature(fn)
+        # no catch-all defined, we need to exactly pass the arguments specified.
+        if not kwargs_name:
+            kwargs = {key: kwargs[key] for key in kwargs if key in args}
+
+            # if any argument of fn is not in kwargs, just return None
+            if any(arg not in kwargs for arg in args):
+                return None
+
+        return fn(**kwargs)
+
     def _run_script():
         """
         Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
@@ -617,25 +663,31 @@ def _run_script():
         try:
             try:
                 with transaction.atomic():
-                    script.output = script.run(data=data, commit=commit)
+                    script._output = call_with_appropriate(script.run, kwargs={'data': data, 'commit': commit, 'job': job})
                     if not commit:
                         raise AbortTransaction()
             except AbortTransaction:
-                script.log_info("Database changes have been reverted automatically.")
+                call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted automatically."})
                 if request:
                     clear_events.send(request)
-            job.data = ScriptOutputSerializer(script).data
+            job.data = {
+                'logs': script._logs,
+                'output': script._output,
+            }
             job.terminate()
         except Exception as e:
             if type(e) is AbortScript:
-                script.log_failure(f"Script aborted with error: {e}")
+                call_with_appropriate(script.log_failure, kwargs={'message': f"Script aborted with error: {e}"})
                 logger.error(f"Script aborted with error: {e}")
             else:
                 stacktrace = traceback.format_exc()
-                script.log_failure(f"An exception occurred: `{type(e).__name__}: {e}`\n```\n{stacktrace}\n```")
+                call_with_appropriate(script.log_failure, kwargs={'message': f"An exception occurred: `{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"})
                 logger.error(f"Exception raised during script execution: {e}")
-            script.log_info("Database changes have been reverted due to error.")
-            job.data = ScriptOutputSerializer(script).data
+            call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted due to error."})
+            job.data = {
+                'logs': script._logs,
+                'output': script._output,
+            }
             job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
             if request:
                 clear_events.send(request)
diff --git a/netbox/extras/urls.py b/netbox/extras/urls.py
index 0a1786f1f39..5627fad5d40 100644
--- a/netbox/extras/urls.py
+++ b/netbox/extras/urls.py
@@ -116,15 +116,6 @@
     path('dashboard/widgets/<uuid:id>/configure/', views.DashboardWidgetConfigView.as_view(), name='dashboardwidget_config'),
     path('dashboard/widgets/<uuid:id>/delete/', views.DashboardWidgetDeleteView.as_view(), name='dashboardwidget_delete'),
 
-    # Reports
-    path('reports/', views.ReportListView.as_view(), name='report_list'),
-    path('reports/add/', views.ReportModuleCreateView.as_view(), name='reportmodule_add'),
-    path('reports/results/<int:job_pk>/', views.ReportResultView.as_view(), name='report_result'),
-    path('reports/<int:pk>/', include(get_model_urls('extras', 'reportmodule'))),
-    path('reports/<str:module>/<str:name>/', views.ReportView.as_view(), name='report'),
-    path('reports/<str:module>/<str:name>/source/', views.ReportSourceView.as_view(), name='report_source'),
-    path('reports/<str:module>/<str:name>/jobs/', views.ReportJobsView.as_view(), name='report_jobs'),
-
     # Scripts
     path('scripts/', views.ScriptListView.as_view(), name='script_list'),
     path('scripts/add/', views.ScriptModuleCreateView.as_view(), name='scriptmodule_add'),
diff --git a/netbox/extras/views.py b/netbox/extras/views.py
index f33b4c89b71..532e3263678 100644
--- a/netbox/extras/views.py
+++ b/netbox/extras/views.py
@@ -26,7 +26,6 @@
 from . import filtersets, forms, tables
 from .forms.reports import ReportForm
 from .models import *
-from .reports import run_report
 from .scripts import run_script
 
 
@@ -1006,185 +1005,6 @@ def post(self, request, id):
         return redirect(reverse('home'))
 
 
-#
-# Reports
-#
-
-@register_model_view(ReportModule, 'edit')
-class ReportModuleCreateView(generic.ObjectEditView):
-    queryset = ReportModule.objects.all()
-    form = ManagedFileForm
-
-    def alter_object(self, obj, *args, **kwargs):
-        obj.file_root = ManagedFileRootPathChoices.REPORTS
-        return obj
-
-
-@register_model_view(ReportModule, 'delete')
-class ReportModuleDeleteView(generic.ObjectDeleteView):
-    queryset = ReportModule.objects.all()
-    default_return_url = 'extras:report_list'
-
-
-class ReportListView(ContentTypePermissionRequiredMixin, View):
-    """
-    Retrieve all the available reports from disk and the recorded Job (if any) for each.
-    """
-    def get_required_permission(self):
-        return 'extras.view_report'
-
-    def get(self, request):
-        report_modules = ReportModule.objects.restrict(request.user)
-
-        return render(request, 'extras/report_list.html', {
-            'model': ReportModule,
-            'report_modules': report_modules,
-        })
-
-
-def get_report_module(module, request):
-    return get_object_or_404(ReportModule.objects.restrict(request.user), file_path__regex=f"^{module}\\.")
-
-
-class ReportView(ContentTypePermissionRequiredMixin, View):
-    """
-    Display a single Report and its associated Job (if any).
-    """
-    def get_required_permission(self):
-        return 'extras.view_report'
-
-    def get(self, request, module, name):
-        module = get_report_module(module, request)
-        report = module.reports[name]()
-
-        object_type = ContentType.objects.get(app_label='extras', model='reportmodule')
-        report.result = Job.objects.filter(
-            object_type=object_type,
-            object_id=module.pk,
-            name=report.name,
-            status__in=JobStatusChoices.TERMINAL_STATE_CHOICES
-        ).first()
-
-        return render(request, 'extras/report.html', {
-            'module': module,
-            'report': report,
-            'form': ReportForm(scheduling_enabled=report.scheduling_enabled),
-        })
-
-    def post(self, request, module, name):
-        if not request.user.has_perm('extras.run_report'):
-            return HttpResponseForbidden()
-
-        module = get_report_module(module, request)
-        report = module.reports[name]()
-        form = ReportForm(request.POST, scheduling_enabled=report.scheduling_enabled)
-
-        if form.is_valid():
-
-            # Allow execution only if RQ worker process is running
-            if not get_workers_for_queue('default'):
-                messages.error(request, "Unable to run report: RQ worker process not running.")
-                return render(request, 'extras/report.html', {
-                    'report': report,
-                })
-
-            # Run the Report. A new Job is created.
-            job = Job.enqueue(
-                run_report,
-                instance=module,
-                name=report.class_name,
-                user=request.user,
-                schedule_at=form.cleaned_data.get('schedule_at'),
-                interval=form.cleaned_data.get('interval'),
-                job_timeout=report.job_timeout
-            )
-
-            return redirect('extras:report_result', job_pk=job.pk)
-
-        return render(request, 'extras/report.html', {
-            'module': module,
-            'report': report,
-            'form': form,
-        })
-
-
-class ReportSourceView(ContentTypePermissionRequiredMixin, View):
-
-    def get_required_permission(self):
-        return 'extras.view_report'
-
-    def get(self, request, module, name):
-        module = get_report_module(module, request)
-        report = module.reports[name]()
-
-        return render(request, 'extras/report/source.html', {
-            'module': module,
-            'report': report,
-            'tab': 'source',
-        })
-
-
-class ReportJobsView(ContentTypePermissionRequiredMixin, View):
-
-    def get_required_permission(self):
-        return 'extras.view_report'
-
-    def get(self, request, module, name):
-        module = get_report_module(module, request)
-        report = module.reports[name]()
-
-        object_type = ContentType.objects.get(app_label='extras', model='reportmodule')
-        jobs = Job.objects.filter(
-            object_type=object_type,
-            object_id=module.pk,
-            name=report.class_name
-        )
-
-        jobs_table = JobTable(
-            data=jobs,
-            orderable=False,
-            user=request.user
-        )
-        jobs_table.configure(request)
-
-        return render(request, 'extras/report/jobs.html', {
-            'module': module,
-            'report': report,
-            'table': jobs_table,
-            'tab': 'jobs',
-        })
-
-
-class ReportResultView(ContentTypePermissionRequiredMixin, View):
-    """
-    Display a Job pertaining to the execution of a Report.
-    """
-    def get_required_permission(self):
-        return 'extras.view_report'
-
-    def get(self, request, job_pk):
-        object_type = ContentType.objects.get_by_natural_key(app_label='extras', model='reportmodule')
-        job = get_object_or_404(Job.objects.all(), pk=job_pk, object_type=object_type)
-
-        module = job.object
-        report = module.reports[job.name]
-
-        # If this is an HTMX request, return only the result HTML
-        if request.htmx:
-            response = render(request, 'extras/htmx/report_result.html', {
-                'report': report,
-                'job': job,
-            })
-            if job.completed or not job.started:
-                response.status_code = 286
-            return response
-
-        return render(request, 'extras/report_result.html', {
-            'report': report,
-            'job': job,
-        })
-
-
 #
 # Scripts
 #
diff --git a/netbox/netbox/navigation/menu.py b/netbox/netbox/navigation/menu.py
index e639474244b..e3e3f05817f 100644
--- a/netbox/netbox/navigation/menu.py
+++ b/netbox/netbox/navigation/menu.py
@@ -317,14 +317,8 @@
             ),
         ),
         MenuGroup(
-            label=_('Reports & Scripts'),
+            label=_('Scripts'),
             items=(
-                MenuItem(
-                    link='extras:report_list',
-                    link_text=_('Reports'),
-                    permissions=['extras.view_report'],
-                    buttons=get_model_buttons('extras', "reportmodule", actions=['add'])
-                ),
                 MenuItem(
                     link='extras:script_list',
                     link_text=_('Scripts'),
diff --git a/netbox/templates/extras/htmx/report_result.html b/netbox/templates/extras/htmx/report_result.html
deleted file mode 100644
index 440b12ebae2..00000000000
--- a/netbox/templates/extras/htmx/report_result.html
+++ /dev/null
@@ -1,77 +0,0 @@
-{% load humanize %}
-{% load helpers %}
-{% load i18n %}
-
-<p>
-  {% if job.started %}
-    {% trans "Started" %}: <strong>{{ job.started|annotated_date }}</strong>
-  {% elif job.scheduled %}
-    {% trans "Scheduled for" %}: <strong>{{ job.scheduled|annotated_date }}</strong> ({{ job.scheduled|naturaltime }})
-  {% else %}
-    {% trans "Created" %}: <strong>{{ job.created|annotated_date }}</strong>
-  {% endif %}
-  {% if job.completed %}
-    {% trans "Duration" %}: <strong>{{ job.duration }}</strong>
-  {% endif %}
-  <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
-</p>
-{% if job.completed %}
-  <div class="card">
-    <h5 class="card-header">{% trans "Report Methods" %}</h5>
-    <table class="table table-hover">
-      {% for method, data in job.data.items %}
-        <tr>
-          <td class="font-monospace"><a href="#{{ method }}">{{ method }}</a></td>
-          <td class="text-end report-stats">
-            <span class="badge text-bg-success">{{ data.success }}</span>
-            <span class="badge text-bg-info">{{ data.info }}</span>
-            <span class="badge text-bg-warning">{{ data.warning }}</span>
-            <span class="badge text-bg-danger">{{ data.failure }}</span>
-          </td>
-        </tr>
-      {% endfor %}
-    </table>
-  </div>
-  <div class="card">
-    <h5 class="card-header">{% trans "Report Results" %}</h5>
-    <table class="table table-hover report">
-      <thead>
-        <tr>
-          <th>{% trans "Time" %}</th>
-          <th>{% trans "Level" %}</th>
-          <th>{% trans "Object" %}</th>
-          <th>{% trans "Message" %}</th>
-        </tr>
-      </thead>
-      <tbody>
-        {% for method, data in job.data.items %}
-          <tr>
-            <th colspan="4" style="font-family: monospace">
-              <a name="{{ method }}"></a>{{ method }}
-            </th>
-          </tr>
-          {% for time, level, obj, url, message in data.log %}
-            <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
-              <td>{{ time }}</td>
-              <td>
-                <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
-              </td>
-              <td>
-                {% if obj and url %}
-                  <a href="{{ url }}">{{ obj }}</a>
-                {% elif obj %}
-                  {{ obj }}
-                {% else %}
-                  {{ ''|placeholder }}
-                {% endif %}
-              </td>
-              <td class="rendered-markdown">{{ message|markdown }}</td>
-            </tr>
-          {% endfor %}
-        {% endfor %}
-      </tbody>
-    </table>
-  </div>
-{% elif job.started %}
-  {% include 'extras/inc/result_pending.html' %}
-{% endif %}
diff --git a/netbox/templates/extras/htmx/script_result.html b/netbox/templates/extras/htmx/script_result.html
index f79fb8e483e..46940358019 100644
--- a/netbox/templates/extras/htmx/script_result.html
+++ b/netbox/templates/extras/htmx/script_result.html
@@ -19,7 +19,7 @@
   <div class="card">
     <h5 class="card-header">{% trans "Script Methods" %}</h5>
     <table class="table table-hover">
-      {% for method, data in job.data.items %}
+      {% for method, data in job.data.logs.items %}
         <tr>
           <td class="font-monospace"><a href="#{{ method }}">{{ method }}</a></td>
           <td class="text-end script-stats">
@@ -44,30 +44,32 @@ <h5 class="card-header">{% trans "Script Results" %}</h5>
         </tr>
       </thead>
       <tbody>
-        {% for method, data in job.data.items %}
-          <tr>
-            <th colspan="4" style="font-family: monospace">
-              <a name="{{ method }}"></a>{{ method }}
-            </th>
-          </tr>
-          {% for time, level, obj, url, message in data.log %}
-            <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
-              <td>{{ time }}</td>
-              <td>
-                <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
-              </td>
-              <td>
-                {% if obj and url %}
-                  <a href="{{ url }}">{{ obj }}</a>
-                {% elif obj %}
-                  {{ obj }}
-                {% else %}
-                  {{ ''|placeholder }}
-                {% endif %}
-              </td>
-              <td class="rendered-markdown">{{ message|markdown }}</td>
+        {% for method, data in job.data.logs.items %}
+          {% if method != 'total' %}
+            <tr>
+              <th colspan="4" style="font-family: monospace">
+                <a name="{{ method }}"></a>{{ method }}
+              </th>
             </tr>
-          {% endfor %}
+            {% for time, level, obj, url, message in data.log %}
+              <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
+                <td>{{ time }}</td>
+                <td>
+                  <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
+                </td>
+                <td>
+                  {% if obj and url %}
+                    <a href="{{ url }}">{{ obj }}</a>
+                  {% elif obj %}
+                    {{ obj }}
+                  {% else %}
+                    {{ ''|placeholder }}
+                  {% endif %}
+                </td>
+                <td class="rendered-markdown">{{ message|markdown }}</td>
+              </tr>
+            {% endfor %}
+          {% endif %}
         {% endfor %}
       </tbody>
     </table>
diff --git a/netbox/templates/extras/report.html b/netbox/templates/extras/report.html
deleted file mode 100644
index 55df94c3e90..00000000000
--- a/netbox/templates/extras/report.html
+++ /dev/null
@@ -1,43 +0,0 @@
-{% extends 'extras/report/base.html' %}
-{% load helpers %}
-{% load form_helpers %}
-{% load i18n %}
-
-{% block content %}
-  <div role="tabpanel" class="tab-pane active" id="report">
-    {% if perms.extras.run_report %}
-      <div class="row">
-        <div class="col">
-          {% if not report.is_valid %}
-            <div class="alert alert-warning">
-              <i class="mdi mdi-alert"></i>
-              {% trans "This report is invalid and cannot be run." %}
-            </div>
-          {% endif %}
-          <form action="{% url 'extras:report' module=report.module name=report.class_name %}" method="post" class="object-edit">
-            {% csrf_token %}
-            {% render_form form %}
-            <div class="float-end">
-              <button type="submit" name="_run" class="btn btn-primary"{% if not report.is_valid %} disabled{% endif %}>
-                {% if report.result %}
-                  <i class="mdi mdi-replay"></i> {% trans "Run Again" %}
-                {% else %}
-                  <i class="mdi mdi-play"></i> {% trans "Run Report" %}
-                {% endif %}
-              </button>
-            </div>
-          </form>
-        </div>
-      </div>
-    {% endif %}
-    <div class="row">
-      <div class="col col-md-12">
-        {% if report.result %}
-          {% trans "Last run" %}: <a href="{% url 'extras:report_result' job_pk=report.result.pk %}">
-            <strong>{{ report.result.created|annotated_date }}</strong>
-          </a>
-        {% endif %}
-      </div>
-    </div>
-  </div>
-{% endblock content %}
diff --git a/netbox/templates/extras/report_list.html b/netbox/templates/extras/report_list.html
deleted file mode 100644
index 97536a4ccde..00000000000
--- a/netbox/templates/extras/report_list.html
+++ /dev/null
@@ -1,128 +0,0 @@
-{% extends 'generic/_base.html' %}
-{% load buttons %}
-{% load helpers %}
-{% load perms %}
-{% load i18n %}
-
-{% block title %}{% trans "Reports" %}{% endblock %}
-
-{% block tabs %}
-  <ul class="nav nav-tabs">
-    <li class="nav-item" role="presentation">
-      <a class="nav-link active" role="tab">{% trans "Reports" %}</a>
-    </li>
-  </ul>
-{% endblock tabs %}
-
-{% block controls %}
-  {% add_button model %}
-{% endblock controls %}
-
-{% block content %}
-  {% for module in report_modules %}
-    <div class="card">
-      <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
-        <div>
-          <i class="mdi mdi-file-document-outline"></i> {{ module }}
-        </div>
-        {% if perms.extras.delete_reportmodule %}
-          <a href="{% url 'extras:reportmodule_delete' pk=module.pk %}" class="btn btn-danger btn-sm">
-            <i class="mdi mdi-trash-can-outline" aria-hidden="true"></i> {% trans "Delete" %}
-          </a>
-        {% endif %}
-      </h5>
-      <div class="card-body">
-        {% include 'inc/sync_warning.html' with object=module %}
-        {% if module.reports %}
-          <table class="table table-hover reports">
-            <thead>
-              <tr>
-                <th width="250">{% trans "Name" %}</th>
-                <th>{% trans "Description" %}</th>
-                <th>{% trans "Last Run" %}</th>
-                <th>{% trans "Status" %}</th>
-                <th width="120"></th>
-              </tr>
-            </thead>
-            <tbody>
-              {% with jobs=module.get_latest_jobs %}
-                {% for report_name, report in module.reports.items %}
-                  {% with last_job=jobs|get_key:report.class_name %}
-                    <tr>
-                      <td>
-                        <a href="{% url 'extras:report' module=module.python_name name=report.class_name %}" id="{{ report.module }}.{{ report.class_name }}">{{ report.name }}</a>
-                      </td>
-                      <td>{{ report.description|markdown|placeholder }}</td>
-                      {% if last_job %}
-                        <td>
-                          <a href="{% url 'extras:report_result' job_pk=last_job.pk %}">{{ last_job.created|annotated_date }}</a>
-                        </td>
-                        <td>
-                          {% badge last_job.get_status_display last_job.get_status_color %}
-                        </td>
-                      {% else %}
-                        <td class="text-muted">{% trans "Never" %}</td>
-                        <td>
-                          {% if report.is_valid %}
-                            {{ ''|placeholder }}
-                          {% else %}
-                            <span class="badge text-bg-danger" title="{% trans "Report has no test methods" %}">
-                              {% trans "Invalid" %}
-                            </span>
-                          {% endif %}
-                        </td>
-                      {% endif %}
-                      <td>
-                        {% if perms.extras.run_report and report.is_valid %}
-                          <div class="float-end d-print-none">
-                            <form action="{% url 'extras:report' module=report.module name=report.class_name %}" method="post">
-                              {% csrf_token %}
-                              <button type="submit" name="_run" class="btn btn-primary" style="width: 110px">
-                                {% if last_job %}
-                                  <i class="mdi mdi-replay"></i> {% trans "Run Again" %}
-                                {% else %}
-                                  <i class="mdi mdi-play"></i> {% trans "Run Report" %}
-                                {% endif %}
-                              </button>
-                            </form>
-                          </div>
-                        {% endif %}
-                      </td>
-                    </tr>
-                    {% for method, stats in last_job.data.items %}
-                      <tr>
-                        <td colspan="4" class="method">
-                          <span class="ps-3">{{ method }}</span>
-                        </td>
-                        <td class="text-end text-nowrap report-stats">
-                          <span class="badge text-bg-success">{{ stats.success }}</span>
-                          <span class="badge text-bg-info">{{ stats.info }}</span>
-                          <span class="badge text-bg-warning">{{ stats.warning }}</span>
-                          <span class="badge text-bg-danger">{{ stats.failure }}</span>
-                        </td>
-                      </tr>
-                    {% endfor %}
-                  {% endwith %}
-                {% endfor %}
-              {% endwith %}
-            </tbody>
-          </table>
-        {% else %}
-          <div class="alert alert-warning" role="alert">
-            <i class="mdi mdi-alert"></i> Could not load reports from {{ module.name }}
-          </div>
-        {% endif %}
-      </div>
-    </div>
-  {% empty %}
-    <div class="alert alert-info" role="alert">
-      <h4 class="alert-heading">{% trans "No Reports Found" %}</h4>
-      {% if perms.extras.add_reportmodule %}
-        {% url 'extras:reportmodule_add' as create_report_url %}
-        {% blocktrans trimmed %}
-          Get started by <a href="{{ create_report_url }}">creating a report</a> from an uploaded file or data source.
-        {% endblocktrans %}
-      {% endif %}
-    </div>
-  {% endfor %}
-{% endblock content %}
diff --git a/netbox/templates/extras/report_result.html b/netbox/templates/extras/report_result.html
deleted file mode 100644
index 1db567364d6..00000000000
--- a/netbox/templates/extras/report_result.html
+++ /dev/null
@@ -1,17 +0,0 @@
-{% extends 'extras/report.html' %}
-{% load buttons %}
-{% load perms %}
-
-{% block controls %}
-  {% if request.user|can_delete:job %}
-    {% delete_button job %}
-  {% endif %}
-{% endblock controls %}
-
-{% block content %}
-  <div class="row">
-    <div class="col col-md-12"{% if not job.completed %} hx-get="{% url 'extras:report_result' job_pk=job.pk %}" hx-trigger="load delay:0.5s, every 5s"{% endif %}>
-      {% include 'extras/htmx/report_result.html' %}
-    </div>
-  </div>
-{% endblock content %}
\ No newline at end of file
diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
index afc4e588825..60753ea9a1d 100644
--- a/netbox/templates/extras/script_list.html
+++ b/netbox/templates/extras/script_list.html
@@ -89,7 +89,7 @@ <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
                         {% endif %}
                       </td>
                     </tr>
-                    {% for method, stats in last_job.data.items %}
+                    {% for method, stats in last_job.data.logs.items %}
                       <tr>
                         <td colspan="4" class="method">
                           <span class="ps-3">{{ method }}</span>

From 23a8b2a9298c14618e0da392fe05ef9c68e0a010 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 26 Jan 2024 15:12:54 -0800
Subject: [PATCH 06/32] 12510 cleanup

---
 netbox/extras/scripts.py | 57 +++++++++++++++++++++-------------------
 1 file changed, 30 insertions(+), 27 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 318a617dbff..8c7a727cda6 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -271,8 +271,8 @@ class Meta:
 
     def __init__(self):
         self._logs = {}
-        self.failed = False
-        self._current_method = 'total'
+        self._failed = False
+        self._current_method = 'totals'
         self._output = ''
 
         # Initiate the log
@@ -283,7 +283,7 @@ def __init__(self):
         self.request = None
 
         # Compile test methods and initialize results skeleton
-        self._logs['total'] = {
+        self._logs['totals'] = {
             'success': 0,
             'info': 0,
             'warning': 0,
@@ -454,8 +454,8 @@ def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=l
         if log_level != LogLevelChoices.LOG_DEFAULT:
             self._logs[self._current_method][log_level] += 1
 
-            if self._current_method != 'total':
-                self._logs['total'][log_level] += 1
+            if self._current_method != 'totals':
+                self._logs['totals'][log_level] += 1
 
         if obj:
             self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
@@ -482,6 +482,7 @@ def log_warning(self, message, obj=None):
 
     def log_failure(self, message, obj=None):
         self._log(str(message), obj, log_level=LogLevelChoices.LOG_FAILURE, level=logging.ERROR)
+        self._failed = True
 
     # Convenience functions
 
@@ -524,23 +525,17 @@ def run_test_scripts(self, job):
                 self._current_method = method_name
                 test_method = getattr(self, method_name)
                 test_method()
-            if self.failed:
-                self.logger.warning("Report failed")
-                job.terminate(status=JobStatusChoices.STATUS_FAILED)
-            else:
-                self.logger.info("Report completed successfully")
-                job.terminate()
         except Exception as e:
-            stacktrace = traceback.format_exc()
-            self.log_failure(None, f"An exception occurred: {type(e).__name__}: {e} <pre>{stacktrace}</pre>")
-            logger.error(f"Exception raised during report execution: {e}")
-            job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
+            self.post_run()
+            self._current_method = 'totals'
+            raise e
 
         # Perform any post-run tasks
         self.post_run()
+        self._current_method = 'totals'
 
-    def run(self, data, commit, job):
-        self.run_test_scripts(job)
+    def run(self, data, commit):
+        self.run_test_scripts()
 
     def pre_run(self):
         """
@@ -655,6 +650,16 @@ def call_with_appropriate(fn, kwargs):
 
         return fn(**kwargs)
 
+    def set_job_data(job, script):
+        logs = script._logs
+        totals = logs.pop('totals')
+        job.data = {
+            'logs': logs,
+            'totals': totals,
+            'output': script._output,
+        }
+        return job
+
     def _run_script():
         """
         Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
@@ -663,18 +668,19 @@ def _run_script():
         try:
             try:
                 with transaction.atomic():
-                    script._output = call_with_appropriate(script.run, kwargs={'data': data, 'commit': commit, 'job': job})
+                    script._output = script.run(data, commit)
                     if not commit:
                         raise AbortTransaction()
             except AbortTransaction:
                 call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted automatically."})
                 if request:
                     clear_events.send(request)
-            job.data = {
-                'logs': script._logs,
-                'output': script._output,
-            }
-            job.terminate()
+            job = set_job_data(job, script)
+            if script._failed:
+                logger.warning(f"Script failed")
+                job.terminate(status=JobStatusChoices.STATUS_FAILED)
+            else:
+                job.terminate()
         except Exception as e:
             if type(e) is AbortScript:
                 call_with_appropriate(script.log_failure, kwargs={'message': f"Script aborted with error: {e}"})
@@ -684,10 +690,7 @@ def _run_script():
                 call_with_appropriate(script.log_failure, kwargs={'message': f"An exception occurred: `{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"})
                 logger.error(f"Exception raised during script execution: {e}")
             call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted due to error."})
-            job.data = {
-                'logs': script._logs,
-                'output': script._output,
-            }
+            job = set_job_data(job, script)
             job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
             if request:
                 clear_events.send(request)

From 52689616e99c1477fccc33002d13be9b5da30f80 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Mon, 29 Jan 2024 11:21:04 -0800
Subject: [PATCH 07/32] 12510 legacy jobs

---
 netbox/extras/views.py                        | 14 ++++
 .../extras/htmx/legacy_report_result.html     | 81 +++++++++++++++++++
 .../extras/htmx/legacy_script_result.html     | 58 +++++++++++++
 netbox/templates/extras/script_result.html    |  8 +-
 4 files changed, 160 insertions(+), 1 deletion(-)
 create mode 100644 netbox/templates/extras/htmx/legacy_report_result.html
 create mode 100644 netbox/templates/extras/htmx/legacy_script_result.html

diff --git a/netbox/extras/views.py b/netbox/extras/views.py
index 532e3263678..75591c6ae35 100644
--- a/netbox/extras/views.py
+++ b/netbox/extras/views.py
@@ -1163,11 +1163,23 @@ def get(self, request, job_pk):
         module = job.object
         script = module.scripts[job.name]()
 
+        if 'logs' in job.data:
+            legacy_script = False
+            legacy_report = False
+        elif 'log' in job.data:
+            legacy_script = True
+            legacy_report = False
+        else:
+            legacy_script = False
+            legacy_report = True
+
         # If this is an HTMX request, return only the result HTML
         if request.htmx:
             response = render(request, 'extras/htmx/script_result.html', {
                 'script': script,
                 'job': job,
+                'legacy_script': legacy_script,
+                'legacy_report': legacy_report,
             })
             if job.completed or not job.started:
                 response.status_code = 286
@@ -1176,6 +1188,8 @@ def get(self, request, job_pk):
         return render(request, 'extras/script_result.html', {
             'script': script,
             'job': job,
+            'legacy_script': legacy_script,
+            'legacy_report': legacy_report,
         })
 
 
diff --git a/netbox/templates/extras/htmx/legacy_report_result.html b/netbox/templates/extras/htmx/legacy_report_result.html
new file mode 100644
index 00000000000..e6b6caf7317
--- /dev/null
+++ b/netbox/templates/extras/htmx/legacy_report_result.html
@@ -0,0 +1,81 @@
+{% load humanize %}
+{% load helpers %}
+{% load i18n %}
+
+<p>
+  {% if job.started %}
+    {% trans "Started" %}: <strong>{{ job.started|annotated_date }}</strong>
+  {% elif job.scheduled %}
+    {% trans "Scheduled for" %}: <strong>{{ job.scheduled|annotated_date }}</strong> ({{ job.scheduled|naturaltime }})
+  {% else %}
+    {% trans "Created" %}: <strong>{{ job.created|annotated_date }}</strong>
+  {% endif %}
+  {% if job.completed %}
+    {% trans "Duration" %}: <strong>{{ job.duration }}</strong>
+  {% endif %}
+  <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
+</p>
+{% if job.completed %}
+  <div class="card">
+    <h5 class="card-header">{% trans "Report Methods" %}</h5>
+    <div class="card-body">
+      <table class="table table-hover">
+        {% for method, data in job.data.items %}
+          <tr>
+            <td class="font-monospace"><a href="#{{ method }}">{{ method }}</a></td>
+            <td class="text-end report-stats">
+              <span class="badge bg-success">{{ data.success }}</span>
+              <span class="badge bg-info">{{ data.info }}</span>
+              <span class="badge bg-warning">{{ data.warning }}</span>
+              <span class="badge bg-danger">{{ data.failure }}</span>
+            </td>
+          </tr>
+        {% endfor %}
+      </table>
+    </div>
+  </div>
+  <div class="card">
+    <h5 class="card-header">{% trans "Report Results" %}</h5>
+    <div class="card-body">
+      <table class="table table-hover report">
+        <thead>
+          <tr class="table-headings">
+            <th>{% trans "Time" %}</th>
+            <th>{% trans "Level" %}</th>
+            <th>{% trans "Object" %}</th>
+            <th>{% trans "Message" %}</th>
+          </tr>
+        </thead>
+        <tbody>
+          {% for method, data in job.data.items %}
+            <tr>
+              <th colspan="4" style="font-family: monospace">
+                <a name="{{ method }}"></a>{{ method }}
+              </th>
+            </tr>
+            {% for time, level, obj, url, message in data.log %}
+              <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
+                <td>{{ time }}</td>
+                <td>
+                  <label class="badge bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
+                </td>
+                <td>
+                  {% if obj and url %}
+                    <a href="{{ url }}">{{ obj }}</a>
+                  {% elif obj %}
+                    {{ obj }}
+                  {% else %}
+                    {{ ''|placeholder }}
+                  {% endif %}
+                </td>
+                <td class="rendered-markdown">{{ message|markdown }}</td>
+              </tr>
+            {% endfor %}
+          {% endfor %}
+        </tbody>
+      </table>
+    </div>
+  </div>
+{% elif job.started %}
+  {% include 'extras/inc/result_pending.html' %}
+{% endif %}
diff --git a/netbox/templates/extras/htmx/legacy_script_result.html b/netbox/templates/extras/htmx/legacy_script_result.html
new file mode 100644
index 00000000000..ddc9b05f609
--- /dev/null
+++ b/netbox/templates/extras/htmx/legacy_script_result.html
@@ -0,0 +1,58 @@
+{% load humanize %}
+{% load helpers %}
+{% load log_levels %}
+{% load i18n %}
+
+<p>
+  {% if job.started %}
+    {% trans "Started" %}: <strong>{{ job.started|annotated_date }}</strong>
+  {% elif job.scheduled %}
+    {% trans "Scheduled for" %}: <strong>{{ job.scheduled|annotated_date }}</strong> ({{ job.scheduled|naturaltime }})
+  {% else %}
+    {% trans "Created" %}: <strong>{{ job.created|annotated_date }}</strong>
+  {% endif %}
+  {% if job.completed %}
+    {% trans "Duration" %}: <strong>{{ job.duration }}</strong>
+  {% endif %}
+  <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
+</p>
+{% if job.completed %}
+  <div class="card mb-3">
+    <h5 class="card-header">{% trans "Script Log" %}</h5>
+    <div class="card-body">
+      <table class="table table-hover panel-body">
+        <tr>
+          <th>{% trans "Line" %}</th>
+          <th>{% trans "Level" %}</th>
+          <th>{% trans "Message" %}</th>
+        </tr>
+        {% for log in job.data.log %}
+          <tr>
+            <td>{{ forloop.counter }}</td>
+            <td>{% log_level log.status %}</td>
+            <td class="rendered-markdown">{{ log.message|markdown }}</td>
+          </tr>
+        {% empty %}
+          <tr>
+            <td colspan="3" class="text-center text-muted">
+              {% trans "No log output" %}
+            </td>
+          </tr>
+        {% endfor %}
+      </table>
+    </div>
+    {% if execution_time %}
+      <div class="card-footer text-end text-muted">
+        <small>{% trans "Exec Time" %}: {{ execution_time|floatformat:3 }} {% trans "seconds" context "Unit of time" %}</small>
+      </div>
+    {% endif %}
+  </div>
+  <h4>{% trans "Output" %}</h4>
+  {% if job.data.output %}
+    <pre class="block">{{ job.data.output }}</pre>
+  {% else %}
+    <p class="text-muted">{% trans "None" %}</p>
+  {% endif %}
+{% elif job.started %}
+  {% include 'extras/inc/result_pending.html' %}
+{% endif %}
diff --git a/netbox/templates/extras/script_result.html b/netbox/templates/extras/script_result.html
index 985c58d634d..02a01149c86 100644
--- a/netbox/templates/extras/script_result.html
+++ b/netbox/templates/extras/script_result.html
@@ -44,7 +44,13 @@
   <div role="tabpanel" class="tab-pane active" id="log">
     <div class="row">
       <div class="col col-md-12"{% if not job.completed %} hx-get="{% url 'extras:script_result' job_pk=job.pk %}" hx-trigger="load delay:0.5s, every 5s"{% endif %}>
-        {% include 'extras/htmx/script_result.html' %}
+        {% if legacy_script %}
+          {% include 'extras/htmx/legacy_script_result.html' %}
+        {% elif legacy_report %}
+          {% include 'extras/htmx/legacy_report_result.html' %}
+        {% else %}
+          {% include 'extras/htmx/script_result.html' %}
+        {% endif %}
       </div>
     </div>
   </div>

From e61b960cd72268d2cd11285bff2a7ae26f0a2a7b Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Mon, 29 Jan 2024 14:55:47 -0800
Subject: [PATCH 08/32] 12510 legacy jobs

---
 netbox/extras/scripts.py                 | 19 +++++------
 netbox/extras/views.py                   | 21 +++++++-----
 netbox/templates/extras/script_list.html | 43 +++++++++++++++++-------
 3 files changed, 50 insertions(+), 33 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 8c7a727cda6..8792e08fa0c 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -272,18 +272,17 @@ class Meta:
     def __init__(self):
         self._logs = {}
         self._failed = False
-        self._current_method = 'totals'
+        self._current_method = 'unassigned'
         self._output = ''
 
         # Initiate the log
         self.logger = logging.getLogger(f"netbox.scripts.{self.__module__}.{self.__class__.__name__}")
-        self.log = []
 
         # Declare the placeholder for the current request
         self.request = None
 
         # Compile test methods and initialize results skeleton
-        self._logs['totals'] = {
+        self._logs['unassigned'] = {
             'success': 0,
             'info': 0,
             'warning': 0,
@@ -454,8 +453,8 @@ def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=l
         if log_level != LogLevelChoices.LOG_DEFAULT:
             self._logs[self._current_method][log_level] += 1
 
-            if self._current_method != 'totals':
-                self._logs['totals'][log_level] += 1
+            if self._current_method != 'unassigned':
+                self._logs['unassigned'][log_level] += 1
 
         if obj:
             self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
@@ -527,12 +526,12 @@ def run_test_scripts(self, job):
                 test_method()
         except Exception as e:
             self.post_run()
-            self._current_method = 'totals'
+            self._current_method = 'unassigned'
             raise e
 
         # Perform any post-run tasks
         self.post_run()
-        self._current_method = 'totals'
+        self._current_method = 'unassigned'
 
     def run(self, data, commit):
         self.run_test_scripts()
@@ -650,12 +649,10 @@ def call_with_appropriate(fn, kwargs):
 
         return fn(**kwargs)
 
-    def set_job_data(job, script):
+    def set_job_data(script):
         logs = script._logs
-        totals = logs.pop('totals')
         job.data = {
             'logs': logs,
-            'totals': totals,
             'output': script._output,
         }
         return job
@@ -675,7 +672,7 @@ def _run_script():
                 call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted automatically."})
                 if request:
                     clear_events.send(request)
-            job = set_job_data(job, script)
+            job = set_job_data(script)
             if script._failed:
                 logger.warning(f"Script failed")
                 job.terminate(status=JobStatusChoices.STATUS_FAILED)
diff --git a/netbox/extras/views.py b/netbox/extras/views.py
index 75591c6ae35..76c6b186ac0 100644
--- a/netbox/extras/views.py
+++ b/netbox/extras/views.py
@@ -1163,15 +1163,18 @@ def get(self, request, job_pk):
         module = job.object
         script = module.scripts[job.name]()
 
-        if 'logs' in job.data:
-            legacy_script = False
-            legacy_report = False
-        elif 'log' in job.data:
-            legacy_script = True
-            legacy_report = False
-        else:
-            legacy_script = False
-            legacy_report = True
+        legacy_script = False
+        legacy_report = False
+        if job.data:
+            if 'logs' in job.data:
+                legacy_script = False
+                legacy_report = False
+            elif 'log' in job.data:
+                legacy_script = True
+                legacy_report = False
+            else:
+                legacy_script = False
+                legacy_report = True
 
         # If this is an HTMX request, return only the result HTML
         if request.htmx:
diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
index 60753ea9a1d..0c58c1eb355 100644
--- a/netbox/templates/extras/script_list.html
+++ b/netbox/templates/extras/script_list.html
@@ -89,19 +89,36 @@ <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
                         {% endif %}
                       </td>
                     </tr>
-                    {% for method, stats in last_job.data.logs.items %}
-                      <tr>
-                        <td colspan="4" class="method">
-                          <span class="ps-3">{{ method }}</span>
-                        </td>
-                        <td class="text-end text-nowrap script-stats">
-                          <span class="badge text-bg-success">{{ stats.success }}</span>
-                          <span class="badge text-bg-info">{{ stats.info }}</span>
-                          <span class="badge text-bg-warning">{{ stats.warning }}</span>
-                          <span class="badge text-bg-danger">{{ stats.failure }}</span>
-                        </td>
-                      </tr>
-                    {% endfor %}
+                    {% if last_job.data.logs %}
+                      {% for method, stats in last_job.data.logs.items %}
+                        <tr>
+                          <td colspan="4" class="method">
+                            <span class="ps-3">{{ method }}</span>
+                          </td>
+                          <td class="text-end text-nowrap script-stats">
+                            <span class="badge text-bg-success">{{ stats.success }}</span>
+                            <span class="badge text-bg-info">{{ stats.info }}</span>
+                            <span class="badge text-bg-warning">{{ stats.warning }}</span>
+                            <span class="badge text-bg-danger">{{ stats.failure }}</span>
+                          </td>
+                        </tr>
+                      {% endfor %}
+                    {% elif not last_job.data.log %}
+                      {# legacy #}
+                      {% for method, stats in last_job.data.items %}
+                        <tr>
+                          <td colspan="4" class="method">
+                            <span class="ps-3">{{ method }}</span>
+                          </td>
+                          <td class="text-end text-nowrap report-stats">
+                            <span class="badge bg-success">{{ stats.success }}</span>
+                            <span class="badge bg-info">{{ stats.info }}</span>
+                            <span class="badge bg-warning">{{ stats.warning }}</span>
+                            <span class="badge bg-danger">{{ stats.failure }}</span>
+                          </td>
+                        </tr>
+                      {% endfor %}
+                    {% endif %}
                   {% endwith %}
                 {% endfor %}
               {% endwith %}

From 53b3875e82606b9ab3ed231cfaf218c0c4df6365 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Mon, 29 Jan 2024 16:01:00 -0800
Subject: [PATCH 09/32] 12510 fixes

---
 .../migrations/0011_job_report_to_script.py   |  7 +--
 netbox/extras/tests/test_api.py               | 31 ------------
 netbox/extras/views.py                        |  9 +---
 .../templates/extras/htmx/script_result.html  | 49 +++++++++----------
 4 files changed, 28 insertions(+), 68 deletions(-)

diff --git a/netbox/core/migrations/0011_job_report_to_script.py b/netbox/core/migrations/0011_job_report_to_script.py
index 4273475ef50..25bc181c48e 100644
--- a/netbox/core/migrations/0011_job_report_to_script.py
+++ b/netbox/core/migrations/0011_job_report_to_script.py
@@ -8,9 +8,10 @@ def migrate_report_jobs(apps, schema_editor):
     Job = apps.get_model('core', 'Job')
 
     # Delete the new ContentType effected by the introduction of core.ConfigRevision
-    report_content_type = ContentType.objects.get(app_label='extras', model='reportmodule')
-    script_content_type = ContentType.objects.get(app_label='extras', model='scriptmodule')
-    jobs = Job.objects.filter(object_type_id=report_content_type.id).update(object_type_id=script_content_type.id)
+    if ContentType.objects.filter(app_label='extras', model='reportmodule'):
+        report_content_type = ContentType.objects.get(app_label='extras', model='reportmodule')
+        script_content_type = ContentType.objects.get(app_label='extras', model='scriptmodule')
+        jobs = Job.objects.filter(object_type_id=report_content_type.id).update(object_type_id=script_content_type.id)
 
 
 class Migration(migrations.Migration):
diff --git a/netbox/extras/tests/test_api.py b/netbox/extras/tests/test_api.py
index 93be2d2c4ba..0c414ef217e 100644
--- a/netbox/extras/tests/test_api.py
+++ b/netbox/extras/tests/test_api.py
@@ -730,37 +730,6 @@ def setUpTestData(cls):
         ConfigTemplate.objects.bulk_create(config_templates)
 
 
-class ReportTest(APITestCase):
-
-    class TestReport(Report):
-
-        def test_foo(self):
-            self.log_success(None, "Report completed")
-
-    @classmethod
-    def setUpTestData(cls):
-        ReportModule.objects.create(
-            file_root=ManagedFileRootPathChoices.REPORTS,
-            file_path='/var/tmp/report.py'
-        )
-
-    def get_test_report(self, *args):
-        return ReportModule.objects.first(), self.TestReport()
-
-    def setUp(self):
-        super().setUp()
-
-        # Monkey-patch the API viewset's _get_report() method to return our test Report above
-        from extras.api.views import ReportViewSet
-        ReportViewSet._get_report = self.get_test_report
-
-    def test_get_report(self):
-        url = reverse('extras-api:report-detail', kwargs={'pk': None})
-        response = self.client.get(url, **self.header)
-
-        self.assertEqual(response.data['name'], self.TestReport.__name__)
-
-
 class ScriptTest(APITestCase):
 
     class TestScript(Script):
diff --git a/netbox/extras/views.py b/netbox/extras/views.py
index 76c6b186ac0..4c9d25cebf4 100644
--- a/netbox/extras/views.py
+++ b/netbox/extras/views.py
@@ -1165,15 +1165,10 @@ def get(self, request, job_pk):
 
         legacy_script = False
         legacy_report = False
-        if job.data:
-            if 'logs' in job.data:
-                legacy_script = False
-                legacy_report = False
-            elif 'log' in job.data:
+        if job.data and ('logs' not in job.data):
+            if 'log' in job.data:
                 legacy_script = True
-                legacy_report = False
             else:
-                legacy_script = False
                 legacy_report = True
 
         # If this is an HTMX request, return only the result HTML
diff --git a/netbox/templates/extras/htmx/script_result.html b/netbox/templates/extras/htmx/script_result.html
index 46940358019..f27672d1039 100644
--- a/netbox/templates/extras/htmx/script_result.html
+++ b/netbox/templates/extras/htmx/script_result.html
@@ -32,8 +32,11 @@ <h5 class="card-header">{% trans "Script Methods" %}</h5>
       {% endfor %}
     </table>
   </div>
+  <h2 class="card-header">{% trans "Script Results" %}</h2>
+
+  {% for method, data in job.data.logs.items %}
   <div class="card">
-    <h5 class="card-header">{% trans "Script Results" %}</h5>
+    <h5 class="card-header"><a name="{{ method }}"></a>{{ method }}</h5>
     <table class="table table-hover script">
       <thead>
         <tr>
@@ -44,36 +47,28 @@ <h5 class="card-header">{% trans "Script Results" %}</h5>
         </tr>
       </thead>
       <tbody>
-        {% for method, data in job.data.logs.items %}
-          {% if method != 'total' %}
-            <tr>
-              <th colspan="4" style="font-family: monospace">
-                <a name="{{ method }}"></a>{{ method }}
-              </th>
+          {% for time, level, obj, url, message in data.log %}
+            <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
+              <td>{{ time }}</td>
+              <td>
+                <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
+              </td>
+              <td>
+                {% if obj and url %}
+                  <a href="{{ url }}">{{ obj }}</a>
+                {% elif obj %}
+                  {{ obj }}
+                {% else %}
+                  {{ ''|placeholder }}
+                {% endif %}
+              </td>
+              <td class="rendered-markdown">{{ message|markdown }}</td>
             </tr>
-            {% for time, level, obj, url, message in data.log %}
-              <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
-                <td>{{ time }}</td>
-                <td>
-                  <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
-                </td>
-                <td>
-                  {% if obj and url %}
-                    <a href="{{ url }}">{{ obj }}</a>
-                  {% elif obj %}
-                    {{ obj }}
-                  {% else %}
-                    {{ ''|placeholder }}
-                  {% endif %}
-                </td>
-                <td class="rendered-markdown">{{ message|markdown }}</td>
-              </tr>
-            {% endfor %}
-          {% endif %}
-        {% endfor %}
+          {% endfor %}
       </tbody>
     </table>
   </div>
+  {% endfor %}
 {% elif job.started %}
   {% include 'extras/inc/result_pending.html' %}
 {% endif %}

From b45fc0e851dd92ec3b60b58b2c80d7bf4cd5dd16 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 08:51:30 -0800
Subject: [PATCH 10/32] 12510 review changes

---
 netbox/extras/models/scripts.py |  4 ++--
 netbox/extras/scripts.py        | 13 +++++--------
 netbox/extras/utils.py          | 22 +---------------------
 3 files changed, 8 insertions(+), 31 deletions(-)

diff --git a/netbox/extras/models/scripts.py b/netbox/extras/models/scripts.py
index 55576421f5d..ff620f60f01 100644
--- a/netbox/extras/models/scripts.py
+++ b/netbox/extras/models/scripts.py
@@ -9,7 +9,7 @@
 
 from core.choices import ManagedFileRootPathChoices
 from core.models import ManagedFile
-from extras.utils import is_script_or_report
+from extras.utils import is_script
 from netbox.models.features import JobsMixin, EventRulesMixin
 from utilities.querysets import RestrictedQuerySet
 from .mixins import PythonModuleMixin
@@ -72,7 +72,7 @@ def _get_name(cls):
 
         for cls in ordered:
             scripts[_get_name(cls)] = cls
-        for name, cls in inspect.getmembers(module, is_script_or_report):
+        for name, cls in inspect.getmembers(module, is_script):
             if cls not in ordered:
                 scripts[_get_name(cls)] = cls
 
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 8792e08fa0c..49a02a1bd78 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -257,7 +257,7 @@ def __init__(self, min_prefix_length=None, max_prefix_length=None, *args, **kwar
 # Scripts
 #
 
-class BaseScript(object):
+class BaseScript:
     """
     Base model for custom scripts. User classes should inherit from this model if they want to extend Script
     functionality for use in other subclasses.
@@ -510,15 +510,12 @@ def load_json(self, filename):
 
         return data
 
-    def run_test_scripts(self, job):
+    def run_tests(self, job):
         """
         Run the report and save its results. Each test method will be executed in order.
         """
         self.logger.info(f"Running report")
 
-        # Perform any post-run tasks
-        self.pre_run()
-
         try:
             for method_name in self.test_methods:
                 self._current_method = method_name
@@ -529,12 +526,12 @@ def run_test_scripts(self, job):
             self._current_method = 'unassigned'
             raise e
 
-        # Perform any post-run tasks
-        self.post_run()
         self._current_method = 'unassigned'
 
     def run(self, data, commit):
-        self.run_test_scripts()
+        self.pre_run()
+        self.run_tests()
+        self.post_run()
 
     def pre_run(self):
         """
diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index 563770f73b3..db06b07f88f 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -51,28 +51,8 @@ def is_script(obj):
     """
     Returns True if the object is a Script.
     """
-    from .scripts import Script
-    try:
-        return issubclass(obj, Script) and obj != Script
-    except TypeError:
-        return False
 
-
-def is_report(obj):
-    """
-    Returns True if the given object is a Report.
-    """
-    from .reports import Report
-    try:
-        return issubclass(obj, Report) and obj != Report
-    except TypeError:
-        return False
-
-
-def is_script_or_report(obj):
-    """
-    Returns True if the given object is a Report.
-    """
+    # TODO: Deprecated legacy reports support
     from .reports import Report
     from .scripts import Script
     try:

From 148bf086d857e02d8009b30e3c8b8881dd33db7e Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 09:57:31 -0800
Subject: [PATCH 11/32] 12510 review changes

---
 netbox/extras/scripts.py | 77 ++++++++++++++--------------------------
 1 file changed, 26 insertions(+), 51 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 49a02a1bd78..f5a3816cac0 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -599,53 +599,6 @@ def run_script(data, job, request=None, commit=True, **kwargs):
     # Add the current request as a property of the script
     script.request = request
 
-    def signature(fn):
-        """
-        Taken from django.tables2 (https://github.com/jieter/django-tables2/blob/master/django_tables2/utils.py)
-        Returns:
-            tuple: Returns a (arguments, kwarg_name)-tuple:
-                 - the arguments (positional or keyword)
-                 - the name of the ** kwarg catch all.
-
-        The self-argument for methods is always removed.
-        """
-
-        signature = inspect.signature(fn)
-
-        args = []
-        keywords = None
-        for arg in signature.parameters.values():
-            if arg.kind == arg.VAR_KEYWORD:
-                keywords = arg.name
-            elif arg.kind == arg.VAR_POSITIONAL:
-                continue  # skip *args catch-all
-            else:
-                args.append(arg.name)
-
-        return tuple(args), keywords
-
-    def call_with_appropriate(fn, kwargs):
-        """
-        Taken from django.tables2 (https://github.com/jieter/django-tables2/blob/master/django_tables2/utils.py)
-        Calls the function ``fn`` with the keyword arguments from ``kwargs`` it expects
-
-        If the kwargs argument is defined, pass all arguments, else provide exactly
-        the arguments wanted.
-
-        If one of the arguments of ``fn`` are not contained in kwargs, ``fn`` will not
-        be called and ``None`` will be returned.
-        """
-        args, kwargs_name = signature(fn)
-        # no catch-all defined, we need to exactly pass the arguments specified.
-        if not kwargs_name:
-            kwargs = {key: kwargs[key] for key in kwargs if key in args}
-
-            # if any argument of fn is not in kwargs, just return None
-            if any(arg not in kwargs for arg in args):
-                return None
-
-        return fn(**kwargs)
-
     def set_job_data(script):
         logs = script._logs
         job.data = {
@@ -659,6 +612,8 @@ def _run_script():
         Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
         the event_tracking context manager (which is bypassed if commit == False).
         """
+        from .reports import Report  # here to prevent circular import
+
         try:
             try:
                 with transaction.atomic():
@@ -666,7 +621,13 @@ def _run_script():
                     if not commit:
                         raise AbortTransaction()
             except AbortTransaction:
-                call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted automatically."})
+                msg = _("Database changes have been reverted automatically.")
+                if issubclass(script, Report):
+                    # script and legacy reports have different log function signatures
+                    script.log_info(message=msg)
+                else:
+                    script.log_info(msg)
+
                 if request:
                     clear_events.send(request)
             job = set_job_data(script)
@@ -677,13 +638,27 @@ def _run_script():
                 job.terminate()
         except Exception as e:
             if type(e) is AbortScript:
-                call_with_appropriate(script.log_failure, kwargs={'message': f"Script aborted with error: {e}"})
+                msg = _("Script aborted with error: ") + str(e)
+                if issubclass(script, Report):
+                    script.log_failure(message=msg)
+                else:
+                    script.log_failure(msg)
+
                 logger.error(f"Script aborted with error: {e}")
             else:
                 stacktrace = traceback.format_exc()
-                call_with_appropriate(script.log_failure, kwargs={'message': f"An exception occurred: `{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"})
+                msg = _("An exception occurred: : ") + f"`{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"
+                if issubclass(script, Report):
+                    script.log_failure(message=msg)
+                else:
+                    script.log_failure(msg)
                 logger.error(f"Exception raised during script execution: {e}")
-            call_with_appropriate(script.log_info, kwargs={'message': "Database changes have been reverted due to error."})
+            msg = _("Database changes have been reverted due to error.")
+            if issubclass(script, Report):
+                script.log_info(message=msg)
+            else:
+                script.log_info(msg)
+
             job = set_job_data(job, script)
             job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
             if request:

From fe591fbfb2332cda1c20cb8f3e97df61d5796396 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 10:48:31 -0800
Subject: [PATCH 12/32] 12510 update docs

---
 docs/customization/custom-scripts.md |  79 ++++++++++++-
 docs/customization/reports.md        | 165 +++++----------------------
 2 files changed, 103 insertions(+), 141 deletions(-)

diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md
index 0b1ed11df5f..013306e7e5e 100644
--- a/docs/customization/custom-scripts.md
+++ b/docs/customization/custom-scripts.md
@@ -8,6 +8,14 @@ Custom scripting was introduced to provide a way for users to execute custom log
 
 Custom scripts are Python code and exist outside of the official NetBox code base, so they can be updated and changed without interfering with the core NetBox installation. And because they're completely custom, there is no inherent limitation on what a script can accomplish.
 
+Custom scripts can also be used as a mechanism for validating the integrity of data within NetBox. Running a script can allow the user to verify that the objects defined within NetBox meet certain arbitrary conditions. For example, you can write script to check that:
+
+* All top-of-rack switches have a console connection
+* Every router has a loopback interface with an IP address assigned
+* Each interface description conforms to a standard format
+* Every site has a minimum set of VLANs defined
+* All IP addresses have a parent prefix
+
 ## Writing Custom Scripts
 
 All custom scripts must inherit from the `extras.scripts.Script` base class. This class provides the functionality necessary to generate forms and log activity.
@@ -135,13 +143,13 @@ These two methods will load data in YAML or JSON format, respectively, from file
 
 The Script object provides a set of convenient functions for recording messages at different severity levels:
 
-* `log_debug`
-* `log_success`
-* `log_info`
-* `log_warning`
-* `log_failure`
+* `log(message)`
+* `log_success(message, object=None)`
+* `log_info(message, object=None)`
+* `log_warning(message, object=None)`
+* `log_failure(message, object=None)`
 
-Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages.
+Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages.  An optional object can be passed that will be linked in the rendered message.
 
 ## Change Logging
 
@@ -410,3 +418,62 @@ class NewBranchScript(Script):
 
         return '\n'.join(output)
 ```
+
+## Test Methods
+
+Within each script class, we can create a number of test methods to validate the integrity of various data. In DeviceConnectionsReport, for instance, we want to ensure that every live device has a console connection, an out-of-band management connection, and two power connections.
+
+```
+from dcim.choices import DeviceStatusChoices
+from dcim.models import ConsolePort, Device, PowerPort
+from extras.scripts import Script
+
+
+class DeviceConnectionsReport(Script):
+    description = "Validate the minimum physical connections for each device"
+
+    def test_console_connection(self):
+
+        # Check that every console port for every active device has a connection defined.
+        active = DeviceStatusChoices.STATUS_ACTIVE
+        for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
+            if not console_port.connected_endpoints:
+                self.log_failure(
+                    "No console connection defined for {}".format(console_port.name),
+                    console_port.device,
+                )
+            elif not console_port.connection_status:
+                self.log_warning(
+                    "Console connection for {} marked as planned".format(console_port.name),
+                    console_port.device,
+                )
+            else:
+                self.log_success("success", console_port.device)
+
+    def test_power_connections(self):
+
+        # Check that every active device has at least two connected power supplies.
+        for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
+            connected_ports = 0
+            for power_port in PowerPort.objects.filter(device=device):
+                if power_port.connected_endpoints:
+                    connected_ports += 1
+                    if not power_port.path.is_active:
+                        self.log_warning(
+                            "Power connection for {} marked as planned".format(power_port.name),
+                            device,
+                        )
+            if connected_ports < 2:
+                self.log_failure(
+                    "{} connected power supplies found (2 needed)".format(connected_ports),
+                    device,
+                )
+            else:
+                self.log_success("success", device)
+
+    def run(self, data, commit):
+        self.run_tests()
+
+```
+
+`run_tests()` is a helper function that will run every method that starts with `test_`
diff --git a/docs/customization/reports.md b/docs/customization/reports.md
index a821c5da76e..109e92a9b69 100644
--- a/docs/customization/reports.md
+++ b/docs/customization/reports.md
@@ -1,167 +1,62 @@
 # NetBox Reports
 
-A NetBox report is a mechanism for validating the integrity of data within NetBox. Running a report allows the user to verify that the objects defined within NetBox meet certain arbitrary conditions. For example, you can write reports to check that:
-
-* All top-of-rack switches have a console connection
-* Every router has a loopback interface with an IP address assigned
-* Each interface description conforms to a standard format
-* Every site has a minimum set of VLANs defined
-* All IP addresses have a parent prefix
-
-...and so on. Reports are completely customizable, so there's practically no limit to what you can test for.
-
-## Writing Reports
-
-Reports must be saved as files in the [`REPORTS_ROOT`](../configuration/system.md#reports_root) path (which defaults to `netbox/reports/`). Each file created within this path is considered a separate module. Each module holds one or more reports (Python classes), each of which performs a certain function. The logic of each report is broken into discrete test methods, each of which applies a small portion of the logic comprising the overall test.
-
 !!! warning
-    The reports path includes a file named `__init__.py`, which registers the path as a Python module. Do not delete this file.
+    Reports are deprecated and merged with [custom scripts](./custom-scripts.md) as of NetBox 4.0.  You should convert any legacy reports to use Script as described below
 
-For example, we can create a module named `devices.py` to hold all of our reports which pertain to devices in NetBox. Within that module, we might define several reports. Each report is defined as a Python class inheriting from `extras.reports.Report`.
-
-```
-from extras.reports import Report
-
-class DeviceConnectionsReport(Report):
-    description = "Validate the minimum physical connections for each device"
+## Converting Reports to Scripts
 
-class DeviceIPsReport(Report):
-    description = "Check that every device has a primary IP address assigned"
-```
+### Step 1: Change Class Definition
 
-Within each report class, we'll create a number of test methods to execute our report's logic. In DeviceConnectionsReport, for instance, we want to ensure that every live device has a console connection, an out-of-band management connection, and two power connections.
+First change the import and class definition to use Script.  For example:
 
 ```
-from dcim.choices import DeviceStatusChoices
-from dcim.models import ConsolePort, Device, PowerPort
 from extras.reports import Report
 
-
 class DeviceConnectionsReport(Report):
-    description = "Validate the minimum physical connections for each device"
-
-    def test_console_connection(self):
-
-        # Check that every console port for every active device has a connection defined.
-        active = DeviceStatusChoices.STATUS_ACTIVE
-        for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
-            if not console_port.connected_endpoints:
-                self.log_failure(
-                    console_port.device,
-                    "No console connection defined for {}".format(console_port.name)
-                )
-            elif not console_port.connection_status:
-                self.log_warning(
-                    console_port.device,
-                    "Console connection for {} marked as planned".format(console_port.name)
-                )
-            else:
-                self.log_success(console_port.device)
-
-    def test_power_connections(self):
-
-        # Check that every active device has at least two connected power supplies.
-        for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
-            connected_ports = 0
-            for power_port in PowerPort.objects.filter(device=device):
-                if power_port.connected_endpoints:
-                    connected_ports += 1
-                    if not power_port.path.is_active:
-                        self.log_warning(
-                            device,
-                            "Power connection for {} marked as planned".format(power_port.name)
-                        )
-            if connected_ports < 2:
-                self.log_failure(
-                    device,
-                    "{} connected power supplies found (2 needed)".format(connected_ports)
-                )
-            else:
-                self.log_success(device)
 ```
-
-As you can see, reports are completely customizable. Validation logic can be as simple or as complex as needed. Also note that the `description` attribute support markdown syntax. It will be rendered in the report list page.
-
-!!! warning
-    Reports should never alter data: If you find yourself using the `create()`, `save()`, `update()`, or `delete()` methods on objects within reports, stop and re-evaluate what you're trying to accomplish. Note that there are no safeguards against the accidental alteration or destruction of data.
-
-## Report Attributes
-
-### `description`
-
-A human-friendly description of what your report does.
-
-### `scheduling_enabled`
-
-By default, a report can be scheduled for execution at a later time. Setting `scheduling_enabled` to False disables this ability: Only immediate execution will be possible. (This also disables the ability to set a recurring execution interval.)
-
-### `job_timeout`
-
-Set the maximum allowed runtime for the report. If not set, `RQ_DEFAULT_TIMEOUT` will be used.
-
-## Logging
-
-The following methods are available to log results within a report:
-
-* log(message)
-* log_success(object, message=None)
-* log_info(object, message)
-* log_warning(object, message)
-* log_failure(object, message)
-
-The recording of one or more failure messages will automatically flag a report as failed. It is advised to log a success for each object that is evaluated so that the results will reflect how many objects are being reported on. (The inclusion of a log message is optional for successes.) Messages recorded with `log()` will appear in a report's results but are not associated with a particular object or status. Log messages also support using markdown syntax and will be rendered on the report result page.
-
-To perform additional tasks, such as sending an email or calling a webhook, before or after a report is run, extend the `pre_run()` and/or `post_run()` methods, respectively.
-
-By default, reports within a module are ordered alphabetically in the reports list page. To return reports in a specific order, you can define the `report_order` variable at the end of your module. The `report_order` variable is a tuple which contains each Report class in the desired order. Any reports that are omitted from this list will be listed last.
+change to:
 
 ```
-from extras.reports import Report
-
-class DeviceConnectionsReport(Report)
-    pass
+from extras.scripts import Script
 
-class DeviceIPsReport(Report)
-    pass
-
-report_order = (DeviceIPsReport, DeviceConnectionsReport)
+class DeviceConnectionsReport(Script):
 ```
 
-Once you have created a report, it will appear in the reports list. Initially, reports will have no results associated with them. To generate results, run the report.
-
-## Running Reports
-
-!!! note
-    To run a report, a user must be assigned via permissions for `Extras > Report`, `Extras > ReportModule`, and `Core > ManagedFile` objects. They must also be assigned the `extras.run_report` permission. This is achieved by assigning the user (or group) a permission on the Report object and specifying the `run` action in the admin UI as shown below.
-
-    ![Adding the run action to a permission](../media/admin_ui_run_permission.png)
-
-### Via the Web UI
+### Step 2: Change Logging Calls
 
-Reports can be run via the web UI by navigating to the report and clicking the "run report" button at top right. Once a report has been run, its associated results will be included in the report view. It is possible to schedule a report to be executed at specified time in the future. A scheduled report can be canceled by deleting the associated job result object.
+The logging methods require the object and message in the logging call to be swapped.  For example:
 
-### Via the API
-
-To run a report via the API, simply issue a POST request to its `run` endpoint. Reports are identified by their module and class name.
 
 ```
-    POST /api/extras/reports/<module>.<name>/run/
+    self.log_failure(
+        console_port.device,
+        "No console connection defined for {}".format(console_port.name)
+    )
 ```
 
-Our example report above would be called as:
+should be changed to:
 
 ```
-    POST /api/extras/reports/devices.DeviceConnectionsReport/run/
+    self.log_failure(
+        "No console connection defined for {}".format(console_port.name),
+        console_port.device,
+    )
 ```
 
-Optionally `schedule_at` can be passed in the form data with a datetime string to schedule a script at the specified date and time.
+This applies to all log_ functions:
 
-### Via the CLI
+* log_success(object, message) -> log_success(message, object)
+* log_info(object, message) -> log_info(message, object)
+* log_warning(object, message) -> log_warning(message, object)
+* log_failure(object, message) -> log_failure(message, object)
 
-Reports can be run on the CLI by invoking the management command:
+### Optional Run Method
+
+Scripts have a default run method that will automatically run all the `test_` methods as well as the pre_run and post_run functions.  You can also define a run method and call `run_tests()` to call all the `test_` functions:
 
 ```
-python3 manage.py runreport <module>
-```
+    def run(self, data, commit):
+        self.run_tests()
 
-where ``<module>`` is the name of the python file in the ``reports`` directory without the ``.py`` extension.  One or more report modules may be specified.
+```
+Any functionality needed for pre or post run can just be put into the the run method before or after the call to run_tests.

From da9b089723e062e2bdf0631820d9bc2ef83b7075 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 14:20:07 -0800
Subject: [PATCH 13/32] 12510 review changes

---
 .../extras/management/commands/runscript.py   | 29 +++++++++++++++++--
 netbox/extras/scripts.py                      | 13 +++++----
 netbox/extras/utils.py                        | 12 ++++++++
 3 files changed, 45 insertions(+), 9 deletions(-)

diff --git a/netbox/extras/management/commands/runscript.py b/netbox/extras/management/commands/runscript.py
index 609374378ec..0346549c8b6 100644
--- a/netbox/extras/management/commands/runscript.py
+++ b/netbox/extras/management/commands/runscript.py
@@ -10,7 +10,6 @@
 
 from core.choices import JobStatusChoices
 from core.models import Job
-from extras.api.serializers import ScriptOutputSerializer
 from extras.context_managers import event_tracking
 from extras.scripts import get_module_and_script
 from extras.signals import clear_events
@@ -34,6 +33,30 @@ def add_arguments(self, parser):
         parser.add_argument('script', help="Script to run")
 
     def handle(self, *args, **options):
+        def _output_results(job):
+            # Report on success/failure
+            if job.status == JobStatusChoices.STATUS_FAILED:
+                status = self.style.ERROR('FAILED')
+            elif job == JobStatusChoices.STATUS_ERRORED:
+                status = self.style.ERROR('ERRORED')
+            else:
+                status = self.style.SUCCESS('SUCCESS')
+
+            for test_name, attrs in job.data.logs.items():
+                self.stdout.write(
+                    "\t{}: {} success, {} info, {} warning, {} failure".format(
+                        test_name, attrs['success'], attrs['info'], attrs['warning'], attrs['failure']
+                    )
+                )
+
+        def _set_job_data(job, script):
+            logs = script._logs
+            job.data = {
+                'logs': logs,
+                'output': script._output,
+            }
+            return job
+
         def _run_script():
             """
             Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
@@ -48,7 +71,7 @@ def _run_script():
                 except AbortTransaction:
                     script.log_info("Database changes have been reverted automatically.")
                     clear_events.send(request)
-                job.data = ScriptOutputSerializer(script).data
+                job = _set_job_data(job, script)
                 job.terminate()
             except Exception as e:
                 stacktrace = traceback.format_exc()
@@ -58,7 +81,7 @@ def _run_script():
                 script.log_info("Database changes have been reverted due to error.")
                 logger.error(f"Exception raised during script execution: {e}")
                 clear_events.send(request)
-                job.data = ScriptOutputSerializer(script).data
+                job = _set_job_data(job, script)
                 job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
 
             logger.info(f"Script completed in {job.duration}")
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index f5a3816cac0..8644277a880 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -12,6 +12,7 @@
 from django.db import transaction
 from django.utils import timezone
 from django.utils.functional import classproperty
+from django.utils.translation import gettext as _
 
 from core.choices import JobStatusChoices
 from core.models import Job
@@ -25,6 +26,8 @@
 from utilities.forms.fields import DynamicModelChoiceField, DynamicModelMultipleChoiceField
 from .context_managers import event_tracking
 from .forms import ScriptForm
+from .utils import is_report
+
 
 __all__ = (
     'BaseScript',
@@ -612,8 +615,6 @@ def _run_script():
         Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
         the event_tracking context manager (which is bypassed if commit == False).
         """
-        from .reports import Report  # here to prevent circular import
-
         try:
             try:
                 with transaction.atomic():
@@ -622,7 +623,7 @@ def _run_script():
                         raise AbortTransaction()
             except AbortTransaction:
                 msg = _("Database changes have been reverted automatically.")
-                if issubclass(script, Report):
+                if is_report(script):
                     # script and legacy reports have different log function signatures
                     script.log_info(message=msg)
                 else:
@@ -639,7 +640,7 @@ def _run_script():
         except Exception as e:
             if type(e) is AbortScript:
                 msg = _("Script aborted with error: ") + str(e)
-                if issubclass(script, Report):
+                if is_report(script):
                     script.log_failure(message=msg)
                 else:
                     script.log_failure(msg)
@@ -648,13 +649,13 @@ def _run_script():
             else:
                 stacktrace = traceback.format_exc()
                 msg = _("An exception occurred: : ") + f"`{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"
-                if issubclass(script, Report):
+                if is_report(script):
                     script.log_failure(message=msg)
                 else:
                     script.log_failure(msg)
                 logger.error(f"Exception raised during script execution: {e}")
             msg = _("Database changes have been reverted due to error.")
-            if issubclass(script, Report):
+            if is_report(script):
                 script.log_info(message=msg)
             else:
                 script.log_info(msg)
diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index db06b07f88f..fd95b8f9be9 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -47,6 +47,18 @@ def register_features(model, features):
         registry['models'][app_label].add(model_name)
 
 
+def is_report(obj):
+    """
+    Returns True if the given object is a Report.
+    """
+    from .reports import Report
+    try:
+        return issubclass(obj, Report) and obj != Report
+    except TypeError:
+        print("TypeError")
+        return False
+
+
 def is_script(obj):
     """
     Returns True if the object is a Script.

From 7e071361783131508c8e49e4d381d02735914a9c Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 14:50:29 -0800
Subject: [PATCH 14/32] 12510 review changes

---
 netbox/extras/scripts.py | 10 +++++-----
 netbox/extras/utils.py   | 18 +++++++-----------
 2 files changed, 12 insertions(+), 16 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 8644277a880..9297b671664 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -513,7 +513,7 @@ def load_json(self, filename):
 
         return data
 
-    def run_tests(self, job):
+    def run_tests(self):
         """
         Run the report and save its results. Each test method will be executed in order.
         """
@@ -623,7 +623,7 @@ def _run_script():
                         raise AbortTransaction()
             except AbortTransaction:
                 msg = _("Database changes have been reverted automatically.")
-                if is_report(script):
+                if is_report(type(script)):
                     # script and legacy reports have different log function signatures
                     script.log_info(message=msg)
                 else:
@@ -640,7 +640,7 @@ def _run_script():
         except Exception as e:
             if type(e) is AbortScript:
                 msg = _("Script aborted with error: ") + str(e)
-                if is_report(script):
+                if is_report(type(script)):
                     script.log_failure(message=msg)
                 else:
                     script.log_failure(msg)
@@ -649,13 +649,13 @@ def _run_script():
             else:
                 stacktrace = traceback.format_exc()
                 msg = _("An exception occurred: : ") + f"`{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"
-                if is_report(script):
+                if is_report(type(script)):
                     script.log_failure(message=msg)
                 else:
                     script.log_failure(msg)
                 logger.error(f"Exception raised during script execution: {e}")
             msg = _("Database changes have been reverted due to error.")
-            if is_report(script):
+            if is_report(type(script)):
                 script.log_info(message=msg)
             else:
                 script.log_info(msg)
diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index fd95b8f9be9..c6b2de18838 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -47,27 +47,23 @@ def register_features(model, features):
         registry['models'][app_label].add(model_name)
 
 
-def is_report(obj):
+def is_script(obj):
     """
-    Returns True if the given object is a Report.
+    Returns True if the object is a Script.
     """
-    from .reports import Report
+    from .scripts import Script
     try:
-        return issubclass(obj, Report) and obj != Report
+        return issubclass(obj, Script) and obj != Script
     except TypeError:
-        print("TypeError")
         return False
 
 
-def is_script(obj):
+def is_report(obj):
     """
-    Returns True if the object is a Script.
+    Returns True if the given object is a Report.
     """
-
-    # TODO: Deprecated legacy reports support
     from .reports import Report
-    from .scripts import Script
     try:
-        return ((issubclass(obj, Report) and obj != Report) or (issubclass(obj, Script) and obj != Script))
+        return issubclass(obj, Report) and obj != Report
     except TypeError:
         return False

From c03cd6b2b9315c330f19ac8078d2bdf40d256114 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 15:28:01 -0800
Subject: [PATCH 15/32] 12510 review changes

---
 netbox/extras/utils.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index c6b2de18838..2a99405d035 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -51,9 +51,13 @@ def is_script(obj):
     """
     Returns True if the object is a Script.
     """
+    """
+    Returns True if the given object is a Report.
+    """
+    from .reports import Report
     from .scripts import Script
     try:
-        return issubclass(obj, Script) and obj != Script
+        return ((issubclass(obj, Report) and obj != Report) or (issubclass(obj, Script) and obj != Script))
     except TypeError:
         return False
 

From c9f8b780488d13138324012c402bb6ad9861cfb9 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Thu, 1 Feb 2024 16:14:08 -0800
Subject: [PATCH 16/32] 12510 review changes

---
 .../extras/management/commands/runscript.py   | 19 +++++++------------
 netbox/extras/scripts.py                      |  2 +-
 2 files changed, 8 insertions(+), 13 deletions(-)

diff --git a/netbox/extras/management/commands/runscript.py b/netbox/extras/management/commands/runscript.py
index 0346549c8b6..3e60083f034 100644
--- a/netbox/extras/management/commands/runscript.py
+++ b/netbox/extras/management/commands/runscript.py
@@ -34,22 +34,15 @@ def add_arguments(self, parser):
 
     def handle(self, *args, **options):
         def _output_results(job):
-            # Report on success/failure
-            if job.status == JobStatusChoices.STATUS_FAILED:
-                status = self.style.ERROR('FAILED')
-            elif job == JobStatusChoices.STATUS_ERRORED:
-                status = self.style.ERROR('ERRORED')
-            else:
-                status = self.style.SUCCESS('SUCCESS')
-
-            for test_name, attrs in job.data.logs.items():
+
+            for test_name, attrs in job.data['logs'].items():
                 self.stdout.write(
                     "\t{}: {} success, {} info, {} warning, {} failure".format(
                         test_name, attrs['success'], attrs['info'], attrs['warning'], attrs['failure']
                     )
                 )
 
-        def _set_job_data(job, script):
+        def _set_job_data(script):
             logs = script._logs
             job.data = {
                 'logs': logs,
@@ -71,7 +64,7 @@ def _run_script():
                 except AbortTransaction:
                     script.log_info("Database changes have been reverted automatically.")
                     clear_events.send(request)
-                job = _set_job_data(job, script)
+                _set_job_data(script)
                 job.terminate()
             except Exception as e:
                 stacktrace = traceback.format_exc()
@@ -81,9 +74,10 @@ def _run_script():
                 script.log_info("Database changes have been reverted due to error.")
                 logger.error(f"Exception raised during script execution: {e}")
                 clear_events.send(request)
-                job = _set_job_data(job, script)
+                _set_job_data(script)
                 job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
 
+            _output_results(job)
             logger.info(f"Script completed in {job.duration}")
 
         User = get_user_model()
@@ -92,6 +86,7 @@ def _run_script():
         script = options['script']
         loglevel = options['loglevel']
         commit = options['commit']
+
         try:
             data = json.loads(options['data'])
         except TypeError:
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 9297b671664..11537e775ed 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -660,7 +660,7 @@ def _run_script():
             else:
                 script.log_info(msg)
 
-            job = set_job_data(job, script)
+            job = set_job_data(script)
             job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
             if request:
                 clear_events.send(request)

From ed361611e437eebf2c19491f9344cf13736d12c3 Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 2 Feb 2024 07:21:02 -0800
Subject: [PATCH 17/32] 12510 main log results to empty string

---
 netbox/extras/scripts.py | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 11537e775ed..a40ac7c91c3 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -275,7 +275,7 @@ class Meta:
     def __init__(self):
         self._logs = {}
         self._failed = False
-        self._current_method = 'unassigned'
+        self._current_method = ''
         self._output = ''
 
         # Initiate the log
@@ -285,7 +285,7 @@ def __init__(self):
         self.request = None
 
         # Compile test methods and initialize results skeleton
-        self._logs['unassigned'] = {
+        self._logs[''] = {
             'success': 0,
             'info': 0,
             'warning': 0,
@@ -456,8 +456,8 @@ def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=l
         if log_level != LogLevelChoices.LOG_DEFAULT:
             self._logs[self._current_method][log_level] += 1
 
-            if self._current_method != 'unassigned':
-                self._logs['unassigned'][log_level] += 1
+            if self._current_method != '':
+                self._logs[''][log_level] += 1
 
         if obj:
             self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
@@ -526,10 +526,10 @@ def run_tests(self):
                 test_method()
         except Exception as e:
             self.post_run()
-            self._current_method = 'unassigned'
+            self._current_method = ''
             raise e
 
-        self._current_method = 'unassigned'
+        self._current_method = ''
 
     def run(self, data, commit):
         self.pre_run()

From 7fe0ee5104fc89107fba0102400bae1ebbedc24e Mon Sep 17 00:00:00 2001
From: Arthur <worldnomad@gmail.com>
Date: Fri, 2 Feb 2024 07:25:41 -0800
Subject: [PATCH 18/32] 12510 move migration

---
 .../migrations/0011_job_report_to_script.py   | 28 -------------------
 .../0106_delete_report_delete_reportmodule.py | 16 ++++++++++-
 2 files changed, 15 insertions(+), 29 deletions(-)
 delete mode 100644 netbox/core/migrations/0011_job_report_to_script.py

diff --git a/netbox/core/migrations/0011_job_report_to_script.py b/netbox/core/migrations/0011_job_report_to_script.py
deleted file mode 100644
index 25bc181c48e..00000000000
--- a/netbox/core/migrations/0011_job_report_to_script.py
+++ /dev/null
@@ -1,28 +0,0 @@
-# Generated by Django 5.0.1 on 2024-01-26 18:11
-
-from django.db import migrations
-
-
-def migrate_report_jobs(apps, schema_editor):
-    ContentType = apps.get_model('contenttypes', 'ContentType')
-    Job = apps.get_model('core', 'Job')
-
-    # Delete the new ContentType effected by the introduction of core.ConfigRevision
-    if ContentType.objects.filter(app_label='extras', model='reportmodule'):
-        report_content_type = ContentType.objects.get(app_label='extras', model='reportmodule')
-        script_content_type = ContentType.objects.get(app_label='extras', model='scriptmodule')
-        jobs = Job.objects.filter(object_type_id=report_content_type.id).update(object_type_id=script_content_type.id)
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('core', '0010_gfk_indexes'),
-    ]
-
-    operations = [
-        migrations.RunPython(
-            code=migrate_report_jobs,
-            reverse_code=migrations.RunPython.noop
-        ),
-    ]
diff --git a/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py b/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py
index 3eb98d56f5f..8ebd2c004fc 100644
--- a/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py
+++ b/netbox/extras/migrations/0106_delete_report_delete_reportmodule.py
@@ -3,14 +3,28 @@
 from django.db import migrations
 
 
+def migrate_report_jobs(apps, schema_editor):
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    Job = apps.get_model('core', 'Job')
+
+    # Delete the new ContentType effected by the introduction of core.ConfigRevision
+    if ContentType.objects.filter(app_label='extras', model='reportmodule'):
+        report_content_type = ContentType.objects.get(app_label='extras', model='reportmodule')
+        script_content_type = ContentType.objects.get(app_label='extras', model='scriptmodule')
+        jobs = Job.objects.filter(object_type_id=report_content_type.id).update(object_type_id=script_content_type.id)
+
+
 class Migration(migrations.Migration):
 
     dependencies = [
         ('extras', '0105_customfield_min_max_values'),
-        ('core', '0011_job_report_to_script'),
     ]
 
     operations = [
+        migrations.RunPython(
+            code=migrate_report_jobs,
+            reverse_code=migrations.RunPython.noop
+        ),
         migrations.DeleteModel(
             name='Report',
         ),

From d7bcf3d4cc00258fba4b0979789c5d46e280cafe Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Mon, 5 Feb 2024 16:37:39 -0500
Subject: [PATCH 19/32] Introduce an internal log level for debug to simplify
 Script logging

---
 netbox/extras/choices.py | 13 ++++++++
 netbox/extras/reports.py | 14 +++++++++
 netbox/extras/scripts.py | 64 +++++++++++++++++++---------------------
 3 files changed, 58 insertions(+), 33 deletions(-)

diff --git a/netbox/extras/choices.py b/netbox/extras/choices.py
index 14179fb397c..d4b41aba94b 100644
--- a/netbox/extras/choices.py
+++ b/netbox/extras/choices.py
@@ -1,3 +1,5 @@
+import logging
+
 from django.utils.translation import gettext_lazy as _
 
 from utilities.choices import ButtonColorChoices, ChoiceSet
@@ -164,6 +166,7 @@ class JournalEntryKindChoices(ChoiceSet):
 
 class LogLevelChoices(ChoiceSet):
 
+    LOG_DEBUG = 'debug'
     LOG_DEFAULT = 'default'
     LOG_SUCCESS = 'success'
     LOG_INFO = 'info'
@@ -171,6 +174,7 @@ class LogLevelChoices(ChoiceSet):
     LOG_FAILURE = 'failure'
 
     CHOICES = (
+        (LOG_DEBUG, _('Debug'), 'teal'),
         (LOG_DEFAULT, _('Default'), 'gray'),
         (LOG_SUCCESS, _('Success'), 'green'),
         (LOG_INFO, _('Info'), 'cyan'),
@@ -178,6 +182,15 @@ class LogLevelChoices(ChoiceSet):
         (LOG_FAILURE, _('Failure'), 'red'),
     )
 
+    SYSTEM_LEVELS = {
+        LOG_DEBUG: logging.DEBUG,
+        LOG_DEFAULT: logging.INFO,
+        LOG_SUCCESS: logging.INFO,
+        LOG_INFO: logging.INFO,
+        LOG_WARNING: logging.WARNING,
+        LOG_FAILURE: logging.ERROR,
+    }
+
 
 class DurationChoices(ChoiceSet):
 
diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py
index 54f80b0c4ef..09a0132123b 100644
--- a/netbox/extras/reports.py
+++ b/netbox/extras/reports.py
@@ -1,3 +1,4 @@
+from .choices import LogLevelChoices
 from .scripts import BaseScript
 
 __all__ = (
@@ -6,6 +7,15 @@
 
 
 class Report(BaseScript):
+
+    #
+    # Legacy logging methods for Reports
+    #
+
+    # There is no generic log() equivalent on BaseScript
+    def log(self, message):
+        self._log(message, None, level=LogLevelChoices.LOG_DEFAULT)
+
     def log_success(self, obj=None, message=None):
         super().log_success(message, obj)
 
@@ -17,3 +27,7 @@ def log_warning(self, obj=None, message=None):
 
     def log_failure(self, obj=None, message=None):
         super().log_failure(message, obj)
+
+    # Added in v4.0 to avoid confusion with the log_debug() method provided by BaseScript
+    def log_debug(self, obj=None, message=None):
+        super().log_debug(message, obj)
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index a40ac7c91c3..2696a75b81c 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -286,10 +286,10 @@ def __init__(self):
 
         # Compile test methods and initialize results skeleton
         self._logs[''] = {
-            'success': 0,
-            'info': 0,
-            'warning': 0,
-            'failure': 0,
+            LogLevelChoices.LOG_SUCCESS: 0,
+            LogLevelChoices.LOG_INFO: 0,
+            LogLevelChoices.LOG_WARNING: 0,
+            LogLevelChoices.LOG_FAILURE: 0,
             'log': [],
         }
         test_methods = []
@@ -297,10 +297,10 @@ def __init__(self):
             if method.startswith('test_') and callable(getattr(self, method)):
                 test_methods.append(method)
                 self._logs[method] = {
-                    'success': 0,
-                    'info': 0,
-                    'warning': 0,
-                    'failure': 0,
+                    LogLevelChoices.LOG_SUCCESS: 0,
+                    LogLevelChoices.LOG_INFO: 0,
+                    LogLevelChoices.LOG_WARNING: 0,
+                    LogLevelChoices.LOG_FAILURE: 0,
                     'log': [],
                 }
         self.test_methods = test_methods
@@ -437,53 +437,51 @@ def as_form(self, data=None, files=None, initial=None):
 
     # Logging
 
-    def _log(self, message, obj=None, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.INFO):
+    def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
         """
-        Log a message from a test method. Do not call this method directly; use one of the log_* wrappers below.
+        Log a message. Do not call this method directly; use one of the log_* wrappers below.
         """
-        if log_level not in LogLevelChoices.values():
-            raise Exception(f"Unknown logging level: {log_level}")
+        if level not in LogLevelChoices.values():
+            raise ValueError(f"Invalid logging level: {level}")
 
         if message:
+
+            # Record to the script's log
             self._logs[self._current_method]['log'].append((
                 timezone.now().isoformat(),
-                log_level,
+                level,
                 str(obj) if obj else None,
                 obj.get_absolute_url() if hasattr(obj, 'get_absolute_url') else None,
-                message,
+                str(message),
             ))
 
-        if log_level != LogLevelChoices.LOG_DEFAULT:
-            self._logs[self._current_method][log_level] += 1
-
-            if self._current_method != '':
-                self._logs[''][log_level] += 1
+            # Record to the system log
+            if obj:
+                message = f"{obj}: {message}"
+            self.logger.log(LogLevelChoices.SYSTEM_LEVELS[level], message)
 
-        if obj:
-            self.logger.log(level, f"{log_level.capitalize()} | {obj}: {message}")
-        else:
-            self.logger.log(level, message)  # No syslog equivalent for SUCCESS
+        # Increment the event counter for this level if applicable
+        if level in self._logs[self._current_method]:
+            self._logs[self._current_method][level] += 1
 
-    def log(self, message):
-        """
-        Log a message which is not associated with a particular object.
-        """
-        self._log(str(message), None, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.INFO)
+            # For individual test methods, increment the global counter as well
+            if self._current_method:
+                self._logs[''][level] += 1
 
     def log_debug(self, message, obj=None):
-        self._log(str(message), obj, log_level=LogLevelChoices.LOG_DEFAULT, level=logging.DEBUG)
+        self._log(message, obj, level=LogLevelChoices.LOG_DEBUG)
 
     def log_success(self, message, obj=None):
-        self._log(str(message), obj, log_level=LogLevelChoices.LOG_SUCCESS, level=logging.INFO)
+        self._log(message, obj, level=LogLevelChoices.LOG_SUCCESS)
 
     def log_info(self, message, obj=None):
-        self._log(str(message), obj, log_level=LogLevelChoices.LOG_INFO, level=logging.INFO)
+        self._log(message, obj, level=LogLevelChoices.LOG_INFO)
 
     def log_warning(self, message, obj=None):
-        self._log(str(message), obj, log_level=LogLevelChoices.LOG_WARNING, level=logging.WARNING)
+        self._log(message, obj, level=LogLevelChoices.LOG_WARNING)
 
     def log_failure(self, message, obj=None):
-        self._log(str(message), obj, log_level=LogLevelChoices.LOG_FAILURE, level=logging.ERROR)
+        self._log(message, obj, level=LogLevelChoices.LOG_FAILURE)
         self._failed = True
 
     # Convenience functions

From 8e2e4979b08e638e9860c7c72869f120bd47feee Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 13:42:21 -0500
Subject: [PATCH 20/32] Misc cleanup

---
 netbox/extras/scripts.py | 28 ++++++++++++++++++++--------
 netbox/extras/utils.py   |  7 ++-----
 2 files changed, 22 insertions(+), 13 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 2696a75b81c..afb68d37d27 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -394,9 +394,18 @@ def _get_vars(cls):
         return ordered_vars
 
     def run(self, data, commit):
-        raise NotImplementedError("The script must define a run() method.")
+        """
+        Override this method with custom script logic.
+        """
+
+        # Backward compatibility for legacy Reports
+        self.pre_run()
+        self.run_tests()
+        self.post_run()
 
+    #
     # Form rendering
+    #
 
     def get_fieldsets(self):
         fieldsets = []
@@ -435,7 +444,9 @@ def as_form(self, data=None, files=None, initial=None):
 
         return form
 
+    #
     # Logging
+    #
 
     def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
         """
@@ -484,7 +495,9 @@ def log_failure(self, message, obj=None):
         self._log(message, obj, level=LogLevelChoices.LOG_FAILURE)
         self._failed = True
 
+    #
     # Convenience functions
+    #
 
     def load_yaml(self, filename):
         """
@@ -511,6 +524,10 @@ def load_json(self, filename):
 
         return data
 
+    #
+    # Legacy Report functionality
+    #
+
     def run_tests(self):
         """
         Run the report and save its results. Each test method will be executed in order.
@@ -529,20 +546,15 @@ def run_tests(self):
 
         self._current_method = ''
 
-    def run(self, data, commit):
-        self.pre_run()
-        self.run_tests()
-        self.post_run()
-
     def pre_run(self):
         """
-        Extend this method to include any tasks which should execute *before* the report is run.
+        Legacy method for operations performed immediately prior to running a Report.
         """
         pass
 
     def post_run(self):
         """
-        Extend this method to include any tasks which should execute *after* the report is run.
+        Legacy method for operations performed immediately after running a Report.
         """
         pass
 
diff --git a/netbox/extras/utils.py b/netbox/extras/utils.py
index 2a99405d035..a3a6670cf86 100644
--- a/netbox/extras/utils.py
+++ b/netbox/extras/utils.py
@@ -49,15 +49,12 @@ def register_features(model, features):
 
 def is_script(obj):
     """
-    Returns True if the object is a Script.
-    """
-    """
-    Returns True if the given object is a Report.
+    Returns True if the object is a Script or Report.
     """
     from .reports import Report
     from .scripts import Script
     try:
-        return ((issubclass(obj, Report) and obj != Report) or (issubclass(obj, Script) and obj != Script))
+        return (issubclass(obj, Report) and obj != Report) or (issubclass(obj, Script) and obj != Script)
     except TypeError:
         return False
 

From f3ef004e0432ecf5b5daf9b6a5d70b2286ca21e7 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 14:18:39 -0500
Subject: [PATCH 21/32] Remove obsolete is_valid() method

---
 netbox/extras/scripts.py                 |  7 -------
 netbox/templates/extras/script_list.html | 12 ++----------
 2 files changed, 2 insertions(+), 17 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index afb68d37d27..3e914e5acb6 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -362,13 +362,6 @@ def filename(self):
     def source(self):
         return inspect.getsource(self.__class__)
 
-    @property
-    def is_valid(self):
-        """
-        Indicates whether the report can be run.
-        """
-        return bool(self.test_methods)
-
     @classmethod
     def _get_vars(cls):
         vars = {}
diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
index 0c58c1eb355..448de2c8d7c 100644
--- a/netbox/templates/extras/script_list.html
+++ b/netbox/templates/extras/script_list.html
@@ -62,18 +62,10 @@ <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
                         </td>
                       {% else %}
                         <td class="text-muted">{% trans "Never" %}</td>
-                        <td>
-                          {% if script.is_valid %}
-                            {{ ''|placeholder }}
-                          {% else %}
-                            <span class="badge text-bg-danger" title="{% trans "Script has no methods" %}">
-                              {% trans "Invalid" %}
-                            </span>
-                          {% endif %}
-                        </td>
+                        <td>{{ ''|placeholder }}</td>
                       {% endif %}
                       <td>
-                        {% if perms.extras.run_script and script.is_valid %}
+                        {% if perms.extras.run_script %}
                           <div class="float-end d-print-none">
                             <form action="{% url 'extras:script' module=script.module name=script.class_name %}" method="post">
                               {% csrf_token %}

From ece5b4635e13866e8aafca9fdbbd667335c18bb5 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 16:38:17 -0500
Subject: [PATCH 22/32] Reformat script job data (log, output, tests)

---
 netbox/extras/scripts.py                      |  61 ++++-----
 netbox/extras/views.py                        |  34 ++---
 .../extras/htmx/legacy_report_result.html     |  81 -----------
 .../extras/htmx/legacy_script_result.html     |  58 --------
 .../templates/extras/htmx/script_result.html  | 129 ++++++++++++------
 netbox/templates/extras/script_result.html    |   8 +-
 6 files changed, 129 insertions(+), 242 deletions(-)
 delete mode 100644 netbox/templates/extras/htmx/legacy_report_result.html
 delete mode 100644 netbox/templates/extras/htmx/legacy_script_result.html

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 3e914e5acb6..5c87483a433 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -273,10 +273,11 @@ class Meta:
         pass
 
     def __init__(self):
-        self._logs = {}
-        self._failed = False
-        self._current_method = ''
-        self._output = ''
+        self.messages = []  # Primary script log
+        self.tests = {}  # Mapping of logs for test methods
+        self.output = ''
+        self.failed = False
+        self._current_method = ''  # Tracks the current test method being run (if any)
 
         # Initiate the log
         self.logger = logging.getLogger(f"netbox.scripts.{self.__module__}.{self.__class__.__name__}")
@@ -285,25 +286,15 @@ def __init__(self):
         self.request = None
 
         # Compile test methods and initialize results skeleton
-        self._logs[''] = {
-            LogLevelChoices.LOG_SUCCESS: 0,
-            LogLevelChoices.LOG_INFO: 0,
-            LogLevelChoices.LOG_WARNING: 0,
-            LogLevelChoices.LOG_FAILURE: 0,
-            'log': [],
-        }
-        test_methods = []
         for method in dir(self):
             if method.startswith('test_') and callable(getattr(self, method)):
-                test_methods.append(method)
-                self._logs[method] = {
+                self.tests[method] = {
                     LogLevelChoices.LOG_SUCCESS: 0,
                     LogLevelChoices.LOG_INFO: 0,
                     LogLevelChoices.LOG_WARNING: 0,
                     LogLevelChoices.LOG_FAILURE: 0,
                     'log': [],
                 }
-        self.test_methods = test_methods
 
     def __str__(self):
         return self.name
@@ -448,10 +439,10 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
         if level not in LogLevelChoices.values():
             raise ValueError(f"Invalid logging level: {level}")
 
-        if message:
+        # A test method is currently active, so log the message using legacy Report logging
+        if self._current_method:
 
-            # Record to the script's log
-            self._logs[self._current_method]['log'].append((
+            self.tests[self._current_method]['log'].append((
                 timezone.now().isoformat(),
                 level,
                 str(obj) if obj else None,
@@ -459,19 +450,22 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
                 str(message),
             ))
 
+            # Increment the event counter for this level
+            if level in self.tests[self._current_method]:
+                self.tests[self._current_method][level] += 1
+
+        elif message:
+
+            # Record to the script's log
+            self.messages.append(
+                (level, str(message))
+            )
+
             # Record to the system log
             if obj:
                 message = f"{obj}: {message}"
             self.logger.log(LogLevelChoices.SYSTEM_LEVELS[level], message)
 
-        # Increment the event counter for this level if applicable
-        if level in self._logs[self._current_method]:
-            self._logs[self._current_method][level] += 1
-
-            # For individual test methods, increment the global counter as well
-            if self._current_method:
-                self._logs[''][level] += 1
-
     def log_debug(self, message, obj=None):
         self._log(message, obj, level=LogLevelChoices.LOG_DEBUG)
 
@@ -486,7 +480,7 @@ def log_warning(self, message, obj=None):
 
     def log_failure(self, message, obj=None):
         self._log(message, obj, level=LogLevelChoices.LOG_FAILURE)
-        self._failed = True
+        self.failed = True
 
     #
     # Convenience functions
@@ -528,7 +522,7 @@ def run_tests(self):
         self.logger.info(f"Running report")
 
         try:
-            for method_name in self.test_methods:
+            for method_name in self.tests:
                 self._current_method = method_name
                 test_method = getattr(self, method_name)
                 test_method()
@@ -606,11 +600,12 @@ def run_script(data, job, request=None, commit=True, **kwargs):
     script.request = request
 
     def set_job_data(script):
-        logs = script._logs
         job.data = {
-            'logs': logs,
-            'output': script._output,
+            'log': script.messages,
+            'output': script.output,
+            'tests': script.tests,
         }
+
         return job
 
     def _run_script():
@@ -621,7 +616,7 @@ def _run_script():
         try:
             try:
                 with transaction.atomic():
-                    script._output = script.run(data, commit)
+                    script.output = script.run(data, commit)
                     if not commit:
                         raise AbortTransaction()
             except AbortTransaction:
@@ -635,7 +630,7 @@ def _run_script():
                 if request:
                     clear_events.send(request)
             job = set_job_data(script)
-            if script._failed:
+            if script.failed:
                 logger.warning(f"Script failed")
                 job.terminate(status=JobStatusChoices.STATUS_FAILED)
             else:
diff --git a/netbox/extras/views.py b/netbox/extras/views.py
index b4f87e63304..de65d64f96b 100644
--- a/netbox/extras/views.py
+++ b/netbox/extras/views.py
@@ -1153,32 +1153,28 @@ def get(self, request, job_pk):
         module = job.object
         script = module.scripts[job.name]()
 
-        legacy_script = False
-        legacy_report = False
-        if job.data and ('logs' not in job.data):
-            if 'log' in job.data:
-                legacy_script = True
-            else:
-                legacy_report = True
+        context = {
+            'script': script,
+            'job': job,
+        }
+        if job.data and 'log' in job.data:
+            # Script
+            context['tests'] = job.data.get('tests', {})
+        elif job.data:
+            # Legacy Report
+            context['tests'] = {
+                name: data for name, data in job.data.items()
+                if name.startswith('test_')
+            }
 
         # If this is an HTMX request, return only the result HTML
         if request.htmx:
-            response = render(request, 'extras/htmx/script_result.html', {
-                'script': script,
-                'job': job,
-                'legacy_script': legacy_script,
-                'legacy_report': legacy_report,
-            })
+            response = render(request, 'extras/htmx/script_result.html', context)
             if job.completed or not job.started:
                 response.status_code = 286
             return response
 
-        return render(request, 'extras/script_result.html', {
-            'script': script,
-            'job': job,
-            'legacy_script': legacy_script,
-            'legacy_report': legacy_report,
-        })
+        return render(request, 'extras/script_result.html', context)
 
 
 #
diff --git a/netbox/templates/extras/htmx/legacy_report_result.html b/netbox/templates/extras/htmx/legacy_report_result.html
deleted file mode 100644
index e6b6caf7317..00000000000
--- a/netbox/templates/extras/htmx/legacy_report_result.html
+++ /dev/null
@@ -1,81 +0,0 @@
-{% load humanize %}
-{% load helpers %}
-{% load i18n %}
-
-<p>
-  {% if job.started %}
-    {% trans "Started" %}: <strong>{{ job.started|annotated_date }}</strong>
-  {% elif job.scheduled %}
-    {% trans "Scheduled for" %}: <strong>{{ job.scheduled|annotated_date }}</strong> ({{ job.scheduled|naturaltime }})
-  {% else %}
-    {% trans "Created" %}: <strong>{{ job.created|annotated_date }}</strong>
-  {% endif %}
-  {% if job.completed %}
-    {% trans "Duration" %}: <strong>{{ job.duration }}</strong>
-  {% endif %}
-  <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
-</p>
-{% if job.completed %}
-  <div class="card">
-    <h5 class="card-header">{% trans "Report Methods" %}</h5>
-    <div class="card-body">
-      <table class="table table-hover">
-        {% for method, data in job.data.items %}
-          <tr>
-            <td class="font-monospace"><a href="#{{ method }}">{{ method }}</a></td>
-            <td class="text-end report-stats">
-              <span class="badge bg-success">{{ data.success }}</span>
-              <span class="badge bg-info">{{ data.info }}</span>
-              <span class="badge bg-warning">{{ data.warning }}</span>
-              <span class="badge bg-danger">{{ data.failure }}</span>
-            </td>
-          </tr>
-        {% endfor %}
-      </table>
-    </div>
-  </div>
-  <div class="card">
-    <h5 class="card-header">{% trans "Report Results" %}</h5>
-    <div class="card-body">
-      <table class="table table-hover report">
-        <thead>
-          <tr class="table-headings">
-            <th>{% trans "Time" %}</th>
-            <th>{% trans "Level" %}</th>
-            <th>{% trans "Object" %}</th>
-            <th>{% trans "Message" %}</th>
-          </tr>
-        </thead>
-        <tbody>
-          {% for method, data in job.data.items %}
-            <tr>
-              <th colspan="4" style="font-family: monospace">
-                <a name="{{ method }}"></a>{{ method }}
-              </th>
-            </tr>
-            {% for time, level, obj, url, message in data.log %}
-              <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
-                <td>{{ time }}</td>
-                <td>
-                  <label class="badge bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
-                </td>
-                <td>
-                  {% if obj and url %}
-                    <a href="{{ url }}">{{ obj }}</a>
-                  {% elif obj %}
-                    {{ obj }}
-                  {% else %}
-                    {{ ''|placeholder }}
-                  {% endif %}
-                </td>
-                <td class="rendered-markdown">{{ message|markdown }}</td>
-              </tr>
-            {% endfor %}
-          {% endfor %}
-        </tbody>
-      </table>
-    </div>
-  </div>
-{% elif job.started %}
-  {% include 'extras/inc/result_pending.html' %}
-{% endif %}
diff --git a/netbox/templates/extras/htmx/legacy_script_result.html b/netbox/templates/extras/htmx/legacy_script_result.html
deleted file mode 100644
index ddc9b05f609..00000000000
--- a/netbox/templates/extras/htmx/legacy_script_result.html
+++ /dev/null
@@ -1,58 +0,0 @@
-{% load humanize %}
-{% load helpers %}
-{% load log_levels %}
-{% load i18n %}
-
-<p>
-  {% if job.started %}
-    {% trans "Started" %}: <strong>{{ job.started|annotated_date }}</strong>
-  {% elif job.scheduled %}
-    {% trans "Scheduled for" %}: <strong>{{ job.scheduled|annotated_date }}</strong> ({{ job.scheduled|naturaltime }})
-  {% else %}
-    {% trans "Created" %}: <strong>{{ job.created|annotated_date }}</strong>
-  {% endif %}
-  {% if job.completed %}
-    {% trans "Duration" %}: <strong>{{ job.duration }}</strong>
-  {% endif %}
-  <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
-</p>
-{% if job.completed %}
-  <div class="card mb-3">
-    <h5 class="card-header">{% trans "Script Log" %}</h5>
-    <div class="card-body">
-      <table class="table table-hover panel-body">
-        <tr>
-          <th>{% trans "Line" %}</th>
-          <th>{% trans "Level" %}</th>
-          <th>{% trans "Message" %}</th>
-        </tr>
-        {% for log in job.data.log %}
-          <tr>
-            <td>{{ forloop.counter }}</td>
-            <td>{% log_level log.status %}</td>
-            <td class="rendered-markdown">{{ log.message|markdown }}</td>
-          </tr>
-        {% empty %}
-          <tr>
-            <td colspan="3" class="text-center text-muted">
-              {% trans "No log output" %}
-            </td>
-          </tr>
-        {% endfor %}
-      </table>
-    </div>
-    {% if execution_time %}
-      <div class="card-footer text-end text-muted">
-        <small>{% trans "Exec Time" %}: {{ execution_time|floatformat:3 }} {% trans "seconds" context "Unit of time" %}</small>
-      </div>
-    {% endif %}
-  </div>
-  <h4>{% trans "Output" %}</h4>
-  {% if job.data.output %}
-    <pre class="block">{{ job.data.output }}</pre>
-  {% else %}
-    <p class="text-muted">{% trans "None" %}</p>
-  {% endif %}
-{% elif job.started %}
-  {% include 'extras/inc/result_pending.html' %}
-{% endif %}
diff --git a/netbox/templates/extras/htmx/script_result.html b/netbox/templates/extras/htmx/script_result.html
index f27672d1039..70988f1f019 100644
--- a/netbox/templates/extras/htmx/script_result.html
+++ b/netbox/templates/extras/htmx/script_result.html
@@ -1,5 +1,6 @@
 {% load humanize %}
 {% load helpers %}
+{% load log_levels %}
 {% load i18n %}
 
 <p>
@@ -16,59 +17,99 @@
   <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
 </p>
 {% if job.completed %}
-  <div class="card">
-    <h5 class="card-header">{% trans "Script Methods" %}</h5>
-    <table class="table table-hover">
-      {% for method, data in job.data.logs.items %}
+  <div class="card mb-3">
+    <h5 class="card-header">{% trans "Script Log" %}</h5>
+    <table class="table table-hover panel-body">
+      <tr>
+        <th>{% trans "Line" %}</th>
+        <th>{% trans "Level" %}</th>
+        <th>{% trans "Message" %}</th>
+      </tr>
+      {% for log in job.data.log %}
         <tr>
-          <td class="font-monospace"><a href="#{{ method }}">{{ method }}</a></td>
-          <td class="text-end script-stats">
-            <span class="badge text-bg-success">{{ data.success }}</span>
-            <span class="badge text-bg-info">{{ data.info }}</span>
-            <span class="badge text-bg-warning">{{ data.warning }}</span>
-            <span class="badge text-bg-danger">{{ data.failure }}</span>
+          <td>{{ forloop.counter }}</td>
+          <td>{% log_level log.status %}</td>
+          <td class="rendered-markdown">{{ log.message|markdown }}</td>
+        </tr>
+      {% empty %}
+        <tr>
+          <td colspan="3" class="text-center text-muted">
+            {% trans "No log output" %}
           </td>
         </tr>
       {% endfor %}
     </table>
+    {% if execution_time %}
+      <div class="card-footer text-end text-muted">
+        <small>{% trans "Exec Time" %}: {{ execution_time|floatformat:3 }} {% trans "seconds" context "Unit of time" %}</small>
+      </div>
+    {% endif %}
   </div>
-  <h2 class="card-header">{% trans "Script Results" %}</h2>
+  <h4>{% trans "Output" %}</h4>
+  {% if job.data.output %}
+    <pre class="block">{{ job.data.output }}</pre>
+  {% else %}
+    <p class="text-muted">{% trans "None" %}</p>
+  {% endif %}
 
-  {% for method, data in job.data.logs.items %}
-  <div class="card">
-    <h5 class="card-header"><a name="{{ method }}"></a>{{ method }}</h5>
-    <table class="table table-hover script">
-      <thead>
-        <tr>
-          <th>{% trans "Time" %}</th>
-          <th>{% trans "Level" %}</th>
-          <th>{% trans "Object" %}</th>
-          <th>{% trans "Message" %}</th>
-        </tr>
-      </thead>
-      <tbody>
-          {% for time, level, obj, url, message in data.log %}
-            <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
-              <td>{{ time }}</td>
-              <td>
-                <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
-              </td>
-              <td>
-                {% if obj and url %}
-                  <a href="{{ url }}">{{ obj }}</a>
-                {% elif obj %}
-                  {{ obj }}
-                {% else %}
-                  {{ ''|placeholder }}
-                {% endif %}
-              </td>
-              <td class="rendered-markdown">{{ message|markdown }}</td>
+  {% if tests %}
+    <div class="card">
+      <h5 class="card-header">{% trans "Report Summary" %}</h5>
+      <table class="table table-hover">
+        {% for test, data in tests.items %}
+          <tr>
+            <td class="font-monospace"><a href="#{{ test }}">{{ test }}</a></td>
+            <td class="text-end report-stats">
+              <span class="badge text-bg-success">{{ data.success }}</span>
+              <span class="badge text-bg-info">{{ data.info }}</span>
+              <span class="badge text-bg-warning">{{ data.warning }}</span>
+              <span class="badge text-bg-danger">{{ data.failure }}</span>
+            </td>
+          </tr>
+        {% endfor %}
+      </table>
+    </div>
+    <div class="card">
+      <h5 class="card-header">{% trans "Report Results" %}</h5>
+      <table class="table table-hover report">
+        <thead>
+          <tr class="table-headings">
+            <th>{% trans "Time" %}</th>
+            <th>{% trans "Level" %}</th>
+            <th>{% trans "Object" %}</th>
+            <th>{% trans "Message" %}</th>
+          </tr>
+        </thead>
+        <tbody>
+          {% for test, data in tests.items %}
+            <tr>
+              <th colspan="4" style="font-family: monospace">
+                <a name="{{ test }}"></a>{{ test }}
+              </th>
             </tr>
+            {% for time, level, obj, url, message in data.log %}
+              <tr class="{% if level == 'failure' %}danger{% elif level %}{{ level }}{% endif %}">
+                <td>{{ time }}</td>
+                <td>
+                  <label class="badge text-bg-{% if level == 'failure' %}danger{% else %}{{ level }}{% endif %}">{{ level|title }}</label>
+                </td>
+                <td>
+                  {% if obj and url %}
+                    <a href="{{ url }}">{{ obj }}</a>
+                  {% elif obj %}
+                    {{ obj }}
+                  {% else %}
+                    {{ ''|placeholder }}
+                  {% endif %}
+                </td>
+                <td class="rendered-markdown">{{ message|markdown }}</td>
+              </tr>
+            {% endfor %}
           {% endfor %}
-      </tbody>
-    </table>
-  </div>
-  {% endfor %}
+        </tbody>
+      </table>
+    </div>
+  {% endif %}
 {% elif job.started %}
   {% include 'extras/inc/result_pending.html' %}
 {% endif %}
diff --git a/netbox/templates/extras/script_result.html b/netbox/templates/extras/script_result.html
index 02a01149c86..985c58d634d 100644
--- a/netbox/templates/extras/script_result.html
+++ b/netbox/templates/extras/script_result.html
@@ -44,13 +44,7 @@
   <div role="tabpanel" class="tab-pane active" id="log">
     <div class="row">
       <div class="col col-md-12"{% if not job.completed %} hx-get="{% url 'extras:script_result' job_pk=job.pk %}" hx-trigger="load delay:0.5s, every 5s"{% endif %}>
-        {% if legacy_script %}
-          {% include 'extras/htmx/legacy_script_result.html' %}
-        {% elif legacy_report %}
-          {% include 'extras/htmx/legacy_report_result.html' %}
-        {% else %}
-          {% include 'extras/htmx/script_result.html' %}
-        {% endif %}
+        {% include 'extras/htmx/script_result.html' %}
       </div>
     </div>
   </div>

From 8a570ec52d69f056b943ac41d4294efe74d79296 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 16:43:19 -0500
Subject: [PATCH 23/32] Remove ScriptLogMessageSerializer

---
 netbox/extras/api/serializers.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py
index cbd2a14777e..e2f30e8b0a9 100644
--- a/netbox/extras/api/serializers.py
+++ b/netbox/extras/api/serializers.py
@@ -50,7 +50,6 @@
     'SavedFilterSerializer',
     'ScriptDetailSerializer',
     'ScriptInputSerializer',
-    'ScriptLogMessageSerializer',
     'ScriptSerializer',
     'TagSerializer',
     'WebhookSerializer',

From da5eb0bb621a544a806f422165333db0a7b299e1 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 17:01:23 -0500
Subject: [PATCH 24/32] Fix formatting of script logs

---
 netbox/extras/scripts.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 5c87483a433..0a55d3c6441 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -442,6 +442,7 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
         # A test method is currently active, so log the message using legacy Report logging
         if self._current_method:
 
+            # TODO: Use a dataclass for test method logs
             self.tests[self._current_method]['log'].append((
                 timezone.now().isoformat(),
                 level,
@@ -457,9 +458,10 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
         elif message:
 
             # Record to the script's log
-            self.messages.append(
-                (level, str(message))
-            )
+            self.messages.append({
+                'status': level,
+                'message': str(message),
+            })
 
             # Record to the system log
             if obj:

From e7f24b7e9ce32f85aa085e619b037541f8afd67c Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 17:08:24 -0500
Subject: [PATCH 25/32] Record a timestamp with script logs

---
 netbox/extras/scripts.py                        | 1 +
 netbox/templates/extras/htmx/script_result.html | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index 0a55d3c6441..ed6a106bcc3 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -459,6 +459,7 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
 
             # Record to the script's log
             self.messages.append({
+                'time': timezone.now().isoformat(),
                 'status': level,
                 'message': str(message),
             })
diff --git a/netbox/templates/extras/htmx/script_result.html b/netbox/templates/extras/htmx/script_result.html
index 70988f1f019..79df7b0c0cf 100644
--- a/netbox/templates/extras/htmx/script_result.html
+++ b/netbox/templates/extras/htmx/script_result.html
@@ -22,12 +22,14 @@ <h5 class="card-header">{% trans "Script Log" %}</h5>
     <table class="table table-hover panel-body">
       <tr>
         <th>{% trans "Line" %}</th>
+        <th>{% trans "Time" %}</th>
         <th>{% trans "Level" %}</th>
         <th>{% trans "Message" %}</th>
       </tr>
       {% for log in job.data.log %}
         <tr>
           <td>{{ forloop.counter }}</td>
+          <td>{{ log.time|placeholder }}</td>
           <td>{% log_level log.status %}</td>
           <td class="rendered-markdown">{{ log.message|markdown }}</td>
         </tr>

From d7c6fb5ddee033711e3a2cacf1fe3ebd2ffdeafa Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 17:21:26 -0500
Subject: [PATCH 26/32] Rename _current_method to _current_test

---
 netbox/extras/scripts.py | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index ed6a106bcc3..b1f9ca719ab 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -277,7 +277,7 @@ def __init__(self):
         self.tests = {}  # Mapping of logs for test methods
         self.output = ''
         self.failed = False
-        self._current_method = ''  # Tracks the current test method being run (if any)
+        self._current_test = None  # Tracks the current test method being run (if any)
 
         # Initiate the log
         self.logger = logging.getLogger(f"netbox.scripts.{self.__module__}.{self.__class__.__name__}")
@@ -440,10 +440,10 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
             raise ValueError(f"Invalid logging level: {level}")
 
         # A test method is currently active, so log the message using legacy Report logging
-        if self._current_method:
+        if self._current_test:
 
             # TODO: Use a dataclass for test method logs
-            self.tests[self._current_method]['log'].append((
+            self.tests[self._current_test]['log'].append((
                 timezone.now().isoformat(),
                 level,
                 str(obj) if obj else None,
@@ -452,8 +452,8 @@ def _log(self, message, obj=None, level=LogLevelChoices.LOG_DEFAULT):
             ))
 
             # Increment the event counter for this level
-            if level in self.tests[self._current_method]:
-                self.tests[self._current_method][level] += 1
+            if level in self.tests[self._current_test]:
+                self.tests[self._current_test][level] += 1
 
         elif message:
 
@@ -525,17 +525,16 @@ def run_tests(self):
         self.logger.info(f"Running report")
 
         try:
-            for method_name in self.tests:
-                self._current_method = method_name
-                test_method = getattr(self, method_name)
+            for test_name in self.tests:
+                self._current_test = test_name
+                test_method = getattr(self, test_name)
                 test_method()
+                self._current_test = None
         except Exception as e:
+            self._current_test = None
             self.post_run()
-            self._current_method = ''
             raise e
 
-        self._current_method = ''
-
     def pre_run(self):
         """
         Legacy method for operations performed immediately prior to running a Report.

From 8bb719661d5daa5a5c1e009d4d2373e091d11a5b Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Tue, 6 Feb 2024 17:33:32 -0500
Subject: [PATCH 27/32] Clean up template

---
 .../templates/extras/htmx/script_result.html  | 83 ++++++++++---------
 1 file changed, 46 insertions(+), 37 deletions(-)

diff --git a/netbox/templates/extras/htmx/script_result.html b/netbox/templates/extras/htmx/script_result.html
index 79df7b0c0cf..ed5dd9cbd29 100644
--- a/netbox/templates/extras/htmx/script_result.html
+++ b/netbox/templates/extras/htmx/script_result.html
@@ -17,46 +17,52 @@
   <span id="pending-result-label">{% badge job.get_status_display job.get_status_color %}</span>
 </p>
 {% if job.completed %}
-  <div class="card mb-3">
-    <h5 class="card-header">{% trans "Script Log" %}</h5>
-    <table class="table table-hover panel-body">
-      <tr>
-        <th>{% trans "Line" %}</th>
-        <th>{% trans "Time" %}</th>
-        <th>{% trans "Level" %}</th>
-        <th>{% trans "Message" %}</th>
-      </tr>
-      {% for log in job.data.log %}
-        <tr>
-          <td>{{ forloop.counter }}</td>
-          <td>{{ log.time|placeholder }}</td>
-          <td>{% log_level log.status %}</td>
-          <td class="rendered-markdown">{{ log.message|markdown }}</td>
-        </tr>
-      {% empty %}
-        <tr>
-          <td colspan="3" class="text-center text-muted">
-            {% trans "No log output" %}
-          </td>
-        </tr>
-      {% endfor %}
-    </table>
-    {% if execution_time %}
-      <div class="card-footer text-end text-muted">
-        <small>{% trans "Exec Time" %}: {{ execution_time|floatformat:3 }} {% trans "seconds" context "Unit of time" %}</small>
-      </div>
-    {% endif %}
-  </div>
-  <h4>{% trans "Output" %}</h4>
-  {% if job.data.output %}
-    <pre class="block">{{ job.data.output }}</pre>
-  {% else %}
-    <p class="text-muted">{% trans "None" %}</p>
+
+  {# Script log. Legacy reports will not have this. #}
+  {% if 'log' in job.data %}
+    <div class="card mb-3">
+      <h5 class="card-header">{% trans "Log" %}</h5>
+      {% if job.data.log %}
+        <table class="table table-hover panel-body">
+          <tr>
+            <th>{% trans "Line" %}</th>
+            <th>{% trans "Time" %}</th>
+            <th>{% trans "Level" %}</th>
+            <th>{% trans "Message" %}</th>
+          </tr>
+          {% for log in job.data.log %}
+            <tr>
+              <td>{{ forloop.counter }}</td>
+              <td>{{ log.time|placeholder }}</td>
+              <td>{% log_level log.status %}</td>
+              <td>{{ log.message|markdown }}</td>
+            </tr>
+          {% endfor %}
+        </table>
+      {% else %}
+        <div class="card-body text-muted">{% trans "None" %}</div>
+      {% endif %}
+    </div>
+  {% endif %}
+
+  {# Script output. Legacy reports will not have this. #}
+  {% if 'output' in job.data %}
+    <div class="card mb-3">
+    <h5 class="card-header">{% trans "Output" %}</h5>
+      {% if job.data.output %}
+        <pre class="card-body font-monospace">{{ job.data.output }}</pre>
+      {% else %}
+        <div class="card-body text-muted">{% trans "None" %}</div>
+      {% endif %}
+    </div>
   {% endif %}
 
+  {# Test method logs (for legacy Reports) #}
   {% if tests %}
+
+    {# Summary of test methods #}
     <div class="card">
-      <h5 class="card-header">{% trans "Report Summary" %}</h5>
+      <h5 class="card-header">{% trans "Test Summary" %}</h5>
       <table class="table table-hover">
         {% for test, data in tests.items %}
           <tr>
@@ -71,8 +77,10 @@ <h5 class="card-header">{% trans "Report Summary" %}</h5>
         {% endfor %}
       </table>
     </div>
+
+    {# Detailed results for individual tests #}
     <div class="card">
-      <h5 class="card-header">{% trans "Report Results" %}</h5>
+      <h5 class="card-header">{% trans "Test Details" %}</h5>
       <table class="table table-hover report">
         <thead>
           <tr class="table-headings">
@@ -111,6 +119,7 @@ <h5 class="card-header">{% trans "Report Results" %}</h5>
         </tbody>
       </table>
     </div>
+
   {% endif %}
 {% elif job.started %}
   {% include 'extras/inc/result_pending.html' %}

From ee429c03287e0f067f97f2c0e14062bdaf4899ca Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Wed, 7 Feb 2024 08:09:11 -0500
Subject: [PATCH 28/32] Remove obsolete runreport management command

---
 .../extras/management/commands/runreport.py   | 65 -------------------
 1 file changed, 65 deletions(-)
 delete mode 100644 netbox/extras/management/commands/runreport.py

diff --git a/netbox/extras/management/commands/runreport.py b/netbox/extras/management/commands/runreport.py
deleted file mode 100644
index 808e07cdfd4..00000000000
--- a/netbox/extras/management/commands/runreport.py
+++ /dev/null
@@ -1,65 +0,0 @@
-import time
-
-from django.core.management.base import BaseCommand
-from django.utils import timezone
-
-from core.choices import JobStatusChoices
-from core.models import Job
-from extras.models import ReportModule
-from extras.reports import run_report
-
-
-class Command(BaseCommand):
-    help = "Run a report to validate data in NetBox"
-
-    def add_arguments(self, parser):
-        parser.add_argument('reports', nargs='+', help="Report(s) to run")
-
-    def handle(self, *args, **options):
-
-        for module in ReportModule.objects.all():
-            for report in module.reports.values():
-                if module.name in options['reports'] or report.full_name in options['reports']:
-
-                    # Run the report and create a new Job
-                    self.stdout.write(
-                        "[{:%H:%M:%S}] Running {}...".format(timezone.now(), report.full_name)
-                    )
-
-                    job = Job.enqueue(
-                        run_report,
-                        instance=module,
-                        name=report.class_name,
-                        job_timeout=report.job_timeout
-                    )
-
-                    # Wait on the job to finish
-                    while job.status not in JobStatusChoices.TERMINAL_STATE_CHOICES:
-                        time.sleep(1)
-                        job = Job.objects.get(pk=job.pk)
-
-                    # Report on success/failure
-                    if job.status == JobStatusChoices.STATUS_FAILED:
-                        status = self.style.ERROR('FAILED')
-                    elif job == JobStatusChoices.STATUS_ERRORED:
-                        status = self.style.ERROR('ERRORED')
-                    else:
-                        status = self.style.SUCCESS('SUCCESS')
-
-                    for test_name, attrs in job.data.items():
-                        self.stdout.write(
-                            "\t{}: {} success, {} info, {} warning, {} failure".format(
-                                test_name, attrs['success'], attrs['info'], attrs['warning'], attrs['failure']
-                            )
-                        )
-                    self.stdout.write(
-                        "[{:%H:%M:%S}] {}: {}".format(timezone.now(), report.full_name, status)
-                    )
-                    self.stdout.write(
-                        "[{:%H:%M:%S}] {}: Duration {}".format(timezone.now(), report.full_name, job.duration)
-                    )
-
-        # Wrap things up
-        self.stdout.write(
-            "[{:%H:%M:%S}] Finished".format(timezone.now())
-        )

From 5939e1d4405701a1983736f3abf9585507a524b0 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Wed, 7 Feb 2024 08:56:53 -0500
Subject: [PATCH 29/32] Misc cleanup & refactoring

---
 .../extras/management/commands/runscript.py   | 29 +++++-------
 netbox/extras/scripts.py                      | 44 +++++++++----------
 2 files changed, 32 insertions(+), 41 deletions(-)

diff --git a/netbox/extras/management/commands/runscript.py b/netbox/extras/management/commands/runscript.py
index 3e60083f034..2098b7a82b8 100644
--- a/netbox/extras/management/commands/runscript.py
+++ b/netbox/extras/management/commands/runscript.py
@@ -33,22 +33,6 @@ def add_arguments(self, parser):
         parser.add_argument('script', help="Script to run")
 
     def handle(self, *args, **options):
-        def _output_results(job):
-
-            for test_name, attrs in job.data['logs'].items():
-                self.stdout.write(
-                    "\t{}: {} success, {} info, {} warning, {} failure".format(
-                        test_name, attrs['success'], attrs['info'], attrs['warning'], attrs['failure']
-                    )
-                )
-
-        def _set_job_data(script):
-            logs = script._logs
-            job.data = {
-                'logs': logs,
-                'output': script._output,
-            }
-            return job
 
         def _run_script():
             """
@@ -64,7 +48,7 @@ def _run_script():
                 except AbortTransaction:
                     script.log_info("Database changes have been reverted automatically.")
                     clear_events.send(request)
-                _set_job_data(script)
+                job.data = script.get_job_data()
                 job.terminate()
             except Exception as e:
                 stacktrace = traceback.format_exc()
@@ -74,10 +58,17 @@ def _run_script():
                 script.log_info("Database changes have been reverted due to error.")
                 logger.error(f"Exception raised during script execution: {e}")
                 clear_events.send(request)
-                _set_job_data(script)
+                job.data = script.get_job_data()
                 job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
 
-            _output_results(job)
+            # Print any test method results
+            for test_name, attrs in job.data['tests'].items():
+                self.stdout.write(
+                    "\t{}: {} success, {} info, {} warning, {} failure".format(
+                        test_name, attrs['success'], attrs['info'], attrs['warning'], attrs['failure']
+                    )
+                )
+
             logger.info(f"Script completed in {job.duration}")
 
         User = get_user_model()
diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py
index b1f9ca719ab..40301e5c999 100644
--- a/netbox/extras/scripts.py
+++ b/netbox/extras/scripts.py
@@ -387,6 +387,16 @@ def run(self, data, commit):
         self.run_tests()
         self.post_run()
 
+    def get_job_data(self):
+        """
+        Return a dictionary of data to attach to the script's Job.
+        """
+        return {
+            'log': self.messages,
+            'output': self.output,
+            'tests': self.tests,
+        }
+
     #
     # Form rendering
     #
@@ -610,7 +620,7 @@ def set_job_data(script):
 
         return job
 
-    def _run_script():
+    def _run_script(job):
         """
         Core script execution task. We capture this within a subfunction to allow for conditionally wrapping it with
         the event_tracking context manager (which is bypassed if commit == False).
@@ -622,21 +632,17 @@ def _run_script():
                     if not commit:
                         raise AbortTransaction()
             except AbortTransaction:
-                msg = _("Database changes have been reverted automatically.")
-                if is_report(type(script)):
-                    # script and legacy reports have different log function signatures
-                    script.log_info(message=msg)
-                else:
-                    script.log_info(msg)
-
+                script.log_info(message=_("Database changes have been reverted automatically."))
                 if request:
                     clear_events.send(request)
-            job = set_job_data(script)
+
+            job.data = script.get_job_data()
             if script.failed:
                 logger.warning(f"Script failed")
                 job.terminate(status=JobStatusChoices.STATUS_FAILED)
             else:
                 job.terminate()
+
         except Exception as e:
             if type(e) is AbortScript:
                 msg = _("Script aborted with error: ") + str(e)
@@ -648,19 +654,13 @@ def _run_script():
                 logger.error(f"Script aborted with error: {e}")
             else:
                 stacktrace = traceback.format_exc()
-                msg = _("An exception occurred: : ") + f"`{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"
-                if is_report(type(script)):
-                    script.log_failure(message=msg)
-                else:
-                    script.log_failure(msg)
+                script.log_failure(
+                    message=_("An exception occurred: ") + f"`{type(e).__name__}: {e}`\n```\n{stacktrace}\n```"
+                )
                 logger.error(f"Exception raised during script execution: {e}")
-            msg = _("Database changes have been reverted due to error.")
-            if is_report(type(script)):
-                script.log_info(message=msg)
-            else:
-                script.log_info(msg)
+            script.log_info(message=_("Database changes have been reverted due to error."))
 
-            job = set_job_data(script)
+            job.data = script.get_job_data()
             job.terminate(status=JobStatusChoices.STATUS_ERRORED, error=repr(e))
             if request:
                 clear_events.send(request)
@@ -671,9 +671,9 @@ def _run_script():
     # change logging, event rules, etc.
     if commit:
         with event_tracking(request):
-            _run_script()
+            _run_script(job)
     else:
-        _run_script()
+        _run_script(job)
 
     # Schedule the next job if an interval has been set
     if job.interval:

From c5916af1d000e22f687208e78cf4e1540eda2897 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Wed, 7 Feb 2024 09:04:20 -0500
Subject: [PATCH 30/32] Clean up template

---
 netbox/templates/extras/script_list.html | 166 +++++++++++------------
 1 file changed, 83 insertions(+), 83 deletions(-)

diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
index 448de2c8d7c..b4c6a05198a 100644
--- a/netbox/templates/extras/script_list.html
+++ b/netbox/templates/extras/script_list.html
@@ -20,6 +20,7 @@
 
 {% block content %}
   {% for module in script_modules %}
+    {% include 'inc/sync_warning.html' with object=module %}
     <div class="card">
       <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
         <div>
@@ -31,97 +32,96 @@ <h5 class="card-header justify-content-between" id="module{{ module.pk }}">
           </a>
         {% endif %}
       </h5>
-      <div class="card-body">
-        {% include 'inc/sync_warning.html' with object=module %}
-        {% if module.scripts %}
-          <table class="table table-hover scripts">
-            <thead>
-              <tr>
-                <th width="250">{% trans "Name" %}</th>
-                <th>{% trans "Description" %}</th>
-                <th>{% trans "Last Run" %}</th>
-                <th>{% trans "Status" %}</th>
-                <th width="120"></th>
-              </tr>
-            </thead>
-            <tbody>
-              {% with jobs=module.get_latest_jobs %}
-                {% for script_name, script in module.scripts.items %}
-                  {% with last_job=jobs|get_key:script.class_name %}
-                    <tr>
+      {% if module.scripts %}
+        <table class="table table-hover scripts">
+          <thead>
+            <tr>
+              <th>{% trans "Name" %}</th>
+              <th>{% trans "Description" %}</th>
+              <th>{% trans "Last Run" %}</th>
+              <th>{% trans "Status" %}</th>
+              <th></th>
+            </tr>
+          </thead>
+          <tbody>
+            {% with jobs=module.get_latest_jobs %}
+              {% for script_name, script in module.scripts.items %}
+                {% with last_job=jobs|get_key:script.class_name %}
+                  <tr>
+                    <td>
+                      <a href="{% url 'extras:script' module=module.python_name name=script.class_name %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.name }}</a>
+                    </td>
+                    <td>{{ script.description|markdown|placeholder }}</td>
+                    {% if last_job %}
                       <td>
-                        <a href="{% url 'extras:script' module=module.python_name name=script.class_name %}" id="{{ script.module }}.{{ script.class_name }}">{{ script.name }}</a>
+                        <a href="{% url 'extras:script_result' job_pk=last_job.pk %}">{{ last_job.created|annotated_date }}</a>
                       </td>
-                      <td>{{ script.description|markdown|placeholder }}</td>
-                      {% if last_job %}
-                        <td>
-                          <a href="{% url 'extras:script_result' job_pk=last_job.pk %}">{{ last_job.created|annotated_date }}</a>
-                        </td>
-                        <td>
-                          {% badge last_job.get_status_display last_job.get_status_color %}
-                        </td>
-                      {% else %}
-                        <td class="text-muted">{% trans "Never" %}</td>
-                        <td>{{ ''|placeholder }}</td>
-                      {% endif %}
                       <td>
-                        {% if perms.extras.run_script %}
-                          <div class="float-end d-print-none">
-                            <form action="{% url 'extras:script' module=script.module name=script.class_name %}" method="post">
-                              {% csrf_token %}
-                              <button type="submit" name="_run" class="btn btn-primary" style="width: 110px">
-                                {% if last_job %}
-                                  <i class="mdi mdi-replay"></i> {% trans "Run Again" %}
-                                {% else %}
-                                  <i class="mdi mdi-play"></i> {% trans "Run Script" %}
-                                {% endif %}
-                              </button>
-                            </form>
-                          </div>
-                        {% endif %}
+                        {% badge last_job.get_status_display last_job.get_status_color %}
                       </td>
-                    </tr>
-                    {% if last_job.data.logs %}
-                      {% for method, stats in last_job.data.logs.items %}
-                        <tr>
-                          <td colspan="4" class="method">
-                            <span class="ps-3">{{ method }}</span>
-                          </td>
-                          <td class="text-end text-nowrap script-stats">
-                            <span class="badge text-bg-success">{{ stats.success }}</span>
-                            <span class="badge text-bg-info">{{ stats.info }}</span>
-                            <span class="badge text-bg-warning">{{ stats.warning }}</span>
-                            <span class="badge text-bg-danger">{{ stats.failure }}</span>
-                          </td>
-                        </tr>
-                      {% endfor %}
-                    {% elif not last_job.data.log %}
-                      {# legacy #}
-                      {% for method, stats in last_job.data.items %}
-                        <tr>
-                          <td colspan="4" class="method">
-                            <span class="ps-3">{{ method }}</span>
-                          </td>
-                          <td class="text-end text-nowrap report-stats">
-                            <span class="badge bg-success">{{ stats.success }}</span>
-                            <span class="badge bg-info">{{ stats.info }}</span>
-                            <span class="badge bg-warning">{{ stats.warning }}</span>
-                            <span class="badge bg-danger">{{ stats.failure }}</span>
-                          </td>
-                        </tr>
-                      {% endfor %}
+                    {% else %}
+                      <td class="text-muted">{% trans "Never" %}</td>
+                      <td>{{ ''|placeholder }}</td>
                     {% endif %}
-                  {% endwith %}
-                {% endfor %}
-              {% endwith %}
-            </tbody>
-          </table>
-        {% else %}
+                    <td>
+                      {% if perms.extras.run_script %}
+                        <div class="float-end d-print-none">
+                          <form action="{% url 'extras:script' module=script.module name=script.class_name %}" method="post">
+                            {% csrf_token %}
+                            <button type="submit" name="_run" class="btn btn-primary btn-sm">
+                              {% if last_job %}
+                                <i class="mdi mdi-replay"></i> {% trans "Run Again" %}
+                              {% else %}
+                                <i class="mdi mdi-play"></i> {% trans "Run Script" %}
+                              {% endif %}
+                            </button>
+                          </form>
+                        </div>
+                      {% endif %}
+                    </td>
+                  </tr>
+                  {% if last_job %}
+                    {% for test_name, data in last_job.data.tests.items %}
+                      <tr>
+                        <td colspan="4" class="method">
+                          <span class="ps-3">{{ test_name }}</span>
+                        </td>
+                        <td class="text-end text-nowrap script-stats">
+                          <span class="badge text-bg-success">{{ data.success }}</span>
+                          <span class="badge text-bg-info">{{ data.info }}</span>
+                          <span class="badge text-bg-warning">{{ data.warning }}</span>
+                          <span class="badge text-bg-danger">{{ data.failure }}</span>
+                        </td>
+                      </tr>
+                    {% endfor %}
+                  {% elif not last_job.data.log %}
+                    {# legacy #}
+                    {% for method, stats in last_job.data.items %}
+                      <tr>
+                        <td colspan="4" class="method">
+                          <span class="ps-3">{{ method }}</span>
+                        </td>
+                        <td class="text-end text-nowrap report-stats">
+                          <span class="badge bg-success">{{ stats.success }}</span>
+                          <span class="badge bg-info">{{ stats.info }}</span>
+                          <span class="badge bg-warning">{{ stats.warning }}</span>
+                          <span class="badge bg-danger">{{ stats.failure }}</span>
+                        </td>
+                      </tr>
+                    {% endfor %}
+                  {% endif %}
+                {% endwith %}
+              {% endfor %}
+            {% endwith %}
+          </tbody>
+        </table>
+      {% else %}
+        <div class="card-body">
           <div class="alert alert-warning" role="alert">
             <i class="mdi mdi-alert"></i> Could not load scripts from {{ module.name }}
           </div>
-        {% endif %}
-      </div>
+        </div>
+      {% endif %}
     </div>
   {% empty %}
     <div class="alert alert-info" role="alert">

From 7a10b4ef8957fcb737a71b706a58e8d4e3eabe1c Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Wed, 7 Feb 2024 09:10:04 -0500
Subject: [PATCH 31/32] Clean up migration

---
 .../0107_convert_reports_to_scripts.py        | 31 +++++++++++++++++
 .../0107_delete_report_delete_reportmodule.py | 34 -------------------
 2 files changed, 31 insertions(+), 34 deletions(-)
 create mode 100644 netbox/extras/migrations/0107_convert_reports_to_scripts.py
 delete mode 100644 netbox/extras/migrations/0107_delete_report_delete_reportmodule.py

diff --git a/netbox/extras/migrations/0107_convert_reports_to_scripts.py b/netbox/extras/migrations/0107_convert_reports_to_scripts.py
new file mode 100644
index 00000000000..ac3222dc71a
--- /dev/null
+++ b/netbox/extras/migrations/0107_convert_reports_to_scripts.py
@@ -0,0 +1,31 @@
+from django.db import migrations
+
+
+def convert_reportmodule_jobs(apps, schema_editor):
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    Job = apps.get_model('core', 'Job')
+
+    # Convert all ReportModule jobs to ScriptModule jobs
+    if reportmodule_ct := ContentType.objects.filter(app_label='extras', model='reportmodule').first():
+        scriptmodule_ct = ContentType.objects.get(app_label='extras', model='scriptmodule')
+        Job.objects.filter(object_type_id=reportmodule_ct.id).update(object_type_id=scriptmodule_ct.id)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('extras', '0106_bookmark_user_cascade_deletion'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            code=convert_reportmodule_jobs,
+            reverse_code=migrations.RunPython.noop
+        ),
+        migrations.DeleteModel(
+            name='Report',
+        ),
+        migrations.DeleteModel(
+            name='ReportModule',
+        ),
+    ]
diff --git a/netbox/extras/migrations/0107_delete_report_delete_reportmodule.py b/netbox/extras/migrations/0107_delete_report_delete_reportmodule.py
deleted file mode 100644
index 652e89ceef9..00000000000
--- a/netbox/extras/migrations/0107_delete_report_delete_reportmodule.py
+++ /dev/null
@@ -1,34 +0,0 @@
-# Generated by Django 5.0.1 on 2024-01-26 22:22
-
-from django.db import migrations
-
-
-def migrate_report_jobs(apps, schema_editor):
-    ContentType = apps.get_model('contenttypes', 'ContentType')
-    Job = apps.get_model('core', 'Job')
-
-    # Delete the new ContentType effected by the introduction of core.ConfigRevision
-    if ContentType.objects.filter(app_label='extras', model='reportmodule'):
-        report_content_type = ContentType.objects.get(app_label='extras', model='reportmodule')
-        script_content_type = ContentType.objects.get(app_label='extras', model='scriptmodule')
-        jobs = Job.objects.filter(object_type_id=report_content_type.id).update(object_type_id=script_content_type.id)
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('extras', '0106_bookmark_user_cascade_deletion'),
-    ]
-
-    operations = [
-        migrations.RunPython(
-            code=migrate_report_jobs,
-            reverse_code=migrations.RunPython.noop
-        ),
-        migrations.DeleteModel(
-            name='Report',
-        ),
-        migrations.DeleteModel(
-            name='ReportModule',
-        ),
-    ]

From 9aabcb2d4f98dc09eeedb007607c664e4c470a4d Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Wed, 7 Feb 2024 10:28:52 -0500
Subject: [PATCH 32/32] Clean up docs

---
 docs/customization/custom-scripts.md | 130 ++++++++++++++-------------
 docs/customization/reports.md        |  71 +++++++--------
 mkdocs.yml                           |   1 +
 3 files changed, 103 insertions(+), 99 deletions(-)

diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md
index cb0d3f30b10..96423a94bd5 100644
--- a/docs/customization/custom-scripts.md
+++ b/docs/customization/custom-scripts.md
@@ -5,10 +5,9 @@ Custom scripting was introduced to provide a way for users to execute custom log
 * Automatically populate new devices and cables in preparation for a new site deployment
 * Create a range of new reserved prefixes or IP addresses
 * Fetch data from an external source and import it to NetBox
+* Update objects with invalid or incomplete data
 
-Custom scripts are Python code and exist outside of the official NetBox code base, so they can be updated and changed without interfering with the core NetBox installation. And because they're completely custom, there is no inherent limitation on what a script can accomplish.
-
-Custom scripts can also be used as a mechanism for validating the integrity of data within NetBox. Running a script can allow the user to verify that the objects defined within NetBox meet certain arbitrary conditions. For example, you can write script to check that:
+They can also be used as a mechanism for validating the integrity of data within NetBox. Script authors can define test to check object against specific rules and conditions. For example, you can write script to check that:
 
 * All top-of-rack switches have a console connection
 * Every router has a loopback interface with an IP address assigned
@@ -16,6 +15,8 @@ Custom scripts can also be used as a mechanism for validating the integrity of d
 * Every site has a minimum set of VLANs defined
 * All IP addresses have a parent prefix
 
+Custom scripts are Python code which exists outside the NetBox code base, so they can be updated and changed without interfering with the core NetBox installation. And because they're completely custom, there is no inherent limitation on what a script can accomplish.
+
 ## Writing Custom Scripts
 
 All custom scripts must inherit from the `extras.scripts.Script` base class. This class provides the functionality necessary to generate forms and log activity.
@@ -143,13 +144,73 @@ These two methods will load data in YAML or JSON format, respectively, from file
 
 The Script object provides a set of convenient functions for recording messages at different severity levels:
 
-* `log(message)`
+* `log_debug(message, object=None)`
 * `log_success(message, object=None)`
 * `log_info(message, object=None)`
 * `log_warning(message, object=None)`
 * `log_failure(message, object=None)`
 
-Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages.  An optional object can be passed that will be linked in the rendered message.
+Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages. A message may optionally be associated with a particular object by passing it as the second argument to the logging method.
+
+## Test Methods
+
+A script can define one or more test methods to report on certain conditions. All test methods must have a name beginning with `test_` and accept no arguments beyond `self`.
+
+These methods are detected and run automatically when the script is executed, unless its `run()` method has been overridden. (When overriding `run()`, `run_tests()` can be called to run all test methods present in the script.)
+
+!!! info
+    This functionality was ported from [legacy reports](./reports.md) in NetBox v4.0.
+
+### Example
+
+```
+from dcim.choices import DeviceStatusChoices
+from dcim.models import ConsolePort, Device, PowerPort
+from extras.scripts import Script
+
+
+class DeviceConnectionsReport(Script):
+    description = "Validate the minimum physical connections for each device"
+
+    def test_console_connection(self):
+
+        # Check that every console port for every active device has a connection defined.
+        active = DeviceStatusChoices.STATUS_ACTIVE
+        for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
+            if not console_port.connected_endpoints:
+                self.log_failure(
+                    f"No console connection defined for {console_port.name}",
+                    console_port.device,
+                )
+            elif not console_port.connection_status:
+                self.log_warning(
+                    f"Console connection for {console_port.name} marked as planned",
+                    console_port.device,
+                )
+            else:
+                self.log_success("Passed", console_port.device)
+
+    def test_power_connections(self):
+
+        # Check that every active device has at least two connected power supplies.
+        for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
+            connected_ports = 0
+            for power_port in PowerPort.objects.filter(device=device):
+                if power_port.connected_endpoints:
+                    connected_ports += 1
+                    if not power_port.path.is_active:
+                        self.log_warning(
+                            f"Power connection for {power_port.name} marked as planned",
+                            device,
+                        )
+            if connected_ports < 2:
+                self.log_failure(
+                    f"{connected_ports} connected power supplies found (2 needed)",
+                    device,
+                )
+            else:
+                self.log_success("Passed", device)
+```
 
 ## Change Logging
 
@@ -418,62 +479,3 @@ class NewBranchScript(Script):
 
         return '\n'.join(output)
 ```
-
-## Test Methods
-
-Within each script class, we can create a number of test methods to validate the integrity of various data. In DeviceConnectionsReport, for instance, we want to ensure that every live device has a console connection, an out-of-band management connection, and two power connections.
-
-```
-from dcim.choices import DeviceStatusChoices
-from dcim.models import ConsolePort, Device, PowerPort
-from extras.scripts import Script
-
-
-class DeviceConnectionsReport(Script):
-    description = "Validate the minimum physical connections for each device"
-
-    def test_console_connection(self):
-
-        # Check that every console port for every active device has a connection defined.
-        active = DeviceStatusChoices.STATUS_ACTIVE
-        for console_port in ConsolePort.objects.prefetch_related('device').filter(device__status=active):
-            if not console_port.connected_endpoints:
-                self.log_failure(
-                    "No console connection defined for {}".format(console_port.name),
-                    console_port.device,
-                )
-            elif not console_port.connection_status:
-                self.log_warning(
-                    "Console connection for {} marked as planned".format(console_port.name),
-                    console_port.device,
-                )
-            else:
-                self.log_success("success", console_port.device)
-
-    def test_power_connections(self):
-
-        # Check that every active device has at least two connected power supplies.
-        for device in Device.objects.filter(status=DeviceStatusChoices.STATUS_ACTIVE):
-            connected_ports = 0
-            for power_port in PowerPort.objects.filter(device=device):
-                if power_port.connected_endpoints:
-                    connected_ports += 1
-                    if not power_port.path.is_active:
-                        self.log_warning(
-                            "Power connection for {} marked as planned".format(power_port.name),
-                            device,
-                        )
-            if connected_ports < 2:
-                self.log_failure(
-                    "{} connected power supplies found (2 needed)".format(connected_ports),
-                    device,
-                )
-            else:
-                self.log_success("success", device)
-
-    def run(self, data, commit):
-        self.run_tests()
-
-```
-
-`run_tests()` is a helper function that will run every method that starts with `test_`
diff --git a/docs/customization/reports.md b/docs/customization/reports.md
index 109e92a9b69..f7eef506d41 100644
--- a/docs/customization/reports.md
+++ b/docs/customization/reports.md
@@ -1,62 +1,63 @@
 # NetBox Reports
 
 !!! warning
-    Reports are deprecated and merged with [custom scripts](./custom-scripts.md) as of NetBox 4.0.  You should convert any legacy reports to use Script as described below
+    Reports are deprecated beginning with NetBox v4.0, and their functionality has been merged with [custom scripts](./custom-scripts.md). While backward compatibility has been maintained, users are advised to convert legacy reports into custom scripts soon, as support for legacy reports will be removed in a future release.
 
 ## Converting Reports to Scripts
 
-### Step 1: Change Class Definition
+### Step 1: Update Class Definition
 
-First change the import and class definition to use Script.  For example:
+Change the parent class from `Report` to `Script`:
 
-```
+```python title="Old code"
 from extras.reports import Report
 
-class DeviceConnectionsReport(Report):
+class MyReport(Report):
 ```
-change to:
 
-```
+```python title="New code"
 from extras.scripts import Script
 
-class DeviceConnectionsReport(Script):
+class MyReport(Script):
 ```
 
-### Step 2: Change Logging Calls
+### Step 2: Update Logging Calls
 
-The logging methods require the object and message in the logging call to be swapped.  For example:
+Reports and scripts both provide logging methods, however their signatures differ. All script logging methods accept a message as the first parameter, and accept an object as an optional second parameter.
 
+Additionally, the Report class' generic `log()` method is **not** available on Script. Users are advised to replace calls of this method with `log_info()`.
 
-```
-    self.log_failure(
-        console_port.device,
-        "No console connection defined for {}".format(console_port.name)
-    )
-```
+Use the table below as a reference when updating these methods.
 
-should be changed to:
+| Report (old)                  | Script (New)                |
+|-------------------------------|-----------------------------|
+| `log(message)`                | `log_info(message)`         |
+| `log_debug(obj, message)`[^1] | `log_debug(message, obj)`   |
+| `log_info(obj, message)`      | `log_info(message, obj)`    |
+| `log_success(obj, message)`   | `log_success(message, obj)` |
+| `log_warning(obj, message)`   | `log_warning(message, obj)` |
+| `log_failure(obj, message)`   | `log_failure(message, obj)` |
 
-```
-    self.log_failure(
-        "No console connection defined for {}".format(console_port.name),
-        console_port.device,
-    )
+[^1]: `log_debug()` was added to the Report class in v4.0 to avoid confusion with the same method on Script
+
+```python title="Old code"
+self.log_failure(
+    console_port.device,
+    f"No console connection defined for {console_port.name}"
+)
 ```
 
-This applies to all log_ functions:
+```python title="New code"
+self.log_failure(
+    f"No console connection defined for {console_port.name}",
+    obj=console_port.device,
+)
+```
 
-* log_success(object, message) -> log_success(message, object)
-* log_info(object, message) -> log_info(message, object)
-* log_warning(object, message) -> log_warning(message, object)
-* log_failure(object, message) -> log_failure(message, object)
+### Other Notes
 
-### Optional Run Method
+Existing reports will be converted to scripts automatically upon upgrading to NetBox v4.0, and previous job history will be retained. However, users are advised to convert legacy reports into custom scripts at the earliest opportunity, as support for legacy reports will be removed in a future release.
 
-Scripts have a default run method that will automatically run all the `test_` methods as well as the pre_run and post_run functions.  You can also define a run method and call `run_tests()` to call all the `test_` functions:
+The `pre_run()` and `post_run()` Report methods have been carried over to Script. These are called automatically by Script's `run()` method. (Note that if you opt to override this method, you are responsible for calling `pre_run()` and `post_run()` where applicable.)
 
-```
-    def run(self, data, commit):
-        self.run_tests()
-
-```
-Any functionality needed for pre or post run can just be put into the the run method before or after the call to run_tests.
+The `is_valid()` method on Report is no longer needed and has been removed.
diff --git a/mkdocs.yml b/mkdocs.yml
index e1128578acd..c5816f5f5c7 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -52,6 +52,7 @@ extra_css:
 markdown_extensions:
     - admonition
     - attr_list
+    - footnotes
     - pymdownx.emoji:
         emoji_index: !!python/name:material.extensions.emoji.twemoji
         emoji_generator: !!python/name:material.extensions.emoji.to_svg