Update VirtualMachineGroupPublishRequest controller to use UID instead of name in managed-by label (#1483)

This PR updates the VirtualMachineGroupPublishRequest controller to
use the VirtualMachineGroupPublishRequest's UID in place of its name
when creating child VirtualMachinePublishRequests with the virtualmachinepublishrequest-managed-by
label.

There is a 63 character limit on label keys. We have and will continue to
hit this limit when using the Group Publish Request's name. We, instead, use
the Group Publish Request's UID as it will fit nicely within this limit.

Author: abaruni

controllers/virtualmachinegrouppublishrequest/virtualmachinegrouppublishrequest_controller.go

@@ -216,7 +216,7 @@ func (r *Reconciler) getVMPublishRequests(
 		reqs,
 		client.InNamespace(ctx.VMGroupPublishRequest.Namespace),
 		client.MatchingLabels{
-			vmopv1.VirtualMachinePublishRequestManagedByLabelKey: ctx.VMGroupPublishRequest.Name,
+			vmopv1.VirtualMachinePublishRequestManagedByLabelKey: string(ctx.VMGroupPublishRequest.UID),
 		}); err != nil {
 		ctx.Logger.Error(err, "failed to list VirtualMachinePublishRequest")
 		return nil, nil, nil, err
@@ -293,7 +293,7 @@ func (r *Reconciler) reconcileNewPublishRequests(
 					*metav1.NewControllerRef(ctx.VMGroupPublishRequest, vmGroupPubReqGvk),
 				},
 				Labels: map[string]string{
-					vmopv1.VirtualMachinePublishRequestManagedByLabelKey: ctx.VMGroupPublishRequest.Name,
+					vmopv1.VirtualMachinePublishRequestManagedByLabelKey: string(ctx.VMGroupPublishRequest.UID),
 				},
 			},
 			Spec: vmopv1.VirtualMachinePublishRequestSpec{

controllers/virtualmachinegrouppublishrequest/virtualmachinegrouppublishrequest_controller_intg_test.go

@@ -53,7 +53,7 @@ func intgTestsReconcile() {
 	getVMPubReqs := func(ctx *builder.IntegrationTestContext, ns string) []vmopv1.VirtualMachinePublishRequest {
 		reqs := &vmopv1.VirtualMachinePublishRequestList{}
 		Expect(ctx.Client.List(ctx, reqs, client.InNamespace(ns), client.MatchingLabels{
-			vmopv1.VirtualMachinePublishRequestManagedByLabelKey: vmGroupPubReq.Name,
+			vmopv1.VirtualMachinePublishRequestManagedByLabelKey: string(vmGroupPubReq.UID),
 		})).NotTo(HaveOccurred())
 		return reqs.Items
 	}

controllers/virtualmachinegrouppublishrequest/virtualmachinegrouppublishrequest_controller_unit_test.go

@@ -6,7 +6,6 @@ package virtualmachinegrouppublishrequest_test
 
 import (
 	"fmt"
-
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -51,6 +50,7 @@ func unitTestsReconcile() {
 			builder.DummyNamespaceName,
 			[]string{builder.DummyVirtualMachineName + "-0", builder.DummyVirtualMachineName + "-1"})
 		controllerutil.AddFinalizer(vmGroupPubReq, finalizerName)
+		vmGroupPubReq.UID = "test-vm-group-pubreq-uid"
 	})
 
 	JustBeforeEach(func() {
@@ -197,7 +197,7 @@ func getVMPublishRequests(
 		reqs,
 		client.InNamespace(vmGroupPubReq.Namespace),
 		client.MatchingLabels{
-			vmopv1.VirtualMachinePublishRequestManagedByLabelKey: vmGroupPubReq.Name,
+			vmopv1.VirtualMachinePublishRequestManagedByLabelKey: string(vmGroupPubReq.UID),
 		})).NotTo(HaveOccurred())
 	Expect(reqs.Items).To(HaveLen(expectedPendingCnt))
 	return reqs.Items
@@ -206,7 +206,7 @@ func getVMPublishRequests(
 func verifyRequest(req vmopv1.VirtualMachinePublishRequest, vmGroupPub *vmopv1.VirtualMachineGroupPublishRequest) {
 	Expect(req.Name).To(ContainSubstring(vmGroupPub.Name))
 	Expect(metav1.HasLabel(req.ObjectMeta, vmopv1.VirtualMachinePublishRequestManagedByLabelKey)).To(BeTrue())
-	Expect(req.Labels).To(HaveKeyWithValue(vmopv1.VirtualMachinePublishRequestManagedByLabelKey, vmGroupPub.Name))
+	Expect(req.Labels).To(HaveKeyWithValue(vmopv1.VirtualMachinePublishRequestManagedByLabelKey, string(vmGroupPub.UID)))
 	Expect(metav1.IsControlledBy(&req, vmGroupPub)).To(BeTrue())
 	Expect(req.Spec.Source.Kind).To(Equal("VirtualMachine"))
 	Expect(req.Spec.Source.Name).To(ContainSubstring("dummy-vm"))

webhooks/virtualmachinepublishrequest/validation/virtualmachinepublishrequest_validator.go

@@ -195,7 +195,7 @@ func (v validator) validateCreateVMGroupPublishRequestOwnership(vmPub *vmopv1.Vi
 
 	for _, ownerRef := range vmPub.OwnerReferences {
 		if ownerRef.Kind == "VirtualMachineGroupPublishRequest" &&
-			ownerRef.Name == vmPub.Labels[vmopv1.VirtualMachinePublishRequestManagedByLabelKey] {
+			string(ownerRef.UID) == vmPub.Labels[vmopv1.VirtualMachinePublishRequestManagedByLabelKey] {
 			return nil
 		}
 	}