starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Config Template unable to dynamically include templates #10243

New Issue
Closed
opened 2025-12-29 21:28:48 +01:00 by adam · 3 comments
adam commented 2025-12-29 21:28:48 +01:00
Owner
Copy Link

Originally created by @robduffy2010 on GitHub (Sep 13, 2024).

Originally assigned to: @jeremystretch on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.0.9

Python Version

3.10

Steps to Reproduce

  1. Create the following template in a data store, as well as child templates in the blocks directory. In this example a template named interface.j2 is located in the blocks/TEST/ directory.
  2. Assign the template to a device
  3. Attempt to render the template

Example of template. This has been tested manually using Jinja2. The configuration blocks referenced are from a plugin.

config system interface
{% for config_block in device.site.configblock_set.all() %}
{% include "blocks/" + custom_block.name + "/interface.j2" %}
{% endfor %}
end

Expected Behavior

Expected behaviour is that the template renders and imports the relevant includes.

Observed Behavior

Traceback (most recent call last):
File "/opt/netbox/netbox/utilities/jinja2.py", line 26, in get_source
template_source = self._template_cache[template]
KeyError: 'blocks/TEST/interface.j2'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "/opt/netbox/netbox/dcim/views.py", line 2060, in get_extra_context
rendered_config = config_template.render(context=context_data)
File "/opt/netbox/netbox/extras/models/configs.py", line 282, in render
output = template.render(**_context)
File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 1304, in render
self.environment.handle_exception()
File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 939, in handle_exception
raise rewrite_traceback_stack(source=source)
File "block-config.j2", line 49, in top-level template code
File "/opt/netbox/netbox/utilities/jinja2.py", line 28, in get_source
raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: blocks/TEST/interface.j2

Originally created by @robduffy2010 on GitHub (Sep 13, 2024). Originally assigned to: @jeremystretch on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.0.9 ### Python Version 3.10 ### Steps to Reproduce 1. Create the following template in a data store, as well as child templates in the blocks directory. In this example a template named interface.j2 is located in the blocks/TEST/ directory. 2. Assign the template to a device 3. Attempt to render the template Example of template. This has been tested manually using Jinja2. The configuration blocks referenced are from a plugin. config system interface {% for config_block in device.site.configblock_set.all() %} {% include "blocks/" + custom_block.name + "/interface.j2" %} {% endfor %} end ### Expected Behavior Expected behaviour is that the template renders and imports the relevant includes. ### Observed Behavior Traceback (most recent call last): File "/opt/netbox/netbox/utilities/jinja2.py", line 26, in get_source template_source = self._template_cache[template] KeyError: 'blocks/TEST/interface.j2' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/opt/netbox/netbox/dcim/views.py", line 2060, in get_extra_context rendered_config = config_template.render(context=context_data) File "/opt/netbox/netbox/extras/models/configs.py", line 282, in render output = template.render(**_context) File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 1304, in render self.environment.handle_exception() File "/usr/local/lib/python3.10/site-packages/jinja2/environment.py", line 939, in handle_exception raise rewrite_traceback_stack(source=source) File "block-config.j2", line 49, in top-level template code File "/opt/netbox/netbox/utilities/jinja2.py", line 28, in get_source raise TemplateNotFound(template) jinja2.exceptions.TemplateNotFound: blocks/TEST/interface.j2
adam added the type: bugstatus: acceptednetboxseverity: low labels 2025-12-29 21:28:48 +01:00
adam closed this issue 2025-12-29 21:28:48 +01:00
adam commented 2025-12-29 21:28:49 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Sep 13, 2024):

Tested this and confirmed this does indeed not import the template.

I honestly have no idea what could be going wrong here as most of the jinja rendering happens within jinja itself. This may be an upstream bug but I am not sure.

@DanSheps commented on GitHub (Sep 13, 2024): Tested this and confirmed this does indeed not import the template. I honestly have no idea what could be going wrong here as most of the jinja rendering happens within jinja itself. This may be an upstream bug but I am not sure.
adam commented 2025-12-29 21:28:49 +01:00
Author
Owner
Copy Link

@robduffy2010 commented on GitHub (Sep 14, 2024):

Thanks for checking. It's very odd alright. I have unittests on the Gitlab repo which hosts the config template, which renders the templates using some test data. It works perfectly on there.

I had a look at the Netbox code and suspect it might could have something to do with the jinja2 sandbox being used but I'm really not sure. I'll have to do some more testing to emulate it as closely as possible.

@robduffy2010 commented on GitHub (Sep 14, 2024): Thanks for checking. It's very odd alright. I have unittests on the Gitlab repo which hosts the config template, which renders the templates using some test data. It works perfectly on there. I had a look at the Netbox code and suspect it might could have something to do with the jinja2 sandbox being used but I'm really not sure. I'll have to do some more testing to emulate it as closely as possible.
adam commented 2025-12-29 21:28:49 +01:00
Author
Owner
Copy Link

@robduffy2010 commented on GitHub (Dec 2, 2024):

I submitted a pull request for this one last Tuesday but the workflows and review are still pending. Is there anything else I need to do to get this accepted? Or does it just take time?

@robduffy2010 commented on GitHub (Dec 2, 2024): I submitted a pull request for this one last Tuesday but the workflows and review are still pending. Is there anything else I need to do to get this accepted? Or does it just take time?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label netbox severity: low status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10243
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?