feat: ✨Add jinja settings support for golden config plugin #527

cablesquirrel · 2023-07-17T15:49:47Z

nautobot_golden_config/nornir_plays/config_intended.py

alextremblay · 2023-07-31T12:54:58Z

Hi @itdependsnetworks, Any chance you guys can cut a new release of nornir-nautobot and move this PR out of draft status?

itdependsnetworks · 2023-07-31T13:39:59Z

@jvanderaa would you be able to get the next release of nornir-nautobot at?

jvanderaa · 2023-07-31T14:49:49Z

@itdependsnetworks I think we are set to put that out. There was one thing that I think we were collaborating on furhter.

jvanderaa · 2023-08-03T13:26:03Z

@itdependsnetworks release 1.5 for nornir-nautobot is out.

alextremblay · 2023-08-25T18:05:06Z

I see that nornir-nautobot v2.5.0 came out with support for this feature, but nautobot-plugin-nornir, which depends on this feature, still depends on nornir-nautobot v2.3.0

I've opened issue nautobot/nautobot-app-nornir#101 to track this

nautobot_golden_config/nornir_plays/config_intended.py

jeffkala · 2023-08-28T18:28:34Z

would expect updates to defaults here:
https://github.com/nautobot/nautobot-plugin-golden-config/blob/4b05247a7f337528a2323fe235ab3a901aa3f1ce/nautobot_golden_config/__init__.py#L27

cablesquirrel · 2023-08-28T18:41:37Z

would expect updates to defaults here:

https://github.com/nautobot/nautobot-plugin-golden-config/blob/4b05247a7f337528a2323fe235ab3a901aa3f1ce/nautobot_golden_config/__init__.py#L27

@jeffkala & @itdependsnetworks

Ok, looking at that now.

@jeffkala

At the request of @jeffkala, define the 'jinja_env_trim_blocks' and 'jinja_env_lstrip_blocks' options in the plugin default settings dict

cablesquirrel · 2023-08-28T18:50:56Z

@jeffkala per your request, I changed how the defaults are defined. Please review my changes and let me know if that is correct.

itdependsnetworks · 2023-08-28T20:22:56Z

docs/admin/admin_install.md

 | sot_agg_transposer        | "mypkg.transposer"            | None    | A string representation of a function that can post-process the graphQL data.                                                                                              |
 | per_feature_bar_width     | 0.15                          | 0.15    | The width of the table bar within the overview report                                                                                                                      |
 | per_feature_width         | 13                            | 13      | The width in inches that the overview table can be.                                                                                                                        |
 | per_feature_height        | 4                             | 4       | The height in inches that the overview table can be.                                                                                                                       |
+| jinja_env_trim_blocks     | True                          | True    | A boolean to represent whether the jinja2 option for "trim_blocks" should be enabled for intended config rendering                                                         |


After getting internal feedback, I think the point @jeffkala and @electro47h is that there are many variables one could set for Jinja, I think the list is:

block_start_string

block_end_string

variable_start_string

variable_end_string

comment_start_string

comment_end_string

line_statement_prefix

line_comment_prefix

trim_blocks

lstrip_blocks

newline_sequence

keep_trailing_newline

extensions

optimized

undefined

finalize

autoescape

loader

cache_size

auto_reload

bytecode_cache

enable_async

It probably makes sense to support them, as a dictionary, with the 3 variables you have set as defaults. So, there should likely be one variable called jinja_env that is set. If you want to have a magic method of some sort such that anything set with jinja_env_* automagically gets into the dictionary, I could buy that as well, as long as it is in addition to the dictionary method.

Understood. None of those were possible to set before, but since they will be now, they should be included. This will take a good bit of rework on my end. I'm going to draft this PR and work on it later this week if time allows.

Question for the masses here. For an option such as 'undefined', how would that look in the nautobot_config.py file for a setting?

from jinja2 import StrictUndefined Environment(undefined=StrictUndefined, lstrip_blocks=...)

It appears most of the settings are boolean or string values, but a few of the options listed for Jinja are enumerations or classes. If the user intended to customize that setting in their nautobot_config.py file, would they have to add the import, or is there another way to represent that?

If the user intended to customize that setting in their nautobot_config.py file, would they have to add the import

Yes, they would have to add that to the import within nautobot_config.py. We could work around it, but the complexity is not really worth it.

Thank you. I have committed what my interpretation of the request is.

I'm out of the office tomorrow and will be unable to test. We also have to get our environment upgraded from 1.5.24 to >=1.6.1 to install this version of the plugin. I will work to get this tested when I can.

Please let me know if this is the correct architecture that you're looking for, or if I need to make changes. Happy to keep plugging away at this.

@itdependsnetworks

Per request from @itdependsnetworks, add support for specifying all options passed into the environment creation in a setting named 'jinja_env'

docs/admin/admin_install.md

cablesquirrel · 2023-08-29T03:09:16Z

Corrected variable naming in the settings, plugin, and docs to match the Jinja Environment variable names since we are now using an exact match to the function parameters that are expected. Commit: f35ef16

) * feat: 🔧 Add jinja settings support for golden config plugin --------- Co-authored-by: Eric M. Hansen <eric.hansen@cox.com>

cablesquirrel added 2 commits July 17, 2023 11:30

feat: 🔧 Add jinja settings support for golden config plugin

d3941b8

nautobot#525

feat: ✨ Add support for jinja environment options

444b7fa

nautobot#525

cablesquirrel requested review from itdependsnetworks, jeffkala and nkallergis as code owners July 17, 2023 15:49

cablesquirrel changed the title ~~feat: ✨ jinja2 env settings~~ feat: ✨Add jinja settings support for golden config plugin Jul 17, 2023

cablesquirrel added 3 commits July 17, 2023 12:03

