NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-16 04:02:52 -06:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

#6529 - Streamline code and resolve some issues

Browse Source
This commit is contained in:
Daniel Sheppard 2021-11-02 13:12:12 -05:00
parent 0a62f75a40
commit b7c0e8b71f
1 changed files with 33 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
netbox/extras/management/commands/runscript.py
View File

@ -6,14 +6,14 @@ import uuid
from django.contrib.auth.models import User from django.contrib.auth.models import User
from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes.models import ContentType
from django.core.management.base import BaseCommand from django.core.management.base import BaseCommand, CommandError
from django.db import transaction from django.db import transaction
from extras.api.serializers import ScriptOutputSerializer from extras.api.serializers import ScriptOutputSerializer
from extras.choices import JobResultStatusChoices from extras.choices import JobResultStatusChoices
from extras.context_managers import change_logging from extras.context_managers import change_logging
from extras.models import JobResult from extras.models import JobResult
from extras.scripts import get_scripts from extras.scripts import get_script
from utilities.exceptions import AbortTransaction from utilities.exceptions import AbortTransaction
from utilities.utils import NetBoxFakeRequest from utilities.utils import NetBoxFakeRequest
@ -27,15 +27,11 @@ class Command(BaseCommand):
help="Logging Level (default: info)", help="Logging Level (default: info)",
dest='loglevel', dest='loglevel',
default='info', default='info',
choices=['debug', 'info', 'warning', 'error']) choices=['debug', 'info', 'warning', 'error', 'critical'])
parser.add_argument('--script', help="Script to run", dest='script') parser.add_argument('--script', help="Script to run", dest='script', required=True)
parser.add_argument('--user', help="Data as a json blob", dest='user') parser.add_argument('--commit', help="Commit this script to database", dest='commit')
parser.add_argument('data', help="Data as a json blob") parser.add_argument('--user', help="User script is running as", dest='user')
parser.add_argument('data', help="Data as a JSON blob")
@staticmethod
def _get_script(module, name):
scripts = get_scripts()
return scripts[module][name]()
def handle(self, *args, **options): def handle(self, *args, **options):
def _run_script(): def _run_script():
@ -72,7 +68,8 @@ class Command(BaseCommand):
# Params # Params
script = options['script'] script = options['script']
loglevel = options['loglevel'] loglevel = options['loglevel']
data = json.loads(options['data']) data = json.loads(options['data']) if options['data'] is not None else None
commit = True if options['commit'] in ['1', 'true', 'True'] else False
module, name = script.split('.', 1) module, name = script.split('.', 1)
@ -94,24 +91,32 @@ class Command(BaseCommand):
logger = logging.getLogger(f"netbox.scripts.{module}.{name}") logger = logging.getLogger(f"netbox.scripts.{module}.{name}")
logger.addHandler(stdouthandler) logger.addHandler(stdouthandler)
if loglevel == 'debug': try:
logger.setLevel(logging.DEBUG) logger.setLevel({
elif loglevel == 'info': 'critical': logging.CRITICAL,
logger.setLevel(logging.INFO) 'debug': logging.DEBUG,
elif loglevel == 'warning': 'error': logging.ERROR,
logger.setLevel(logging.WARNING) 'fatal': logging.FATAL,
elif loglevel == 'error': 'info': logging.INFO,
logger.setLevel(logging.ERROR) 'warning': logging.WARNING,
else: }[loglevel])
logger.setLevel(logging.INFO) except KeyError:
raise CommandError(f"Invalid log level: {loglevel}")
# Get the script # Get the script
script = self._get_script(module, name) script = get_script(module, name)()
# Parse the parameters # Parse the parameters
form = script.as_form(data, None) form = script.as_form(data, None)
script_content_type = ContentType.objects.get(app_label='extras', model='script') script_content_type = ContentType.objects.get(app_label='extras', model='script')
# Delete any previous terminal state results
JobResult.objects.filter(
obj_type=script_content_type,
name=script.full_name,
status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES
).delete()
# Create the job result # Create the job result
job_result = JobResult.objects.create( job_result = JobResult.objects.create(
name=script.full_name, name=script.full_name,
@ -134,27 +139,17 @@ class Command(BaseCommand):
job_result.status = JobResultStatusChoices.STATUS_RUNNING job_result.status = JobResultStatusChoices.STATUS_RUNNING
job_result.save() job_result.save()
commit = form.cleaned_data.pop('_commit')
logger.info(f"Running script (commit={commit})") logger.info(f"Running script (commit={commit})")
script.request = request script.request = request
# Execute the script. If commit is True, wrap it with the change_logging context manager to ensure we process # Execute the script. If commit is True, wrap it with the change_logging context manager to ensure we process
# change logging, webhooks, etc. # change logging, webhooks, etc.
if commit: with change_logging(request):
with change_logging(request):
_run_script()
else:
_run_script() _run_script()
# Delete any previous terminal state results
JobResult.objects.filter(
obj_type=job_result.obj_type,
name=job_result.name,
status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES
).exclude(
pk=job_result.pk
).delete()
else: else:
logger.error('Data is not valid:')
for field, errors in form.errors.get_json_data().items():
for error in errors:
logger.error(f'\t{field}: {error.get("message")}')
job_result.status = JobResultStatusChoices.STATUS_ERRORED job_result.status = JobResultStatusChoices.STATUS_ERRORED
job_result.save() job_result.save()