Remove testutil.WaitForPort, users can use testify.Eventually

CHANGELOG.md

@@ -12,6 +12,7 @@
 - Remove `configparser.DecodeTypeAndName`, use `config.IDFromString` (#2869)
 - Remove `config.NewViper`, users should use `config.NewParser` (#2917)
 - Remove `testutil.WaitFor`, use `testify.Eventually` helper if needed (#2920)
+- Remove testutil.WaitForPort, users can use testify.Eventually (#2926)
 
 ## 💡 Enhancements 💡
 

receiver/jaegerreceiver/jaeger_agent_test.go

@@ -157,7 +157,14 @@ func TestJaegerHTTP(t *testing.T) {
 	assert.NoError(t, jr.Start(context.Background(), componenttest.NewNopHost()), "Start failed")
 
 	// allow http server to start
-	assert.NoError(t, testutil.WaitForPort(t, port), "WaitForPort failed")
+	assert.Eventually(t, func() bool {
+		conn, err := net.Dial("tcp", fmt.Sprintf("localhost:%d", port))
+		if err == nil && conn != nil {
+			conn.Close()
+			return true
+		}
+		return false
+	}, 10*time.Second, 5*time.Millisecond, "failed to wait for the port to be open")
 
 	resp, err := http.Get(fmt.Sprintf("http://localhost:%d/sampling?service=test", port))
 	assert.NoError(t, err, "should not have failed to make request")

testbed/testbed/test_case.go

@@ -195,8 +195,12 @@ func (tc *TestCase) StartAgent(args ...string) {
 		// if the endpoint is not-empty, i.e. the sender does use network (some senders
 		// like text log writers don't).
 		tc.WaitFor(func() bool {
-			_, err := net.Dial(tc.LoadGenerator.sender.GetEndpoint().Network(), tc.LoadGenerator.sender.GetEndpoint().String())
-			return err == nil
+			conn, err := net.Dial(tc.LoadGenerator.sender.GetEndpoint().Network(), tc.LoadGenerator.sender.GetEndpoint().String())
+			if err == nil && conn != nil {
+				conn.Close()
+				return true
+			}
+			return false
 		})
 	}
 }

testutil/testutil.go

@@ -17,7 +17,6 @@ package testutil
 import (
 	"bytes"
 	"encoding/json"
-	"fmt"
 	"io"
 	"io/ioutil"
 	"net"
@@ -27,7 +26,6 @@ import (
 	"strconv"
 	"strings"
 	"testing"
-	"time"
 
 	"github.com/stretchr/testify/require"
 )
@@ -143,35 +141,6 @@ func createExclusionsList(exclusionsText string, t *testing.T) []portpair {
 	return exclusions
 }
 
-// WaitForPort repeatedly attempts to open a local port until it either succeeds or 5 seconds pass
-// It is useful if you need to asynchronously start a service and wait for it to start
-func WaitForPort(t *testing.T, port uint16) error {
-	t.Helper()
-
-	totalDuration := 5 * time.Second
-	wait := 100 * time.Millisecond
-	address := fmt.Sprintf("localhost:%d", port)
-
-	ticker := time.NewTicker(wait)
-	defer ticker.Stop()
-
-	timeout := time.After(totalDuration)
-
-	for {
-		select {
-		case <-ticker.C:
-			conn, err := net.Dial("tcp", address)
-			if err == nil && conn != nil {
-				conn.Close()
-				return nil
-			}
-
-		case <-timeout:
-			return fmt.Errorf("failed to wait for port %d", port)
-		}
-	}
-}
-
 // LimitedWriter is an io.Writer that will return an EOF error after MaxLen has
 // been reached.  If MaxLen is 0, Writes will always succeed.
 type LimitedWriter struct {

testutil/testutil_test.go

@@ -15,7 +15,6 @@
 package testutil
 
 import (
-	"fmt"
 	"net"
 	"strconv"
 	"testing"
@@ -34,22 +33,6 @@ func TestGetAvailablePort(t *testing.T) {
 	testEndpointAvailable(t, "localhost:"+portStr)
 }
 
-func TestWaitForPort(t *testing.T) {
-	port := GetAvailablePort(t)
-	err := WaitForPort(t, port)
-	require.Error(t, err)
-
-	port = GetAvailablePort(t)
-	l, err := net.Listen("tcp", fmt.Sprintf("localhost:%d", port))
-	require.NoError(t, err)
-
-	err = WaitForPort(t, port)
-	require.NoError(t, err)
-
-	err = l.Close()
-	require.NoError(t, err)
-}
-
 func testEndpointAvailable(t *testing.T, endpoint string) {
 	// Endpoint should be free.
 	ln0, err := net.Listen("tcp", endpoint)