[release-0.16] 🐛 Fix returning object after status update (#2490)

* Draft: Test that an object is updatable after updating its status. * Draft: ensure we udpate the new obj's accessor's ResourceVersion after doing the deep copy * Rework code to pass object back on status update --------- Co-authored-by: Adam Berlin <[email protected]> Co-authored-by: Alvaro Aleman <[email protected]>
kubernetes-sigs · Sep 10, 2023 · b40bcb8 · b40bcb8
1 parent 1cf5b88
commit b40bcb8
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 5 deletions.
diff --git a/pkg/client/fake/client.go b/pkg/client/fake/client.go
@@ -403,7 +403,9 @@ func (t versionedTracker) update(gvr schema.GroupVersionResource, obj runtime.Ob
 			if err := copyStatusFrom(obj, oldObject); err != nil {
 				return fmt.Errorf("failed to copy non-status field for object with status subresouce: %w", err)
 			}
-			obj = oldObject.DeepCopyObject().(client.Object)
+			passedRV := accessor.GetResourceVersion()
+			reflect.ValueOf(obj).Elem().Set(reflect.ValueOf(oldObject.DeepCopyObject()).Elem())
+			accessor.SetResourceVersion(passedRV)
 		} else { // copy status from original object
 			if err := copyStatusFrom(oldObject, obj); err != nil {
 				return fmt.Errorf("failed to copy the status for object with status subresource: %w", err)

diff --git a/pkg/client/fake/client_test.go b/pkg/client/fake/client_test.go
@@ -45,6 +45,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
 )
 
+const (
+	machineIDFromStatusUpdate = "machine-id-from-status-update"
+	cidrFromStatusUpdate      = "cidr-from-status-update"
+)
+
 var _ = Describe("Fake client", func() {
 	var dep *appsv1.Deployment
 	var dep2 *appsv1.Deployment
@@ -1456,15 +1461,15 @@ var _ = Describe("Fake client", func() {
 		cl := NewClientBuilder().WithStatusSubresource(obj).WithObjects(obj).Build()
 		objOriginal := obj.DeepCopy()
 
-		obj.Spec.PodCIDR = "cidr-from-status-update"
+		obj.Spec.PodCIDR = cidrFromStatusUpdate
 		obj.Annotations = map[string]string{
 			"some-annotation-key": "some-annotation-value",
 		}
 		obj.Labels = map[string]string{
 			"some-label-key": "some-label-value",
 		}
 
-		obj.Status.NodeInfo.MachineID = "machine-id-from-status-update"
+		obj.Status.NodeInfo.MachineID = machineIDFromStatusUpdate
 		Expect(cl.Status().Update(context.Background(), obj)).NotTo(HaveOccurred())
 
 		actual := &corev1.Node{ObjectMeta: metav1.ObjectMeta{Name: obj.Name}}
@@ -1473,9 +1478,87 @@ var _ = Describe("Fake client", func() {
 		objOriginal.APIVersion = actual.APIVersion
 		objOriginal.Kind = actual.Kind
 		objOriginal.ResourceVersion = actual.ResourceVersion
-		objOriginal.Status.NodeInfo.MachineID = "machine-id-from-status-update"
+		objOriginal.Status.NodeInfo.MachineID = machineIDFromStatusUpdate
 		Expect(cmp.Diff(objOriginal, actual)).To(BeEmpty())
 	})
+
+	It("should be able to update an object after updating an object's status", func() {
+		obj := &corev1.Node{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: "node",
+			},
+			Spec: corev1.NodeSpec{
+				PodCIDR: "old-cidr",
+			},
+			Status: corev1.NodeStatus{
+				NodeInfo: corev1.NodeSystemInfo{
+					MachineID: "machine-id",
+				},
+			},
+		}
+		cl := NewClientBuilder().WithStatusSubresource(obj).WithObjects(obj).Build()
+		expectedObj := obj.DeepCopy()
+
+		obj.Status.NodeInfo.MachineID = machineIDFromStatusUpdate
+		Expect(cl.Status().Update(context.Background(), obj)).NotTo(HaveOccurred())
+
+		obj.Annotations = map[string]string{
+			"some-annotation-key": "some",
+		}
+		expectedObj.Annotations = map[string]string{
+			"some-annotation-key": "some",
+		}
+		Expect(cl.Update(context.Background(), obj)).NotTo(HaveOccurred())
+
+		actual := &corev1.Node{ObjectMeta: metav1.ObjectMeta{Name: obj.Name}}
+		Expect(cl.Get(context.Background(), client.ObjectKeyFromObject(actual), actual)).NotTo(HaveOccurred())
+
+		expectedObj.APIVersion = actual.APIVersion
+		expectedObj.Kind = actual.Kind
+		expectedObj.ResourceVersion = actual.ResourceVersion
+		expectedObj.Status.NodeInfo.MachineID = machineIDFromStatusUpdate
+		Expect(cmp.Diff(expectedObj, actual)).To(BeEmpty())
+	})
+
+	It("should be able to update an object's status after updating an object", func() {
+		obj := &corev1.Node{
+			ObjectMeta: metav1.ObjectMeta{
+				Name: "node",
+			},
+			Spec: corev1.NodeSpec{
+				PodCIDR: "old-cidr",
+			},
+			Status: corev1.NodeStatus{
+				NodeInfo: corev1.NodeSystemInfo{
+					MachineID: "machine-id",
+				},
+			},
+		}
+		cl := NewClientBuilder().WithStatusSubresource(obj).WithObjects(obj).Build()
+		expectedObj := obj.DeepCopy()
+
+		obj.Annotations = map[string]string{
+			"some-annotation-key": "some",
+		}
+		expectedObj.Annotations = map[string]string{
+			"some-annotation-key": "some",
+		}
+		Expect(cl.Update(context.Background(), obj)).NotTo(HaveOccurred())
+
+		obj.Spec.PodCIDR = cidrFromStatusUpdate
+		obj.Status.NodeInfo.MachineID = machineIDFromStatusUpdate
+		Expect(cl.Status().Update(context.Background(), obj)).NotTo(HaveOccurred())
+
+		actual := &corev1.Node{ObjectMeta: metav1.ObjectMeta{Name: obj.Name}}
+		Expect(cl.Get(context.Background(), client.ObjectKeyFromObject(actual), actual)).NotTo(HaveOccurred())
+
+		expectedObj.APIVersion = actual.APIVersion
+		expectedObj.Kind = actual.Kind
+		expectedObj.ResourceVersion = actual.ResourceVersion
+		expectedObj.Status.NodeInfo.MachineID = machineIDFromStatusUpdate
+		Expect(cmp.Diff(expectedObj, actual)).To(BeEmpty())
+	})
+
 	It("Should only override status fields of typed objects that have a status subresource on status update", func() {
 		obj := &corev1.Node{
 			ObjectMeta: metav1.ObjectMeta{
@@ -1536,7 +1619,7 @@ var _ = Describe("Fake client", func() {
 		cl := NewClientBuilder().WithStatusSubresource(obj).WithObjects(obj).Build()
 		objOriginal := obj.DeepCopy()
 
-		obj.Spec.PodCIDR = "cidr-from-status-update"
+		obj.Spec.PodCIDR = cidrFromStatusUpdate
 		obj.Status.NodeInfo.MachineID = "machine-id"
 		Expect(cl.Status().Patch(context.Background(), obj, client.MergeFrom(objOriginal))).NotTo(HaveOccurred())
 

diff --git a/pkg/client/interfaces.go b/pkg/client/interfaces.go
@@ -142,6 +142,7 @@ type SubResourceWriter interface {
 	// Create saves the subResource object in the Kubernetes cluster. obj must be a
 	// struct pointer so that obj can be updated with the content returned by the Server.
 	Create(ctx context.Context, obj Object, subResource Object, opts ...SubResourceCreateOption) error
+
 	// Update updates the fields corresponding to the status subresource for the
 	// given obj. obj must be a struct pointer so that obj can be updated
 	// with the content returned by the Server.