Skip to content

Commit c475fe0

Browse files
skittk8s-publishing-bot
skitt
authored and
k8s-publishing-bot
committed
Generify fake clientsets
This adds a generic implementation of a fake clientset, and uses it to replace the template code in generated fake clientsets for the default methods. The templates are preserved as-is (or as close as they can be) for use in extensions, whether for resources or subresources. Fake clientsets with no extensions are reduced to their main getter, their specific struct, and their constructor. All method implementations are provided by the generic implementation. The dedicated struct is preserved to allow extensions and expansions to be defined where necessary. Instead of handling the variants (with/without list, apply) with a complex sequence of if statements, build up an index into an array containing the various declarations. Similarly, instead of calling different action constructors for namespaced and non-namespaced clientsets, assume the current behaviour of non-namespaced action creation (equivalent to creating a namespaced action with an empty namespace) and document that assumption in the action implementation. Signed-off-by: Stephen Kitt <[email protected]> Kubernetes-commit: b0ce65df9b74d4dc72050840d5ad067596d7b822
1 parent 955401c commit c475fe0

13 files changed

+365
-67
lines changed

‎gentype/fake.go

+297
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,297 @@
1+
/*
2+
Copyright 2024 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 gentype
18+
19+
import (
20+
"context"
21+
json "encoding/json"
22+
"fmt"
23+
24+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
25+
labels "k8s.io/apimachinery/pkg/labels"
26+
"k8s.io/apimachinery/pkg/runtime"
27+
"k8s.io/apimachinery/pkg/runtime/schema"
28+
types "k8s.io/apimachinery/pkg/types"
29+
watch "k8s.io/apimachinery/pkg/watch"
30+
testing "k8s.io/client-go/testing"
31+
)
32+
33+
// FakeClient represents a fake client
34+
type FakeClient[T objectWithMeta] struct {
35+
*testing.Fake
36+
ns string
37+
resource schema.GroupVersionResource
38+
kind schema.GroupVersionKind
39+
newObject func() T
40+
}
41+
42+
// FakeClientWithList represents a fake client with support for lists.
43+
type FakeClientWithList[T objectWithMeta, L runtime.Object] struct {
44+
*FakeClient[T]
45+
alsoFakeLister[T, L]
46+
}
47+
48+
// FakeClientWithApply represents a fake client with support for apply declarative configurations.
49+
type FakeClientWithApply[T objectWithMeta, C namedObject] struct {
50+
*FakeClient[T]
51+
alsoFakeApplier[T, C]
52+
}
53+
54+
// FakeClientWithListAndApply represents a fake client with support for lists and apply declarative configurations.
55+
type FakeClientWithListAndApply[T objectWithMeta, L runtime.Object, C namedObject] struct {
56+
*FakeClient[T]
57+
alsoFakeLister[T, L]
58+
alsoFakeApplier[T, C]
59+
}
60+
61+
// Helper types for composition
62+
type alsoFakeLister[T objectWithMeta, L runtime.Object] struct {
63+
client *FakeClient[T]
64+
newList func() L
65+
copyListMeta func(L, L)
66+
getItems func(L) []T
67+
setItems func(L, []T)
68+
}
69+
70+
type alsoFakeApplier[T objectWithMeta, C namedObject] struct {
71+
client *FakeClient[T]
72+
}
73+
74+
// NewFakeClient constructs a fake client, namespaced or not, with no support for lists or apply.
75+
// Non-namespaced clients are constructed by passing an empty namespace ("").
76+
func NewFakeClient[T objectWithMeta](
77+
fake *testing.Fake, namespace string, resource schema.GroupVersionResource, kind schema.GroupVersionKind, emptyObjectCreator func() T,
78+
) *FakeClient[T] {
79+
return &FakeClient[T]{fake, namespace, resource, kind, emptyObjectCreator}
80+
}
81+
82+
// NewFakeClientWithList constructs a namespaced client with support for lists.
83+
func NewFakeClientWithList[T runtime.Object, L runtime.Object](
84+
fake *testing.Fake, namespace string, resource schema.GroupVersionResource, kind schema.GroupVersionKind, emptyObjectCreator func() T,
85+
emptyListCreator func() L, listMetaCopier func(L, L), itemGetter func(L) []T, itemSetter func(L, []T),
86+
) *FakeClientWithList[T, L] {
87+
fakeClient := NewFakeClient[T](fake, namespace, resource, kind, emptyObjectCreator)
88+
return &FakeClientWithList[T, L]{
89+
fakeClient,
90+
alsoFakeLister[T, L]{fakeClient, emptyListCreator, listMetaCopier, itemGetter, itemSetter},
91+
}
92+
}
93+
94+
// NewFakeClientWithApply constructs a namespaced client with support for apply declarative configurations.
95+
func NewFakeClientWithApply[T runtime.Object, C namedObject](
96+
fake *testing.Fake, namespace string, resource schema.GroupVersionResource, kind schema.GroupVersionKind, emptyObjectCreator func() T,
97+
) *FakeClientWithApply[T, C] {
98+
fakeClient := NewFakeClient[T](fake, namespace, resource, kind, emptyObjectCreator)
99+
return &FakeClientWithApply[T, C]{
100+
fakeClient,
101+
alsoFakeApplier[T, C]{fakeClient},
102+
}
103+
}
104+
105+
// NewFakeClientWithListAndApply constructs a client with support for lists and applying declarative configurations.
106+
func NewFakeClientWithListAndApply[T runtime.Object, L runtime.Object, C namedObject](
107+
fake *testing.Fake, namespace string, resource schema.GroupVersionResource, kind schema.GroupVersionKind, emptyObjectCreator func() T,
108+
emptyListCreator func() L, listMetaCopier func(L, L), itemGetter func(L) []T, itemSetter func(L, []T),
109+
) *FakeClientWithListAndApply[T, L, C] {
110+
fakeClient := NewFakeClient[T](fake, namespace, resource, kind, emptyObjectCreator)
111+
return &FakeClientWithListAndApply[T, L, C]{
112+
fakeClient,
113+
alsoFakeLister[T, L]{fakeClient, emptyListCreator, listMetaCopier, itemGetter, itemSetter},
114+
alsoFakeApplier[T, C]{fakeClient},
115+
}
116+
}
117+
118+
// Get takes name of a resource, and returns the corresponding object, and an error if there is any.
119+
func (c *FakeClient[T]) Get(ctx context.Context, name string, options metav1.GetOptions) (T, error) {
120+
emptyResult := c.newObject()
121+
122+
obj, err := c.Fake.
123+
Invokes(testing.NewGetActionWithOptions(c.resource, c.ns, name, options), emptyResult)
124+
if obj == nil {
125+
return emptyResult, err
126+
}
127+
return obj.(T), err
128+
}
129+
130+
func ToPointerSlice[T any](src []T) []*T {
131+
if src == nil {
132+
return nil
133+
}
134+
result := make([]*T, len(src))
135+
for i := range src {
136+
result[i] = &src[i]
137+
}
138+
return result
139+
}
140+
141+
func FromPointerSlice[T any](src []*T) []T {
142+
if src == nil {
143+
return nil
144+
}
145+
result := make([]T, len(src))
146+
for i := range src {
147+
result[i] = *src[i]
148+
}
149+
return result
150+
}
151+
152+
// List takes label and field selectors, and returns the list of ClusterRoles that match those selectors.
153+
func (l *alsoFakeLister[T, L]) List(ctx context.Context, opts metav1.ListOptions) (result L, err error) {
154+
emptyResult := l.newList()
155+
obj, err := l.client.Fake.
156+
Invokes(testing.NewListActionWithOptions(l.client.resource, l.client.kind, l.client.ns, opts), emptyResult)
157+
if obj == nil {
158+
return emptyResult, err
159+
}
160+
161+
label, _, _ := testing.ExtractFromListOptions(opts)
162+
if label == nil {
163+
label = labels.Everything()
164+
}
165+
list := l.newList()
166+
l.copyListMeta(list, obj.(L))
167+
var items []T
168+
for _, item := range l.getItems(obj.(L)) {
169+
if label.Matches(labels.Set(item.GetLabels())) {
170+
items = append(items, item)
171+
}
172+
}
173+
l.setItems(list, items)
174+
return list, err
175+
}
176+
177+
// Watch returns a watch.Interface that watches the requested resources.
178+
func (c *FakeClient[T]) Watch(ctx context.Context, opts metav1.ListOptions) (watch.Interface, error) {
179+
return c.Fake.
180+
InvokesWatch(testing.NewWatchActionWithOptions(c.resource, c.ns, opts))
181+
}
182+
183+
// Create takes the representation of a resource and creates it. Returns the server's representation of the resource, and an error, if there is any.
184+
func (c *FakeClient[T]) Create(ctx context.Context, resource T, opts metav1.CreateOptions) (result T, err error) {
185+
emptyResult := c.newObject()
186+
obj, err := c.Fake.
187+
Invokes(testing.NewCreateActionWithOptions(c.resource, c.ns, resource, opts), emptyResult)
188+
if obj == nil {
189+
return emptyResult, err
190+
}
191+
return obj.(T), err
192+
}
193+
194+
// Update takes the representation of a resource and updates it. Returns the server's representation of the resource, and an error, if there is any.
195+
func (c *FakeClient[T]) Update(ctx context.Context, resource T, opts metav1.UpdateOptions) (result T, err error) {
196+
emptyResult := c.newObject()
197+
obj, err := c.Fake.
198+
Invokes(testing.NewUpdateActionWithOptions(c.resource, c.ns, resource, opts), emptyResult)
199+
if obj == nil {
200+
return emptyResult, err
201+
}
202+
return obj.(T), err
203+
}
204+
205+
// UpdateStatus updates the resource's status and returns the updated resource.
206+
func (c *FakeClient[T]) UpdateStatus(ctx context.Context, resource T, opts metav1.UpdateOptions) (result T, err error) {
207+
emptyResult := c.newObject()
208+
obj, err := c.Fake.
209+
Invokes(testing.NewUpdateSubresourceActionWithOptions(c.resource, "status", c.ns, resource, opts), emptyResult)
210+
211+
if obj == nil {
212+
return emptyResult, err
213+
}
214+
return obj.(T), err
215+
}
216+
217+
// Delete deletes the resource matching the given name. Returns an error if one occurs.
218+
func (c *FakeClient[T]) Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error {
219+
_, err := c.Fake.
220+
Invokes(testing.NewDeleteActionWithOptions(c.resource, c.ns, name, opts), c.newObject())
221+
return err
222+
}
223+
224+
// DeleteCollection deletes a collection of objects.
225+
func (l *alsoFakeLister[T, L]) DeleteCollection(ctx context.Context, opts metav1.DeleteOptions, listOpts metav1.ListOptions) error {
226+
_, err := l.client.Fake.
227+
Invokes(testing.NewDeleteCollectionActionWithOptions(l.client.resource, l.client.ns, opts, listOpts), l.newList())
228+
return err
229+
}
230+
231+
// Patch applies the patch and returns the patched resource.
232+
func (c *FakeClient[T]) Patch(ctx context.Context, name string, pt types.PatchType, data []byte, opts metav1.PatchOptions, subresources ...string) (result T, err error) {
233+
emptyResult := c.newObject()
234+
obj, err := c.Fake.
235+
Invokes(testing.NewPatchSubresourceActionWithOptions(c.resource, c.ns, name, pt, data, opts, subresources...), emptyResult)
236+
if obj == nil {
237+
return emptyResult, err
238+
}
239+
return obj.(T), err
240+
}
241+
242+
// Apply takes the given apply declarative configuration, applies it and returns the applied resource.
243+
func (a *alsoFakeApplier[T, C]) Apply(ctx context.Context, configuration C, opts metav1.ApplyOptions) (result T, err error) {
244+
if configuration == *new(C) {
245+
return *new(T), fmt.Errorf("configuration provided to Apply must not be nil")
246+
}
247+
data, err := json.Marshal(configuration)
248+
if err != nil {
249+
return *new(T), err
250+
}
251+
name := configuration.GetName()
252+
if name == nil {
253+
return *new(T), fmt.Errorf("configuration.Name must be provided to Apply")
254+
}
255+
emptyResult := a.client.newObject()
256+
obj, err := a.client.Fake.
257+
Invokes(testing.NewPatchSubresourceActionWithOptions(a.client.resource, a.client.ns, *name, types.ApplyPatchType, data, opts.ToPatchOptions()), emptyResult)
258+
if obj == nil {
259+
return emptyResult, err
260+
}
261+
return obj.(T), err
262+
}
263+
264+
// ApplyStatus applies the given apply declarative configuration to the resource's status and returns the updated resource.
265+
func (a *alsoFakeApplier[T, C]) ApplyStatus(ctx context.Context, configuration C, opts metav1.ApplyOptions) (result T, err error) {
266+
if configuration == *new(C) {
267+
return *new(T), fmt.Errorf("configuration provided to Apply must not be nil")
268+
}
269+
data, err := json.Marshal(configuration)
270+
if err != nil {
271+
return *new(T), err
272+
}
273+
name := configuration.GetName()
274+
if name == nil {
275+
return *new(T), fmt.Errorf("configuration.Name must be provided to Apply")
276+
}
277+
emptyResult := a.client.newObject()
278+
obj, err := a.client.Fake.
279+
Invokes(testing.NewPatchSubresourceActionWithOptions(a.client.resource, a.client.ns, *name, types.ApplyPatchType, data, opts.ToPatchOptions(), "status"), emptyResult)
280+
281+
if obj == nil {
282+
return emptyResult, err
283+
}
284+
return obj.(T), err
285+
}
286+
287+
func (c *FakeClient[T]) Namespace() string {
288+
return c.ns
289+
}
290+
291+
func (c *FakeClient[T]) Kind() schema.GroupVersionKind {
292+
return c.kind
293+
}
294+
295+
func (c *FakeClient[T]) Resource() schema.GroupVersionResource {
296+
return c.resource
297+
}

‎kubernetes/typed/certificates/v1beta1/fake/fake_certificatesigningrequest_expansion.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ import (
2424
core "k8s.io/client-go/testing"
2525
)
2626

27-
func (c *FakeCertificateSigningRequests) UpdateApproval(ctx context.Context, certificateSigningRequest *certificates.CertificateSigningRequest, opts metav1.UpdateOptions) (result *certificates.CertificateSigningRequest, err error) {
27+
func (c *fakeCertificateSigningRequests) UpdateApproval(ctx context.Context, certificateSigningRequest *certificates.CertificateSigningRequest, opts metav1.UpdateOptions) (result *certificates.CertificateSigningRequest, err error) {
2828
obj, err := c.Fake.
29-
Invokes(core.NewRootUpdateSubresourceAction(certificatesigningrequestsResource, "approval", certificateSigningRequest), &certificates.CertificateSigningRequest{})
29+
Invokes(core.NewRootUpdateSubresourceAction(c.Resource(), "approval", certificateSigningRequest), &certificates.CertificateSigningRequest{})
3030
if obj == nil {
3131
return nil, err
3232
}

‎kubernetes/typed/core/v1/fake/fake_event_expansion.go

+18-18
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ import (
2525
core "k8s.io/client-go/testing"
2626
)
2727

28-
func (c *FakeEvents) CreateWithEventNamespace(event *v1.Event) (*v1.Event, error) {
28+
func (c *fakeEvents) CreateWithEventNamespace(event *v1.Event) (*v1.Event, error) {
2929
var action core.CreateActionImpl
30-
if c.ns != "" {
31-
action = core.NewCreateAction(eventsResource, c.ns, event)
30+
if c.Namespace() != "" {
31+
action = core.NewCreateAction(c.Resource(), c.Namespace(), event)
3232
} else {
33-
action = core.NewCreateAction(eventsResource, event.GetNamespace(), event)
33+
action = core.NewCreateAction(c.Resource(), event.GetNamespace(), event)
3434
}
3535
obj, err := c.Fake.Invokes(action, event)
3636
if obj == nil {
@@ -41,12 +41,12 @@ func (c *FakeEvents) CreateWithEventNamespace(event *v1.Event) (*v1.Event, error
4141
}
4242

4343
// Update replaces an existing event. Returns the copy of the event the server returns, or an error.
44-
func (c *FakeEvents) UpdateWithEventNamespace(event *v1.Event) (*v1.Event, error) {
44+
func (c *fakeEvents) UpdateWithEventNamespace(event *v1.Event) (*v1.Event, error) {
4545
var action core.UpdateActionImpl
46-
if c.ns != "" {
47-
action = core.NewUpdateAction(eventsResource, c.ns, event)
46+
if c.Namespace() != "" {
47+
action = core.NewUpdateAction(c.Resource(), c.Namespace(), event)
4848
} else {
49-
action = core.NewUpdateAction(eventsResource, event.GetNamespace(), event)
49+
action = core.NewUpdateAction(c.Resource(), event.GetNamespace(), event)
5050
}
5151
obj, err := c.Fake.Invokes(action, event)
5252
if obj == nil {
@@ -58,14 +58,14 @@ func (c *FakeEvents) UpdateWithEventNamespace(event *v1.Event) (*v1.Event, error
5858

5959
// PatchWithEventNamespace patches an existing event. Returns the copy of the event the server returns, or an error.
6060
// TODO: Should take a PatchType as an argument probably.
61-
func (c *FakeEvents) PatchWithEventNamespace(event *v1.Event, data []byte) (*v1.Event, error) {
61+
func (c *fakeEvents) PatchWithEventNamespace(event *v1.Event, data []byte) (*v1.Event, error) {
6262
// TODO: Should be configurable to support additional patch strategies.
6363
pt := types.StrategicMergePatchType
6464
var action core.PatchActionImpl
65-
if c.ns != "" {
66-
action = core.NewPatchAction(eventsResource, c.ns, event.Name, pt, data)
65+
if c.Namespace() != "" {
66+
action = core.NewPatchAction(c.Resource(), c.Namespace(), event.Name, pt, data)
6767
} else {
68-
action = core.NewPatchAction(eventsResource, event.GetNamespace(), event.Name, pt, data)
68+
action = core.NewPatchAction(c.Resource(), event.GetNamespace(), event.Name, pt, data)
6969
}
7070
obj, err := c.Fake.Invokes(action, event)
7171
if obj == nil {
@@ -76,12 +76,12 @@ func (c *FakeEvents) PatchWithEventNamespace(event *v1.Event, data []byte) (*v1.
7676
}
7777

7878
// Search returns a list of events matching the specified object.
79-
func (c *FakeEvents) Search(scheme *runtime.Scheme, objOrRef runtime.Object) (*v1.EventList, error) {
79+
func (c *fakeEvents) Search(scheme *runtime.Scheme, objOrRef runtime.Object) (*v1.EventList, error) {
8080
var action core.ListActionImpl
81-
if c.ns != "" {
82-
action = core.NewListAction(eventsResource, eventsKind, c.ns, metav1.ListOptions{})
81+
if c.Namespace() != "" {
82+
action = core.NewListAction(c.Resource(), c.Kind(), c.Namespace(), metav1.ListOptions{})
8383
} else {
84-
action = core.NewListAction(eventsResource, eventsKind, v1.NamespaceDefault, metav1.ListOptions{})
84+
action = core.NewListAction(c.Resource(), c.Kind(), v1.NamespaceDefault, metav1.ListOptions{})
8585
}
8686
obj, err := c.Fake.Invokes(action, &v1.EventList{})
8787
if obj == nil {
@@ -91,10 +91,10 @@ func (c *FakeEvents) Search(scheme *runtime.Scheme, objOrRef runtime.Object) (*v
9191
return obj.(*v1.EventList), err
9292
}
9393

94-
func (c *FakeEvents) GetFieldSelector(involvedObjectName, involvedObjectNamespace, involvedObjectKind, involvedObjectUID *string) fields.Selector {
94+
func (c *fakeEvents) GetFieldSelector(involvedObjectName, involvedObjectNamespace, involvedObjectKind, involvedObjectUID *string) fields.Selector {
9595
action := core.GenericActionImpl{}
9696
action.Verb = "get-field-selector"
97-
action.Resource = eventsResource
97+
action.Resource = c.Resource()
9898

9999
c.Fake.Invokes(action, nil)
100100
return fields.Everything()

0 commit comments

Comments
 (0)