kubernetes/pkg/scheduler/framework/plugins/podtopologyspread/plugin_test.go

/*
Copyright 2020 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 podtopologyspread

import (
	"strings"
	"testing"

	"github.com/google/go-cmp/cmp"
	v1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/client-go/informers"
	"k8s.io/client-go/kubernetes/fake"
	schedulerv1alpha2 "k8s.io/kube-scheduler/config/v1alpha2"
	framework "k8s.io/kubernetes/pkg/scheduler/framework/v1alpha1"
	"k8s.io/kubernetes/pkg/scheduler/internal/cache"
)

func TestNew(t *testing.T) {
	cases := []struct {
		name     string
		args     runtime.Unknown
		wantErr  string
		wantArgs schedulerv1alpha2.PodTopologySpreadArgs
	}{
		{name: "empty args"},
		{
			name: "valid constraints",
			args: runtime.Unknown{
				ContentType: runtime.ContentTypeYAML,
				Raw: []byte(`defaultConstraints:
  - maxSkew: 1
    topologyKey: "node"
    whenUnsatisfiable: "ScheduleAnyway"
  - maxSkew: 5
    topologyKey: "zone"
    whenUnsatisfiable: "DoNotSchedule"
`),
			},
			wantArgs: schedulerv1alpha2.PodTopologySpreadArgs{
				DefaultConstraints: []v1.TopologySpreadConstraint{
					{
						MaxSkew:           1,
						TopologyKey:       "node",
						WhenUnsatisfiable: v1.ScheduleAnyway,
					},
					{
						MaxSkew:           5,
						TopologyKey:       "zone",
						WhenUnsatisfiable: v1.DoNotSchedule,
					},
				},
			},
		},
		{
			name: "repeated constraints",
			args: runtime.Unknown{
				ContentType: runtime.ContentTypeYAML,
				Raw: []byte(`defaultConstraints:
  - maxSkew: 1
    topologyKey: "node"
    whenUnsatisfiable: "ScheduleAnyway"
  - maxSkew: 5
    topologyKey: "node"
    whenUnsatisfiable: "ScheduleAnyway"
`),
			},
			wantErr: "Duplicate value",
		},
		{
			name: "unknown whenUnsatisfiable",
			args: runtime.Unknown{
				ContentType: runtime.ContentTypeYAML,
				Raw: []byte(`defaultConstraints:
  - maxSkew: 1
    topologyKey: "node"
    whenUnsatisfiable: "Unknown"
`),
			},
			wantErr: "Unsupported value",
		},
		{
			name: "negative maxSkew",
			args: runtime.Unknown{
				ContentType: runtime.ContentTypeYAML,
				Raw: []byte(`defaultConstraints:
  - maxSkew: -1
    topologyKey: "node"
    whenUnsatisfiable: "ScheduleAnyway"
`),
			},
			wantErr: "must be greater than zero",
		},
		{
			name: "empty topologyKey",
			args: runtime.Unknown{
				ContentType: runtime.ContentTypeYAML,
				Raw: []byte(`defaultConstraints:
  - maxSkew: 1
    whenUnsatisfiable: "ScheduleAnyway"
`),
			},
			wantErr: "can not be empty",
		},
		{
			name: "with label selector",
			args: runtime.Unknown{
				ContentType: runtime.ContentTypeYAML,
				Raw: []byte(`defaultConstraints:
  - maxSkew: 1
    topologyKey: "rack"
    whenUnsatisfiable: "ScheduleAnyway"
    labelSelector:
      matchLabels:
        foo: "bar"
`),
			},
			wantErr: "constraint must not define a selector",
		},
	}
	for _, tc := range cases {
		t.Run(tc.name, func(t *testing.T) {
			informerFactory := informers.NewSharedInformerFactory(fake.NewSimpleClientset(), 0)
			f, err := framework.NewFramework(nil, nil, nil,
				framework.WithSnapshotSharedLister(cache.NewSnapshot(nil, nil)),
				framework.WithInformerFactory(informerFactory),
			)
			if err != nil {
				t.Fatal(err)
			}
			pl, err := New(&tc.args, f)
			if len(tc.wantErr) != 0 {
				if err == nil || !strings.Contains(err.Error(), tc.wantErr) {
					t.Errorf("must fail, got error %q, want %q", err, tc.wantErr)
				}
				return
			}
			if err != nil {
				t.Fatal(err)
			}
			plObj := pl.(*PodTopologySpread)
			if diff := cmp.Diff(tc.wantArgs, plObj.BuildArgs()); diff != "" {
				t.Errorf("wrong plugin build args (-want,+got):\n%s", diff)
			}
		})
	}
}