refactor: executor functional options #2085
Merged
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
andreynering approved these changes Feb 23, 2025
executor.go Outdated
Comment on lines 231 to 301
| func WithStdin(stdin io.Reader) ExecutorOption { | ||
| return func(e *Executor) { | ||
| e.Stdin = stdin | ||
| } | ||
| } | ||
| | ||
| func WithStdout(stdout io.Writer) ExecutorOption { | ||
| return func(e *Executor) { | ||
| e.Stdout = stdout | ||
| } | ||
| } | ||
| | ||
| func WithStderr(stderr io.Writer) ExecutorOption { | ||
| return func(e *Executor) { | ||
| e.Stderr = stderr | ||
| } | ||
| } |
There was a problem hiding this comment.
In theory we could have an additional function that accepts all three, for shortness. Optional suggestion, though.
func WithIO(stdin io.Reader, stdout, stderr io.Writer) ExecutorOption { return func(e *Executor) { e.Stdin = stdin e.Stdout = stdout e.Stderr = stderr } }There was a problem hiding this comment.
To me, it makes more sense to keep these separate if you're passing different values into each of them. Sometimes you might only want to pass in 1 or 2 of them and leave the others blank. However, I think if you're setting them all to the same value, we could have something like this:
func WithIO(rw io.ReadWriter) ExecutorOption { return func(e *Executor) { e.Stdin = rw e.Stdout = rw e.Stderr = rw } }This would be super handy in the new tests I've been writing where we want to write everything to a single buffer.
pd93 added the area: package api 
pd93 force-pushed the executor-functional-options branch from ec2aa2e to 60ff636 Compare 
| Couple of minor changes:
|
pd93 added a commit that referenced this pull request Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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 PR migrates the
Executorto use the functional options pattern. This follows other similar changes totaskfile.Readerandtaskfile.Snippet. This allows package API users to easily construct anExecutorwith sensible defaults and only supply a list of things they want to override.Our internal CLI implementation has a special functional option in
internal/flagscalledWithFlagswhich will gather all the CLI flags and pass them in as functional options.