Templating Update #358
Templating Update #358
Conversation
|
seems really cool like this , even if the delimiter overall, you should try to clean a lil bit all the tabs/ new line , it's kinda hard to read clearly all the changes. |
|
@DrummyFloyd thanks for the feedback. This still works with all the current templating in place, to include the cert manager annotations. I am working on cleaning it up a bit more but wanted feedback before I went too far. |
… 0.93.0 skip-checks:true
…io#363) * fix : timeout issue for argocd and vault * Update Dockerfile * Update argocd.go
There was a problem hiding this comment.
Leaving some general comments. Thanks a lot for your help answering my questions on Slack, @dahendel!
pkg/providerConfigs/detokenize.go
Outdated
| // If no match found, return the original input as a string, so we can have a visual indication | ||
| // that the token was not found in the Token Struct without erroring out | ||
| return "<variable-not-found>" |
There was a problem hiding this comment.
It seems the comment is off, since the return does not return the original input as a string, but the hardcoded string instead (the original input could've been <FOO_BAR> but it won't return that).
pkg/providerConfigs/detokenize.go
Outdated
| func ToTemplateVars(input string, instance Tokens) string { | ||
| value := reflect.ValueOf(instance) | ||
| if value.Kind() == reflect.Ptr { | ||
| value = value.Elem() | ||
| } | ||
| sanitizer := strings.NewReplacer("<", "", "_", "", ">", "", "-", "") | ||
|
|
||
| fields := value.Type() | ||
| normalizedName := strings.ToLower(sanitizer.Replace(input)) | ||
| for i := 0; i < fields.NumField(); i++ { | ||
| field := fields.Field(i) | ||
| val := value.Field(i) | ||
|
|
||
| if normalizedName == strings.ToLower(field.Name) { | ||
| // If the field value is the zero value of the field template | ||
| // will add - to the template variable to clean up extra whitespace. | ||
| // We do not have any bool values in the tokens, so we should be ok. | ||
| // TODO: Find a better way to handle this. | ||
| if val.IsZero() { | ||
| return fmt.Sprintf("%s- .%s %s", leftDelimiter, field.Name, rightDelimiter) | ||
| } | ||
| // if field name matches return the correct formatted name | ||
| return fmt.Sprintf("%s .%s %s", leftDelimiter, field.Name, rightDelimiter) | ||
| } | ||
| } | ||
|
|
||
| // If no match found, return the original input as a string, so we can have a visual indication | ||
| // that the token was not found in the Token Struct without erroring out | ||
| return "<variable-not-found>" | ||
| } |
There was a problem hiding this comment.
This function would definitely benefit from a table test, especially for the zero-value handling to ensure other devs don't break the code.
pkg/providerConfigs/detokenize.go
Outdated
| return err | ||
| } | ||
| func replaceTemplateVariables(content string, tokens Tokens) string { | ||
| regex := regexp.MustCompile(TokenRegexPattern) |
There was a problem hiding this comment.
To prevent paying the compilation price, the MustCompile could be called outside of the function once and save some CPU cycles 😄
pkg/providerConfigs/detokenize.go
Outdated
| funcs := sprig.GenericFuncMap() | ||
| funcs["toJson"] = toJson |
There was a problem hiding this comment.
Masterminds/sprig includes a toJson function already and the function below seems generic enough
pkg/providerConfigs/detokenize.go
Outdated
| func detokenize(path string, tokens Tokens, gitProtocol string, useCloudflareOriginIssuer bool) filepath.WalkFunc { | ||
| return filepath.WalkFunc(func(path string, fi os.FileInfo, err error) error { |
There was a problem hiding this comment.
Seems to have been there from before but the path string from func detokenize() is never used, since the path string inside filepath.WalkFunc is not the same as the top one.
pkg/providerConfigs/constants.go
Outdated
| leftDelimiter = "${k1" | ||
| rightDelimiter = "}" |
There was a problem hiding this comment.
After discussing with the rest of the team, we want to go with these for delimiters:
| leftDelimiter = "${k1" | |
| rightDelimiter = "}" | |
| leftDelimiter = "<%" | |
| rightDelimiter = "%>" |
This PR adds go templating support while aiming to not introduce any breaking changes to the current
gitops-templatesrepository or code functionality.It also adds
detokenize_test.gowhich clones a template repo and then executes theDetokenizeGitGitopsfunction calls on the supplied path.Introduces
Tokensinterface to help reduce duplicate code.The code works as follows:
<GITOPS_REPO_URL>becomes${K1 .GitopsRepoURL }