decouple suspension of propagation and resourcebinding

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

Author: Monokaix

Diff for: api/openapi-spec/swagger.json

@@ -20395,7 +20395,7 @@
         },
         "suspension": {
           "description": "Suspension declares the policy for suspending different aspects of propagation. nil means no suspension. no default values.",
-          "$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.Suspension"
+          "$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.work.v1alpha2.Suspension"
         }
       }
     },
@@ -20434,6 +20434,20 @@
         }
       }
     },
+    "com.github.karmada-io.karmada.pkg.apis.work.v1alpha2.Suspension": {
+      "description": "Suspension defines the policy for suspending of propagation.",
+      "type": "object",
+      "properties": {
+        "dispatching": {
+          "description": "Dispatching controls whether dispatching should be suspended. nil means not suspend, no default value, only accepts 'true'. Note: true means stop propagating to all clusters. Can not co-exist with DispatchingOnClusters which is used to suspend particular clusters.",
+          "type": "boolean"
+        },
+        "dispatchingOnClusters": {
+          "description": "DispatchingOnClusters declares a list of clusters to which the dispatching should be suspended. Note: Can not co-exist with Dispatching which is used to suspend all.",
+          "$ref": "#/definitions/com.github.karmada-io.karmada.pkg.apis.policy.v1alpha1.SuspendClusters"
+        }
+      }
+    },
     "com.github.karmada-io.karmada.pkg.apis.work.v1alpha2.TargetCluster": {
       "description": "TargetCluster represents the identifier of a member cluster.",
       "type": "object",

Diff for: pkg/apis/work/v1alpha2/binding_types.go

@@ -150,7 +150,7 @@ type ResourceBindingSpec struct {
 	// Suspension declares the policy for suspending different aspects of propagation.
 	// nil means no suspension. no default values.
 	// +optional
-	Suspension *policyv1alpha1.Suspension `json:"suspension,omitempty"`
+	Suspension *Suspension `json:"suspension,omitempty"`
 
 	// PreserveResourcesOnDeletion controls whether resources should be preserved on the
 	// member clusters when the binding object is deleted.
@@ -322,6 +322,11 @@ type BindingSnapshot struct {
 	Clusters []TargetCluster `json:"clusters,omitempty"`
 }
 
+// Suspension defines the policy for suspending of propagation.
+type Suspension struct {
+	*policyv1alpha1.Suspension `json:",inline"`
+}
+
 // ResourceBindingStatus represents the overall status of the strategy as well as the referenced resources.
 type ResourceBindingStatus struct {
 	// SchedulerObservedGeneration is the generation(.metadata.generation) observed by the scheduler.

Diff for: pkg/apis/work/v1alpha2/zz_generated.deepcopy.go

@@ -302,8 +302,8 @@ func needReviseReplicas(replicas int32, placement *policyv1alpha1.Placement) boo
 	return replicas > 0 && placement != nil && placement.ReplicaSchedulingType() == policyv1alpha1.ReplicaSchedulingTypeDivided
 }
 
-func shouldSuspendDispatching(suspension *policyv1alpha1.Suspension, targetCluster workv1alpha2.TargetCluster) bool {
-	if suspension == nil {
+func shouldSuspendDispatching(suspension *workv1alpha2.Suspension, targetCluster workv1alpha2.TargetCluster) bool {
+	if suspension == nil || suspension.Suspension == nil {
 		return false
 	}
 

Diff for: pkg/controllers/binding/common.go

@@ -321,7 +321,7 @@ func Test_mergeConflictResolution(t *testing.T) {
 
 func Test_shouldSuspendDispatching(t *testing.T) {
 	type args struct {
-		suspension    *policyv1alpha1.Suspension
+		suspension    *workv1alpha2.Suspension
 		targetCluster workv1alpha2.TargetCluster
 	}
 	tests := []struct {
@@ -334,39 +334,47 @@ func Test_shouldSuspendDispatching(t *testing.T) {
 			args: args{},
 			want: false,
 		},
+
+		{
+			name: "false for nil suspension.Suspension",
+			args: args{
+				suspension: &workv1alpha2.Suspension{},
+			},
+			want: false,
+		},
 		{
 			name: "false for nil dispatching",
 			args: args{
-				suspension: &policyv1alpha1.Suspension{Dispatching: nil},
+				suspension: &workv1alpha2.Suspension{Suspension: &policyv1alpha1.Suspension{Dispatching: nil}},
 			},
 			want: false,
 		},
 		{
 			name: "false for not suspension",
 			args: args{
-				suspension: &policyv1alpha1.Suspension{Dispatching: ptr.To(false)},
+				suspension: &workv1alpha2.Suspension{Suspension: &policyv1alpha1.Suspension{Dispatching: ptr.To(false)}},
 			},
 			want: false,
 		},
 		{
 			name: "true for suspension",
 			args: args{
-				suspension: &policyv1alpha1.Suspension{Dispatching: ptr.To(true)},
+				suspension: &workv1alpha2.Suspension{Suspension: &policyv1alpha1.Suspension{Dispatching: ptr.To(true)}},
 			},
 			want: true,
 		},
 		{
 			name: "true for matching cluster",
 			args: args{
-				suspension:    &policyv1alpha1.Suspension{DispatchingOnClusters: &policyv1alpha1.SuspendClusters{ClusterNames: []string{"clusterA"}}},
+				suspension:    &workv1alpha2.Suspension{Suspension: &policyv1alpha1.Suspension{DispatchingOnClusters: &policyv1alpha1.SuspendClusters{ClusterNames: []string{"clusterA"}}}},
 				targetCluster: workv1alpha2.TargetCluster{Name: "clusterA"},
 			},
 			want: true,
 		},
 		{
 			name: "false for mismatched cluster",
 			args: args{
-				suspension:    &policyv1alpha1.Suspension{DispatchingOnClusters: &policyv1alpha1.SuspendClusters{ClusterNames: []string{"clusterB"}}},
+				suspension:    &workv1alpha2.Suspension{Suspension: &policyv1alpha1.Suspension{DispatchingOnClusters: &policyv1alpha1.SuspendClusters{ClusterNames: []string{"clusterB"}}}},
 				targetCluster: workv1alpha2.TargetCluster{Name: "clusterA"},
 			},
 			want: false,

Diff for: pkg/controllers/binding/common_test.go

@@ -724,7 +724,7 @@ func (d *ResourceDetector) BuildResourceBinding(object *unstructured.Unstructure
 			Placement:                   &policySpec.Placement,
 			Failover:                    policySpec.Failover,
 			ConflictResolution:          policySpec.ConflictResolution,
-			Suspension:                  policySpec.Suspension,
+			Suspension:                  &workv1alpha2.Suspension{Suspension: policySpec.Suspension},
 			PreserveResourcesOnDeletion: policySpec.PreserveResourcesOnDeletion,
 			Resource: workv1alpha2.ObjectReference{
 				APIVersion:      object.GetAPIVersion(),
@@ -769,7 +769,7 @@ func (d *ResourceDetector) BuildClusterResourceBinding(object *unstructured.Unst
 			Placement:                   &policySpec.Placement,
 			Failover:                    policySpec.Failover,
 			ConflictResolution:          policySpec.ConflictResolution,
-			Suspension:                  policySpec.Suspension,
+			Suspension:                  &workv1alpha2.Suspension{Suspension: policySpec.Suspension},
 			PreserveResourcesOnDeletion: policySpec.PreserveResourcesOnDeletion,
 			Resource: workv1alpha2.ObjectReference{
 				APIVersion:      object.GetAPIVersion(),

Diff for: pkg/detector/detector.go

@@ -1124,7 +1124,7 @@ var _ = ginkgo.Describe("[Suspension] ClusterPropagationPolicy testing", func()
 
 		ginkgo.By("check CRB suspension spec", func() {
 			framework.WaitClusterResourceBindingFitWith(karmadaClient, resourceBindingName, func(binding *workv1alpha2.ClusterResourceBinding) bool {
-				return binding.Spec.Suspension != nil && ptr.Deref(binding.Spec.Suspension.Dispatching, false)
+				return binding.Spec.Suspension != nil && binding.Spec.Suspension.Suspension != nil && ptr.Deref(binding.Spec.Suspension.Dispatching, false)
 			})
 		})
 

Diff for: pkg/generated/openapi/zz_generated.openapi.go

@@ -1207,7 +1207,7 @@ var _ = ginkgo.Describe("[Suspension] PropagationPolicy testing", func() {
 		ginkgo.By("check RB suspension spec", func() {
 			framework.WaitResourceBindingFitWith(karmadaClient, deployment.Namespace, names.GenerateBindingName(deployment.Kind, deployment.Name),
 				func(binding *workv1alpha2.ResourceBinding) bool {
-					return binding.Spec.Suspension != nil && ptr.Deref(binding.Spec.Suspension.Dispatching, false)
+					return binding.Spec.Suspension != nil && binding.Spec.Suspension.Suspension != nil && ptr.Deref(binding.Spec.Suspension.Dispatching, false)
 				})
 		})