-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2661 from priyawadhwa/kubectltest
Add unit tests to kubectl forwarder
- Loading branch information
Showing
5 changed files
with
199 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
164 changes: 164 additions & 0 deletions
164
pkg/skaffold/kubernetes/portforward/kubectl_forwarder_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| Copyright 2019 The Skaffold Authors | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package portforward | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "os/exec" | ||
| "strings" | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest" | ||
| ) | ||
|
|
||
| func TestUnavailablePort(t *testing.T) { | ||
|
|
||
| original := isPortFree | ||
| defer func() { isPortFree = original }() | ||
|
|
||
| // Return that the port is false, while also | ||
| // adding a sync group so we know when isPortFree | ||
| // has been called | ||
| portFreeWG := &sync.WaitGroup{} | ||
| portFreeWG.Add(1) | ||
| isPortFree = func(_ int) bool { | ||
| defer portFreeWG.Done() | ||
| return false | ||
| } | ||
|
|
||
| // Create a wait group that will only be | ||
| // fulfilled when the forward function returns | ||
| forwardFunctionWG := &sync.WaitGroup{} | ||
| forwardFunctionWG.Add(1) | ||
| originalDefer := deferFunc | ||
| defer func() { deferFunc = originalDefer }() | ||
| deferFunc = func() { defer forwardFunctionWG.Done() } | ||
|
|
||
| buf := bytes.NewBuffer([]byte{}) | ||
| k := KubectlForwarder{ | ||
| out: buf, | ||
| } | ||
| pfe := newPortForwardEntry(0, latest.PortForwardResource{}, "", "", "", 8080, false) | ||
| k.Forward(context.Background(), pfe) | ||
|
|
||
| // wait for isPortFree to be called | ||
| portFreeWG.Wait() | ||
|
|
||
| // then, end port forwarding and wait for the forward function to return. | ||
| pfe.terminationLock.Lock() | ||
| pfe.terminated = true | ||
| pfe.terminationLock.Unlock() | ||
| forwardFunctionWG.Wait() | ||
|
|
||
| // read output to make sure logs are expected | ||
| output := buf.String() | ||
| if !strings.Contains(output, "port 8080 is taken") { | ||
| t.Fatalf("port wasn't available but didn't get warning, got: \n%s", output) | ||
| } | ||
| } | ||
|
|
||
| func TestTerminate(t *testing.T) { | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
|
||
| pfe := newPortForwardEntry(0, latest.PortForwardResource{}, "", "", "", 8080, false) | ||
| pfe.cancel = cancel | ||
|
|
||
| k := &KubectlForwarder{} | ||
| k.Terminate(pfe) | ||
| if pfe.terminated != true { | ||
| t.Fatalf("expected pfe.terminated to be true after termination") | ||
| } | ||
| if ctx.Err() != context.Canceled { | ||
| t.Fatalf("expected cancel to be called") | ||
| } | ||
| } | ||
|
|
||
| func TestMonitorErrorLogs(t *testing.T) { | ||
| tests := []struct { | ||
| description string | ||
| input string | ||
| cmdRunning bool | ||
| }{ | ||
| { | ||
| description: "no error logs appear", | ||
| input: "some random logs", | ||
| cmdRunning: true, | ||
| }, { | ||
| description: "match on 'error forwarding port'", | ||
| input: "error forwarding port 8080", | ||
| }, { | ||
| description: "match on 'unable to forward'", | ||
| input: "unable to forward 8080", | ||
| }, { | ||
| description: "match on 'error upgrading connection'", | ||
| input: "error upgrading connection 8080", | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.description, func(t *testing.T) { | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
|
||
| cmd := exec.Command("sleep", "5") | ||
| if err := cmd.Start(); err != nil { | ||
| t.Fatal("error starting command") | ||
| } | ||
|
|
||
| wg := &sync.WaitGroup{} | ||
| wg.Add(1) | ||
|
|
||
| go func() { | ||
| defer wg.Done() | ||
| k := KubectlForwarder{} | ||
| logs := bytes.NewBuffer([]byte(test.input)) | ||
| k.monitorErrorLogs(ctx, logs, cmd, &portForwardEntry{}) | ||
| }() | ||
|
|
||
| // need to sleep for one second before cancelling the context | ||
| // because there is a one second sleep in the switch statement | ||
| // of monitorLogs | ||
| time.Sleep(1 * time.Second) | ||
|
|
||
| // cancel the context and then wait for monitorErrorLogs to return | ||
| cancel() | ||
| wg.Wait() | ||
|
|
||
| // make sure the command is running or killed based on what's expected | ||
| if test.cmdRunning { | ||
| assertCmdIsRunning(t, cmd) | ||
| cmd.Process.Kill() | ||
| } else { | ||
| assertCmdWasKilled(t, cmd) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func assertCmdIsRunning(t *testing.T, cmd *exec.Cmd) { | ||
| if cmd.ProcessState != nil { | ||
| t.Fatal("cmd was killed but expected to continue running") | ||
| } | ||
| } | ||
|
|
||
| func assertCmdWasKilled(t *testing.T, cmd *exec.Cmd) { | ||
| if err := cmd.Wait(); err == nil { | ||
| t.Fatal("cmd was not killed but expected to be killed") | ||
| } | ||
| } |