Merge pull request #267 from JackZxj/fix/terminating-filter

fix(scheduler): add terminating filter

pkg/apis/core/v1alpha1/extensions_schedulingprofile.go

@@ -28,6 +28,7 @@ func GetDefaultEnabledPlugins() *fedcore.EnabledPlugins {
 		names.PlacementFilter,
 		names.ClusterAffinity,
 		names.ClusterReady,
+		names.ClusterTerminating,
 	}
 
 	scorePlugins := []string{

pkg/controllers/scheduler/framework/plugins/clusterterminating/clusterterminating.go

@@ -0,0 +1,53 @@
+/*
+Copyright 2023 The KubeAdmiral Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package clusterterminating
+
+import (
+	"context"
+
+	fedcorev1a1 "github.com/kubewharf/kubeadmiral/pkg/apis/core/v1alpha1"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/names"
+)
+
+type ClusterTerminating struct{}
+
+func NewClusterTerminating(_ framework.Handle) (framework.Plugin, error) {
+	return &ClusterTerminating{}, nil
+}
+
+func (pl *ClusterTerminating) Name() string {
+	return names.ClusterTerminating
+}
+
+func (pl *ClusterTerminating) Filter(
+	ctx context.Context,
+	su *framework.SchedulingUnit,
+	cluster *fedcorev1a1.FederatedCluster,
+) *framework.Result {
+	err := framework.PreCheck(ctx, su, cluster)
+	if err != nil {
+		return framework.NewResult(framework.Error, err.Error())
+	}
+
+	// Prevent scheduling to terminating cluster.
+	if !cluster.DeletionTimestamp.IsZero() {
+		return framework.NewResult(framework.Unschedulable, "cluster(s) were terminating")
+	}
+
+	return framework.NewResult(framework.Success)
+}

pkg/controllers/scheduler/framework/plugins/clusterterminating/clusterterminating_test.go

@@ -0,0 +1,137 @@
+/*
+Copyright 2023 The KubeAdmiral Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package clusterterminating
+
+import (
+	"context"
+	"reflect"
+	"testing"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/pointer"
+
+	fedcorev1a1 "github.com/kubewharf/kubeadmiral/pkg/apis/core/v1alpha1"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/names"
+)
+
+func TestClusterTerminating_Name(t *testing.T) {
+	pl, err := NewClusterTerminating(nil)
+	if err != nil {
+		t.Error(err)
+	}
+	if pl.Name() != names.ClusterTerminating {
+		t.Errorf("Expected name %s, got %s", names.ClusterTerminating, pl.Name())
+	}
+}
+
+func TestClusterTerminating_Filter(t *testing.T) {
+	now := metav1.Now()
+	type args struct {
+		su      *framework.SchedulingUnit
+		cluster *fedcorev1a1.FederatedCluster
+	}
+	tests := []struct {
+		name            string
+		args            args
+		want            *framework.Result
+		wantMaxReplicas int64
+	}{
+		{
+			name: "cluster scheduled",
+			args: args{
+				su: &framework.SchedulingUnit{
+					CurrentClusters: map[string]*int64{"cluster1": pointer.Int64(1)},
+				},
+				cluster: &fedcorev1a1.FederatedCluster{
+					ObjectMeta: metav1.ObjectMeta{Name: "cluster1"},
+				},
+			},
+			want: framework.NewResult(framework.Success),
+		},
+		{
+			name: "cluster scheduled, but is terminating",
+			args: args{
+				su: &framework.SchedulingUnit{
+					CurrentClusters: map[string]*int64{"cluster1": pointer.Int64(1)},
+				},
+				cluster: &fedcorev1a1.FederatedCluster{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:              "cluster1",
+						DeletionTimestamp: &now,
+					},
+				},
+			},
+			want: framework.NewResult(framework.Unschedulable, "cluster(s) were terminating"),
+		},
+		{
+			name: "cluster not scheduled",
+			args: args{
+				su: &framework.SchedulingUnit{
+					CurrentClusters: map[string]*int64{"cluster1": pointer.Int64(1)},
+				},
+				cluster: &fedcorev1a1.FederatedCluster{
+					ObjectMeta: metav1.ObjectMeta{
+						Name: "cluster2",
+					},
+				},
+			},
+			want: framework.NewResult(framework.Success),
+		},
+		{
+			name: "cluster not scheduled, and is terminating",
+			args: args{
+				su: &framework.SchedulingUnit{
+					CurrentClusters: map[string]*int64{"cluster1": pointer.Int64(1)},
+				},
+				cluster: &fedcorev1a1.FederatedCluster{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:              "cluster2",
+						DeletionTimestamp: &now,
+					},
+				},
+			},
+			want: framework.NewResult(framework.Unschedulable, "cluster(s) were terminating"),
+		},
+		{
+			name: "cluster is nil",
+			args: args{
+				su: &framework.SchedulingUnit{
+					CurrentClusters: map[string]*int64{"cluster1": pointer.Int64(1)},
+				},
+				cluster: nil,
+			},
+			want: framework.NewResult(framework.Error, "invalid federated cluster"),
+		},
+		{
+			name: "su is nil",
+			args: args{
+				su:      nil,
+				cluster: nil,
+			},
+			want: framework.NewResult(framework.Error, "invalid scheduling unit"),
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			pl := &ClusterTerminating{}
+			if got := pl.Filter(context.Background(), tt.args.su, tt.args.cluster); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("Filter() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

pkg/controllers/scheduler/framework/plugins/names/names.go

@@ -20,6 +20,7 @@ const (
 	APIResources                       = "APIResources"
 	TaintToleration                    = "TaintToleration"
 	ClusterReady                       = "ClusterReady"
+	ClusterTerminating                 = "ClusterTerminating"
 	ClusterResourcesFit                = "ClusterResourcesFit"
 	PlacementFilter                    = "PlacementFilter"
 	ClusterAffinity                    = "ClusterAffinity"

pkg/controllers/scheduler/profile.go

@@ -28,6 +28,7 @@ import (
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/clusteraffinity"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/clusterready"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/clusterresources"
+	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/clusterterminating"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/maxcluster"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/names"
 	"github.com/kubewharf/kubeadmiral/pkg/controllers/scheduler/framework/plugins/placement"
@@ -40,6 +41,7 @@ import (
 var inTreeRegistry = runtime.Registry{
 	names.APIResources:                       apiresources.NewAPIResources,
 	names.ClusterReady:                       clusterready.NewClusterReady,
+	names.ClusterTerminating:                 clusterterminating.NewClusterTerminating,
 	names.ClusterAffinity:                    clusteraffinity.NewClusterAffinity,
 	names.ClusterResourcesFit:                clusterresources.NewClusterResourcesFit,
 	names.PlacementFilter:                    placement.NewPlacementFilter,