test: Improve TestSSH/ForwardGPG stability on macOS via pty.ReadRune #5739
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
Writing to stdin for `coder ssh` too early could result in the input being discarded. To work around this we add a new `ptytest` method called `ReadRune` that lets us read one character of output. This will indicate the command is ready to accept input. It could be one character of the prompt, or of the loading message waiting for connection to be established.
deansheather
approved these changes
Jan 17, 2023
| @@ -475,6 +475,10 @@ Expire-Date: 0 | |||
| // real error from being printed. | |||
| t.Cleanup(cancel) | |||
|
|
|||
| // Wait for the prompt or any output really to indicate the command has | |||
| // started and accepting input on stdin. | |||
| _ = pty.ReadRune(ctx) | |||
There was a problem hiding this comment.
If the goal is to wait for output why not make a method WaitForOutput instead or something, which has similar behavior but doesn't advance the reader (e.g. using Peek instead of Read)
There was a problem hiding this comment.
That's not a bad suggestion, I think both methods can be useful though. I'll add Peek and use that instead. 👍🏻
Agreed. I was in the process of rewriting this and ReadLine to use a common method. I'll put it on my TODO to do a more complete refactor later. |
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.
Writing to stdin for
coder sshtoo early could result in the inputbeing discarded. To work around this we add a new
ptytestmethodcalled
ReadRunethat lets us read one character of output. This willindicate the command is ready to accept input.
It could be one character of the prompt, or of the loading message
waiting for connection to be established.