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.

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

client-go: Dynamically assigned local port number not retrievable when port-forwarding #73676

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions staging/src/k8s.io/client-go/tools/portforward/portforward.go
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,9 @@ func (pf *PortForwarder) forward() error {
var err error

listenSuccess := false
for _, port := range pf.ports {
err = pf.listenOnPort(&port)
for i := range pf.ports {
port := &pf.ports[i]
err = pf.listenOnPort(port)
switch {
case err == nil:
listenSuccess = true
Expand Down
76 changes: 76 additions & 0 deletions staging/src/k8s.io/client-go/tools/portforward/portforward_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ package portforward

import (
"net"
"net/http"
"os"
"reflect"
"sort"
"strings"
"testing"
"time"

"k8s.io/apimachinery/pkg/util/httpstream"
)
Expand All @@ -39,6 +41,37 @@ func (d *fakeDialer) Dial(protocols ...string) (httpstream.Connection, string, e
return d.conn, d.negotiatedProtocol, d.err
}

type fakeConnection struct {
closed bool
closeChan chan bool
}

func newFakeConnection() httpstream.Connection {
return &fakeConnection{
closeChan: make(chan bool),
}
}

func (c *fakeConnection) CreateStream(headers http.Header) (httpstream.Stream, error) {
return nil, nil
}

func (c *fakeConnection) Close() error {
if !c.closed {
c.closed = true
close(c.closeChan)
}
return nil
}

func (c *fakeConnection) CloseChan() <-chan bool {
return c.closeChan
}

func (c *fakeConnection) SetIdleTimeout(timeout time.Duration) {
// no-op
}

func TestParsePortsAndNew(t *testing.T) {
tests := []struct {
input []string
Expand Down Expand Up @@ -254,3 +287,46 @@ func TestGetListener(t *testing.T) {

}
}

func TestGetPortsReturnsDynamicallyAssignedLocalPort(t *testing.T) {
dialer := &fakeDialer{
conn: newFakeConnection(),
}

stopChan := make(chan struct{})
readyChan := make(chan struct{})
errChan := make(chan error)

defer func() {
close(stopChan)

forwardErr := <-errChan
if forwardErr != nil {
t.Fatalf("ForwardPorts returned error: %s", forwardErr)
}
}()

pf, err := New(dialer, []string{":5000"}, stopChan, readyChan, os.Stdout, os.Stderr)

if err != nil {
t.Fatalf("error while calling New: %s", err)
}

go func() {
errChan <- pf.ForwardPorts()
close(errChan)
}()

<-pf.Ready

ports, err := pf.GetPorts()

if len(ports) != 1 {
t.Fatalf("expected 1 port, got %d", len(ports))
}

port := ports[0]
if port.Local == 0 {
t.Fatalf("local port is 0, expected != 0")
}
}