fix: Improve ptytest closure on expect match timeout #5337
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
To ensure ptytest closure always happens the same way, we now define a new `Close` function on `PTY` and always call the close function instead of manually closing read/writers. A few additional log messages have been added as well, to better understand the shutdown process in case of errors.
mtojek
approved these changes
Dec 7, 2022
| tpty.logf("closed %s: %v", name, err) | ||
| } | ||
| // Set the actual close function for the tpty. | ||
| tpty.close = func(reason string) error { |
pty/ptytest/ptytest.go
Outdated
| } | ||
| // Set the actual close function for the tpty. | ||
| tpty.close = func(reason string) error { | ||
| ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitMedium) |
There was a problem hiding this comment.
nit: in theory, this can be also WaitShort.
There was a problem hiding this comment.
I was paranoid since we're waiting on two goroutines to close, but we can always bump it if it becomes a problem. I'll go with short.
Comment on lines
+218
to
+220
| p.logf("%s: %s", reason, fmt.Sprintf(format, args...)) | ||
|
|
||
| require.FailNowf(t, reason, format, args...) | ||
| require.FailNowf(p.t, reason, format, args...) |
There was a problem hiding this comment.
I'm curious, is there a reason why these 2 lists are not merged into one call, require.FailNowf?
There was a problem hiding this comment.
Because require output differs from the common ptytest logs, this may duplicate the information but it gives an easier trail to follow.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
To ensure ptytest closure always happens the same way, we now define a
new
Closefunction onPTYand always call the close function insteadof manually closing read/writers.
A few additional log messages have been added as well, to better
understand the shutdown process in case of errors.