fix: Better method to detect helm chart version in template tests #3781
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
template tests
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
Please add unit tests for this to prevent regression in case of change |
sumo-drosiek
reviewed
Jul 8, 2024
tests/helm/goldenfile_test.go
Outdated
Comment on lines
136
to
143
| patternString := fmt.Sprintf( | ||
| `(?m)^(\s*app\.kubernetes\.io\/version:\s*"%s"\s*)$`+ | ||
| `|^(\s*chart:\s*"sumologic-%s"\s*)$`+ | ||
| `|^(\s*chart:\s*sumologic-%s\s*)$`+ | ||
| `|^(\s*client:\s*k8s_%s\s*)$`+ | ||
| `|^(\s*value:\s*"%s"\s*)$`, | ||
| chartVersion, chartVersion, chartVersion, chartVersion, chartVersion) | ||
| pattern := regexp.MustCompile(patternString) |
There was a problem hiding this comment.
As it's correct, it's not so easy to understand the regex. I would recommend to create list of strings (regexes if strings won't be sufficient), and then iterate over them and replace them in the output. I wouldn't want to maintain it in actual form after all
sumo-drosiek
reviewed
Jul 9, 2024
tests/helm/goldenfile_test.go
Outdated
Comment on lines
136
to
142
| replacements := map[string]string{ | ||
| fmt.Sprintf("app.kubernetes.io/version: \"%s\"", chartVersion): "app.kubernetes.io/version: \"%CURRENT_CHART_VERSION%\"", | ||
| fmt.Sprintf("chart: \"sumologic-%s\"", chartVersion): "chart: \"sumologic-%CURRENT_CHART_VERSION%\"", | ||
| fmt.Sprintf("chart: sumologic-%s", chartVersion): "chart: sumologic-%CURRENT_CHART_VERSION%", | ||
| fmt.Sprintf("client: k8s_%s", chartVersion): "client: k8s_%CURRENT_CHART_VERSION%", | ||
| fmt.Sprintf("value: \"%s\"", chartVersion): "value: \"%CURRENT_CHART_VERSION%\"", | ||
| } |
There was a problem hiding this comment.
Suggested change
| replacements := map[string]string{ | |
| fmt.Sprintf("app.kubernetes.io/version: \"%s\"", chartVersion): "app.kubernetes.io/version: \"%CURRENT_CHART_VERSION%\"", | |
| fmt.Sprintf("chart: \"sumologic-%s\"", chartVersion): "chart: \"sumologic-%CURRENT_CHART_VERSION%\"", | |
| fmt.Sprintf("chart: sumologic-%s", chartVersion): "chart: sumologic-%CURRENT_CHART_VERSION%", | |
| fmt.Sprintf("client: k8s_%s", chartVersion): "client: k8s_%CURRENT_CHART_VERSION%", | |
| fmt.Sprintf("value: \"%s\"", chartVersion): "value: \"%CURRENT_CHART_VERSION%\"", | |
| } | |
| replacements :=[]string{ | |
| "app.kubernetes.io/version: \"%s\"", | |
| "chart: \"sumologic-%s\"", | |
| "chart: sumologic-%s", | |
| "client: k8s_%s", | |
| "value: \"%s\"", | |
| } |
tests/helm/goldenfile_test.go
Outdated
Comment on lines
146
to
148
| for oldString, newString := range replacements { | ||
| output = strings.ReplaceAll(output, oldString, newString) | ||
| } |
There was a problem hiding this comment.
Suggested change
| for oldString, newString := range replacements { | |
| output = strings.ReplaceAll(output, oldString, newString) | |
| } | |
| for_, r := range replacements { | |
| output = strings.ReplaceAll(output, fmt.Sprintf(r, chartVersion), fmt.Sprintf(r, "%CURRENT_CHART_VERSION%")) | |
| } |
echlebek
requested changes
Jul 11, 2024
tests/helm/goldenfile_test.go
Outdated
Comment on lines
136
to
142
| // replacements := map[string]string{ | ||
| // fmt.Sprintf("app.kubernetes.io/version: \"%s\"", chartVersion): "app.kubernetes.io/version: \"%CURRENT_CHART_VERSION%\"", | ||
| // fmt.Sprintf("chart: \"sumologic-%s\"", chartVersion): "chart: \"sumologic-%CURRENT_CHART_VERSION%\"", | ||
| // fmt.Sprintf("chart: sumologic-%s", chartVersion): "chart: sumologic-%CURRENT_CHART_VERSION%", | ||
| // fmt.Sprintf("client: k8s_%s", chartVersion): "client: k8s_%CURRENT_CHART_VERSION%", | ||
| // fmt.Sprintf("value: \"%s\"", chartVersion): "value: \"%CURRENT_CHART_VERSION%\"", | ||
| // } |
There was a problem hiding this comment.
Commented out code should be removed
tests/helm/goldenfile_test.go
Outdated
Comment on lines
144
to
148
| "app.kubernetes.io/version: \"%s\"", | ||
| "chart: \"sumologic-%s\"", | ||
| "chart: sumologic-%s", | ||
| "client: k8s_%s", | ||
| "value: \"%s\"", |
There was a problem hiding this comment.
Use %q instead of %s for items that need to be surrounded in quotes, as this allows you to avoid escapes here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change finds a new method using regex for updating the helm chart version without affecting any other version that matches it
Find the Ticket
Checklist