auto-tune: refactor to use text/template library #58
+35
−24
Conversation
This file contains hidden or 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
While reviewing this to understand the story better, I noticed that we could simplify creating the cnf file by using the text/template package This feels a little more clear about what's happening compared to hacking together the strings as it was done before The only gotcha - we need to use hyphens, "-", to clean up whitespace and make sure we don't accidentally add newlines. But the existing tests drove this out [TNZ-36064](https://jira.eng.vmware.com/browse/TNZ-36064) Authored-by: Ryan Wittrup <[email protected]>
cf-foundation-community-automation
bot
moved this to Inbox
in Foundational Infrastructure Working Group
abg
requested changes
Apr 17, 2025
| . "github.com/onsi/ginkgo/v2" | ||
| . "github.com/onsi/gomega" | ||
| "github.com/onsi/gomega/format" |
There was a problem hiding this comment.
$ go vet ./...
vet: ./auto_tune_generator_test.go:9:2: "github.com/onsi/gomega/format" imported and not used
$ go run github.com/onsi/ginkgo/v2/ginkgo run -v
...
# github.com/cloudfoundry/generate-auto-tune-mysql_test [github.com/cloudfoundry/generate-auto-tune-mysql.test]
./auto_tune_generator_test.go:9:2: "github.com/onsi/gomega/format" imported and not used
| tmpl, _ := template.New("auto_tune").Parse(` | ||
| [mysqld] | ||
| innodb_buffer_pool_size = {{.BufferPoolSize}} | ||
| {{if ne .TargetPercentageOfDisk 0.0 -}} |
There was a problem hiding this comment.
I understand we were programmatically comparing this before, but I would be keen to consider turning this into a boolean to reduce template logic, particularly around float comparisons.
i.e. Compute the inputs up-front and the template is just rendering logic.
For example, this go playground snippet:
| maxBinlogSize := min(int64(binLogSpaceLimit/3), 1024*1024*1024) | ||
| maxBinlogSize = (maxBinlogSize / binlogBlockSize) * binlogBlockSize | ||
|
|
||
| tmpl, _ := template.New("auto_tune").Parse(` |
There was a problem hiding this comment.
I would feel better if we assert the error though.
There are conditionals that are hopefully driven out in the unit tests (effectively exercising all the template paths).
Since this should only be a programmatic error, maybe https://pkg.go.dev/text/template#Must could be reasonable.
github-project-automation
bot
moved this from Inbox
to Waiting for Changes | Open for Contribution
in Foundational Infrastructure Working Group
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.
While reviewing this to understand the story better, I noticed that we could simplify creating the cnf file by using the text/template package
This feels a little more clear about what's happening compared to hacking together the strings as it was done before
The only gotcha - we need to use hyphens, "-", to clean up whitespace and make sure we don't accidentally add newlines. But the existing tests drove this out
TNZ-36064
Authored-by: Ryan Wittrup [email protected]