Render Config fails with DataFile templates using dynamic include statements #10502

New Issue

adam · 2025-12-29T21:32:20+01:00

adam commented

2025-12-29 21:32:20 +01:00

Originally created by @ed-ud on GitHub (Nov 21, 2024).

Deployment Type

Self-hosted

Triage priority

N/A

NetBox Version

v4.1.4

Python Version

3.12

Steps to Reproduce

Create a Data Source with several Jinja2 template files:

start.j2:
{%- set PATH = 'my/prefix/' %}
{%- include PATH + 'test.j2' %}

my/prefix/test.j2:
SOME RENDERED TEXT

Create Config Template using the Data Source and the Data File start.j2
Attach Config Template to a Device
Select the Render Config tab on the Device

Expected Behavior

Should not fail to render.

Observed Behavior

Fails to render with TemplateNotFound 'my/prefix/test.j2' exception.

Originally created by @ed-ud on GitHub (Nov 21, 2024). ### Deployment Type Self-hosted ### Triage priority N/A ### NetBox Version v4.1.4 ### Python Version 3.12 ### Steps to Reproduce 1. Create a Data Source with several Jinja2 template files: start.j2: {%- set PATH = 'my/prefix/' %} {%- include PATH + 'test.j2' %} my/prefix/test.j2: SOME RENDERED TEXT 2. Create Config Template using the Data Source and the Data File start.j2 3. Attach Config Template to a Device 4. Select the Render Config tab on the Device ### Expected Behavior Should not fail to render. ### Observed Behavior Fails to render with TemplateNotFound 'my/prefix/test.j2' exception.

adam added the type: bug status: duplicate labels 2025-12-29 21:32:20 +01:00

adam closed this issue

2025-12-29 21:32:20 +01:00

adam commented

2025-12-29 21:32:21 +01:00

@ed-ud commented on GitHub (Nov 21, 2024):

A potential fix is to recognize when the Jinja template files are using dynamic includes (the list of referenced_templates contains None entries) and in that case, include all DataFiles from the DataSource.
In utilities/jinja2.py:

diff jinja2.py.orig jinja2.py
32,35c32,41
<             self.cache_templates({
<                 df.path: df.data_as_string for df in
<                 DataFile.objects.filter(source=self.data_source, path__in=referenced_templates)
<             })
---
>             if None in referenced_templates:
>                 self.cache_templates({
>                     df.path: df.data_as_string for df in
>                     DataFile.objects.filter(source=self.data_source)
>                 })
>             else:
>                 self.cache_templates({
>                     df.path: df.data_as_string for df in
>                     DataFile.objects.filter(source=self.data_source, path__in=referenced_templates)
>                 })

@ed-ud commented on GitHub (Nov 21, 2024): A potential fix is to recognize when the Jinja template files are using dynamic includes (the list of referenced_templates contains None entries) and in that case, include all DataFiles from the DataSource. In utilities/jinja2.py: ``` diff jinja2.py.orig jinja2.py 32,35c32,41 < self.cache_templates({ < df.path: df.data_as_string for df in < DataFile.objects.filter(source=self.data_source, path__in=referenced_templates) < }) --- > if None in referenced_templates: > self.cache_templates({ > df.path: df.data_as_string for df in > DataFile.objects.filter(source=self.data_source) > }) > else: > self.cache_templates({ > df.path: df.data_as_string for df in > DataFile.objects.filter(source=self.data_source, path__in=referenced_templates) > }) ```

adam commented

2025-12-29 21:32:21 +01:00

@pl0xym0r commented on GitHub (Nov 22, 2024):

same as #17490

@pl0xym0r commented on GitHub (Nov 22, 2024): same as #17490

adam commented

2025-12-29 21:32:22 +01:00

@jeremystretch commented on GitHub (Nov 22, 2024):

Thank you for submitting this issue, however it appears that this topic has already been raised. Please see issue #17490 for further discussion.

@jeremystretch commented on GitHub (Nov 22, 2024): Thank you for submitting this issue, however it appears that this topic has already been raised. Please see issue #17490 for further discussion.

adam referenced this issue

2025-12-29 23:20:04 +01:00

[PR #10502] [MERGED] Allow Plugins to register a list of Django apps to be appended to INSTALLED_APPS #13649

Sign in to join this conversation.

Branches Tags

main

21102-fix-graphiql-explorer

update-changelog-comments-docs

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#10502