kubernetes helpers_test 源码

kubernetes helpers_test 代码

文件路径：/staging/src/k8s.io/kubectl/pkg/cmd/util/helpers_test.go

/*
Copyright 2014 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 util

import (
	goerrors "errors"
	"fmt"
	"io/ioutil"
	"net/http"
	"os"
	"strings"
	"syscall"
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
	"github.com/spf13/cobra"

	corev1 "k8s.io/api/core/v1"
	apiequality "k8s.io/apimachinery/pkg/api/equality"
	"k8s.io/apimachinery/pkg/api/errors"
	"k8s.io/apimachinery/pkg/api/meta"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/runtime/schema"
	"k8s.io/apimachinery/pkg/util/diff"
	"k8s.io/apimachinery/pkg/util/validation/field"
	"k8s.io/kubectl/pkg/scheme"
	"k8s.io/utils/exec"
)

func TestMerge(t *testing.T) {
	tests := []struct {
		obj       runtime.Object
		fragment  string
		expected  runtime.Object
		expectErr bool
	}{
		{
			obj: &corev1.Pod{
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
				},
			},
			fragment: fmt.Sprintf(`{ "apiVersion": "%s" }`, "v1"),
			expected: &corev1.Pod{
				TypeMeta: metav1.TypeMeta{
					Kind:       "Pod",
					APIVersion: "v1",
				},
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
				},
				Spec: corev1.PodSpec{},
			},
		},
		{
			obj: &corev1.Pod{
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
				},
			},
			fragment: fmt.Sprintf(`{ "apiVersion": "%s", "spec": { "volumes": [ {"name": "v1"}, {"name": "v2"} ] } }`, "v1"),
			expected: &corev1.Pod{
				TypeMeta: metav1.TypeMeta{
					Kind:       "Pod",
					APIVersion: "v1",
				},
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
				},
				Spec: corev1.PodSpec{
					Volumes: []corev1.Volume{
						{
							Name: "v1",
						},
						{
							Name: "v2",
						},
					},
				},
			},
		},
		{
			obj:       &corev1.Pod{},
			fragment:  "invalid json",
			expected:  &corev1.Pod{},
			expectErr: true,
		},
		{
			obj:       &corev1.Service{},
			fragment:  `{ "apiVersion": "badVersion" }`,
			expectErr: true,
		},
		{
			obj: &corev1.Service{
				Spec: corev1.ServiceSpec{},
			},
			fragment: fmt.Sprintf(`{ "apiVersion": "%s", "spec": { "ports": [ { "port": 0 } ] } }`, "v1"),
			expected: &corev1.Service{
				TypeMeta: metav1.TypeMeta{
					Kind:       "Service",
					APIVersion: "v1",
				},
				Spec: corev1.ServiceSpec{
					Ports: []corev1.ServicePort{
						{
							Port: 0,
						},
					},
				},
			},
		},
		{
			obj: &corev1.Service{
				Spec: corev1.ServiceSpec{
					Selector: map[string]string{
						"version": "v1",
					},
				},
			},
			fragment: fmt.Sprintf(`{ "apiVersion": "%s", "spec": { "selector": { "version": "v2" } } }`, "v1"),
			expected: &corev1.Service{
				TypeMeta: metav1.TypeMeta{
					Kind:       "Service",
					APIVersion: "v1",
				},
				Spec: corev1.ServiceSpec{
					Selector: map[string]string{
						"version": "v2",
					},
				},
			},
		},
	}

	codec := runtime.NewCodec(scheme.DefaultJSONEncoder(),
		scheme.Codecs.UniversalDecoder(scheme.Scheme.PrioritizedVersionsAllGroups()...))
	for i, test := range tests {
		out, err := Merge(codec, test.obj, test.fragment)
		if !test.expectErr {
			if err != nil {
				t.Errorf("testcase[%d], unexpected error: %v", i, err)
			} else if !apiequality.Semantic.DeepEqual(test.expected, out) {
				t.Errorf("\n\ntestcase[%d]\nexpected:\n%s", i, diff.ObjectReflectDiff(test.expected, out))
			}
		}
		if test.expectErr && err == nil {
			t.Errorf("testcase[%d], unexpected non-error", i)
		}
	}
}

func TestStrategicMerge(t *testing.T) {
	tests := []struct {
		obj        runtime.Object
		dataStruct runtime.Object
		fragment   string
		expected   runtime.Object
		expectErr  bool
	}{
		{
			obj: &corev1.Pod{
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
				},
				Spec: corev1.PodSpec{
					Containers: []corev1.Container{
						{
							Name:  "c1",
							Image: "red-image",
						},
						{
							Name:  "c2",
							Image: "blue-image",
						},
					},
				},
			},
			dataStruct: &corev1.Pod{},
			fragment: fmt.Sprintf(`{ "apiVersion": "%s", "spec": { "containers": [ { "name": "c1", "image": "green-image" } ] } }`,
				schema.GroupVersion{Group: "", Version: "v1"}.String()),
			expected: &corev1.Pod{
				TypeMeta: metav1.TypeMeta{
					Kind:       "Pod",
					APIVersion: "v1",
				},
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
				},
				Spec: corev1.PodSpec{
					Containers: []corev1.Container{
						{
							Name:  "c1",
							Image: "green-image",
						},
						{
							Name:  "c2",
							Image: "blue-image",
						},
					},
				},
			},
		},
		{
			obj:        &corev1.Pod{},
			dataStruct: &corev1.Pod{},
			fragment:   "invalid json",
			expected:   &corev1.Pod{},
			expectErr:  true,
		},
		{
			obj:        &corev1.Service{},
			dataStruct: &corev1.Pod{},
			fragment:   `{ "apiVersion": "badVersion" }`,
			expectErr:  true,
		},
	}

	codec := runtime.NewCodec(scheme.DefaultJSONEncoder(),
		scheme.Codecs.UniversalDecoder(scheme.Scheme.PrioritizedVersionsAllGroups()...))
	for i, test := range tests {
		out, err := StrategicMerge(codec, test.obj, test.fragment, test.dataStruct)
		if !test.expectErr {
			if err != nil {
				t.Errorf("testcase[%d], unexpected error: %v", i, err)
			} else if !apiequality.Semantic.DeepEqual(test.expected, out) {
				t.Errorf("\n\ntestcase[%d]\nexpected:\n%s", i, diff.ObjectReflectDiff(test.expected, out))
			}
		}
		if test.expectErr && err == nil {
			t.Errorf("testcase[%d], unexpected non-error", i)
		}
	}
}

func TestJSONPatch(t *testing.T) {
	tests := []struct {
		obj       runtime.Object
		fragment  string
		expected  runtime.Object
		expectErr bool
	}{
		{
			obj: &corev1.Pod{
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
					Labels: map[string]string{
						"run": "test",
					},
				},
			},
			fragment: `[ {"op": "add", "path": "/metadata/labels/foo", "value": "bar"} ]`,
			expected: &corev1.Pod{
				TypeMeta: metav1.TypeMeta{
					Kind:       "Pod",
					APIVersion: "v1",
				},
				ObjectMeta: metav1.ObjectMeta{
					Name: "foo",
					Labels: map[string]string{
						"run": "test",
						"foo": "bar",
					},
				},
				Spec: corev1.PodSpec{},
			},
		},
		{
			obj:       &corev1.Pod{},
			fragment:  "invalid json",
			expected:  &corev1.Pod{},
			expectErr: true,
		},
		{
			obj:       &corev1.Pod{},
			fragment:  `[ {"op": "add", "path": "/metadata/labels/foo", "value": "bar"} ]`,
			expectErr: true,
		},
	}

	codec := runtime.NewCodec(scheme.DefaultJSONEncoder(),
		scheme.Codecs.UniversalDecoder(scheme.Scheme.PrioritizedVersionsAllGroups()...))
	for i, test := range tests {
		out, err := JSONPatch(codec, test.obj, test.fragment)
		if !test.expectErr {
			if err != nil {
				t.Errorf("testcase[%d], unexpected error: %v", i, err)
			} else if !apiequality.Semantic.DeepEqual(test.expected, out) {
				t.Errorf("\n\ntestcase[%d]\nexpected:\n%s", i, diff.ObjectReflectDiff(test.expected, out))
			}
		}
		if test.expectErr && err == nil {
			t.Errorf("testcase[%d], unexpected non-error", i)
		}
	}
}

type checkErrTestCase struct {
	err          error
	expectedErr  string
	expectedCode int
}

func TestCheckInvalidErr(t *testing.T) {
	testCheckError(t, []checkErrTestCase{
		{
			errors.NewInvalid(corev1.SchemeGroupVersion.WithKind("Invalid1").GroupKind(), "invalidation", field.ErrorList{field.Invalid(field.NewPath("field"), "single", "details")}),
			"The Invalid1 \"invalidation\" is invalid: field: Invalid value: \"single\": details\n",
			DefaultErrorExitCode,
		},
		{
			errors.NewInvalid(corev1.SchemeGroupVersion.WithKind("Invalid2").GroupKind(), "invalidation", field.ErrorList{field.Invalid(field.NewPath("field1"), "multi1", "details"), field.Invalid(field.NewPath("field2"), "multi2", "details")}),
			"The Invalid2 \"invalidation\" is invalid: \n* field1: Invalid value: \"multi1\": details\n* field2: Invalid value: \"multi2\": details\n",
			DefaultErrorExitCode,
		},
		{
			errors.NewInvalid(corev1.SchemeGroupVersion.WithKind("Invalid3").GroupKind(), "invalidation", field.ErrorList{}),
			"The Invalid3 \"invalidation\" is invalid",
			DefaultErrorExitCode,
		},
		{
			errors.NewInvalid(corev1.SchemeGroupVersion.WithKind("Invalid4").GroupKind(), "invalidation", field.ErrorList{field.Invalid(field.NewPath("field4"), "multi4", "details"), field.Invalid(field.NewPath("field4"), "multi4", "details")}),
			"The Invalid4 \"invalidation\" is invalid: field4: Invalid value: \"multi4\": details\n",
			DefaultErrorExitCode,
		},
		{
			&errors.StatusError{metav1.Status{
				Status: metav1.StatusFailure,
				Code:   http.StatusUnprocessableEntity,
				Reason: metav1.StatusReasonInvalid,
				// Details is nil.
			}},
			"The request is invalid",
			DefaultErrorExitCode,
		},
		// invalid error that that includes a message but no details
		{
			&errors.StatusError{metav1.Status{
				Status: metav1.StatusFailure,
				Code:   http.StatusUnprocessableEntity,
				Reason: metav1.StatusReasonInvalid,
				// Details is nil.
				Message: "Some message",
			}},
			"The request is invalid: Some message",
			DefaultErrorExitCode,
		},
		// webhook response that sets code=422 with no reason
		{
			&errors.StatusError{metav1.Status{
				Status:  "Failure",
				Message: `admission webhook "my.webhook" denied the request without explanation`,
				Code:    422,
			}},
			`Error from server: admission webhook "my.webhook" denied the request without explanation`,
			DefaultErrorExitCode,
		},
		// webhook response that sets code=422 with no reason and non-nil details
		{
			&errors.StatusError{metav1.Status{
				Status:  "Failure",
				Message: `admission webhook "my.webhook" denied the request without explanation`,
				Code:    422,
				Details: &metav1.StatusDetails{},
			}},
			`Error from server: admission webhook "my.webhook" denied the request without explanation`,
			DefaultErrorExitCode,
		},
		// source-wrapped webhook response that sets code=422 with no reason
		{
			AddSourceToErr("creating", "configmap.yaml", &errors.StatusError{metav1.Status{
				Status:  "Failure",
				Message: `admission webhook "my.webhook" denied the request without explanation`,
				Code:    422,
			}}),
			`Error from server: error when creating "configmap.yaml": admission webhook "my.webhook" denied the request without explanation`,
			DefaultErrorExitCode,
		},
		// webhook response that sets reason=Invalid and code=422 and a message
		{
			&errors.StatusError{metav1.Status{
				Status:  "Failure",
				Reason:  "Invalid",
				Message: `admission webhook "my.webhook" denied the request without explanation`,
				Code:    422,
			}},
			`The request is invalid: admission webhook "my.webhook" denied the request without explanation`,
			DefaultErrorExitCode,
		},
	})
}

func TestCheckNoResourceMatchError(t *testing.T) {
	testCheckError(t, []checkErrTestCase{
		{
			&meta.NoResourceMatchError{PartialResource: schema.GroupVersionResource{Resource: "foo"}},
			`the server doesn't have a resource type "foo"`,
			DefaultErrorExitCode,
		},
		{
			&meta.NoResourceMatchError{PartialResource: schema.GroupVersionResource{Version: "theversion", Resource: "foo"}},
			`the server doesn't have a resource type "foo" in version "theversion"`,
			DefaultErrorExitCode,
		},
		{
			&meta.NoResourceMatchError{PartialResource: schema.GroupVersionResource{Group: "thegroup", Version: "theversion", Resource: "foo"}},
			`the server doesn't have a resource type "foo" in group "thegroup" and version "theversion"`,
			DefaultErrorExitCode,
		},
		{
			&meta.NoResourceMatchError{PartialResource: schema.GroupVersionResource{Group: "thegroup", Resource: "foo"}},
			`the server doesn't have a resource type "foo" in group "thegroup"`,
			DefaultErrorExitCode,
		},
	})
}

func TestCheckExitError(t *testing.T) {
	testCheckError(t, []checkErrTestCase{
		{
			exec.CodeExitError{Err: fmt.Errorf("pod foo/bar terminated"), Code: 42},
			"pod foo/bar terminated",
			42,
		},
	})
}

func testCheckError(t *testing.T, tests []checkErrTestCase) {
	var errReturned string
	var codeReturned int
	errHandle := func(err string, code int) {
		errReturned = err
		codeReturned = code
	}

	for _, test := range tests {
		checkErr(test.err, errHandle)

		if errReturned != test.expectedErr {
			t.Fatalf("Got: %s, expected: %s", errReturned, test.expectedErr)
		}
		if codeReturned != test.expectedCode {
			t.Fatalf("Got: %d, expected: %d", codeReturned, test.expectedCode)
		}
	}
}

func TestDumpReaderToFile(t *testing.T) {
	testString := "TEST STRING"
	tempFile, err := ioutil.TempFile(os.TempDir(), "hlpers_test_dump_")
	if err != nil {
		t.Errorf("unexpected error setting up a temporary file %v", err)
	}
	defer syscall.Unlink(tempFile.Name())
	defer tempFile.Close()
	defer func() {
		if !t.Failed() {
			os.Remove(tempFile.Name())
		}
	}()
	err = DumpReaderToFile(strings.NewReader(testString), tempFile.Name())
	if err != nil {
		t.Errorf("error in DumpReaderToFile: %v", err)
	}
	data, err := ioutil.ReadFile(tempFile.Name())
	if err != nil {
		t.Errorf("error when reading %s: %v", tempFile.Name(), err)
	}
	stringData := string(data)
	if stringData != testString {
		t.Fatalf("Wrong file content %s != %s", testString, stringData)
	}
}

func TestDifferenceFunc(t *testing.T) {
	tests := []struct {
		name      string
		fullArray []string
		subArray  []string
		expected  []string
	}{
		{
			name:      "remove some",
			fullArray: []string{"a", "b", "c", "d"},
			subArray:  []string{"c", "b"},
			expected:  []string{"a", "d"},
		},
		{
			name:      "remove all",
			fullArray: []string{"a", "b", "c", "d"},
			subArray:  []string{"b", "d", "a", "c"},
			expected:  nil,
		},
		{
			name:      "remove none",
			fullArray: []string{"a", "b", "c", "d"},
			subArray:  nil,
			expected:  []string{"a", "b", "c", "d"},
		},
	}

	for _, tc := range tests {
		result := Difference(tc.fullArray, tc.subArray)
		if !cmp.Equal(tc.expected, result, cmpopts.SortSlices(func(x, y string) bool {
			return x < y
		})) {
			t.Errorf("%s -> Expected: %v, but got: %v", tc.name, tc.expected, result)
		}
	}
}

func TestGetValidationDirective(t *testing.T) {
	tests := []struct {
		validateFlag      string
		expectedDirective string
		expectedErr       error
	}{
		{
			expectedDirective: metav1.FieldValidationStrict,
		},
		{
			validateFlag:      "true",
			expectedDirective: metav1.FieldValidationStrict,
		},
		{
			validateFlag:      "True",
			expectedDirective: metav1.FieldValidationStrict,
		},
		{
			validateFlag:      "strict",
			expectedDirective: metav1.FieldValidationStrict,
		},
		{
			validateFlag:      "warn",
			expectedDirective: metav1.FieldValidationWarn,
		},
		{
			validateFlag:      "ignore",
			expectedDirective: metav1.FieldValidationIgnore,
		},
		{
			validateFlag:      "false",
			expectedDirective: metav1.FieldValidationIgnore,
		},
		{
			validateFlag:      "False",
			expectedDirective: metav1.FieldValidationIgnore,
		},
		{
			validateFlag:      "foo",
			expectedDirective: metav1.FieldValidationStrict,
			expectedErr:       goerrors.New(`invalid - validate option "foo"; must be one of: strict (or true), warn, ignore (or false)`),
		},
	}

	for _, tc := range tests {
		cmd := &cobra.Command{}
		AddValidateFlags(cmd)
		if tc.validateFlag != "" {
			cmd.Flags().Set("validate", tc.validateFlag)
		}
		directive, err := GetValidationDirective(cmd)
		if directive != tc.expectedDirective {
			t.Errorf("validation directive, expected: %v, but got: %v", tc.expectedDirective, directive)
		}
		if tc.expectedErr != nil {
			if err.Error() != tc.expectedErr.Error() {
				t.Errorf("GetValidationDirective error, expected: %v, but got: %v", tc.expectedErr, err)
			}
		} else {
			if err != nil {
				t.Errorf("expecte no error, but got: %v", err)
			}
		}

	}
}

相关信息

kubernetes 源码目录

相关文章

kubernetes env_file 源码

kubernetes env_file_test 源码

kubernetes factory 源码

kubernetes factory_client_access 源码

kubernetes helpers 源码

kubernetes kubectl_match_version 源码

kubernetes override_options 源码

kubernetes printing 源码