feat: use bindingObj interface instead of ClusterResourceBinding in the scheduler (#111)

Author: ryanzhang-oss

.github/.copilot/breadcrumbs/2025-06-13-1500-scheduler-binding-interface-refactor.md

@@ -525,10 +525,10 @@ func (r *Reconciler) selectResourcesForPlacement(placement *fleetv1beta1.Cluster
 			return 0, nil, nil, err
 		}
 		uGVK := unstructuredObj.GetObjectKind().GroupVersionKind().GroupKind()
-		switch {
-		case uGVK == utils.ClusterResourceEnvelopeGK:
+		switch uGVK {
+		case utils.ClusterResourceEnvelopeGK:
 			envelopeObjCount++
-		case uGVK == utils.ResourceEnvelopeGK:
+		case utils.ResourceEnvelopeGK:
 			envelopeObjCount++
 		}
 		resources[i] = *rc

.github/.copilot/breadcrumbs/2025-06-19-0800-scheduler-patch-functions-unified-refactor.md

@@ -606,14 +606,14 @@ func (r *Reconciler) calculateRealTarget(crp *fleetv1beta1.ClusterResourcePlacem
 	targetNumber := 0
 
 	// note that if the policy will be overwritten if it is nil in this controller.
-	switch {
-	case crp.Spec.Policy.PlacementType == fleetv1beta1.PickAllPlacementType:
+	switch crp.Spec.Policy.PlacementType {
+	case fleetv1beta1.PickAllPlacementType:
 		// we use the scheduler picked bindings as the target number since there is no target in the CRP
 		targetNumber = len(schedulerTargetedBinds)
-	case crp.Spec.Policy.PlacementType == fleetv1beta1.PickFixedPlacementType:
+	case fleetv1beta1.PickFixedPlacementType:
 		// we use the length of the given cluster names are targets
 		targetNumber = len(crp.Spec.Policy.ClusterNames)
-	case crp.Spec.Policy.PlacementType == fleetv1beta1.PickNPlacementType:
+	case fleetv1beta1.PickNPlacementType:
 		// we use the given number as the target
 		targetNumber = int(*crp.Spec.Policy.NumberOfClusters)
 	default:

pkg/controllers/clusterresourceplacement/resource_selector.go

@@ -125,10 +125,10 @@ var _ = Describe("Test the rollout Controller", func() {
 
 			// Prepare bindings of various states.
 			var binding *fleetv1beta1.ClusterResourceBinding
-			switch {
-			case i%3 == 0:
+			switch i % 3 {
+			case 0:
 				binding = generateClusterResourceBinding(fleetv1beta1.BindingStateScheduled, resourceSnapshot.Name, clusters[i])
-			case i%3 == 1:
+			case 1:
 				binding = generateClusterResourceBinding(fleetv1beta1.BindingStateBound, resourceSnapshot.Name, clusters[i])
 			default:
 				binding = generateClusterResourceBinding(fleetv1beta1.BindingStateUnscheduled, resourceSnapshot.Name, clusters[i])

pkg/controllers/rollout/controller.go

@@ -588,8 +588,8 @@ func (r *Reconciler) processOneSelectedResource(
 	}
 
 	uGVK := uResource.GetObjectKind().GroupVersionKind().GroupKind()
-	switch {
-	case uGVK == utils.ClusterResourceEnvelopeGK:
+	switch uGVK {
+	case utils.ClusterResourceEnvelopeGK:
 		// The resource is a ClusterResourceEnvelope; extract its contents.
 		var clusterResourceEnvelope fleetv1beta1.ClusterResourceEnvelope
 		if err := runtime.DefaultUnstructuredConverter.FromUnstructured(uResource.Object, &clusterResourceEnvelope); err != nil {
@@ -609,7 +609,7 @@ func (r *Reconciler) processOneSelectedResource(
 		}
 		activeWork[work.Name] = work
 		newWork = append(newWork, work)
-	case uGVK == utils.ResourceEnvelopeGK:
+	case utils.ResourceEnvelopeGK:
 		// The resource is a ResourceEnvelope; extract its contents.
 		var resourceEnvelope fleetv1beta1.ResourceEnvelope
 		if err := runtime.DefaultUnstructuredConverter.FromUnstructured(uResource.Object, &resourceEnvelope); err != nil {

pkg/controllers/rollout/controller_integration_test.go

@@ -140,7 +140,7 @@ func (c *CycleState) HasObsoleteBindingFor(clusterName string) bool {
 // IsClusterObsolete
 
 // NewCycleState creates a CycleState.
-func NewCycleState(clusters []clusterv1beta1.MemberCluster, obsoleteBindings []*placementv1beta1.ClusterResourceBinding, scheduledOrBoundBindings ...[]*placementv1beta1.ClusterResourceBinding) *CycleState {
+func NewCycleState(clusters []clusterv1beta1.MemberCluster, obsoleteBindings []placementv1beta1.BindingObj, scheduledOrBoundBindings ...[]placementv1beta1.BindingObj) *CycleState {
 	return &CycleState{
 		store:                    sync.Map{},
 		clusters:                 clusters,

pkg/controllers/workgenerator/controller.go

@@ -24,6 +24,7 @@ import (
 
 	clusterv1beta1 "github.com/kubefleet-dev/kubefleet/apis/cluster/v1beta1"
 	placementv1beta1 "github.com/kubefleet-dev/kubefleet/apis/placement/v1beta1"
+	"github.com/kubefleet-dev/kubefleet/pkg/utils/controller"
 )
 
 // TestCycleStateBasicOps tests the basic ops of a CycleState.
@@ -67,7 +68,9 @@ func TestCycleStateBasicOps(t *testing.T) {
 		},
 	}
 
-	cs := NewCycleState(clusters, obsoleteBindings, scheduledOrBoundBindings)
+	// Convert concrete bindings to interface slices
+
+	cs := NewCycleState(clusters, controller.ConvertCRBArrayToBindingObjs(obsoleteBindings), controller.ConvertCRBArrayToBindingObjs(scheduledOrBoundBindings))
 
 	k, v := "key", "value"
 	cs.Write(StateKey(k), StateValue(v))
@@ -125,7 +128,8 @@ func TestPrepareScheduledOrBoundBindingsMap(t *testing.T) {
 		altClusterName: true,
 	}
 
-	scheduleOrBoundBindingsMap := prepareScheduledOrBoundBindingsMap(scheduled, bound)
+	// Convert concrete bindings to interface slices
+	scheduleOrBoundBindingsMap := prepareScheduledOrBoundBindingsMap(controller.ConvertCRBArrayToBindingObjs(scheduled), controller.ConvertCRBArrayToBindingObjs(bound))
 	if diff := cmp.Diff(scheduleOrBoundBindingsMap, want); diff != "" {
 		t.Errorf("preparedScheduledOrBoundBindingsMap() scheduledOrBoundBindingsMap diff (-got, +want): %s", diff)
 	}
@@ -157,7 +161,8 @@ func TestPrepareObsoleteBindingsMap(t *testing.T) {
 		altClusterName: true,
 	}
 
-	obsoleteBindingsMap := prepareObsoleteBindingsMap(obsolete)
+	// Convert concrete bindings to interface slice
+	obsoleteBindingsMap := prepareObsoleteBindingsMap(controller.ConvertCRBArrayToBindingObjs(obsolete))
 	if diff := cmp.Diff(obsoleteBindingsMap, want); diff != "" {
 		t.Errorf("prepareObsoleteBindingsMap() obsoleteBindingsMap diff (-got, +want): %s", diff)
 	}

pkg/scheduler/framework/cyclestate.go

@@ -23,12 +23,12 @@ import (
 // prepareScheduledOrBoundBindingsMap returns a map that allows quick lookup of whether a cluster
 // already has a binding of the scheduled or bound state relevant to the current scheduling
 // cycle.
-func prepareScheduledOrBoundBindingsMap(scheduledOrBoundBindings ...[]*fleetv1beta1.ClusterResourceBinding) map[string]bool {
+func prepareScheduledOrBoundBindingsMap(scheduledOrBoundBindings ...[]fleetv1beta1.BindingObj) map[string]bool {
 	bm := make(map[string]bool)
 
 	for _, bindingSet := range scheduledOrBoundBindings {
 		for _, binding := range bindingSet {
-			bm[binding.Spec.TargetCluster] = true
+			bm[binding.GetBindingSpec().TargetCluster] = true
 		}
 	}
 
@@ -37,11 +37,11 @@ func prepareScheduledOrBoundBindingsMap(scheduledOrBoundBindings ...[]*fleetv1be
 
 // prepareObsoleteBindingsMap returns a map that allows quick lookup of whether a cluster
 // already has an obsolete binding relevant to the current scheduling cycle.
-func prepareObsoleteBindingsMap(obsoleteBindings []*fleetv1beta1.ClusterResourceBinding) map[string]bool {
+func prepareObsoleteBindingsMap(obsoleteBindings []fleetv1beta1.BindingObj) map[string]bool {
 	bm := make(map[string]bool)
 
 	for _, binding := range obsoleteBindings {
-		bm[binding.Spec.TargetCluster] = true
+		bm[binding.GetBindingSpec().TargetCluster] = true
 	}
 
 	return bm