-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
resource_test.go
148 lines (120 loc) · 6.04 KB
/
resource_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
/*
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 resource_test
import (
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
. "sigs.k8s.io/kubebuilder/pkg/scaffold/resource"
)
var _ = Describe("Resource", func() {
Describe("scaffolding an API", func() {
It("should succeed if the Resource is valid", func() {
instance := &Resource{Group: "crew", Version: "v1", Kind: "FirstMate"}
Expect(instance.Validate()).To(Succeed())
})
It("should fail if the Group is not specified", func() {
instance := &Resource{Version: "v1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring("group cannot be empty"))
})
It("should fail if the Group is not all lowercase", func() {
instance := &Resource{Group: "Crew", Version: "v1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring("group name is invalid: ([a DNS-1123 subdomain must consist of lower case alphanumeric characters"))
})
It("should fail if the Group contains non-alpha characters", func() {
instance := &Resource{Group: "crew1*?", Version: "v1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring("group name is invalid: ([a DNS-1123 subdomain must consist of lower case alphanumeric characters"))
})
It("should fail if the Version is not specified", func() {
instance := &Resource{Group: "crew", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring("version cannot be empty"))
})
It("should fail if the Version does not match the version format", func() {
instance := &Resource{Group: "crew", Version: "1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`version must match ^v\d+(alpha\d+|beta\d+)?$ (was 1)`))
instance = &Resource{Group: "crew", Version: "1beta1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`version must match ^v\d+(alpha\d+|beta\d+)?$ (was 1beta1)`))
instance = &Resource{Group: "crew", Version: "a1beta1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`version must match ^v\d+(alpha\d+|beta\d+)?$ (was a1beta1)`))
instance = &Resource{Group: "crew", Version: "v1beta", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`version must match ^v\d+(alpha\d+|beta\d+)?$ (was v1beta)`))
instance = &Resource{Group: "crew", Version: "v1beta1alpha1", Kind: "FirstMate"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`version must match ^v\d+(alpha\d+|beta\d+)?$ (was v1beta1alpha1)`))
})
It("should fail if the Kind is not specified", func() {
instance := &Resource{Group: "crew", Version: "v1"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring("kind cannot be empty"))
})
It("should fail if the Kind is not pascal cased", func() {
// Base case
instance := &Resource{Group: "crew", Kind: "FirstMate", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
// Can't detect this case :(
instance = &Resource{Group: "crew", Kind: "Firstmate", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
instance = &Resource{Group: "crew", Kind: "firstMate", Version: "v1"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`kind must be PascalCase (expected FirstMate was firstMate)`))
instance = &Resource{Group: "crew", Kind: "firstmate", Version: "v1"}
Expect(instance.Validate()).NotTo(Succeed())
Expect(instance.Validate().Error()).To(ContainSubstring(
`kind must be PascalCase (expected Firstmate was firstmate)`))
})
It("should default the Resource by pluralizing the Kind", func() {
instance := &Resource{Group: "crew", Kind: "FirstMate", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.Resource).To(Equal("firstmates"))
instance = &Resource{Group: "crew", Kind: "Fish", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.Resource).To(Equal("fish"))
instance = &Resource{Group: "crew", Kind: "Helmswoman", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.Resource).To(Equal("helmswomen"))
})
It("should allow Cat as a Kind", func() {
instance := &Resource{Group: "crew", Kind: "Cat", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.Resource).To(Equal("cats"))
})
It("should allow hyphens in group names", func() {
instance := &Resource{Group: "my-project", Kind: "Cat", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.GroupImportSafe).To(Equal("myproject"))
})
It("should allow dots in group names", func() {
instance := &Resource{Group: "example.com", Kind: "Cat", Version: "v1"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.GroupImportSafe).To(Equal("examplecom"))
})
It("should keep the Resource if specified", func() {
instance := &Resource{Group: "crew", Kind: "FirstMate", Version: "v1", Resource: "myresource"}
Expect(instance.Validate()).To(Succeed())
Expect(instance.Resource).To(Equal("myresource"))
})
})
})