scottk/kubernetes
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/kubernetes.git synced 2025-12-01 22:03:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
44d7510ee05040ce90337215880c7a76b51e7404
kubernetes/pkg/kubelet/cm/topologymanager/topology_manager_test.go
Kevin Klues 4ee5d5409e Update the topologymanager to error out if an invalid policy is given 
Previously, the topologymanager would simply fall back to the None() policy
if an invalid policy was specified. This patch updates this to return an
error when an invalid policy is passed, forcing the kubelet to fail
fast when this occurs.

These semantics should be preferable because an invalid policy likely
indicates operator error in setting the policy flag on the kubelet
correctly (e.g. misspelling 'strict' as 'striict'). In this case it is
better to fail fast so the operator can detect this and correct the
mistake, than to mask the error and essentially disable the
topologymanager unexpectedly.
2019-07-18 13:24:09 +02:00

819 lines
18 KiB
Go
Raw Blame History

/*
Copyright 2019 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 topologymanager
import (
"fmt"
"reflect"
"strings"
"testing"
"k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/kubernetes/pkg/kubelet/cm/topologymanager/socketmask"
"k8s.io/kubernetes/pkg/kubelet/lifecycle"
)
func NewTestSocketMask(sockets ...int) socketmask.SocketMask {
s, _ := socketmask.NewSocketMask(sockets...)
return s
}
func NewTestSocketMaskFull() socketmask.SocketMask {
s, _ := socketmask.NewSocketMask()
s.Fill()
return s
}
func TestNewManager(t *testing.T) {
tcases := []struct {
description string
policyName string
expectedPolicy string
expectedError error
}{
{
description: "Policy is set preferred",
policyName: "preferred",
expectedPolicy: "preferred",
},
{
description: "Policy is set to strict",
policyName: "strict",
expectedPolicy: "strict",
},
{
description: "Policy is set to unknown",
policyName: "unknown",
expectedError: fmt.Errorf("unknown policy: \"unknown\""),
},
}
for _, tc := range tcases {
mngr, err := NewManager(tc.policyName)
if tc.expectedError != nil {
if !strings.Contains(err.Error(), tc.expectedError.Error()) {
t.Errorf("Unexpected error message. Have: %s wants %s", err.Error(), tc.expectedError.Error())
}
} else {
rawMgr := mngr.(*manager)
if rawMgr.policy.Name() != tc.expectedPolicy {
t.Errorf("Unexpected policy name. Have: %q wants %q", rawMgr.policy.Name(), tc.expectedPolicy)
}
}
}
}
type mockHintProvider struct {
th []TopologyHint
}
func (m *mockHintProvider) GetTopologyHints(pod v1.Pod, container v1.Container) []TopologyHint {
return m.th
}
func TestGetAffinity(t *testing.T) {
tcases := []struct {
name string
containerName string
podUID string
expected TopologyHint
}{
{
name: "case1",
containerName: "nginx",
podUID: "0aafa4c4-38e8-11e9-bcb1-a4bf01040474",
expected: TopologyHint{},
},
}
for _, tc := range tcases {
mngr := manager{}
actual := mngr.GetAffinity(tc.podUID, tc.containerName)
if !reflect.DeepEqual(actual, tc.expected) {
t.Errorf("Expected Affinity in result to be %v, got %v", tc.expected, actual)
}
}
}
func TestCalculateAffinity(t *testing.T) {
tcases := []struct {
name string
hp []HintProvider
expected TopologyHint
}{
{
name: "TopologyHint not set",
hp: []HintProvider{},
expected: TopologyHint{
SocketAffinity: NewTestSocketMaskFull(),
Preferred: true,
},
},
{
name: "HintProvider returns empty non-nil []TopologyHint",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMaskFull(),
Preferred: true,
},
},
{
name: "Single TopologyHint with Preferred as true and SocketAffinity as nil",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: nil,
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMaskFull(),
Preferred: true,
},
},
{
name: "Single TopologyHint with Preferred as false and SocketAffinity as nil",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: nil,
Preferred: false,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMaskFull(),
Preferred: true,
},
},
{
name: "Two providers, 1 hint each, same mask, both preferred 1/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
{
name: "Two providers, 1 hint each, same mask, both preferred 2/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
{
name: "Two providers, 1 hint each, 1 wider mask, both preferred 1/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
{
name: "Two providers, 1 hint each, 1 wider mask, both preferred 1/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
{
name: "Two providers, 1 hint each, no common mask",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMaskFull(),
Preferred: false,
},
},
{
name: "Two providers, 1 hint each, same mask, 1 preferred, 1 not 1/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: false,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: false,
},
},
{
name: "Two providers, 1 hint each, same mask, 1 preferred, 1 not 2/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: false,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(1),
Preferred: false,
},
},
{
name: "Two providers, 1 no hints, 1 single hint preferred 1/2",
hp: []HintProvider{
&mockHintProvider{},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
{
name: "Two providers, 1 no hints, 1 single hint preferred 2/2",
hp: []HintProvider{
&mockHintProvider{},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
{
name: "Two providers, 1 with 2 hints, 1 with single hint matching 1/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
{
name: "Two providers, 1 with 2 hints, 1 with single hint matching 2/2",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
{
name: "Two providers, 1 with 2 hints, 1 with single non-preferred hint matching",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: false,
},
},
{
name: "Two providers, both with 2 hints, matching narrower preferred hint from both",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
},
{
name: "Ensure less narrow preferred hints are chosen over narrower non-preferred hints",
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: TopologyHint{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
},
}
for _, tc := range tcases {
mngr := manager{}
mngr.hintProviders = tc.hp
actual := mngr.calculateAffinity(v1.Pod{}, v1.Container{})
if !actual.SocketAffinity.IsEqual(tc.expected.SocketAffinity) {
t.Errorf("Expected SocketAffinity in result to be %v, got %v", tc.expected.SocketAffinity, actual.SocketAffinity)
}
if actual.Preferred != tc.expected.Preferred {
t.Errorf("Expected Affinity preference in result to be %v, got %v", tc.expected.Preferred, actual.Preferred)
}
}
}
func TestAddContainer(t *testing.T) {
testCases := []struct {
name string
containerID string
podUID types.UID
}{
{
name: "Case1",
containerID: "nginx",
podUID: "0aafa4c4-38e8-11e9-bcb1-a4bf01040474",
},
{
name: "Case2",
containerID: "Busy_Box",
podUID: "b3ee37fc-39a5-11e9-bcb1-a4bf01040474",
},
}
mngr := manager{}
mngr.podMap = make(map[string]string)
for _, tc := range testCases {
pod := v1.Pod{}
pod.UID = tc.podUID
err := mngr.AddContainer(&pod, tc.containerID)
if err != nil {
t.Errorf("Expected error to be nil but got: %v", err)
}
if val, ok := mngr.podMap[tc.containerID]; ok {
if reflect.DeepEqual(val, pod.UID) {
t.Errorf("Error occurred")
}
} else {
t.Errorf("Error occurred, Pod not added to podMap")
}
}
}
func TestRemoveContainer(t *testing.T) {
testCases := []struct {
name string
containerID string
podUID types.UID
}{
{
name: "Case1",
containerID: "nginx",
podUID: "0aafa4c4-38e8-11e9-bcb1-a4bf01040474",
},
{
name: "Case2",
containerID: "Busy_Box",
podUID: "b3ee37fc-39a5-11e9-bcb1-a4bf01040474",
},
}
var len1, len2 int
mngr := manager{}
mngr.podMap = make(map[string]string)
for _, tc := range testCases {
mngr.podMap[tc.containerID] = string(tc.podUID)
len1 = len(mngr.podMap)
err := mngr.RemoveContainer(tc.containerID)
len2 = len(mngr.podMap)
if err != nil {
t.Errorf("Expected error to be nil but got: %v", err)
}
if len1-len2 != 1 {
t.Errorf("Remove Pod resulted in error")
}
}
}
func TestAddHintProvider(t *testing.T) {
var len1 int
tcases := []struct {
name string
hp []HintProvider
}{
{
name: "Add HintProvider",
hp: []HintProvider{
&mockHintProvider{},
},
},
}
mngr := manager{}
for _, tc := range tcases {
mngr.hintProviders = []HintProvider{}
len1 = len(mngr.hintProviders)
mngr.AddHintProvider(tc.hp[0])
}
len2 := len(mngr.hintProviders)
if len2-len1 != 1 {
t.Errorf("error")
}
}
func TestAdmit(t *testing.T) {
tcases := []struct {
name string
result lifecycle.PodAdmitResult
qosClass v1.PodQOSClass
policy Policy
hp []HintProvider
expected bool
}{
{
name: "QOSClass set as BestEffort. None Policy. No Hints.",
qosClass: v1.PodQOSBestEffort,
policy: NewNonePolicy(),
hp: []HintProvider{},
expected: true,
},
{
name: "QOSClass set as Guaranteed. None Policy. No Hints.",
qosClass: v1.PodQOSGuaranteed,
policy: NewNonePolicy(),
hp: []HintProvider{},
expected: true,
},
{
name: "QOSClass set as Guaranteed. Preferred Policy. Preferred Affinity.",
qosClass: v1.PodQOSGuaranteed,
policy: NewPreferredPolicy(),
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: true,
},
{
name: "QOSClass set as Guaranteed. Preferred Policy. More than one Preferred Affinity.",
qosClass: v1.PodQOSGuaranteed,
policy: NewPreferredPolicy(),
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: true,
},
{
name: "QOSClass set as Guaranteed. Preferred Policy. No Preferred Affinity.",
qosClass: v1.PodQOSGuaranteed,
policy: NewPreferredPolicy(),
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: true,
},
{
name: "QOSClass set as Guaranteed. Strict Policy. Preferred Affinity.",
qosClass: v1.PodQOSGuaranteed,
policy: NewStrictPolicy(),
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: true,
},
{
name: "QOSClass set as Guaranteed. Strict Policy. More than one Preferred affinity.",
qosClass: v1.PodQOSGuaranteed,
policy: NewStrictPolicy(),
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(1),
Preferred: true,
},
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: true,
},
{
name: "QOSClass set as Guaranteed. Strict Policy. No Preferred affinity.",
qosClass: v1.PodQOSGuaranteed,
policy: NewStrictPolicy(),
hp: []HintProvider{
&mockHintProvider{
[]TopologyHint{
{
SocketAffinity: NewTestSocketMask(0, 1),
Preferred: false,
},
},
},
},
expected: false,
},
}
for _, tc := range tcases {
man := manager{}
man.policy = tc.policy
man.podTopologyHints = make(map[string]map[string]TopologyHint)
man.hintProviders = tc.hp
pod := &v1.Pod{
Spec: v1.PodSpec{
Containers: []v1.Container{
{
Resources: v1.ResourceRequirements{},
},
},
},
}
podAttr := lifecycle.PodAdmitAttributes{}
pod.Status.QOSClass = tc.qosClass
podAttr.Pod = pod
actual := man.Admit(&podAttr)
if actual.Admit != tc.expected {
t.Errorf("Error occurred, expected Admit in result to be %v got %v", tc.expected, actual.Admit)
}
}
}
Reference in New Issue View Git Blame Copy Permalink