-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Adds a client that enables strict field validation by default. (#2860)
* Adds fieldValidation field to create, patch, and update request options * Adds a client that enables strict field validation for all requests * fixup! Adds fieldValidation field to create, patch, and update request options Remove "+optional" tag. * fixup! Adds a client that enables strict field validation for all requests Construct client wrapper using validation as a parameter.
- Loading branch information
1 parent
89bb86e
commit 3cbfa0c
Showing
3 changed files
with
342 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| Copyright 2024 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 client | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "k8s.io/apimachinery/pkg/api/meta" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/runtime/schema" | ||
| ) | ||
|
|
||
| // WithFieldValidation wraps a Client and configures field validation, by | ||
| // default, for all write requests from this client. Users can override field | ||
| // validation for individual write requests. | ||
| func WithFieldValidation(c Client, validation FieldValidation) Client { | ||
| return &clientWithFieldValidation{ | ||
| validation: validation, | ||
| client: c, | ||
| Reader: c, | ||
| } | ||
| } | ||
|
|
||
| type clientWithFieldValidation struct { | ||
| validation FieldValidation | ||
| client Client | ||
| Reader | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) Create(ctx context.Context, obj Object, opts ...CreateOption) error { | ||
| return c.client.Create(ctx, obj, append([]CreateOption{c.validation}, opts...)...) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) Update(ctx context.Context, obj Object, opts ...UpdateOption) error { | ||
| return c.client.Update(ctx, obj, append([]UpdateOption{c.validation}, opts...)...) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) Patch(ctx context.Context, obj Object, patch Patch, opts ...PatchOption) error { | ||
| return c.client.Patch(ctx, obj, patch, append([]PatchOption{c.validation}, opts...)...) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) Delete(ctx context.Context, obj Object, opts ...DeleteOption) error { | ||
| return c.client.Delete(ctx, obj, opts...) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) DeleteAllOf(ctx context.Context, obj Object, opts ...DeleteAllOfOption) error { | ||
| return c.client.DeleteAllOf(ctx, obj, opts...) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) Scheme() *runtime.Scheme { return c.client.Scheme() } | ||
| func (c *clientWithFieldValidation) RESTMapper() meta.RESTMapper { return c.client.RESTMapper() } | ||
| func (c *clientWithFieldValidation) GroupVersionKindFor(obj runtime.Object) (schema.GroupVersionKind, error) { | ||
| return c.client.GroupVersionKindFor(obj) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) IsObjectNamespaced(obj runtime.Object) (bool, error) { | ||
| return c.client.IsObjectNamespaced(obj) | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) Status() StatusWriter { | ||
| return &subresourceClientWithFieldValidation{ | ||
| validation: c.validation, | ||
| subresourceWriter: c.client.Status(), | ||
| } | ||
| } | ||
|
|
||
| func (c *clientWithFieldValidation) SubResource(subresource string) SubResourceClient { | ||
| srClient := c.client.SubResource(subresource) | ||
| return &subresourceClientWithFieldValidation{ | ||
| validation: c.validation, | ||
| subresourceWriter: srClient, | ||
| SubResourceReader: srClient, | ||
| } | ||
| } | ||
|
|
||
| type subresourceClientWithFieldValidation struct { | ||
| validation FieldValidation | ||
| subresourceWriter SubResourceWriter | ||
| SubResourceReader | ||
| } | ||
|
|
||
| func (c *subresourceClientWithFieldValidation) Create(ctx context.Context, obj Object, subresource Object, opts ...SubResourceCreateOption) error { | ||
| return c.subresourceWriter.Create(ctx, obj, subresource, append([]SubResourceCreateOption{c.validation}, opts...)...) | ||
| } | ||
|
|
||
| func (c *subresourceClientWithFieldValidation) Update(ctx context.Context, obj Object, opts ...SubResourceUpdateOption) error { | ||
| return c.subresourceWriter.Update(ctx, obj, append([]SubResourceUpdateOption{c.validation}, opts...)...) | ||
| } | ||
|
|
||
| func (c *subresourceClientWithFieldValidation) Patch(ctx context.Context, obj Object, patch Patch, opts ...SubResourcePatchOption) error { | ||
| return c.subresourceWriter.Patch(ctx, obj, patch, append([]SubResourcePatchOption{c.validation}, opts...)...) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| Copyright 2024 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 client_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/fake" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/interceptor" | ||
| ) | ||
|
|
||
| func TestWithStrictFieldValidation(t *testing.T) { | ||
| calls := 0 | ||
| fakeClient := testFieldValidationClient(t, metav1.FieldValidationStrict, func() { calls++ }) | ||
| wrappedClient := client.WithFieldValidation(fakeClient, metav1.FieldValidationStrict) | ||
|
|
||
| ctx := context.Background() | ||
| dummyObj := &corev1.Namespace{} | ||
|
|
||
| _ = wrappedClient.Create(ctx, dummyObj) | ||
| _ = wrappedClient.Update(ctx, dummyObj) | ||
| _ = wrappedClient.Patch(ctx, dummyObj, nil) | ||
| _ = wrappedClient.Status().Create(ctx, dummyObj, dummyObj) | ||
| _ = wrappedClient.Status().Update(ctx, dummyObj) | ||
| _ = wrappedClient.Status().Patch(ctx, dummyObj, nil) | ||
| _ = wrappedClient.SubResource("some-subresource").Create(ctx, dummyObj, dummyObj) | ||
| _ = wrappedClient.SubResource("some-subresource").Update(ctx, dummyObj) | ||
| _ = wrappedClient.SubResource("some-subresource").Patch(ctx, dummyObj, nil) | ||
|
|
||
| if expectedCalls := 9; calls != expectedCalls { | ||
| t.Fatalf("wrong number of calls to assertions: expected=%d; got=%d", expectedCalls, calls) | ||
| } | ||
| } | ||
|
|
||
| func TestWithStrictFieldValidationOverridden(t *testing.T) { | ||
| calls := 0 | ||
|
|
||
| fakeClient := testFieldValidationClient(t, metav1.FieldValidationWarn, func() { calls++ }) | ||
| wrappedClient := client.WithFieldValidation(fakeClient, metav1.FieldValidationStrict) | ||
|
|
||
| ctx := context.Background() | ||
| dummyObj := &corev1.Namespace{} | ||
|
|
||
| _ = wrappedClient.Create(ctx, dummyObj, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.Update(ctx, dummyObj, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.Patch(ctx, dummyObj, nil, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.Status().Create(ctx, dummyObj, dummyObj, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.Status().Update(ctx, dummyObj, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.Status().Patch(ctx, dummyObj, nil, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.SubResource("some-subresource").Create(ctx, dummyObj, dummyObj, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.SubResource("some-subresource").Update(ctx, dummyObj, client.FieldValidation(metav1.FieldValidationWarn)) | ||
| _ = wrappedClient.SubResource("some-subresource").Patch(ctx, dummyObj, nil, client.FieldValidation(metav1.FieldValidationWarn)) | ||
|
|
||
| if expectedCalls := 9; calls != expectedCalls { | ||
| t.Fatalf("wrong number of calls to assertions: expected=%d; got=%d", expectedCalls, calls) | ||
| } | ||
| } | ||
|
|
||
| // testFieldValidationClient is a helper function that checks if calls have the expected field validation, | ||
| // and calls the callback function on each intercepted call. | ||
| func testFieldValidationClient(t *testing.T, expectedFieldValidation string, callback func()) client.Client { | ||
| // TODO: we could use the dummyClient in interceptor pkg if we move it to an internal pkg | ||
| return fake.NewClientBuilder().WithInterceptorFuncs(interceptor.Funcs{ | ||
| Create: func(ctx context.Context, c client.WithWatch, obj client.Object, opts ...client.CreateOption) error { | ||
| callback() | ||
| out := &client.CreateOptions{} | ||
| for _, f := range opts { | ||
| f.ApplyToCreate(out) | ||
| } | ||
| if got := out.FieldValidation; expectedFieldValidation != got { | ||
| t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got) | ||
| } | ||
| return nil | ||
| }, | ||
| Update: func(ctx context.Context, c client.WithWatch, obj client.Object, opts ...client.UpdateOption) error { | ||
| callback() | ||
| out := &client.UpdateOptions{} | ||
| for _, f := range opts { | ||
| f.ApplyToUpdate(out) | ||
| } | ||
| if got := out.FieldValidation; expectedFieldValidation != got { | ||
| t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got) | ||
| } | ||
| return nil | ||
| }, | ||
| Patch: func(ctx context.Context, c client.WithWatch, obj client.Object, patch client.Patch, opts ...client.PatchOption) error { | ||
| callback() | ||
| out := &client.PatchOptions{} | ||
| for _, f := range opts { | ||
| f.ApplyToPatch(out) | ||
| } | ||
| if got := out.FieldValidation; expectedFieldValidation != got { | ||
| t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got) | ||
| } | ||
| return nil | ||
| }, | ||
| SubResourceCreate: func(ctx context.Context, c client.Client, subResourceName string, obj client.Object, subResource client.Object, opts ...client.SubResourceCreateOption) error { | ||
| callback() | ||
| out := &client.SubResourceCreateOptions{} | ||
| for _, f := range opts { | ||
| f.ApplyToSubResourceCreate(out) | ||
| } | ||
| if got := out.FieldValidation; expectedFieldValidation != got { | ||
| t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got) | ||
| } | ||
| return nil | ||
| }, | ||
| SubResourceUpdate: func(ctx context.Context, c client.Client, subResourceName string, obj client.Object, opts ...client.SubResourceUpdateOption) error { | ||
| callback() | ||
| out := &client.SubResourceUpdateOptions{} | ||
| for _, f := range opts { | ||
| f.ApplyToSubResourceUpdate(out) | ||
| } | ||
| if got := out.FieldValidation; expectedFieldValidation != got { | ||
| t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got) | ||
| } | ||
| return nil | ||
| }, | ||
| SubResourcePatch: func(ctx context.Context, c client.Client, subResourceName string, obj client.Object, patch client.Patch, opts ...client.SubResourcePatchOption) error { | ||
| callback() | ||
| out := &client.SubResourcePatchOptions{} | ||
| for _, f := range opts { | ||
| f.ApplyToSubResourcePatch(out) | ||
| } | ||
| if got := out.FieldValidation; expectedFieldValidation != got { | ||
| t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got) | ||
| } | ||
| return nil | ||
| }, | ||
| }).Build() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters