Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix racy X11 forwarding test #48045

Merged
merged 1 commit into from
Oct 29, 2024
Merged

Fix racy X11 forwarding test #48045

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions integration/integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4740,7 +4740,7 @@ func testX11Forwarding(t *testing.T, suite *integrationTestSuite) {

// Reading the display may fail if the session is not fully initialized
// and the write to stdin is swallowed.
var display string
display := make(chan string, 1)
require.EventuallyWithT(t, func(t *assert.CollectT) {
// enter 'printenv DISPLAY > /path/to/tmp/file' into the session (dumping the value of DISPLAY into the temp file)
_, err = keyboard.Write([]byte(fmt.Sprintf("printenv %v > %s\n\r", x11.DisplayEnv, tmpFile.Name())))
Expand All @@ -4749,15 +4749,15 @@ func testX11Forwarding(t *testing.T, suite *integrationTestSuite) {
assert.Eventually(t, func() bool {
output, err := os.ReadFile(tmpFile.Name())
if err == nil && len(output) != 0 {
display = strings.TrimSpace(string(output))
display <- strings.TrimSpace(string(output))
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a buffer of 1 should be okay, since as soon as this write occurs the entire require.EventuallyWithT should complete, but would appreciate more 👀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could make it a non-blocking channel write that just discards the value if there's something in the channel already?

return true
}
return false
}, time.Second, 100*time.Millisecond, "failed to read display")
}, 10*time.Second, time.Second)

// Make a new connection to the XServer proxy to confirm that forwarding is working.
serverDisplay, err := x11.ParseDisplay(display)
serverDisplay, err := x11.ParseDisplay(<-display)
require.NoError(t, err)

conn, err := serverDisplay.Dial()
Expand Down
Loading