Skip to content

Commit b5f85d2

Browse files
committed
add field selector enabled fake client
1 parent 0fcf28e commit b5f85d2

File tree

2 files changed

+337
-0
lines changed

2 files changed

+337
-0
lines changed
+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
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 fake
18+
19+
import (
20+
"context"
21+
22+
"k8s.io/apimachinery/pkg/api/meta"
23+
"k8s.io/apimachinery/pkg/fields"
24+
"k8s.io/apimachinery/pkg/runtime"
25+
"k8s.io/apimachinery/pkg/runtime/schema"
26+
"sigs.k8s.io/controller-runtime/pkg/client"
27+
28+
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
29+
)
30+
31+
var _ client.Client = &fieldSelectorEnableClient{}
32+
33+
// NewFieldSelectorEnableClient wrapper a fake client that List method enables field selector
34+
func NewFieldSelectorEnableClient(client client.Client, scheme *runtime.Scheme, obj runtime.Object, indexers map[string]client.IndexerFunc) (client.Client, error) {
35+
gvk, err := apiutil.GVKForObject(obj, scheme)
36+
if err != nil {
37+
return nil, err
38+
}
39+
40+
return &fieldSelectorEnableClient{
41+
Client: client,
42+
scheme: scheme,
43+
gvk: gvk,
44+
indexers: indexers,
45+
}, nil
46+
}
47+
48+
type fieldSelectorEnableClient struct {
49+
client.Client
50+
scheme *runtime.Scheme
51+
52+
gvk schema.GroupVersionKind
53+
54+
indexers map[string]client.IndexerFunc
55+
}
56+
57+
func (f *fieldSelectorEnableClient) List(ctx context.Context, list runtime.Object, opts ...client.ListOption) error {
58+
if err := f.Client.List(ctx, list, opts...); err != nil {
59+
return err
60+
}
61+
62+
if len(opts) == 0 {
63+
return nil
64+
}
65+
66+
objs, err := meta.ExtractList(list)
67+
if err != nil {
68+
return err
69+
}
70+
71+
if len(objs) == 0 {
72+
return nil
73+
}
74+
75+
if gvk, err := apiutil.GVKForObject(objs[0], f.scheme); err != nil {
76+
return err
77+
} else if gvk != f.gvk {
78+
return nil
79+
}
80+
81+
options := client.ListOptions{}
82+
options.ApplyOptions(opts)
83+
84+
if options.FieldSelector == nil {
85+
return nil
86+
}
87+
88+
filtered := make([]runtime.Object, 0)
89+
for i := range objs {
90+
objFields := map[string]string{}
91+
92+
for k, indexer := range f.indexers {
93+
values := indexer(objs[i])
94+
if len(values) != 1 {
95+
continue
96+
}
97+
objFields[k] = values[0]
98+
}
99+
100+
if options.FieldSelector.Matches(fields.Set(objFields)) {
101+
filtered = append(filtered, objs[i])
102+
}
103+
}
104+
105+
return meta.SetList(list, filtered)
106+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
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 fake
18+
19+
import (
20+
"context"
21+
"testing"
22+
23+
corev1 "k8s.io/api/core/v1"
24+
"k8s.io/apimachinery/pkg/api/meta"
25+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
26+
"k8s.io/apimachinery/pkg/fields"
27+
"k8s.io/apimachinery/pkg/runtime"
28+
"k8s.io/client-go/kubernetes/scheme"
29+
30+
"sigs.k8s.io/controller-runtime/pkg/client"
31+
)
32+
33+
func TestListByFieldSelector(t *testing.T) {
34+
pod := &corev1.Pod{
35+
ObjectMeta: metav1.ObjectMeta{
36+
Name: "foo",
37+
Namespace: "bar",
38+
},
39+
Spec: corev1.PodSpec{
40+
NodeName: "node1",
41+
ServiceAccountName: "sa1",
42+
},
43+
}
44+
45+
node := &corev1.Node{
46+
ObjectMeta: metav1.ObjectMeta{
47+
Name: "foo",
48+
},
49+
Spec: corev1.NodeSpec{
50+
PodCIDR: "cidr1",
51+
ProviderID: "provider1",
52+
},
53+
}
54+
55+
fakeClient := NewFakeClientWithScheme(scheme.Scheme, pod, node)
56+
57+
podIndexers := map[string]client.IndexerFunc{
58+
"spec.nodeName": func(o runtime.Object) []string {
59+
po, ok := o.(*corev1.Pod)
60+
if !ok {
61+
return nil
62+
}
63+
64+
return []string{po.Spec.NodeName}
65+
},
66+
"spec.serviceAccountName": func(o runtime.Object) []string {
67+
po, ok := o.(*corev1.Pod)
68+
if !ok {
69+
return nil
70+
}
71+
72+
return []string{po.Spec.ServiceAccountName}
73+
},
74+
}
75+
76+
nodeIndexers := map[string]client.IndexerFunc{
77+
"spec.podCIDR": func(o runtime.Object) []string {
78+
no, ok := o.(*corev1.Node)
79+
if !ok {
80+
return nil
81+
}
82+
83+
return []string{no.Spec.PodCIDR}
84+
},
85+
"spec.providerID": func(o runtime.Object) []string {
86+
no, ok := o.(*corev1.Node)
87+
if !ok {
88+
return nil
89+
}
90+
91+
return []string{no.Spec.ProviderID}
92+
},
93+
}
94+
95+
fieldSelectorClient, err := NewFieldSelectorEnableClient(fakeClient, scheme.Scheme, &corev1.Pod{}, podIndexers)
96+
if err != nil {
97+
t.Fatalf("unexpect init client err: %v", err)
98+
}
99+
100+
fieldSelectorClient, err = NewFieldSelectorEnableClient(fieldSelectorClient, scheme.Scheme, &corev1.Node{}, nodeIndexers)
101+
if err != nil {
102+
t.Fatalf("unexpect init client err: %v", err)
103+
}
104+
105+
cases := []struct {
106+
obj runtime.Object
107+
name string
108+
opts client.ListOption
109+
expectObjectsCount int
110+
}{
111+
{
112+
name: "list Pod using nil fieldSelector",
113+
obj: &corev1.PodList{},
114+
opts: nil,
115+
expectObjectsCount: 1,
116+
},
117+
{
118+
name: "list Node using nil fieldSelector",
119+
obj: &corev1.NodeList{},
120+
opts: nil,
121+
expectObjectsCount: 1,
122+
},
123+
{
124+
name: "list Pod does not match fieldSelector name",
125+
obj: &corev1.PodList{},
126+
opts: client.MatchingFields(fields.Set{
127+
"spec.nodeName1": "node1",
128+
}),
129+
expectObjectsCount: 0,
130+
},
131+
{
132+
name: "list Node does not match fieldSelector name",
133+
obj: &corev1.NodeList{},
134+
opts: client.MatchingFields(fields.Set{
135+
"spec.podCIDR1": "node1",
136+
}),
137+
expectObjectsCount: 0,
138+
},
139+
{
140+
name: "list Pod does not match fieldSelector value",
141+
obj: &corev1.PodList{},
142+
opts: client.MatchingFields(fields.Set{
143+
"spec.nodeName": "node2",
144+
}),
145+
expectObjectsCount: 0,
146+
},
147+
{
148+
name: "list Node does not match fieldSelector value",
149+
obj: &corev1.NodeList{},
150+
opts: client.MatchingFields(fields.Set{
151+
"spec.podCIDR": "bar2",
152+
}),
153+
expectObjectsCount: 0,
154+
},
155+
{
156+
name: "list Pod match fieldSelector one name and value",
157+
obj: &corev1.PodList{},
158+
opts: client.MatchingFields(fields.Set{
159+
"spec.nodeName": "node1",
160+
}),
161+
expectObjectsCount: 1,
162+
},
163+
{
164+
name: "list Node match fieldSelector one name and value",
165+
obj: &corev1.NodeList{},
166+
opts: client.MatchingFields(fields.Set{
167+
"spec.podCIDR": "cidr1",
168+
}),
169+
expectObjectsCount: 1,
170+
},
171+
{
172+
name: "list Pod match fieldSelector one name and value, and does not match one value",
173+
obj: &corev1.PodList{},
174+
opts: client.MatchingFields(fields.Set{
175+
"spec.nodeName": "node1",
176+
"spec.serviceAccountName": "sa2",
177+
}),
178+
expectObjectsCount: 0,
179+
},
180+
{
181+
name: "list Node match fieldSelector one name and value, and does not match one value",
182+
obj: &corev1.NodeList{},
183+
opts: client.MatchingFields(fields.Set{
184+
"spec.podCIDR": "cidr1",
185+
"spec.providerID": "provider2",
186+
}),
187+
expectObjectsCount: 0,
188+
},
189+
{
190+
name: "list Pod match fieldSelector two name and value",
191+
obj: &corev1.PodList{},
192+
opts: client.MatchingFields(fields.Set{
193+
"spec.nodeName": "node1",
194+
"spec.serviceAccountName": "sa1",
195+
}),
196+
expectObjectsCount: 1,
197+
},
198+
{
199+
name: "list Node match fieldSelector two name and value",
200+
obj: &corev1.NodeList{},
201+
opts: client.MatchingFields(fields.Set{
202+
"spec.podCIDR": "cidr1",
203+
"spec.providerID": "provider1",
204+
}),
205+
expectObjectsCount: 1,
206+
},
207+
}
208+
209+
for _, tc := range cases {
210+
t.Run(tc.name, func(t *testing.T) {
211+
if tc.opts != nil {
212+
if err := fieldSelectorClient.List(context.TODO(), tc.obj, tc.opts); err != nil {
213+
t.Fatalf("unexpect list err: %v", err)
214+
}
215+
} else {
216+
if err := fieldSelectorClient.List(context.TODO(), tc.obj); err != nil {
217+
t.Fatalf("unexpect list err: %v", err)
218+
}
219+
}
220+
221+
objs, err := meta.ExtractList(tc.obj)
222+
if err != nil {
223+
t.Fatalf("unexpect extra list err: %v", err)
224+
}
225+
226+
if len(objs) != tc.expectObjectsCount {
227+
t.Errorf("expect list object result count: %d, got: %d", tc.expectObjectsCount, len(objs))
228+
}
229+
})
230+
}
231+
}

0 commit comments

Comments
 (0)