-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
config_test.go
638 lines (570 loc) · 17.4 KB
/
config_test.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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
/*
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 v3
import (
"errors"
"sort"
"testing"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"sigs.k8s.io/kubebuilder/v3/pkg/config"
"sigs.k8s.io/kubebuilder/v3/pkg/model/resource"
)
func TestConfigV3(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Config V3 Suite")
}
var _ = Describe("cfg", func() {
const (
domain = "my.domain"
repo = "myrepo"
name = "ProjectName"
otherDomain = "other.domain"
otherRepo = "otherrepo"
otherName = "OtherProjectName"
)
var (
c cfg
pluginChain = []string{"go.kubebuilder.io/v2"}
otherPluginChain = []string{"go.kubebuilder.io/v3"}
)
BeforeEach(func() {
c = cfg{
Version: Version,
Domain: domain,
Repository: repo,
Name: name,
PluginChain: pluginChain,
}
})
Context("Version", func() {
It("GetVersion should return version 3", func() {
Expect(c.GetVersion().Compare(Version)).To(Equal(0))
})
})
Context("Domain", func() {
It("GetDomain should return the domain", func() {
Expect(c.GetDomain()).To(Equal(domain))
})
It("SetDomain should set the domain", func() {
Expect(c.SetDomain(otherDomain)).To(Succeed())
Expect(c.Domain).To(Equal(otherDomain))
})
})
Context("Repository", func() {
It("GetRepository should return the repository", func() {
Expect(c.GetRepository()).To(Equal(repo))
})
It("SetRepository should set the repository", func() {
Expect(c.SetRepository(otherRepo)).To(Succeed())
Expect(c.Repository).To(Equal(otherRepo))
})
})
Context("Project name", func() {
It("GetProjectName should return the name", func() {
Expect(c.GetProjectName()).To(Equal(name))
})
It("SetProjectName should set the name", func() {
Expect(c.SetProjectName(otherName)).To(Succeed())
Expect(c.Name).To(Equal(otherName))
})
})
Context("Plugin chain", func() {
It("GetPluginChain should return the plugin chain", func() {
Expect(c.GetPluginChain()).To(Equal(pluginChain))
})
It("SetPluginChain should set the plugin chain", func() {
Expect(c.SetPluginChain(otherPluginChain)).To(Succeed())
Expect([]string(c.PluginChain)).To(Equal(otherPluginChain))
})
})
Context("Multi group", func() {
It("IsMultiGroup should return false if not set", func() {
Expect(c.IsMultiGroup()).To(BeFalse())
})
It("IsMultiGroup should return true if set", func() {
c.MultiGroup = true
Expect(c.IsMultiGroup()).To(BeTrue())
})
It("SetMultiGroup should enable multi-group support", func() {
Expect(c.SetMultiGroup()).To(Succeed())
Expect(c.MultiGroup).To(BeTrue())
})
It("ClearMultiGroup should disable multi-group support", func() {
c.MultiGroup = true
Expect(c.ClearMultiGroup()).To(Succeed())
Expect(c.MultiGroup).To(BeFalse())
})
})
Context("Component config", func() {
It("IsComponentConfig should return false if not set", func() {
Expect(c.IsComponentConfig()).To(BeFalse())
})
It("IsComponentConfig should return true if set", func() {
c.ComponentConfig = true
Expect(c.IsComponentConfig()).To(BeTrue())
})
It("SetComponentConfig should fail to enable component config support", func() {
Expect(c.SetComponentConfig()).To(Succeed())
Expect(c.ComponentConfig).To(BeTrue())
})
It("ClearComponentConfig should fail to disable component config support", func() {
c.ComponentConfig = false
Expect(c.ClearComponentConfig()).To(Succeed())
Expect(c.ComponentConfig).To(BeFalse())
})
})
Context("Resources", func() {
var (
res = resource.Resource{
GVK: resource.GVK{
Group: "group",
Version: "v1",
Kind: "Kind",
},
Plural: "kinds",
Path: "api/v1",
API: &resource.API{
CRDVersion: "v1",
Namespaced: true,
},
Controller: true,
Webhooks: &resource.Webhooks{
WebhookVersion: "v1",
Defaulting: true,
Validation: true,
Conversion: true,
},
}
resWithoutPlural = res.Copy()
)
// As some of the tests insert directly into the slice without using the interface methods,
// regular plural forms should not be present in here. rsWithoutPlural is used for this purpose.
resWithoutPlural.Plural = ""
// Auxiliary function for GetResource, AddResource and UpdateResource tests
checkResource := func(result, expected resource.Resource) {
Expect(result.GVK.IsEqualTo(expected.GVK)).To(BeTrue())
Expect(result.Plural).To(Equal(expected.Plural))
Expect(result.Path).To(Equal(expected.Path))
if expected.API == nil {
Expect(result.API).To(BeNil())
} else {
Expect(result.API).NotTo(BeNil())
Expect(result.API.CRDVersion).To(Equal(expected.API.CRDVersion))
Expect(result.API.Namespaced).To(Equal(expected.API.Namespaced))
}
Expect(result.Controller).To(Equal(expected.Controller))
if expected.Webhooks == nil {
Expect(result.Webhooks).To(BeNil())
} else {
Expect(result.Webhooks).NotTo(BeNil())
Expect(result.Webhooks.WebhookVersion).To(Equal(expected.Webhooks.WebhookVersion))
Expect(result.Webhooks.Defaulting).To(Equal(expected.Webhooks.Defaulting))
Expect(result.Webhooks.Validation).To(Equal(expected.Webhooks.Validation))
Expect(result.Webhooks.Conversion).To(Equal(expected.Webhooks.Conversion))
}
}
DescribeTable("ResourcesLength should return the number of resources",
func(n int) {
for i := 0; i < n; i++ {
c.Resources = append(c.Resources, resWithoutPlural)
}
Expect(c.ResourcesLength()).To(Equal(n))
},
Entry("for no resources", 0),
Entry("for one resource", 1),
Entry("for several resources", 3),
)
It("HasResource should return false for a non-existent resource", func() {
Expect(c.HasResource(res.GVK)).To(BeFalse())
})
It("HasResource should return true for an existent resource", func() {
c.Resources = append(c.Resources, resWithoutPlural)
Expect(c.HasResource(res.GVK)).To(BeTrue())
})
It("GetResource should fail for a non-existent resource", func() {
_, err := c.GetResource(res.GVK)
Expect(err).To(HaveOccurred())
})
It("GetResource should return an existent resource", func() {
c.Resources = append(c.Resources, resWithoutPlural)
r, err := c.GetResource(res.GVK)
Expect(err).NotTo(HaveOccurred())
checkResource(r, res)
})
It("GetResources should return a slice of the tracked resources", func() {
c.Resources = append(c.Resources, resWithoutPlural, resWithoutPlural, resWithoutPlural)
resources, err := c.GetResources()
Expect(err).NotTo(HaveOccurred())
Expect(resources).To(Equal([]resource.Resource{res, res, res}))
})
It("AddResource should add the provided resource if non-existent", func() {
l := len(c.Resources)
Expect(c.AddResource(res)).To(Succeed())
Expect(len(c.Resources)).To(Equal(l + 1))
checkResource(c.Resources[0], resWithoutPlural)
})
It("AddResource should do nothing if the resource already exists", func() {
c.Resources = append(c.Resources, res)
l := len(c.Resources)
Expect(c.AddResource(res)).To(Succeed())
Expect(len(c.Resources)).To(Equal(l))
})
It("UpdateResource should add the provided resource if non-existent", func() {
l := len(c.Resources)
Expect(c.UpdateResource(res)).To(Succeed())
Expect(len(c.Resources)).To(Equal(l + 1))
checkResource(c.Resources[0], resWithoutPlural)
})
It("UpdateResource should update it if the resource already exists", func() {
r := resource.Resource{
GVK: resource.GVK{
Group: "group",
Version: "v1",
Kind: "Kind",
},
Path: "api/v1",
}
c.Resources = append(c.Resources, r)
l := len(c.Resources)
checkResource(c.Resources[0], r)
Expect(c.UpdateResource(res)).To(Succeed())
Expect(len(c.Resources)).To(Equal(l))
checkResource(c.Resources[0], resWithoutPlural)
})
It("HasGroup should return false with no tracked resources", func() {
Expect(c.HasGroup(res.Group)).To(BeFalse())
})
It("HasGroup should return true with tracked resources in the same group", func() {
c.Resources = append(c.Resources, res)
Expect(c.HasGroup(res.Group)).To(BeTrue())
})
It("HasGroup should return false with tracked resources in other group", func() {
c.Resources = append(c.Resources, res)
Expect(c.HasGroup("other-group")).To(BeFalse())
})
It("ListCRDVersions should return an empty list with no tracked resources", func() {
Expect(c.ListCRDVersions()).To(BeEmpty())
})
It("ListCRDVersions should return a list of tracked resources CRD versions", func() {
c.Resources = append(c.Resources,
resource.Resource{
GVK: resource.GVK{
Group: res.Group,
Version: res.Version,
Kind: res.Kind,
},
API: &resource.API{CRDVersion: "v1beta1"},
},
resource.Resource{
GVK: resource.GVK{
Group: res.Group,
Version: res.Version,
Kind: "OtherKind",
},
API: &resource.API{CRDVersion: "v1"},
},
)
versions := c.ListCRDVersions()
sort.Strings(versions) // ListCRDVersions has no order guarantee so sorting for reproducibility
Expect(versions).To(Equal([]string{"v1", "v1beta1"}))
})
It("ListWebhookVersions should return an empty list with no tracked resources", func() {
Expect(c.ListWebhookVersions()).To(BeEmpty())
})
It("ListWebhookVersions should return a list of tracked resources webhook versions", func() {
c.Resources = append(c.Resources,
resource.Resource{
GVK: resource.GVK{
Group: res.Group,
Version: res.Version,
Kind: res.Kind,
},
Webhooks: &resource.Webhooks{WebhookVersion: "v1beta1"},
},
resource.Resource{
GVK: resource.GVK{
Group: res.Group,
Version: res.Version,
Kind: "OtherKind",
},
Webhooks: &resource.Webhooks{WebhookVersion: "v1"},
},
)
versions := c.ListWebhookVersions()
sort.Strings(versions) // ListWebhookVersions has no order guarantee so sorting for reproducibility
Expect(versions).To(Equal([]string{"v1", "v1beta1"}))
})
})
Context("Plugins", func() {
// Test plugin config. Don't want to export this config, but need it to
// be accessible by test.
type PluginConfig struct {
Data1 string `json:"data-1"`
Data2 string `json:"data-2,omitempty"`
}
const (
key = "plugin-x"
)
var (
c0 = cfg{
Version: Version,
Domain: domain,
Repository: repo,
Name: name,
PluginChain: pluginChain,
}
c1 = cfg{
Version: Version,
Domain: domain,
Repository: repo,
Name: name,
PluginChain: pluginChain,
Plugins: pluginConfigs{
key: map[string]interface{}{
"data-1": "",
},
},
}
c2 = cfg{
Version: Version,
Domain: domain,
Repository: repo,
Name: name,
PluginChain: pluginChain,
Plugins: pluginConfigs{
key: map[string]interface{}{
"data-1": "plugin value 1",
"data-2": "plugin value 2",
},
},
}
pluginConfig = PluginConfig{
Data1: "plugin value 1",
Data2: "plugin value 2",
}
)
It("DecodePluginConfig should fail for no plugin config object", func() {
var pluginConfig PluginConfig
err := c0.DecodePluginConfig(key, &pluginConfig)
Expect(err).To(HaveOccurred())
Expect(errors.As(err, &config.PluginKeyNotFoundError{})).To(BeTrue())
})
It("DecodePluginConfig should fail to retrieve data from a non-existent plugin", func() {
var pluginConfig PluginConfig
err := c1.DecodePluginConfig("plugin-y", &pluginConfig)
Expect(err).To(HaveOccurred())
Expect(errors.As(err, &config.PluginKeyNotFoundError{})).To(BeTrue())
})
DescribeTable("DecodePluginConfig should retrieve the plugin data correctly",
func(inputConfig cfg, expectedPluginConfig PluginConfig) {
var pluginConfig PluginConfig
Expect(inputConfig.DecodePluginConfig(key, &pluginConfig)).To(Succeed())
Expect(pluginConfig).To(Equal(expectedPluginConfig))
},
Entry("for an empty plugin config object", c1, PluginConfig{}),
Entry("for a full plugin config object", c2, pluginConfig),
// TODO (coverage): add cases where yaml.Marshal returns an error
// TODO (coverage): add cases where yaml.Unmarshal returns an error
)
DescribeTable("EncodePluginConfig should encode the plugin data correctly",
func(pluginConfig PluginConfig, expectedConfig cfg) {
Expect(c.EncodePluginConfig(key, pluginConfig)).To(Succeed())
Expect(c).To(Equal(expectedConfig))
},
Entry("for an empty plugin config object", PluginConfig{}, c1),
Entry("for a full plugin config object", pluginConfig, c2),
// TODO (coverage): add cases where yaml.Marshal returns an error
// TODO (coverage): add cases where yaml.Unmarshal returns an error
)
})
Context("Persistence", func() {
var (
// BeforeEach is called after the entries are evaluated, and therefore, c is not available
c1 = cfg{
Version: Version,
Domain: domain,
Repository: repo,
Name: name,
PluginChain: pluginChain,
}
c2 = cfg{
Version: Version,
Domain: otherDomain,
Repository: otherRepo,
Name: otherName,
PluginChain: otherPluginChain,
MultiGroup: true,
ComponentConfig: true,
Resources: []resource.Resource{
{
GVK: resource.GVK{
Group: "group",
Version: "v1",
Kind: "Kind",
},
},
{
GVK: resource.GVK{
Group: "group",
Version: "v1",
Kind: "Kind2",
},
API: &resource.API{CRDVersion: "v1"},
Controller: true,
Webhooks: &resource.Webhooks{WebhookVersion: "v1"},
},
{
GVK: resource.GVK{
Group: "group",
Version: "v1-beta",
Kind: "Kind",
},
Plural: "kindes",
API: &resource.API{},
Webhooks: &resource.Webhooks{},
},
{
GVK: resource.GVK{
Group: "group2",
Version: "v1",
Kind: "Kind",
},
API: &resource.API{
CRDVersion: "v1",
Namespaced: true,
},
Controller: true,
Webhooks: &resource.Webhooks{
WebhookVersion: "v1",
Defaulting: true,
Validation: true,
Conversion: true,
},
},
},
Plugins: pluginConfigs{
"plugin-x": map[string]interface{}{
"data-1": "single plugin datum",
},
"plugin-y/v1": map[string]interface{}{
"data-1": "plugin value 1",
"data-2": "plugin value 2",
"data-3": []string{"plugin value 3", "plugin value 4"},
},
},
}
// TODO: include cases with Path when added
s1 = `domain: my.domain
layout:
- go.kubebuilder.io/v2
projectName: ProjectName
repo: myrepo
version: "3"
`
s1bis = `domain: my.domain
layout: go.kubebuilder.io/v2
projectName: ProjectName
repo: myrepo
version: "3"
`
s2 = `componentConfig: true
domain: other.domain
layout:
- go.kubebuilder.io/v3
multigroup: true
plugins:
plugin-x:
data-1: single plugin datum
plugin-y/v1:
data-1: plugin value 1
data-2: plugin value 2
data-3:
- plugin value 3
- plugin value 4
projectName: OtherProjectName
repo: otherrepo
resources:
- group: group
kind: Kind
version: v1
- api:
crdVersion: v1
controller: true
group: group
kind: Kind2
version: v1
webhooks:
webhookVersion: v1
- group: group
kind: Kind
plural: kindes
version: v1-beta
- api:
crdVersion: v1
namespaced: true
controller: true
group: group2
kind: Kind
version: v1
webhooks:
conversion: true
defaulting: true
validation: true
webhookVersion: v1
version: "3"
`
)
DescribeTable("MarshalYAML should succeed",
func(c cfg, content string) {
b, err := c.MarshalYAML()
Expect(err).NotTo(HaveOccurred())
Expect(string(b)).To(Equal(content))
},
Entry("for a basic configuration", c1, s1),
Entry("for a full configuration", c2, s2),
)
DescribeTable("UnmarshalYAML should succeed",
func(content string, c cfg) {
var unmarshalled cfg
Expect(unmarshalled.UnmarshalYAML([]byte(content))).To(Succeed())
Expect(unmarshalled.Version.Compare(c.Version)).To(Equal(0))
Expect(unmarshalled.Domain).To(Equal(c.Domain))
Expect(unmarshalled.Repository).To(Equal(c.Repository))
Expect(unmarshalled.Name).To(Equal(c.Name))
Expect(unmarshalled.PluginChain).To(Equal(c.PluginChain))
Expect(unmarshalled.MultiGroup).To(Equal(c.MultiGroup))
Expect(unmarshalled.ComponentConfig).To(Equal(c.ComponentConfig))
Expect(unmarshalled.Resources).To(Equal(c.Resources))
Expect(unmarshalled.Plugins).To(HaveLen(len(c.Plugins)))
// TODO: fully test Plugins field and not on its length
},
Entry("basic", s1, c1),
Entry("full", s2, c2),
Entry("string layout", s1bis, c1),
)
DescribeTable("UnmarshalYAML should fail",
func(content string) {
var c cfg
Expect(c.UnmarshalYAML([]byte(content))).NotTo(Succeed())
},
Entry("for unknown fields", `field: 1
version: "3"`),
)
})
})
var _ = Describe("New", func() {
It("should return a new config for project configuration 3", func() {
Expect(New().GetVersion().Compare(Version)).To(Equal(0))
})
})