NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-29 03:46:25 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Improve error message display; replicate changes for VMs

Browse Source
This commit is contained in:
Jeremy Stretch 2024-12-11 09:59:54 -05:00
parent 4cb6abfc18
commit c2d429f4d8
4 changed files with 52 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
netbox/dcim/views.py
View File

@ -2104,7 +2104,8 @@ class DeviceRenderConfigView(generic.ObjectView):
# If a direct export has been requested, return the rendered template content as a # If a direct export has been requested, return the rendered template content as a
# downloadable file. # downloadable file.
if request.GET.get('export'): if request.GET.get('export'):
response = HttpResponse(context['rendered_config'], content_type='text') content = context['rendered_config'] or context['error_message']
response = HttpResponse(content, content_type='text')
filename = f"{instance.name or 'config'}.txt" filename = f"{instance.name or 'config'}.txt"
response['Content-Disposition'] = f'attachment; filename="{filename}"' response['Content-Disposition'] = f'attachment; filename="{filename}"'
return response return response
@ -2122,18 +2123,18 @@ class DeviceRenderConfigView(generic.ObjectView):
# Render the config template # Render the config template
rendered_config = None rendered_config = None
error_message = None
if config_template := instance.get_config_template(): if config_template := instance.get_config_template():
try: try:
rendered_config = config_template.render(context=context_data) rendered_config = config_template.render(context=context_data)
except TemplateError as e: except TemplateError as e:
msg = _("An error occurred while rendering the template: {error}").format(error=e) error_message = _("An error occurred while rendering the template: {error}").format(error=e)
messages.error(request, msg)
rendered_config = msg
return { return {
'config_template': config_template, 'config_template': config_template,
'context_data': context_data, 'context_data': context_data,
'rendered_config': rendered_config, 'rendered_config': rendered_config,
'error_message': error_message,
} }

33
netbox/templates/dcim/device/render_config.html
View File

@ -5,7 +5,7 @@
{% block title %}{{ object }} - {% trans "Config" %}{% endblock %} {% block title %}{{ object }} - {% trans "Config" %}{% endblock %}
{% block content %} {% block content %}
<div class="row mb-3"> <div class="row">
<div class="col-5"> <div class="col-5">
<div class="card"> <div class="card">
<h2 class="card-header">{% trans "Config Template" %}</h2> <h2 class="card-header">{% trans "Config Template" %}</h2>
@ -48,19 +48,28 @@
</div> </div>
<div class="row"> <div class="row">
<div class="col"> <div class="col">
<div class="card"> {% if config_template %}
<h2 class="card-header d-flex justify-content-between"> {% if rendered_config %}
{% trans "Rendered Config" %} <div class="card">
<a href="?export=True" class="btn btn-primary lh-1" role="button"> <h2 class="card-header d-flex justify-content-between">
<i class="mdi mdi-download" aria-hidden="true"></i> {% trans "Download" %} {% trans "Rendered Config" %}
</a> <a href="?export=True" class="btn btn-primary lh-1" role="button">
</h2> <i class="mdi mdi-download" aria-hidden="true"></i> {% trans "Download" %}
{% if config_template %} </a>
<pre class="card-body">{{ rendered_config }}</pre> </h2>
<pre class="card-body">{{ rendered_config }}</pre>
</div>
{% else %} {% else %}
<div class="card-body text-muted">{% trans "No configuration template found" %}</div> <div class="alert alert-warning">
<h4 class="alert-title mb-1">{% trans "Error rendering template" %}</h4>
{% trans error_message %}
</div>
{% endif %} {% endif %}
</div> {% else %}
<div class="alert alert-info">
{% trans "No configuration template has been assigned for this device." %}
</div>
{% endif %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}

33
netbox/templates/virtualization/virtualmachine/render_config.html
View File

@ -5,7 +5,7 @@
{% block title %}{{ object }} - {% trans "Config" %}{% endblock %} {% block title %}{{ object }} - {% trans "Config" %}{% endblock %}
{% block content %} {% block content %}
<div class="row mb-3"> <div class="row">
<div class="col-5"> <div class="col-5">
<div class="card"> <div class="card">
<h2 class="card-header">{% trans "Config Template" %}</h2> <h2 class="card-header">{% trans "Config Template" %}</h2>
@ -48,19 +48,28 @@
</div> </div>
<div class="row"> <div class="row">
<div class="col"> <div class="col">
<div class="card"> {% if config_template %}
<h2 class="card-header d-flex justify-content-between"> {% if rendered_config %}
{% trans "Rendered Config" %} <div class="card">
<a href="?export=True" class="btn btn-primary lh-1" role="button"> <h2 class="card-header d-flex justify-content-between">
<i class="mdi mdi-download" aria-hidden="true"></i> {% trans "Download" %} {% trans "Rendered Config" %}
</a> <a href="?export=True" class="btn btn-primary lh-1" role="button">
</h2> <i class="mdi mdi-download" aria-hidden="true"></i> {% trans "Download" %}
{% if config_template %} </a>
<pre class="card-body">{{ rendered_config }}</pre> </h2>
<pre class="card-body">{{ rendered_config }}</pre>
</div>
{% else %} {% else %}
<div class="card-body text-muted">{% trans "No configuration template found" %}</div> <div class="alert alert-warning">
<h4 class="alert-title mb-1">{% trans "Error rendering template" %}</h4>
{% trans error_message %}
</div>
{% endif %} {% endif %}
</div> {% else %}
<div class="alert alert-info">
{% trans "No configuration template has been assigned for this virtual machine." %}
</div>
{% endif %}
</div> </div>
</div> </div>
{% endblock %} {% endblock %}

10
netbox/virtualization/views.py
View File

@ -1,5 +1,3 @@
import traceback
from django.contrib import messages from django.contrib import messages
from django.db import transaction from django.db import transaction
from django.db.models import Prefetch, Sum from django.db.models import Prefetch, Sum
@ -425,7 +423,8 @@ class VirtualMachineRenderConfigView(generic.ObjectView):
# If a direct export has been requested, return the rendered template content as a # If a direct export has been requested, return the rendered template content as a
# downloadable file. # downloadable file.
if request.GET.get('export'): if request.GET.get('export'):
response = HttpResponse(context['rendered_config'], content_type='text') content = context['rendered_config'] or context['error_message']
response = HttpResponse(content, content_type='text')
filename = f"{instance.name or 'config'}.txt" filename = f"{instance.name or 'config'}.txt"
response['Content-Disposition'] = f'attachment; filename="{filename}"' response['Content-Disposition'] = f'attachment; filename="{filename}"'
return response return response
@ -443,17 +442,18 @@ class VirtualMachineRenderConfigView(generic.ObjectView):
# Render the config template # Render the config template
rendered_config = None rendered_config = None
error_message = None
if config_template := instance.get_config_template(): if config_template := instance.get_config_template():
try: try:
rendered_config = config_template.render(context=context_data) rendered_config = config_template.render(context=context_data)
except TemplateError as e: except TemplateError as e:
messages.error(request, _("An error occurred while rendering the template: {error}").format(error=e)) error_message = _("An error occurred while rendering the template: {error}").format(error=e)
rendered_config = traceback.format_exc()
return { return {
'config_template': config_template, 'config_template': config_template,
'context_data': context_data, 'context_data': context_data,
'rendered_config': rendered_config, 'rendered_config': rendered_config,
'error_message': error_message,
} }