Merge pull request #954 from spike-liu/master

Plugin arguments defaulting + moving plugin arguments to each corresponding plugin #925

pkg/framework/plugins/defaultevictor/defaults.go

@@ -0,0 +1,51 @@
+/*
+Copyright 2022 The Kubernetes 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 defaultevictor
+
+import (
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+func addDefaultingFuncs(scheme *runtime.Scheme) error {
+	return RegisterDefaults(scheme)
+}
+
+// SetDefaults_DefaultEvictorArgs
+// TODO: the final default values would be discussed in community
+func SetDefaults_DefaultEvictorArgs(obj *DefaultEvictorArgs) {
+	if obj.NodeSelector == "" {
+		obj.NodeSelector = ""
+	}
+	if !obj.EvictLocalStoragePods {
+		obj.EvictSystemCriticalPods = false
+	}
+	if !obj.EvictSystemCriticalPods {
+		obj.EvictSystemCriticalPods = false
+	}
+	if !obj.IgnorePvcPods {
+		obj.IgnorePvcPods = false
+	}
+	if !obj.EvictFailedBarePods {
+		obj.EvictFailedBarePods = false
+	}
+	if obj.LabelSelector == nil {
+		obj.LabelSelector = nil
+	}
+	if obj.PriorityThreshold == nil {
+		obj.PriorityThreshold = nil
+	}
+	if !obj.NodeFit {
+		obj.NodeFit = false
+	}
+}

pkg/framework/plugins/defaultevictor/defaults_test.go

@@ -0,0 +1,83 @@
+/*
+Copyright 2022 The Kubernetes 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 defaultevictor
+
+import (
+	"github.com/google/go-cmp/cmp"
+	"k8s.io/apimachinery/pkg/runtime"
+	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
+	"k8s.io/utils/pointer"
+	"sigs.k8s.io/descheduler/pkg/api"
+	"testing"
+)
+
+func TestSetDefaults_DefaultEvictorArgs(t *testing.T) {
+	tests := []struct {
+		name string
+		in   runtime.Object
+		want runtime.Object
+	}{
+		{
+			name: "DefaultEvictorArgs empty",
+			in:   &DefaultEvictorArgs{},
+			want: &DefaultEvictorArgs{
+				NodeSelector:            "",
+				EvictLocalStoragePods:   false,
+				EvictSystemCriticalPods: false,
+				IgnorePvcPods:           false,
+				EvictFailedBarePods:     false,
+				LabelSelector:           nil,
+				PriorityThreshold:       nil,
+				NodeFit:                 false,
+			},
+		},
+		{
+			name: "DefaultEvictorArgs with value",
+			in: &DefaultEvictorArgs{
+				NodeSelector:            "NodeSelector",
+				EvictLocalStoragePods:   true,
+				EvictSystemCriticalPods: true,
+				IgnorePvcPods:           true,
+				EvictFailedBarePods:     true,
+				LabelSelector:           nil,
+				PriorityThreshold: &api.PriorityThreshold{
+					Value: pointer.Int32(800),
+				},
+				NodeFit: true,
+			},
+			want: &DefaultEvictorArgs{
+				NodeSelector:            "NodeSelector",
+				EvictLocalStoragePods:   true,
+				EvictSystemCriticalPods: true,
+				IgnorePvcPods:           true,
+				EvictFailedBarePods:     true,
+				LabelSelector:           nil,
+				PriorityThreshold: &api.PriorityThreshold{
+					Value: pointer.Int32(800),
+				},
+				NodeFit: true,
+			},
+		},
+	}
+	for _, tc := range tests {
+		scheme := runtime.NewScheme()
+		utilruntime.Must(AddToScheme(scheme))
+		t.Run(tc.name, func(t *testing.T) {
+			scheme.Default(tc.in)
+			if diff := cmp.Diff(tc.in, tc.want); diff != "" {
+				t.Errorf("Got unexpected defaults (-want, +got):\n%s", diff)
+			}
+		})
+	}
+}

pkg/framework/plugins/defaultevictor/doc.go

@@ -0,0 +1,16 @@
+/*
+Copyright 2022 The Kubernetes 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.
+*/
+
+// +k8s:defaulter-gen=TypeMeta
+
+package defaultevictor

pkg/framework/plugins/defaultevictor/register.go

@@ -0,0 +1,31 @@
+/*
+Copyright 2022 The Kubernetes 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 defaultevictor
+
+import (
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+var (
+	SchemeBuilder      = runtime.NewSchemeBuilder()
+	localSchemeBuilder = &SchemeBuilder
+	AddToScheme        = localSchemeBuilder.AddToScheme
+)
+
+func init() {
+	// We only register manually written functions here. The registration of the
+	// generated functions takes place in the generated files. The separation
+	// makes the code compile even when the generated files are missing.
+	localSchemeBuilder.Register(addDefaultingFuncs)
+}

pkg/framework/plugins/defaultevictor/zz_generated.defaults.go

@@ -0,0 +1,38 @@
+//go:build !ignore_autogenerated
+// +build !ignore_autogenerated
+
+/*
+Copyright 2022 The Kubernetes 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.
+*/
+
+// Code generated by defaulter-gen. DO NOT EDIT.
+
+package defaultevictor
+
+import (
+	runtime "k8s.io/apimachinery/pkg/runtime"
+)
+
+// RegisterDefaults adds defaulters functions to the given scheme.
+// Public to allow building arbitrary schemes.
+// All generated defaulters are covering - they call all nested defaulters.
+func RegisterDefaults(scheme *runtime.Scheme) error {
+	scheme.AddTypeDefaultingFunc(&DefaultEvictorArgs{}, func(obj interface{}) { SetObjectDefaults_DefaultEvictorArgs(obj.(*DefaultEvictorArgs)) })
+	return nil
+}
+
+func SetObjectDefaults_DefaultEvictorArgs(in *DefaultEvictorArgs) {
+	SetDefaults_DefaultEvictorArgs(in)
+}