mirror of
				https://github.com/k3s-io/kubernetes.git
				synced 2025-11-04 07:49:35 +00:00 
			
		
		
		
	For containers that don't have bash, we should support env substitution like we do on command and args. However, without major refactoring valueFrom is not supportable from inside the prober. For now, implement substitution based on hardcoded env and leave TODOs for future work.
		
			
				
	
	
		
			369 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			369 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
/*
 | 
						|
Copyright 2015 The Kubernetes 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 prober
 | 
						|
 | 
						|
import (
 | 
						|
	"errors"
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
	"reflect"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	"k8s.io/apimachinery/pkg/util/intstr"
 | 
						|
	"k8s.io/client-go/tools/record"
 | 
						|
	"k8s.io/kubernetes/pkg/api/v1"
 | 
						|
	kubecontainer "k8s.io/kubernetes/pkg/kubelet/container"
 | 
						|
	containertest "k8s.io/kubernetes/pkg/kubelet/container/testing"
 | 
						|
	"k8s.io/kubernetes/pkg/kubelet/prober/results"
 | 
						|
	"k8s.io/kubernetes/pkg/probe"
 | 
						|
	execprobe "k8s.io/kubernetes/pkg/probe/exec"
 | 
						|
)
 | 
						|
 | 
						|
func TestFormatURL(t *testing.T) {
 | 
						|
	testCases := []struct {
 | 
						|
		scheme string
 | 
						|
		host   string
 | 
						|
		port   int
 | 
						|
		path   string
 | 
						|
		result string
 | 
						|
	}{
 | 
						|
		{"http", "localhost", 93, "", "http://localhost:93"},
 | 
						|
		{"https", "localhost", 93, "/path", "https://localhost:93/path"},
 | 
						|
		{"http", "localhost", 93, "?foo", "http://localhost:93?foo"},
 | 
						|
		{"https", "localhost", 93, "/path?bar", "https://localhost:93/path?bar"},
 | 
						|
	}
 | 
						|
	for _, test := range testCases {
 | 
						|
		url := formatURL(test.scheme, test.host, test.port, test.path)
 | 
						|
		if url.String() != test.result {
 | 
						|
			t.Errorf("Expected %s, got %s", test.result, url.String())
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestFindPortByName(t *testing.T) {
 | 
						|
	container := v1.Container{
 | 
						|
		Ports: []v1.ContainerPort{
 | 
						|
			{
 | 
						|
				Name:          "foo",
 | 
						|
				ContainerPort: 8080,
 | 
						|
			},
 | 
						|
			{
 | 
						|
				Name:          "bar",
 | 
						|
				ContainerPort: 9000,
 | 
						|
			},
 | 
						|
		},
 | 
						|
	}
 | 
						|
	want := 8080
 | 
						|
	got, err := findPortByName(container, "foo")
 | 
						|
	if got != want || err != nil {
 | 
						|
		t.Errorf("Expected %v, got %v, err: %v", want, got, err)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestGetURLParts(t *testing.T) {
 | 
						|
	testCases := []struct {
 | 
						|
		probe *v1.HTTPGetAction
 | 
						|
		ok    bool
 | 
						|
		host  string
 | 
						|
		port  int
 | 
						|
		path  string
 | 
						|
	}{
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromInt(-1), Path: ""}, false, "", -1, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromString(""), Path: ""}, false, "", -1, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromString("-1"), Path: ""}, false, "", -1, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromString("not-found"), Path: ""}, false, "", -1, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromString("found"), Path: ""}, true, "127.0.0.1", 93, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromInt(76), Path: ""}, true, "127.0.0.1", 76, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "", Port: intstr.FromString("118"), Path: ""}, true, "127.0.0.1", 118, ""},
 | 
						|
		{&v1.HTTPGetAction{Host: "hostname", Port: intstr.FromInt(76), Path: "path"}, true, "hostname", 76, "path"},
 | 
						|
	}
 | 
						|
 | 
						|
	for _, test := range testCases {
 | 
						|
		state := v1.PodStatus{PodIP: "127.0.0.1"}
 | 
						|
		container := v1.Container{
 | 
						|
			Ports: []v1.ContainerPort{{Name: "found", ContainerPort: 93}},
 | 
						|
			LivenessProbe: &v1.Probe{
 | 
						|
				Handler: v1.Handler{
 | 
						|
					HTTPGet: test.probe,
 | 
						|
				},
 | 
						|
			},
 | 
						|
		}
 | 
						|
 | 
						|
		scheme := test.probe.Scheme
 | 
						|
		if scheme == "" {
 | 
						|
			scheme = v1.URISchemeHTTP
 | 
						|
		}
 | 
						|
		host := test.probe.Host
 | 
						|
		if host == "" {
 | 
						|
			host = state.PodIP
 | 
						|
		}
 | 
						|
		port, err := extractPort(test.probe.Port, container)
 | 
						|
		if test.ok && err != nil {
 | 
						|
			t.Errorf("Unexpected error: %v", err)
 | 
						|
		}
 | 
						|
		path := test.probe.Path
 | 
						|
 | 
						|
		if !test.ok && err == nil {
 | 
						|
			t.Errorf("Expected error for %+v, got %s%s:%d/%s", test, scheme, host, port, path)
 | 
						|
		}
 | 
						|
		if test.ok {
 | 
						|
			if host != test.host || port != test.port || path != test.path {
 | 
						|
				t.Errorf("Expected %s:%d/%s, got %s:%d/%s",
 | 
						|
					test.host, test.port, test.path, host, port, path)
 | 
						|
			}
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestGetTCPAddrParts(t *testing.T) {
 | 
						|
	testCases := []struct {
 | 
						|
		probe *v1.TCPSocketAction
 | 
						|
		ok    bool
 | 
						|
		host  string
 | 
						|
		port  int
 | 
						|
	}{
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromInt(-1)}, false, "", -1},
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromString("")}, false, "", -1},
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromString("-1")}, false, "", -1},
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromString("not-found")}, false, "", -1},
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromString("found")}, true, "1.2.3.4", 93},
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromInt(76)}, true, "1.2.3.4", 76},
 | 
						|
		{&v1.TCPSocketAction{Port: intstr.FromString("118")}, true, "1.2.3.4", 118},
 | 
						|
	}
 | 
						|
 | 
						|
	for _, test := range testCases {
 | 
						|
		host := "1.2.3.4"
 | 
						|
		container := v1.Container{
 | 
						|
			Ports: []v1.ContainerPort{{Name: "found", ContainerPort: 93}},
 | 
						|
			LivenessProbe: &v1.Probe{
 | 
						|
				Handler: v1.Handler{
 | 
						|
					TCPSocket: test.probe,
 | 
						|
				},
 | 
						|
			},
 | 
						|
		}
 | 
						|
		port, err := extractPort(test.probe.Port, container)
 | 
						|
		if !test.ok && err == nil {
 | 
						|
			t.Errorf("Expected error for %+v, got %s:%d", test, host, port)
 | 
						|
		}
 | 
						|
		if test.ok && err != nil {
 | 
						|
			t.Errorf("Unexpected error: %v", err)
 | 
						|
		}
 | 
						|
		if test.ok {
 | 
						|
			if host != test.host || port != test.port {
 | 
						|
				t.Errorf("Expected %s:%d, got %s:%d", test.host, test.port, host, port)
 | 
						|
			}
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestHTTPHeaders(t *testing.T) {
 | 
						|
	testCases := []struct {
 | 
						|
		input  []v1.HTTPHeader
 | 
						|
		output http.Header
 | 
						|
	}{
 | 
						|
		{[]v1.HTTPHeader{}, http.Header{}},
 | 
						|
		{[]v1.HTTPHeader{
 | 
						|
			{Name: "X-Muffins-Or-Cupcakes", Value: "Muffins"},
 | 
						|
		}, http.Header{"X-Muffins-Or-Cupcakes": {"Muffins"}}},
 | 
						|
		{[]v1.HTTPHeader{
 | 
						|
			{Name: "X-Muffins-Or-Cupcakes", Value: "Muffins"},
 | 
						|
			{Name: "X-Muffins-Or-Plumcakes", Value: "Muffins!"},
 | 
						|
		}, http.Header{"X-Muffins-Or-Cupcakes": {"Muffins"},
 | 
						|
			"X-Muffins-Or-Plumcakes": {"Muffins!"}}},
 | 
						|
		{[]v1.HTTPHeader{
 | 
						|
			{Name: "X-Muffins-Or-Cupcakes", Value: "Muffins"},
 | 
						|
			{Name: "X-Muffins-Or-Cupcakes", Value: "Cupcakes, too"},
 | 
						|
		}, http.Header{"X-Muffins-Or-Cupcakes": {"Muffins", "Cupcakes, too"}}},
 | 
						|
	}
 | 
						|
	for _, test := range testCases {
 | 
						|
		headers := buildHeader(test.input)
 | 
						|
		if !reflect.DeepEqual(test.output, headers) {
 | 
						|
			t.Errorf("Expected %#v, got %#v", test.output, headers)
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestProbe(t *testing.T) {
 | 
						|
	containerID := kubecontainer.ContainerID{Type: "test", ID: "foobar"}
 | 
						|
 | 
						|
	execProbe := &v1.Probe{
 | 
						|
		Handler: v1.Handler{
 | 
						|
			Exec: &v1.ExecAction{},
 | 
						|
		},
 | 
						|
	}
 | 
						|
	tests := []struct {
 | 
						|
		probe          *v1.Probe
 | 
						|
		env            []v1.EnvVar
 | 
						|
		execError      bool
 | 
						|
		expectError    bool
 | 
						|
		execResult     probe.Result
 | 
						|
		expectedResult results.Result
 | 
						|
		expectCommand  []string
 | 
						|
	}{
 | 
						|
		{ // No probe
 | 
						|
			probe:          nil,
 | 
						|
			expectedResult: results.Success,
 | 
						|
		},
 | 
						|
		{ // No handler
 | 
						|
			probe:          &v1.Probe{},
 | 
						|
			expectError:    true,
 | 
						|
			expectedResult: results.Failure,
 | 
						|
		},
 | 
						|
		{ // Probe fails
 | 
						|
			probe:          execProbe,
 | 
						|
			execResult:     probe.Failure,
 | 
						|
			expectedResult: results.Failure,
 | 
						|
		},
 | 
						|
		{ // Probe succeeds
 | 
						|
			probe:          execProbe,
 | 
						|
			execResult:     probe.Success,
 | 
						|
			expectedResult: results.Success,
 | 
						|
		},
 | 
						|
		{ // Probe result is unknown
 | 
						|
			probe:          execProbe,
 | 
						|
			execResult:     probe.Unknown,
 | 
						|
			expectedResult: results.Failure,
 | 
						|
		},
 | 
						|
		{ // Probe has an error
 | 
						|
			probe:          execProbe,
 | 
						|
			execError:      true,
 | 
						|
			expectError:    true,
 | 
						|
			execResult:     probe.Unknown,
 | 
						|
			expectedResult: results.Failure,
 | 
						|
		},
 | 
						|
		{ // Probe arguments are passed through
 | 
						|
			probe: &v1.Probe{
 | 
						|
				Handler: v1.Handler{
 | 
						|
					Exec: &v1.ExecAction{
 | 
						|
						Command: []string{"/bin/bash", "-c", "some script"},
 | 
						|
					},
 | 
						|
				},
 | 
						|
			},
 | 
						|
			expectCommand:  []string{"/bin/bash", "-c", "some script"},
 | 
						|
			execResult:     probe.Success,
 | 
						|
			expectedResult: results.Success,
 | 
						|
		},
 | 
						|
		{ // Probe arguments are passed through
 | 
						|
			probe: &v1.Probe{
 | 
						|
				Handler: v1.Handler{
 | 
						|
					Exec: &v1.ExecAction{
 | 
						|
						Command: []string{"/bin/bash", "-c", "some $(A) $(B)"},
 | 
						|
					},
 | 
						|
				},
 | 
						|
			},
 | 
						|
			env: []v1.EnvVar{
 | 
						|
				{Name: "A", Value: "script"},
 | 
						|
			},
 | 
						|
			expectCommand:  []string{"/bin/bash", "-c", "some script $(B)"},
 | 
						|
			execResult:     probe.Success,
 | 
						|
			expectedResult: results.Success,
 | 
						|
		},
 | 
						|
	}
 | 
						|
 | 
						|
	for i, test := range tests {
 | 
						|
		for _, probeType := range [...]probeType{liveness, readiness} {
 | 
						|
			prober := &prober{
 | 
						|
				refManager: kubecontainer.NewRefManager(),
 | 
						|
				recorder:   &record.FakeRecorder{},
 | 
						|
			}
 | 
						|
			testID := fmt.Sprintf("%d-%s", i, probeType)
 | 
						|
			testContainer := v1.Container{Env: test.env}
 | 
						|
			switch probeType {
 | 
						|
			case liveness:
 | 
						|
				testContainer.LivenessProbe = test.probe
 | 
						|
			case readiness:
 | 
						|
				testContainer.ReadinessProbe = test.probe
 | 
						|
			}
 | 
						|
			if test.execError {
 | 
						|
				prober.exec = fakeExecProber{test.execResult, errors.New("exec error")}
 | 
						|
			} else {
 | 
						|
				prober.exec = fakeExecProber{test.execResult, nil}
 | 
						|
			}
 | 
						|
 | 
						|
			result, err := prober.probe(probeType, &v1.Pod{}, v1.PodStatus{}, testContainer, containerID)
 | 
						|
			if test.expectError && err == nil {
 | 
						|
				t.Errorf("[%s] Expected probe error but no error was returned.", testID)
 | 
						|
			}
 | 
						|
			if !test.expectError && err != nil {
 | 
						|
				t.Errorf("[%s] Didn't expect probe error but got: %v", testID, err)
 | 
						|
			}
 | 
						|
			if test.expectedResult != result {
 | 
						|
				t.Errorf("[%s] Expected result to be %v but was %v", testID, test.expectedResult, result)
 | 
						|
			}
 | 
						|
 | 
						|
			if len(test.expectCommand) > 0 {
 | 
						|
				prober.exec = execprobe.New()
 | 
						|
				prober.runner = &containertest.FakeContainerCommandRunner{}
 | 
						|
				_, err := prober.probe(probeType, &v1.Pod{}, v1.PodStatus{}, testContainer, containerID)
 | 
						|
				if err != nil {
 | 
						|
					t.Errorf("[%s] Didn't expect probe error but got: %v", testID, err)
 | 
						|
					continue
 | 
						|
				}
 | 
						|
				if !reflect.DeepEqual(test.expectCommand, prober.runner.(*containertest.FakeContainerCommandRunner).Cmd) {
 | 
						|
					t.Errorf("[%s] unexpected probe arguments: %v", testID, prober.runner.(*containertest.FakeContainerCommandRunner).Cmd)
 | 
						|
				}
 | 
						|
			}
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestNewExecInContainer(t *testing.T) {
 | 
						|
	tests := []struct {
 | 
						|
		name string
 | 
						|
		err  error
 | 
						|
	}{
 | 
						|
		{
 | 
						|
			name: "no error",
 | 
						|
			err:  nil,
 | 
						|
		},
 | 
						|
		{
 | 
						|
			name: "error - make sure we get output",
 | 
						|
			err:  errors.New("bad"),
 | 
						|
		},
 | 
						|
	}
 | 
						|
 | 
						|
	for _, test := range tests {
 | 
						|
		runner := &containertest.FakeContainerCommandRunner{
 | 
						|
			Stdout: "foo",
 | 
						|
			Err:    test.err,
 | 
						|
		}
 | 
						|
		prober := &prober{
 | 
						|
			runner: runner,
 | 
						|
		}
 | 
						|
 | 
						|
		container := v1.Container{}
 | 
						|
		containerID := kubecontainer.ContainerID{Type: "docker", ID: "containerID"}
 | 
						|
		cmd := []string{"/foo", "bar"}
 | 
						|
		exec := prober.newExecInContainer(container, containerID, cmd, 0)
 | 
						|
 | 
						|
		actualOutput, err := exec.CombinedOutput()
 | 
						|
		if e, a := containerID, runner.ContainerID; e != a {
 | 
						|
			t.Errorf("%s: container id: expected %v, got %v", test.name, e, a)
 | 
						|
		}
 | 
						|
		if e, a := cmd, runner.Cmd; !reflect.DeepEqual(e, a) {
 | 
						|
			t.Errorf("%s: cmd: expected %v, got %v", test.name, e, a)
 | 
						|
		}
 | 
						|
		// this isn't 100% foolproof as a bug in a real ContainerCommandRunner where it fails to copy to stdout/stderr wouldn't be caught by this test
 | 
						|
		if e, a := "foo", string(actualOutput); e != a {
 | 
						|
			t.Errorf("%s: output: expected %q, got %q", test.name, e, a)
 | 
						|
		}
 | 
						|
		if e, a := fmt.Sprintf("%v", test.err), fmt.Sprintf("%v", err); e != a {
 | 
						|
			t.Errorf("%s: error: expected %s, got %s", test.name, e, a)
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 |