Add explanation for complex test logics and TODO for refactoring

Signed-off-by: Nont <[email protected]>

Author: Nont

pkg/webhook/managedresource/createordelete.go

@@ -39,6 +39,7 @@ func EnsureVAP(ctx context.Context, c client.Client, isHub bool) error {
 		obj    client.Object
 		mutate func() error
 	}
+	// TODO: this can be simplified by dealing with the specific type rather than using client.Object
 	vap, mutateVAP := getVAPWithMutator(isHub)
 	vapb, mutateVAPB := getVAPBindingWithMutator()
 	objsAndMutators := []vapObjectAndMutator{

pkg/webhook/managedresource/createordelete_test.go

@@ -127,6 +127,8 @@ func TestEnsureVAP(t *testing.T) {
 			}
 
 			interceptorFuncs := interceptor.Funcs{
+				// This is needed for a test scenario that GET would retrieve the same object as what was created/updated.
+				// TODO: refactor to simplify this. The store should not be needed as UPDATE should update the same object provided in fakeClient's WithObjects
 				Get: func(ctx context.Context, c client.WithWatch, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
 					if storedObj, exists := objectStore[key]; exists {
 						switch v := obj.(type) {

pkg/webhook/managedresource/validatingadmissionpolicy.go

@@ -10,6 +10,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+// TODO use a differnt name for binding to simplify the code
+// and add a migration path
 const resourceName = "aks-fleet-managed-by-arm"
 
 var forbidden = metav1.StatusReasonForbidden

test/e2e/setup_test.go

@@ -397,6 +397,7 @@ func beforeSuiteForProcess1() {
 
 	setAllMemberClustersToJoin()
 	checkIfAllMemberClustersHaveJoined()
+	// TODO: add checks for VAP and its binding existence in Join Leave scenarios
 	for _, c := range allMemberClusters {
 		checkVAPAndBindingExistence(c)
 	}
@@ -418,6 +419,7 @@ var _ = SynchronizedAfterSuite(func() {}, func() {
 	deleteTestResourceCRD()
 	setAllMemberClustersToLeave()
 	checkIfAllMemberClustersHaveLeft()
+	// TODO: add checks for VAP and its binding absence in Join Leave scenarios
 	for _, c := range allMemberClusters {
 		checkVAPAndBindingAbsence(c)
 	}