-
Notifications
You must be signed in to change notification settings - Fork 38.6k
/
topology.go
360 lines (304 loc) · 11.6 KB
/
topology.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
/*
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.
*/
// This suite tests volume topology
package testsuites
import (
"context"
"fmt"
"math/rand"
"github.com/onsi/ginkgo"
v1 "k8s.io/api/core/v1"
storagev1 "k8s.io/api/storage/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
clientset "k8s.io/client-go/kubernetes"
"k8s.io/kubernetes/test/e2e/framework"
e2enode "k8s.io/kubernetes/test/e2e/framework/node"
e2epod "k8s.io/kubernetes/test/e2e/framework/pod"
e2epv "k8s.io/kubernetes/test/e2e/framework/pv"
e2eskipper "k8s.io/kubernetes/test/e2e/framework/skipper"
storageframework "k8s.io/kubernetes/test/e2e/storage/framework"
storageutils "k8s.io/kubernetes/test/e2e/storage/utils"
admissionapi "k8s.io/pod-security-admission/api"
)
type topologyTestSuite struct {
tsInfo storageframework.TestSuiteInfo
}
type topologyTest struct {
config *storageframework.PerTestConfig
driverCleanup func()
migrationCheck *migrationOpCheck
resource storageframework.VolumeResource
pod *v1.Pod
allTopologies []topology
}
type topology map[string]string
// InitCustomTopologyTestSuite returns topologyTestSuite that implements TestSuite interface
// using custom test patterns
func InitCustomTopologyTestSuite(patterns []storageframework.TestPattern) storageframework.TestSuite {
return &topologyTestSuite{
tsInfo: storageframework.TestSuiteInfo{
Name: "topology",
TestPatterns: patterns,
},
}
}
// InitTopologyTestSuite returns topologyTestSuite that implements TestSuite interface
// using testsuite default patterns
func InitTopologyTestSuite() storageframework.TestSuite {
patterns := []storageframework.TestPattern{
storageframework.TopologyImmediate,
storageframework.TopologyDelayed,
}
return InitCustomTopologyTestSuite(patterns)
}
func (t *topologyTestSuite) GetTestSuiteInfo() storageframework.TestSuiteInfo {
return t.tsInfo
}
func (t *topologyTestSuite) SkipUnsupportedTests(driver storageframework.TestDriver, pattern storageframework.TestPattern) {
dInfo := driver.GetDriverInfo()
var ok bool
_, ok = driver.(storageframework.DynamicPVTestDriver)
if !ok {
e2eskipper.Skipf("Driver %s doesn't support %v -- skipping", dInfo.Name, pattern.VolType)
}
if !dInfo.Capabilities[storageframework.CapTopology] {
e2eskipper.Skipf("Driver %q does not support topology - skipping", dInfo.Name)
}
}
func (t *topologyTestSuite) DefineTests(driver storageframework.TestDriver, pattern storageframework.TestPattern) {
var (
dInfo = driver.GetDriverInfo()
dDriver storageframework.DynamicPVTestDriver
cs clientset.Interface
err error
)
// Beware that it also registers an AfterEach which renders f unusable. Any code using
// f must run inside an It or Context callback.
f := framework.NewFrameworkWithCustomTimeouts("topology", storageframework.GetDriverTimeouts(driver))
f.NamespacePodSecurityEnforceLevel = admissionapi.LevelPrivileged
init := func() topologyTest {
dDriver, _ = driver.(storageframework.DynamicPVTestDriver)
l := topologyTest{}
// Now do the more expensive test initialization.
l.config, l.driverCleanup = driver.PrepareTest(f)
l.resource = storageframework.VolumeResource{
Config: l.config,
Pattern: pattern,
}
// After driver is installed, check driver topologies on nodes
cs = f.ClientSet
keys := dInfo.TopologyKeys
if len(keys) == 0 {
e2eskipper.Skipf("Driver didn't provide topology keys -- skipping")
}
if dInfo.NumAllowedTopologies == 0 {
// Any plugin that supports topology defaults to 1 topology
dInfo.NumAllowedTopologies = 1
}
// We collect 1 additional topology, if possible, for the conflicting topology test
// case, but it's not needed for the positive test
l.allTopologies, err = t.getCurrentTopologies(cs, keys, dInfo.NumAllowedTopologies+1)
framework.ExpectNoError(err, "failed to get current driver topologies")
if len(l.allTopologies) < dInfo.NumAllowedTopologies {
e2eskipper.Skipf("Not enough topologies in cluster -- skipping")
}
l.resource.Sc = dDriver.GetDynamicProvisionStorageClass(l.config, pattern.FsType)
framework.ExpectNotEqual(l.resource.Sc, nil, "driver failed to provide a StorageClass")
l.resource.Sc.VolumeBindingMode = &pattern.BindingMode
testVolumeSizeRange := t.GetTestSuiteInfo().SupportedSizeRange
driverVolumeSizeRange := dDriver.GetDriverInfo().SupportedSizeRange
claimSize, err := storageutils.GetSizeRangesIntersection(testVolumeSizeRange, driverVolumeSizeRange)
framework.ExpectNoError(err, "determine intersection of test size range %+v and driver size range %+v", testVolumeSizeRange, driverVolumeSizeRange)
l.resource.Pvc = e2epv.MakePersistentVolumeClaim(e2epv.PersistentVolumeClaimConfig{
ClaimSize: claimSize,
StorageClassName: &(l.resource.Sc.Name),
}, l.config.Framework.Namespace.Name)
l.migrationCheck = newMigrationOpCheck(f.ClientSet, f.ClientConfig(), dInfo.InTreePluginName)
return l
}
cleanup := func(l topologyTest) {
t.CleanupResources(cs, &l)
err := storageutils.TryFunc(l.driverCleanup)
l.driverCleanup = nil
framework.ExpectNoError(err, "while cleaning up driver")
l.migrationCheck.validateMigrationVolumeOpCounts()
}
ginkgo.It("should provision a volume and schedule a pod with AllowedTopologies", func() {
l := init()
defer func() {
cleanup(l)
}()
// If possible, exclude one topology, otherwise allow them all
excludedIndex := -1
if len(l.allTopologies) > dInfo.NumAllowedTopologies {
excludedIndex = rand.Intn(len(l.allTopologies))
}
allowedTopologies := t.setAllowedTopologies(l.resource.Sc, l.allTopologies, excludedIndex)
t.createResources(cs, &l, nil)
err = e2epod.WaitTimeoutForPodRunningInNamespace(cs, l.pod.Name, l.pod.Namespace, f.Timeouts.PodStart)
framework.ExpectNoError(err)
ginkgo.By("Verifying pod scheduled to correct node")
pod, err := cs.CoreV1().Pods(l.pod.Namespace).Get(context.TODO(), l.pod.Name, metav1.GetOptions{})
framework.ExpectNoError(err)
node, err := cs.CoreV1().Nodes().Get(context.TODO(), pod.Spec.NodeName, metav1.GetOptions{})
framework.ExpectNoError(err)
t.verifyNodeTopology(node, allowedTopologies)
})
ginkgo.It("should fail to schedule a pod which has topologies that conflict with AllowedTopologies", func() {
l := init()
defer func() {
cleanup(l)
}()
if len(l.allTopologies) < dInfo.NumAllowedTopologies+1 {
e2eskipper.Skipf("Not enough topologies in cluster -- skipping")
}
// Exclude one topology
excludedIndex := rand.Intn(len(l.allTopologies))
t.setAllowedTopologies(l.resource.Sc, l.allTopologies, excludedIndex)
// Set pod nodeSelector to the excluded topology
exprs := []v1.NodeSelectorRequirement{}
for k, v := range l.allTopologies[excludedIndex] {
exprs = append(exprs, v1.NodeSelectorRequirement{
Key: k,
Operator: v1.NodeSelectorOpIn,
Values: []string{v},
})
}
affinity := &v1.Affinity{
NodeAffinity: &v1.NodeAffinity{
RequiredDuringSchedulingIgnoredDuringExecution: &v1.NodeSelector{
NodeSelectorTerms: []v1.NodeSelectorTerm{
{
MatchExpressions: exprs,
},
},
},
},
}
t.createResources(cs, &l, affinity)
// Wait for pod to fail scheduling
// With delayed binding, the scheduler errors before provisioning
// With immediate binding, the volume gets provisioned but cannot be scheduled
err = e2epod.WaitForPodNameUnschedulableInNamespace(cs, l.pod.Name, l.pod.Namespace)
framework.ExpectNoError(err)
})
}
// getCurrentTopologies() goes through all Nodes and returns up to maxCount unique driver topologies
func (t *topologyTestSuite) getCurrentTopologies(cs clientset.Interface, keys []string, maxCount int) ([]topology, error) {
nodes, err := e2enode.GetReadySchedulableNodes(cs)
if err != nil {
return nil, err
}
topos := []topology{}
// TODO: scale?
for _, n := range nodes.Items {
topo := map[string]string{}
for _, k := range keys {
v, ok := n.Labels[k]
if !ok {
return nil, fmt.Errorf("node %v missing topology label %v", n.Name, k)
}
topo[k] = v
}
found := false
for _, existingTopo := range topos {
if topologyEqual(existingTopo, topo) {
found = true
break
}
}
if !found {
framework.Logf("found topology %v", topo)
topos = append(topos, topo)
}
if len(topos) >= maxCount {
break
}
}
return topos, nil
}
// reflect.DeepEqual doesn't seem to work
func topologyEqual(t1, t2 topology) bool {
if len(t1) != len(t2) {
return false
}
for k1, v1 := range t1 {
if v2, ok := t2[k1]; !ok || v1 != v2 {
return false
}
}
return true
}
// Set StorageClass.Allowed topologies from topos while excluding the topology at excludedIndex.
// excludedIndex can be -1 to specify nothing should be excluded.
// Return the list of allowed topologies generated.
func (t *topologyTestSuite) setAllowedTopologies(sc *storagev1.StorageClass, topos []topology, excludedIndex int) []topology {
allowedTopologies := []topology{}
sc.AllowedTopologies = []v1.TopologySelectorTerm{}
for i := 0; i < len(topos); i++ {
if i != excludedIndex {
exprs := []v1.TopologySelectorLabelRequirement{}
for k, v := range topos[i] {
exprs = append(exprs, v1.TopologySelectorLabelRequirement{
Key: k,
Values: []string{v},
})
}
sc.AllowedTopologies = append(sc.AllowedTopologies, v1.TopologySelectorTerm{MatchLabelExpressions: exprs})
allowedTopologies = append(allowedTopologies, topos[i])
}
}
return allowedTopologies
}
func (t *topologyTestSuite) verifyNodeTopology(node *v1.Node, allowedTopos []topology) {
for _, topo := range allowedTopos {
for k, v := range topo {
nodeV, _ := node.Labels[k]
if nodeV == v {
return
}
}
}
framework.Failf("node %v topology labels %+v doesn't match allowed topologies +%v", node.Name, node.Labels, allowedTopos)
}
func (t *topologyTestSuite) createResources(cs clientset.Interface, l *topologyTest, affinity *v1.Affinity) {
var err error
framework.Logf("Creating storage class object and pvc object for driver - sc: %v, pvc: %v", l.resource.Sc, l.resource.Pvc)
ginkgo.By("Creating sc")
l.resource.Sc, err = cs.StorageV1().StorageClasses().Create(context.TODO(), l.resource.Sc, metav1.CreateOptions{})
framework.ExpectNoError(err)
ginkgo.By("Creating pvc")
l.resource.Pvc, err = cs.CoreV1().PersistentVolumeClaims(l.resource.Pvc.Namespace).Create(context.TODO(), l.resource.Pvc, metav1.CreateOptions{})
framework.ExpectNoError(err)
ginkgo.By("Creating pod")
podConfig := e2epod.Config{
NS: l.config.Framework.Namespace.Name,
PVCs: []*v1.PersistentVolumeClaim{l.resource.Pvc},
NodeSelection: e2epod.NodeSelection{Affinity: affinity},
SeLinuxLabel: e2epod.GetLinuxLabel(),
ImageID: e2epod.GetDefaultTestImageID(),
}
l.pod, err = e2epod.MakeSecPod(&podConfig)
framework.ExpectNoError(err)
l.pod, err = cs.CoreV1().Pods(l.pod.Namespace).Create(context.TODO(), l.pod, metav1.CreateOptions{})
framework.ExpectNoError(err)
}
func (t *topologyTestSuite) CleanupResources(cs clientset.Interface, l *topologyTest) {
if l.pod != nil {
ginkgo.By("Deleting pod")
err := e2epod.DeletePodWithWait(cs, l.pod)
framework.ExpectNoError(err, "while deleting pod")
}
err := l.resource.CleanupResource()
framework.ExpectNoError(err, "while clean up resource")
}