Set deterministic order of agentPoolProfiles when creating ManagedCluster for AzureASOManagedControlPlane

Author: nojnhuh

pkg/mutators/azureasomanagedcontrolplane.go

@@ -17,9 +17,11 @@ limitations under the License.
 package mutators
 
 import (
+	"cmp"
 	"context"
 	"errors"
 	"fmt"
+	"slices"
 	"strings"
 
 	asocontainerservicev1 "github.com/Azure/azure-service-operator/v2/api/containerservice/v1api20231001"
@@ -264,6 +266,11 @@ func agentPoolsFromManagedMachinePools(ctx context.Context, ctrlClient client.Cl
 		return nil, fmt.Errorf("failed to list AzureASOManagedMachinePools: %w", err)
 	}
 
+	// Make sure we don't update the ManagedCluster with different orders of the same set of agent pools.
+	slices.SortFunc(asoManagedMachinePools.Items, func(a, b infrav1.AzureASOManagedMachinePool) int {
+		return cmp.Compare(a.Name, b.Name)
+	})
+
 	var agentPools []conversion.Convertible
 	for _, asoManagedMachinePool := range asoManagedMachinePools.Items {
 		machinePool, err := exputil.GetOwnerMachinePool(ctx, ctrlClient, asoManagedMachinePool.ObjectMeta)

pkg/mutators/azureasomanagedcontrolplane_test.go

@@ -17,21 +17,25 @@ limitations under the License.
 package mutators
 
 import (
+	"context"
 	"encoding/json"
+	"slices"
 	"testing"
 
 	asocontainerservicev1 "github.com/Azure/azure-service-operator/v2/api/containerservice/v1api20231001"
 	asocontainerservicev1preview "github.com/Azure/azure-service-operator/v2/api/containerservice/v1api20231102preview"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"
 	"github.com/google/go-cmp/cmp"
 	. "github.com/onsi/gomega"
+	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/utils/ptr"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	expv1 "sigs.k8s.io/cluster-api/exp/api/v1beta1"
 	"sigs.k8s.io/cluster-api/util/secret"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 	fakeclient "sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
@@ -727,9 +731,11 @@ func TestSetManagedClusterAgentPoolProfiles(t *testing.T) {
 			},
 		}
 
-		c := fakeClientBuilder().
-			WithLists(asoManagedMachinePools, machinePools).
-			Build()
+		c := reverseListingClient{
+			WithWatch: fakeClientBuilder().
+				WithLists(asoManagedMachinePools, machinePools).
+				Build(),
+		}
 
 		cluster := &clusterv1.Cluster{ObjectMeta: metav1.ObjectMeta{Name: clusterName}}
 		err := setManagedClusterAgentPoolProfiles(ctx, c, namespace, cluster, "", umc)
@@ -855,3 +861,21 @@ func apUnstructured(g Gomega, ap *asocontainerservicev1.ManagedClustersAgentPool
 	g.Expect(s.Convert(ap, u, nil)).To(Succeed())
 	return u
 }
+
+// reverseListingClient lists objects in the reverse order of the testing client.
+type reverseListingClient struct {
+	client.WithWatch
+}
+
+func (c reverseListingClient) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error {
+	err := c.WithWatch.List(ctx, list, opts...)
+	if err != nil {
+		return err
+	}
+	objs, err := meta.ExtractList(list)
+	if err != nil {
+		return err
+	}
+	slices.Reverse(objs)
+	return meta.SetList(list, objs)
+}