Add additional template functions #569
Conversation
|
an example for using it in nova for the nova.conf is in openstack-k8s-operators/nova-operator#874 |
.pre-commit-config.yaml
Outdated
| exclude: | | ||
| (?x)( | ||
| ^vendor| | ||
| ^modules/common/util/template_util_test.go |
There was a problem hiding this comment.
I had to add this because of the test data for TestRemoveNewLines where I test spaces and tabs in empty lines
There was a problem hiding this comment.
this feels a bit scary. I would the test data to normal strings with \n and \t to avoid this. But that can be done in a follow up.
There was a problem hiding this comment.
I have removed the spaces from the test data and returned the config.
|
we coudl do this but i guess we were trying to avoid defienign our own dsl |
yes we should not introduce a lot of/further complexity. At least right now I am not aware of something else needed. I can remove the |
yep that is a plus as it not a net new way of doing this. |
modules/common/util/template_util.go
Outdated
| } | ||
|
|
||
| // template function to remove empty lines if there are > n continuous empty lines | ||
| func removeNewLines(n int, in string) (out string) { |
There was a problem hiding this comment.
IIUTC, this allow people to have n number of lines in between.
I think we may not need this in case conf files, but may be for other templates!
There was a problem hiding this comment.
this will remove n number of continuous empty lines, like you wanted to achieve, only not covering the special use case for the section headers.
There was a problem hiding this comment.
yep and for readabliyt we shoudl be ensuring that we have the correct spaceing for the headers in the template anyway so I'm fine with the proposal to just remove multiple newlines and leave having a new line before section to how we write the template.
|
I think its better approach, as there are only template level changes at operator side. right now, the removeNewLines function is not working as we want/expected, I had tested it locally. (but that may not be the focus of this patch) |
Isnt' this what you wanted? it will remove multiple continuous empty lines and just keep a single?
|
yes, after adding for section-header with n =0, it should work |
I have added a form of your cleanup func from #557 and added you as co-author to the commit msg. I was just not sure if you want your full name listed there as it is not shown in your github account. I can change that, just let me know. |
|
reflecting on this over the weekend i think I'm satisfied that this is a better approach to achieve this usecase, i left one comment inline but I'm mostly happy with this as proposed. |
|
lgtm |
.pre-commit-config.yaml
Outdated
| exclude: | | ||
| (?x)( | ||
| ^vendor| | ||
| ^modules/common/util/template_util_test.go |
There was a problem hiding this comment.
this feels a bit scary. I would the test data to normal strings with \n and \t to avoid this. But that can be done in a follow up.
Adds template functions which:
- to exec an inline template
- indent a template
- remove n continuous empty lines from a template
- specific to openstack ini files, removes all new lines in sections,
but have them in section separation.
An example would be a template like:
```
{{define "my-template"}}new template
content
with empty lines
to
remove
{{end}}
Some other template content and add the rendered from my-template
{{$var := execTempl "my-template" . | removeNewLines 1}}
{{$var}}
```
Co-authored-by: auniyal61
Signed-off-by: Martin Schuppert <[email protected]>
Adds templat functions which:
An example would be a template like: