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

Add constructor for creating portForwardEntry #2648

Merged
merged 2 commits into from
Aug 14, 2019
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 11 additions & 16 deletions pkg/skaffold/kubernetes/portforward/entry_manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,17 @@ func TestNewEntryManager(t *testing.T) {
}

func TestStop(t *testing.T) {
pfe1 := &portForwardEntry{
resource: latest.PortForwardResource{
Type: constants.Pod,
Name: "resource",
Namespace: "default",
},
localPort: 9000,
}
pfe2 := &portForwardEntry{
resource: latest.PortForwardResource{
Type: constants.Pod,
Name: "resource2",
Namespace: "default",
},
localPort: 9001,
}
pfe1 := newPortForwardEntry(0, latest.PortForwardResource{
Type: constants.Pod,
Name: "resource",
Namespace: "default",
}, "", "", "", 9000, false)

pfe2 := newPortForwardEntry(0, latest.PortForwardResource{
Type: constants.Pod,
Name: "resource2",
Namespace: "default",
}, "", "", "", 9001, false)

em := NewEntryManager(ioutil.Discard, nil)

Expand Down
11 changes: 1 addition & 10 deletions pkg/skaffold/kubernetes/portforward/pod_forwarder.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package portforward
import (
"context"
"strconv"
"sync"

"github.com/GoogleContainerTools/skaffold/pkg/skaffold/color"
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
Expand Down Expand Up @@ -138,15 +137,7 @@ func (p *WatchingPodForwarder) podForwardingEntry(resourceVersion, containerName
if err != nil {
return nil, errors.Wrap(err, "converting resource version to integer")
}
entry := &portForwardEntry{
resource: resource,
resourceVersion: rv,
podName: resource.Name,
containerName: containerName,
portName: portName,
automaticPodForwarding: true,
terminationLock: &sync.Mutex{},
}
entry := newPortForwardEntry(rv, resource, resource.Name, containerName, portName, 0, true)

// If we have, return the current entry
oldEntry, ok := p.forwardedResources.Load(entry.key())
Expand Down
14 changes: 14 additions & 0 deletions pkg/skaffold/kubernetes/portforward/port_forward_entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ type portForwardEntry struct {
cancel context.CancelFunc
}

// newPortForwardEntry returns a port forward entry.
func newPortForwardEntry(resourceVersion int, resource latest.PortForwardResource, podName, containerName, portName string, localPort int, automaticPodForwarding bool) *portForwardEntry {
return &portForwardEntry{
resourceVersion: resourceVersion,
resource: resource,
podName: podName,
containerName: containerName,
portName: portName,
localPort: localPort,
automaticPodForwarding: automaticPodForwarding,
terminationLock: &sync.Mutex{},
}
}

// key is an identifier for the lock on a port during the skaffold dev cycle.
// if automaticPodForwarding is set, we return a key that doesn't include podName, since we want the key
// to be the same whenever pods restart
Expand Down
45 changes: 18 additions & 27 deletions pkg/skaffold/kubernetes/portforward/port_forward_entry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,21 @@ func TestPortForwardEntryKey(t *testing.T) {
}{
{
description: "entry for pod",
pfe: &portForwardEntry{
resource: latest.PortForwardResource{
Type: "pod",
Name: "podName",
Namespace: "default",
Port: 8080,
},
},
pfe: newPortForwardEntry(0, latest.PortForwardResource{
Type: "pod",
Name: "podName",
Namespace: "default",
Port: 8080,
}, "", "", "", 0, false),
expected: "pod-podName-default-8080",
}, {
description: "entry for deploy",
pfe: &portForwardEntry{
resource: latest.PortForwardResource{
Type: "deployment",
Name: "depName",
Namespace: "namespace",
Port: 9000,
},
},
pfe: newPortForwardEntry(0, latest.PortForwardResource{
Type: "deployment",
Name: "depName",
Namespace: "namespace",
Port: 9000,
}, "", "", "", 0, false),
expected: "deployment-depName-namespace-9000",
},
}
Expand Down Expand Up @@ -78,17 +74,12 @@ func TestAutomaticPodForwardingKey(t *testing.T) {
}{
{
description: "entry for automatically port forwarded pod",
pfe: &portForwardEntry{
containerName: "containerName",
portName: "portName",
resource: latest.PortForwardResource{
Type: "pod",
Name: "podName",
Namespace: "default",
Port: 8080,
},
automaticPodForwarding: true,
},
pfe: newPortForwardEntry(0, latest.PortForwardResource{
Type: "pod",
Name: "podName",
Namespace: "default",
Port: 8080,
}, "", "containerName", "portName", 0, true),
expected: "containerName-default-portName-8080",
},
}
Expand Down
19 changes: 6 additions & 13 deletions pkg/skaffold/kubernetes/portforward/port_forward_integration.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package portforward
import (
"context"
"os"
"sync"
"testing"
"time"

Expand All @@ -38,18 +37,12 @@ func WhiteBoxPortForwardCycle(t *testing.T, kubectlCLI *kubectl.CLI, namespace s
portForwardEvent = func(entry *portForwardEntry) {}
ctx := context.Background()
localPort := retrieveAvailablePort(9000, em.forwardedPorts)
pfe := &portForwardEntry{
resource: latest.PortForwardResource{
Type: "deployment",
Name: "leeroy-web",
Namespace: namespace,
Port: 8080,
},
containerName: "dummy container",
localPort: localPort,
terminationLock: &sync.Mutex{},
}

pfe := newPortForwardEntry(0, latest.PortForwardResource{
Type: "deployment",
Name: "leeroy-web",
Namespace: namespace,
Port: 8080,
}, "", "dummy container", "", localPort, false)
defer em.Stop()
em.forwardPortForwardEntry(ctx, pfe)
em.Stop()
Expand Down
7 changes: 2 additions & 5 deletions pkg/skaffold/kubernetes/portforward/resource_forwarder.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package portforward

import (
"context"
"sync"

"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
"github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes"
Expand Down Expand Up @@ -81,10 +80,8 @@ func (p *ResourceForwarder) portForwardResource(ctx context.Context, resource la

func (p *ResourceForwarder) getCurrentEntry(resource latest.PortForwardResource) *portForwardEntry {
// determine if we have seen this before
entry := &portForwardEntry{
resource: resource,
terminationLock: &sync.Mutex{},
}
entry := newPortForwardEntry(0, resource, "", "", "", 0, false)

// If we have, return the current entry
oldEntry, ok := p.forwardedResources.Load(entry.key())

Expand Down
10 changes: 2 additions & 8 deletions pkg/skaffold/kubernetes/portforward/resource_forwarder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,7 @@ func TestGetCurrentEntryFunc(t *testing.T) {
Port: 8080,
},
availablePorts: []int{8080},
expected: &portForwardEntry{
localPort: 8080,
terminationLock: &sync.Mutex{},
},
expected: newPortForwardEntry(0, latest.PortForwardResource{}, "", "", "", 8080, false),
}, {
description: "port forward existing deployment",
resource: latest.PortForwardResource{
Expand All @@ -177,10 +174,7 @@ func TestGetCurrentEntryFunc(t *testing.T) {
localPort: 9000,
},
},
expected: &portForwardEntry{
localPort: 9000,
terminationLock: &sync.Mutex{},
},
expected: newPortForwardEntry(0, latest.PortForwardResource{}, "", "", "", 9000, false),
},
}

Expand Down