fix: 🐛 Change default setting for lstrip_blocks to False

47d96d0

nautobot#525

fix: 🐛 Correct environment variable name for lstrip_blocks option

c0287ac

nautobot#525

docs: 📝 Update docs to add jinja environment options

d655eea

nautobot#525

itdependsnetworks reviewed Jul 17, 2023

View reviewed changes

nautobot_golden_config/nornir_plays/config_intended.py Show resolved Hide resolved

cablesquirrel mentioned this pull request Jul 17, 2023

Enable lstrip_blocks Jinja2 Environment Option for Intended Configs #525

Closed

itdependsnetworks changed the title ~~feat: ✨Add jinja settings support for golden config plugin~~ [draft] feat: ✨Add jinja settings support for golden config plugin Jul 17, 2023

itdependsnetworks changed the title ~~[draft] feat: ✨Add jinja settings support for golden config plugin~~ [WIP] feat: ✨Add jinja settings support for golden config plugin Jul 17, 2023

itdependsnetworks marked this pull request as draft July 17, 2023 17:16

alextremblay mentioned this pull request Aug 25, 2023

Add jinja settings support for golden config plugin nautobot/nautobot-app-nornir#101

Closed

itdependsnetworks marked this pull request as ready for review August 26, 2023 22:34

itdependsnetworks reviewed Aug 26, 2023

View reviewed changes

nautobot_golden_config/nornir_plays/config_intended.py Outdated Show resolved Hide resolved

itdependsnetworks reviewed Aug 26, 2023

View reviewed changes

nautobot_golden_config/nornir_plays/config_intended.py Show resolved Hide resolved

docs: 💡 Correct spelling of 'django' in comment

bfa531b

itdependsnetworks changed the base branch from develop to next August 28, 2023 18:16

refactor: ♻️ Move Jinja ENV defaults

a450d6c

At the request of @jeffkala, define the 'jinja_env_trim_blocks' and 'jinja_env_lstrip_blocks' options in the plugin default settings dict

jeffkala approved these changes Aug 28, 2023

View reviewed changes

itdependsnetworks reviewed Aug 28, 2023

View reviewed changes

cablesquirrel marked this pull request as draft August 28, 2023 20:48

erhansen-cox and others added 3 commits August 28, 2023 21:42

feat: ✨ Allow setting of all Jinja2 Environment options

5162ea9

Per request from @itdependsnetworks, add support for specifying all options passed into the environment creation in a setting named 'jinja_env'

fix: 📝 Correct code fence in markdown

7c75303

Merge branch 'next' into feat-jinja2-env-settings

1f201ac

itdependsnetworks reviewed Aug 29, 2023

View reviewed changes

docs/admin/admin_install.md Outdated Show resolved Hide resolved

itdependsnetworks reviewed Aug 29, 2023

View reviewed changes

docs/admin/admin_install.md Outdated Show resolved Hide resolved

erhansen-cox added 3 commits August 28, 2023 22:47

docs: 📝 Indent code block in notes

6710c5a

docs: 📝 Correct example plugin config for Jinja2 environment settings

a460597

fix: 🐛 Use jinja variable names in place of the nautobot settings names

f35ef16

itdependsnetworks changed the title ~~[WIP] feat: ✨Add jinja settings support for golden config plugin~~ feat: ✨Add jinja settings support for golden config plugin Aug 29, 2023

itdependsnetworks marked this pull request as ready for review August 29, 2023 16:15

jeffkala approved these changes Aug 29, 2023

View reviewed changes

itdependsnetworks merged commit cdf7faf into nautobot:next Aug 29, 2023
16 checks passed

cablesquirrel deleted the feat-jinja2-env-settings branch August 31, 2023 15:44

jdrew82 mentioned this pull request Sep 22, 2023

Netutils Jinja Filters Missing #607

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ✨Add jinja settings support for golden config plugin #527

feat: ✨Add jinja settings support for golden config plugin #527

cablesquirrel commented Jul 17, 2023 •

edited

Loading

alextremblay commented Jul 31, 2023

itdependsnetworks commented Jul 31, 2023

jvanderaa commented Jul 31, 2023

jvanderaa commented Aug 3, 2023

alextremblay commented Aug 25, 2023

jeffkala commented Aug 28, 2023

cablesquirrel commented Aug 28, 2023

cablesquirrel commented Aug 28, 2023

itdependsnetworks Aug 28, 2023

cablesquirrel Aug 28, 2023

cablesquirrel Aug 28, 2023

itdependsnetworks Aug 28, 2023

cablesquirrel Aug 29, 2023

cablesquirrel commented Aug 29, 2023 •

edited

Loading

feat: ✨Add jinja settings support for golden config plugin #527

feat: ✨Add jinja settings support for golden config plugin #527

Conversation

cablesquirrel commented Jul 17, 2023 • edited Loading

alextremblay commented Jul 31, 2023

itdependsnetworks commented Jul 31, 2023

jvanderaa commented Jul 31, 2023

jvanderaa commented Aug 3, 2023

alextremblay commented Aug 25, 2023

jeffkala commented Aug 28, 2023

cablesquirrel commented Aug 28, 2023

cablesquirrel commented Aug 28, 2023

itdependsnetworks Aug 28, 2023

Choose a reason for hiding this comment

cablesquirrel Aug 28, 2023

Choose a reason for hiding this comment

cablesquirrel Aug 28, 2023

Choose a reason for hiding this comment

itdependsnetworks Aug 28, 2023

Choose a reason for hiding this comment

cablesquirrel Aug 29, 2023

Choose a reason for hiding this comment

cablesquirrel commented Aug 29, 2023 • edited Loading

cablesquirrel commented Jul 17, 2023 •

edited

Loading

cablesquirrel commented Aug 29, 2023 •

edited

Loading