|
| 1 | +/* |
| 2 | +Copyright 2020 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package v1 |
| 18 | + |
| 19 | +import ( |
| 20 | + "encoding/json" |
| 21 | + "reflect" |
| 22 | + "strings" |
| 23 | + "testing" |
| 24 | + |
| 25 | + "github.com/google/go-cmp/cmp" |
| 26 | + |
| 27 | + corev1 "k8s.io/api/core/v1" |
| 28 | + v1 "k8s.io/api/core/v1" |
| 29 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 30 | + "k8s.io/apimachinery/pkg/types" |
| 31 | +) |
| 32 | + |
| 33 | +// TestCompatibility verifies that the types in extender/v1 can be successfully encoded to json and decoded back, even when lowercased, |
| 34 | +// since these types were written around JSON tags and we need to enforce consistency on them now. |
| 35 | +// @TODO(88634): v2 of these types should be defined with proper JSON tags to enforce field casing to a single approach |
| 36 | +func TestCompatibility(t *testing.T) { |
| 37 | + testcases := []struct { |
| 38 | + emptyObj interface{} |
| 39 | + obj interface{} |
| 40 | + expectJSON string |
| 41 | + }{ |
| 42 | + { |
| 43 | + emptyObj: &ExtenderPreemptionResult{}, |
| 44 | + obj: &ExtenderPreemptionResult{ |
| 45 | + NodeNameToMetaVictims: map[string]*MetaVictims{"foo": {Pods: []*MetaPod{{UID: "myuid"}}, NumPDBViolations: 1}}, |
| 46 | + }, |
| 47 | + expectJSON: `{"NodeNameToMetaVictims":{"foo":{"Pods":[{"UID":"myuid"}],"NumPDBViolations":1}}}`, |
| 48 | + }, |
| 49 | + { |
| 50 | + emptyObj: &ExtenderPreemptionArgs{}, |
| 51 | + obj: &ExtenderPreemptionArgs{ |
| 52 | + Pod: &corev1.Pod{ObjectMeta: metav1.ObjectMeta{Name: "podname"}}, |
| 53 | + NodeNameToVictims: map[string]*Victims{"foo": {Pods: []*v1.Pod{&corev1.Pod{ObjectMeta: metav1.ObjectMeta{Name: "podname"}}}, NumPDBViolations: 1}}, |
| 54 | + NodeNameToMetaVictims: map[string]*MetaVictims{"foo": {Pods: []*MetaPod{{UID: "myuid"}}, NumPDBViolations: 1}}, |
| 55 | + }, |
| 56 | + expectJSON: `{"Pod":{"metadata":{"name":"podname","creationTimestamp":null},"spec":{"containers":null},"status":{}},"NodeNameToVictims":{"foo":{"Pods":[{"metadata":{"name":"podname","creationTimestamp":null},"spec":{"containers":null},"status":{}}],"NumPDBViolations":1}},"NodeNameToMetaVictims":{"foo":{"Pods":[{"UID":"myuid"}],"NumPDBViolations":1}}}`, |
| 57 | + }, |
| 58 | + { |
| 59 | + emptyObj: &ExtenderArgs{}, |
| 60 | + obj: &ExtenderArgs{ |
| 61 | + Pod: &corev1.Pod{ObjectMeta: metav1.ObjectMeta{Name: "podname"}}, |
| 62 | + Nodes: &corev1.NodeList{Items: []corev1.Node{{ObjectMeta: metav1.ObjectMeta{Name: "nodename"}}}}, |
| 63 | + NodeNames: &[]string{"node1"}, |
| 64 | + }, |
| 65 | + expectJSON: `{"Pod":{"metadata":{"name":"podname","creationTimestamp":null},"spec":{"containers":null},"status":{}},"Nodes":{"metadata":{},"items":[{"metadata":{"name":"nodename","creationTimestamp":null},"spec":{},"status":{"daemonEndpoints":{"kubeletEndpoint":{"Port":0}},"nodeInfo":{"machineID":"","systemUUID":"","bootID":"","kernelVersion":"","osImage":"","containerRuntimeVersion":"","kubeletVersion":"","kubeProxyVersion":"","operatingSystem":"","architecture":""}}}]},"NodeNames":["node1"]}`, |
| 66 | + }, |
| 67 | + { |
| 68 | + emptyObj: &ExtenderFilterResult{}, |
| 69 | + obj: &ExtenderFilterResult{ |
| 70 | + Nodes: &corev1.NodeList{Items: []corev1.Node{{ObjectMeta: metav1.ObjectMeta{Name: "nodename"}}}}, |
| 71 | + NodeNames: &[]string{"node1"}, |
| 72 | + FailedNodes: FailedNodesMap{"foo": "bar"}, |
| 73 | + Error: "myerror", |
| 74 | + }, |
| 75 | + expectJSON: `{"Nodes":{"metadata":{},"items":[{"metadata":{"name":"nodename","creationTimestamp":null},"spec":{},"status":{"daemonEndpoints":{"kubeletEndpoint":{"Port":0}},"nodeInfo":{"machineID":"","systemUUID":"","bootID":"","kernelVersion":"","osImage":"","containerRuntimeVersion":"","kubeletVersion":"","kubeProxyVersion":"","operatingSystem":"","architecture":""}}}]},"NodeNames":["node1"],"FailedNodes":{"foo":"bar"},"Error":"myerror"}`, |
| 76 | + }, |
| 77 | + { |
| 78 | + emptyObj: &ExtenderBindingArgs{}, |
| 79 | + obj: &ExtenderBindingArgs{ |
| 80 | + PodName: "mypodname", |
| 81 | + PodNamespace: "mypodnamespace", |
| 82 | + PodUID: types.UID("mypoduid"), |
| 83 | + Node: "mynode", |
| 84 | + }, |
| 85 | + expectJSON: `{"PodName":"mypodname","PodNamespace":"mypodnamespace","PodUID":"mypoduid","Node":"mynode"}`, |
| 86 | + }, |
| 87 | + { |
| 88 | + emptyObj: &ExtenderBindingResult{}, |
| 89 | + obj: &ExtenderBindingResult{Error: "myerror"}, |
| 90 | + expectJSON: `{"Error":"myerror"}`, |
| 91 | + }, |
| 92 | + { |
| 93 | + emptyObj: &HostPriority{}, |
| 94 | + obj: &HostPriority{Host: "myhost", Score: 1}, |
| 95 | + expectJSON: `{"Host":"myhost","Score":1}`, |
| 96 | + }, |
| 97 | + } |
| 98 | + |
| 99 | + for _, tc := range testcases { |
| 100 | + t.Run(reflect.TypeOf(tc.obj).String(), func(t *testing.T) { |
| 101 | + data, err := json.Marshal(tc.obj) |
| 102 | + if err != nil { |
| 103 | + t.Fatal(err) |
| 104 | + } |
| 105 | + if string(data) != tc.expectJSON { |
| 106 | + t.Fatalf("expected %s, got %s", tc.expectJSON, string(data)) |
| 107 | + } |
| 108 | + if err := json.Unmarshal([]byte(strings.ToLower(string(data))), tc.emptyObj); err != nil { |
| 109 | + t.Fatal(err) |
| 110 | + } |
| 111 | + if !reflect.DeepEqual(tc.emptyObj, tc.obj) { |
| 112 | + t.Fatalf("round-tripped case-insensitive diff: %s", cmp.Diff(tc.obj, tc.emptyObj)) |
| 113 | + } |
| 114 | + }) |
| 115 | + } |
| 116 | +} |
0 commit comments