Field validation

Author: alvaroaleman

pkg/client/client_test.go

@@ -949,6 +949,62 @@ U5wwSivyi7vmegHKmblOzNVKA5qPO8zWzqBC
 				Expect(cm.Data).To(BeComparableTo(obj.Data))
 			})
 		})
+
+		Context("with FieldValidation", func() {
+			It("should handle invalid fields based on FieldValidation setting", func() {
+				cl, err := client.New(cfg, client.Options{})
+				Expect(err).NotTo(HaveOccurred())
+				Expect(cl).NotTo(BeNil())
+
+				data := map[string]any{
+					"some-key": "some-value",
+				}
+				obj := &unstructured.Unstructured{Object: map[string]any{
+					"apiVersion": "v1",
+					"kind":       "ConfigMap",
+					"metadata": map[string]any{
+						"name":      "test-configmap-fieldvalidation",
+						"namespace": "default",
+					},
+					"data": data,
+					"invalidField": "invalid-value",
+				}}
+
+				// Apply with disabled field validation should succeed
+				err = cl.Apply(context.Background(), client.ApplyConfigurationFromUnstructured(obj), &client.ApplyOptions{
+					FieldManager:    "test-manager",
+					FieldValidation: metav1.FieldValidationIgnore,
+				})
+				Expect(err).NotTo(HaveOccurred())
+
+				cm, err := clientset.CoreV1().ConfigMaps(obj.GetNamespace()).Get(context.Background(), obj.GetName(), metav1.GetOptions{})
+				Expect(err).NotTo(HaveOccurred())
+
+				actualData := map[string]any{}
+				for k, v := range cm.Data {
+					actualData[k] = v
+				}
+				Expect(actualData).To(BeComparableTo(data))
+
+				// Apply with default (strict) field validation should fail
+				obj2 := &unstructured.Unstructured{Object: map[string]any{
+					"apiVersion": "v1",
+					"kind":       "ConfigMap",
+					"metadata": map[string]any{
+						"name":      "test-configmap-fieldvalidation-strict",
+						"namespace": "default",
+					},
+					"data": data,
+					"invalidField": "invalid-value",
+				}}
+
+				err = cl.Apply(context.Background(), client.ApplyConfigurationFromUnstructured(obj2), &client.ApplyOptions{
+					FieldManager: "test-manager",
+				})
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring("unknown field"))
+			})
+		})
 	})
 
 	Describe("SubResourceClient", func() {

pkg/client/fieldvalidation.go

@@ -18,7 +18,6 @@ package client
 
 import (
 	"context"
-	"errors"
 
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -55,7 +54,7 @@ func (c *clientWithFieldValidation) Patch(ctx context.Context, obj Object, patch
 }
 
 func (c *clientWithFieldValidation) Apply(ctx context.Context, obj runtime.ApplyConfiguration, opts ...ApplyOption) error {
-	return errors.New("Apply is not supported with field validation")
+	return c.client.Apply(ctx, obj, append([]ApplyOption{c.validation}, opts...)...)
 }
 
 func (c *clientWithFieldValidation) Delete(ctx context.Context, obj Object, opts ...DeleteOption) error {

pkg/client/fieldvalidation_test.go

@@ -25,6 +25,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
@@ -105,14 +106,15 @@ func TestWithStrictFieldValidation(t *testing.T) {
 	_ = wrappedClient.Create(ctx, dummyObj)
 	_ = wrappedClient.Update(ctx, dummyObj)
 	_ = wrappedClient.Patch(ctx, dummyObj, nil)
+	_ = wrappedClient.Apply(ctx, 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 {
+	if expectedCalls := 10; calls != expectedCalls {
 		t.Fatalf("wrong number of calls to assertions: expected=%d; got=%d", expectedCalls, calls)
 	}
 }
@@ -129,14 +131,15 @@ func TestWithStrictFieldValidationOverridden(t *testing.T) {
 	_ = 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.Apply(ctx, 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 {
+	if expectedCalls := 10; calls != expectedCalls {
 		t.Fatalf("wrong number of calls to assertions: expected=%d; got=%d", expectedCalls, calls)
 	}
 }
@@ -272,5 +275,26 @@ func testFieldValidationClient(t *testing.T, expectedFieldValidation string, cal
 			}
 			return nil
 		},
+		Apply: func(ctx context.Context, c client.WithWatch, obj runtime.ApplyConfiguration, opts ...client.ApplyOption) error {
+			callback()
+			out := &client.ApplyOptions{}
+			for _, f := range opts {
+				f.ApplyToApply(out)
+			}
+			if got := out.FieldValidation; expectedFieldValidation != got {
+				t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got)
+			}
+
+			if got := out.AsPatchOptions().FieldValidation; expectedFieldValidation != got {
+				t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got)
+			}
+
+			co := &client.ApplyOptions{}
+			out.ApplyToApply(co)
+			if got := co.FieldValidation; expectedFieldValidation != got {
+				t.Fatalf("wrong field validation: expected=%q; got=%q", expectedFieldValidation, got)
+			}
+			return nil
+		},
 	}).Build()
 }

pkg/client/options.go

@@ -218,6 +218,11 @@ func (f FieldValidation) ApplyToSubResourceUpdate(opts *SubResourceUpdateOptions
 	opts.FieldValidation = string(f)
 }
 
+// ApplyToApply applies this configuration to the given apply options.
+func (f FieldValidation) ApplyToApply(opts *ApplyOptions) {
+	opts.FieldValidation = string(f)
+}
+
 // }}}
 
 // {{{ Create Options
@@ -993,6 +998,24 @@ type ApplyOptions struct {
 	// as defined by https://golang.org/pkg/unicode/#IsPrint. This
 	// field is required.
 	FieldManager string `json:"fieldManager" protobuf:"bytes,3,name=fieldManager"`
+
+	// fieldValidation instructs the server on how to handle
+	// objects in the apply request containing unknown
+	// or duplicate fields. Valid values are:
+	// - Ignore: This will ignore any unknown fields that are silently
+	// dropped from the object, and will ignore all but the last duplicate
+	// field that the decoder encounters.
+	// - Warn: This will send a warning via the standard warning response
+	// header for each unknown field that is dropped from the object, and
+	// for each duplicate field that is encountered. The request will
+	// still succeed if there are no other errors, and will only persist
+	// the last of any duplicate fields.
+	// - Strict: This will fail the request with a BadRequest error if
+	// any unknown fields would be dropped from the object, or if any
+	// duplicate fields are present. The error returned from the server
+	// will contain all unknown and duplicate fields encountered.
+	// This is the default for apply requests.
+	FieldValidation string `json:"fieldValidation,omitempty" protobuf:"bytes,4,opt,name=fieldValidation"`
 }
 
 // ApplyOptions applies the given opts onto the ApplyOptions
@@ -1015,13 +1038,17 @@ func (o *ApplyOptions) ApplyToApply(opts *ApplyOptions) {
 	if o.FieldManager != "" {
 		opts.FieldManager = o.FieldManager
 	}
+	if o.FieldValidation != "" {
+		opts.FieldValidation = o.FieldValidation
+	}
 }
 
 // AsPatchOptions constructs patch options from the given ApplyOptions
 func (o *ApplyOptions) AsPatchOptions() *metav1.PatchOptions {
 	return &metav1.PatchOptions{
-		DryRun:       o.DryRun,
-		Force:        o.Force,
-		FieldManager: o.FieldManager,
+		DryRun:          o.DryRun,
+		Force:           o.Force,
+		FieldManager:    o.FieldManager,
+		FieldValidation: o.FieldValidation,
 	}
 }