Skip to content

Enable synctest-based SSH proxy connection tests #4950

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

Open
pietern wants to merge 1 commit into
base: main
Choose a base branch
from
+110 −113
Open

Enable synctest-based SSH proxy connection tests #4950

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
223 changes: 110 additions & 113 deletions experimental/ssh/internal/proxy/connections_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ import (
"fmt"
"sync"
"testing"
"testing/synctest"
"time"

// TODO: re-enable synctests after we update to Go 1.25
// "testing/synctest"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestConnectionsManager_TryAdd_Success(t *testing.T) {
Expand Down Expand Up @@ -137,113 +136,111 @@ func TestConnectionsManager_ThreadSafety(t *testing.T) {
assert.Equal(t, 0, finalCount)
}

// TODO: re-enable synctests after we update to Go 1.25

// func TestConnectionsManager_ShutdownTimer_TriggersOnEmptyConnections(t *testing.T) {
// synctest.Test(t, func(t *testing.T) {
// cm := NewConnectionsManager(3, time.Second)
// timedOut := false
// go func() {
// select {
// case <-cm.TimedOut:
// timedOut = true
// case <-time.After(time.Hour):
// }
// }()
// time.Sleep(time.Hour)
// synctest.Wait()
// assert.True(t, timedOut, "Expected timeout signal but didn't receive one")
// })
// }

// func TestConnectionsManager_ShutdownTimer_CancelledWhenConnectionAdded(t *testing.T) {
// synctest.Test(t, func(t *testing.T) {
// cm := NewConnectionsManager(3, time.Second)
// timedOut := false
// go func() {
// select {
// case <-cm.TimedOut:
// timedOut = true
// case <-time.After(time.Hour):
// }
// }()

// // Add connection to cancel shutdown timer
// conn := &proxyConnection{}
// result := cm.TryAdd("test-id", conn)
// require.True(t, result)

// time.Sleep(time.Hour)
// synctest.Wait()
// assert.False(t, timedOut, "Unexpected timeout signal while connection exists")
// })
// }

// func TestConnectionsManager_ShutdownTimer_RestartsWhenLastConnectionRemoved(t *testing.T) {
// synctest.Test(t, func(t *testing.T) {
// cm := NewConnectionsManager(3, time.Second)
// conn := &proxyConnection{}
// timedOut := false
// go func() {
// select {
// case <-cm.TimedOut:
// timedOut = true
// case <-time.After(time.Hour):
// }
// }()

// // Add connection
// result := cm.TryAdd("test-id", conn)
// require.True(t, result)

// // Wait a bit to ensure timer would have triggered if not cancelled
// time.Sleep(time.Hour)
// synctest.Wait()
// assert.False(t, timedOut, "Unexpected timeout signal while connection exists")

// // Setup new goroutine to listen for timeout signal
// timedOut = false
// go func() {
// select {
// case <-cm.TimedOut:
// timedOut = true
// case <-time.After(time.Hour):
// }
// }()
// // Remove connection - should restart shutdown timer
// cm.Remove("test-id")
// time.Sleep(time.Hour)
// synctest.Wait()
// assert.True(t, timedOut, "Expected timeout signal after last connection removed but didn't receive one")
// })
// }

// func TestConnectionsManager_ShutdownTimer_NoRestartWhenConnectionsRemain(t *testing.T) {
// synctest.Test(t, func(t *testing.T) {
// cm := NewConnectionsManager(3, time.Second)
// timedOut := false
// go func() {
// select {
// case <-cm.TimedOut:
// timedOut = true
// case <-time.After(time.Hour):
// }
// }()
// conn1 := &proxyConnection{}
// conn2 := &proxyConnection{}

// // Add two connections
// result := cm.TryAdd("conn1", conn1)
// require.True(t, result)
// result = cm.TryAdd("conn2", conn2)
// require.True(t, result)

// // Remove one connection - timer should not restart since connections remain
// cm.Remove("conn1")
// assert.Equal(t, 1, cm.Count())

// time.Sleep(time.Hour)
// synctest.Wait()
// assert.False(t, timedOut, "Unexpected timeout signal while connections still exist")
// })
// }
func TestConnectionsManager_ShutdownTimer_TriggersOnEmptyConnections(t *testing.T) {
synctest.Test(t, func(t *testing.T) {
cm := NewConnectionsManager(3, time.Second)
timedOut := false
go func() {
select {
case <-cm.TimedOut:
timedOut = true
case <-time.After(time.Hour):
}
}()
time.Sleep(time.Hour)
synctest.Wait()
assert.True(t, timedOut, "Expected timeout signal but didn't receive one")
})
}

func TestConnectionsManager_ShutdownTimer_CancelledWhenConnectionAdded(t *testing.T) {
synctest.Test(t, func(t *testing.T) {
cm := NewConnectionsManager(3, time.Second)
timedOut := false
go func() {
select {
case <-cm.TimedOut:
timedOut = true
case <-time.After(time.Hour):
}
}()

// Add connection to cancel shutdown timer
conn := &proxyConnection{}
result := cm.TryAdd("test-id", conn)
require.True(t, result)

time.Sleep(time.Hour)
synctest.Wait()
assert.False(t, timedOut, "Unexpected timeout signal while connection exists")
})
}

func TestConnectionsManager_ShutdownTimer_RestartsWhenLastConnectionRemoved(t *testing.T) {
synctest.Test(t, func(t *testing.T) {
cm := NewConnectionsManager(3, time.Second)
conn := &proxyConnection{}
timedOut := false
go func() {
select {
case <-cm.TimedOut:
timedOut = true
case <-time.After(time.Hour):
}
}()

// Add connection
result := cm.TryAdd("test-id", conn)
require.True(t, result)

// Wait a bit to ensure timer would have triggered if not cancelled
time.Sleep(time.Hour)
synctest.Wait()
assert.False(t, timedOut, "Unexpected timeout signal while connection exists")

// Setup new goroutine to listen for timeout signal
timedOut = false
go func() {
select {
case <-cm.TimedOut:
timedOut = true
case <-time.After(time.Hour):
}
}()
// Remove connection - should restart shutdown timer
cm.Remove("test-id")
time.Sleep(time.Hour)
synctest.Wait()
assert.True(t, timedOut, "Expected timeout signal after last connection removed but didn't receive one")
})
}

func TestConnectionsManager_ShutdownTimer_NoRestartWhenConnectionsRemain(t *testing.T) {
synctest.Test(t, func(t *testing.T) {
cm := NewConnectionsManager(3, time.Second)
timedOut := false
go func() {
select {
case <-cm.TimedOut:
timedOut = true
case <-time.After(time.Hour):
}
}()
conn1 := &proxyConnection{}
conn2 := &proxyConnection{}

// Add two connections
result := cm.TryAdd("conn1", conn1)
require.True(t, result)
result = cm.TryAdd("conn2", conn2)
require.True(t, result)

// Remove one connection - timer should not restart since connections remain
cm.Remove("conn1")
assert.Equal(t, 1, cm.Count())

time.Sleep(time.Hour)
synctest.Wait()
assert.False(t, timedOut, "Unexpected timeout signal while connections still exist")
})
}
Loading