agent: test ListeningPorts

ammario · ammario · commit 7353a0c1d6d7 · 2022-11-28T15:14:15.000Z
diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -695,6 +695,48 @@ func TestAgent(t *testing.T) {
 			return err == nil
 		}, testutil.WaitShort, testutil.IntervalFast)
 	})
+	t.Run("ListeningPorts", func(t *testing.T) {
+		t.Parallel()
+
+		if runtime.GOOS != "linux" {
+			t.Skip("Only supported on linux currently")
+		}
+
+		conn, _, _ := setupAgent(t, codersdk.WorkspaceAgentMetadata{}, testutil.WaitShort)
+		defer conn.Close()
+
+		var wantPorts []uint16
+		for i := 0; i < 4; i++ {
+			l, err := net.Listen("tcp", "127.0.0.1:0")
+			require.NoError(t, err)
+			t.Cleanup(func() { l.Close() })
+			_, portStr, err := net.SplitHostPort(l.Addr().String())
+			require.NoError(t, err)
+			portInt, err := strconv.Atoi(portStr)
+			require.NoError(t, err)
+			wantPorts = append(wantPorts, uint16(portInt))
+		}
+
+		ctx := context.Background()
+		require.Eventually(t, func() bool {
+			ports, err := conn.ListeningPorts(ctx)
+			if err != nil {
+				panic(err)
+			}
+		outer:
+			for _, wantPort := range wantPorts {
+				for _, port := range ports.Ports {
+					if port.Port == wantPort {
+						// found this port
+						continue outer
+					}
+				}
+				t.Errorf("didn't find %v", wantPort)
+				return false
+			}
+			return true
+		}, testutil.WaitMedium, testutil.IntervalFast)
+	})
 }
 
 func setupSSHCommand(t *testing.T, beforeArgs []string, afterArgs []string) *exec.Cmd {
diff --git a/agent/ports_supported.go b/agent/ports_supported.go
@@ -15,6 +15,7 @@ func (lp *listeningPortsHandler) getListeningPorts() ([]codersdk.ListeningPort,
 	lp.mut.Lock()
 	defer lp.mut.Unlock()
 
+	// Refresh cache every second.
 	if time.Since(lp.mtime) < time.Second {
 		// copy
 		ports := make([]codersdk.ListeningPort, len(lp.ports))
