-
Notifications
You must be signed in to change notification settings - Fork 30
/
Copy pathcomponent_image_controller_test.go
280 lines (225 loc) · 13.1 KB
/
component_image_controller_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
/*
Copyright 2023 Red Hat, Inc.
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 controllers
import (
"encoding/json"
"fmt"
"time"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
imagerepositoryv1alpha1 "github.com/konflux-ci/image-controller/api/v1alpha1"
"github.com/konflux-ci/image-controller/pkg/quay"
)
var _ = Describe("Component image controller", func() {
var imageTestNamespace = "component-image-controller-test"
BeforeEach(func() {
createNamespace(imageTestNamespace)
})
Context("Image repository provision flow", func() {
var resourceImageProvisionKey = types.NamespacedName{Name: defaultComponentName + "-imageprovision", Namespace: imageTestNamespace}
var imageRepositoryName = types.NamespacedName{
Name: fmt.Sprintf("imagerepository-for-%s-%s", defaultComponentApplication, resourceImageProvisionKey.Name),
Namespace: resourceImageProvisionKey.Namespace,
}
var applicationKey = types.NamespacedName{Name: defaultComponentApplication, Namespace: imageTestNamespace}
var componentSaName = getComponentSaName(resourceImageProvisionKey.Name)
var applicationSaName = getApplicationSaName(defaultComponentApplication)
BeforeEach(func() {
quay.ResetTestQuayClient()
createApplication(applicationConfig{ApplicationKey: applicationKey})
})
AfterEach(func() {
deleteApplication(applicationKey)
deleteComponent(resourceImageProvisionKey)
})
It("should prepare environment", func() {
createServiceAccount(imageTestNamespace, buildPipelineServiceAccountName)
createServiceAccount(imageTestNamespace, componentSaName)
// wait for application SA to be created
Eventually(func() bool {
saList := getServiceAccountList(imageTestNamespace)
// there will be 3 service accounts
// appstudio-pipeline SA, component's SA and application's SA
return len(saList) == 3
}, timeout, interval).WithTimeout(ensureTimeout).Should(BeTrue())
})
It("should do image repository provision", func() {
expectedVisibility := imagerepositoryv1alpha1.ImageVisibility("private")
createComponent(componentConfig{
ComponentKey: resourceImageProvisionKey,
Annotations: map[string]string{
GenerateImageAnnotationName: "{\"visibility\": \"private\"}",
},
})
// wait for component_image_controller to finish
waitComponentAnnotationGone(resourceImageProvisionKey, GenerateImageAnnotationName)
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageProvisionKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(1))
component := getComponent(resourceImageProvisionKey)
// wait for imagerepository_controller to finish
waitImageRepositoryFinalizerOnImageRepository(imageRepositoryName)
imageRepository := getImageRepository(imageRepositoryName)
Expect(imageRepository.ObjectMeta.Labels[ApplicationNameLabelName]).To(Equal(component.Spec.Application))
Expect(imageRepository.ObjectMeta.Labels[ComponentNameLabelName]).To(Equal(component.Name))
Expect(imageRepository.Spec.Image.Visibility).To(Equal(expectedVisibility))
Expect(imageRepository.ObjectMeta.OwnerReferences[0].UID).To(Equal(component.UID))
Expect(imageRepository.ObjectMeta.Annotations[updateComponentAnnotationName]).To(BeEmpty())
component = getComponent(resourceImageProvisionKey)
Expect(component.Annotations[ImageAnnotationName]).To(BeEmpty())
Expect(component.Spec.ContainerImage).ToNot(BeEmpty())
deleteImageRepository(imageRepositoryName)
})
It("should accept deprecated true value for repository options", func() {
expectedVisibility := imagerepositoryv1alpha1.ImageVisibility("public")
createComponent(componentConfig{
ComponentKey: resourceImageProvisionKey,
Annotations: map[string]string{
GenerateImageAnnotationName: "true",
},
})
// wait for component_image_controller to finish
waitComponentAnnotationGone(resourceImageProvisionKey, GenerateImageAnnotationName)
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageProvisionKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(1))
component := getComponent(resourceImageProvisionKey)
// wait for imagerepository_controller to finish
waitImageRepositoryFinalizerOnImageRepository(imageRepositoryName)
imageRepository := getImageRepository(imageRepositoryName)
Expect(imageRepository.ObjectMeta.Labels[ApplicationNameLabelName]).To(Equal(component.Spec.Application))
Expect(imageRepository.ObjectMeta.Labels[ComponentNameLabelName]).To(Equal(component.Name))
Expect(imageRepository.Spec.Image.Visibility).To(Equal(expectedVisibility))
Expect(imageRepository.ObjectMeta.OwnerReferences[0].UID).To(Equal(component.UID))
Expect(imageRepository.ObjectMeta.Annotations[updateComponentAnnotationName]).To(BeEmpty())
component = getComponent(resourceImageProvisionKey)
Expect(component.Annotations[ImageAnnotationName]).To(BeEmpty())
Expect(component.Spec.ContainerImage).ToNot(BeEmpty())
deleteImageRepository(imageRepositoryName)
deleteServiceAccount(types.NamespacedName{Name: buildPipelineServiceAccountName, Namespace: imageTestNamespace})
deleteServiceAccount(types.NamespacedName{Name: componentSaName, Namespace: imageTestNamespace})
deleteServiceAccount(types.NamespacedName{Name: applicationSaName, Namespace: imageTestNamespace})
})
})
Context("Image repository provision error cases", func() {
var resourceImageErrorKey = types.NamespacedName{Name: defaultComponentName + "-imageerrors", Namespace: imageTestNamespace}
var applicationKey = types.NamespacedName{Name: defaultComponentApplication, Namespace: imageTestNamespace}
var componentSaName = getComponentSaName(resourceImageErrorKey.Name)
var applicationSaName = getApplicationSaName(defaultComponentApplication)
It("should prepare environment", func() {
deleteComponent(resourceImageErrorKey)
quay.ResetTestQuayClient()
createApplication(applicationConfig{ApplicationKey: applicationKey})
createServiceAccount(imageTestNamespace, buildPipelineServiceAccountName)
createServiceAccount(imageTestNamespace, componentSaName)
// wait for application SA to be created
Eventually(func() bool {
saList := getServiceAccountList(imageTestNamespace)
return len(saList) == 3
}, timeout, interval).WithTimeout(ensureTimeout).Should(BeTrue())
})
It("should do nothing if generate annotation is not set", func() {
createComponent(componentConfig{ComponentKey: resourceImageErrorKey})
time.Sleep(ensureTimeout)
waitComponentAnnotationGone(resourceImageErrorKey, GenerateImageAnnotationName)
waitComponentAnnotationGone(resourceImageErrorKey, ImageAnnotationName)
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageErrorKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(0))
})
It("should do nothing if imageRepository for the component already exists, with expected name", func() {
component := getComponent(resourceImageErrorKey)
imageRepositoryName := fmt.Sprintf("imagerepository-for-%s-%s", component.Spec.Application, component.Name)
imageRepository := types.NamespacedName{Name: imageRepositoryName, Namespace: component.Namespace}
ownerReferences := []metav1.OwnerReference{
{Kind: "Component", Name: component.Name, UID: types.UID(component.UID), APIVersion: "appstudio.redhat.com/v1alpha1"},
}
createImageRepository(imageRepositoryConfig{
ResourceKey: &imageRepository,
OwnerReferences: ownerReferences,
})
// wait for imagerepository_controller to finish
waitImageRepositoryFinalizerOnImageRepository(imageRepository)
// add generate annotation and it will not create new ImageRepository
setComponentAnnotationValue(resourceImageErrorKey, GenerateImageAnnotationName, `{"visibility": "public"}`)
waitComponentAnnotationGone(resourceImageErrorKey, GenerateImageAnnotationName)
component = getComponent(resourceImageErrorKey)
Expect(component.Annotations[ImageAnnotationName]).To(BeEmpty())
// just to double check that new ImageRepository wasn't created, which would add ContainerImage
Expect(component.Spec.ContainerImage).To(BeEmpty())
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageErrorKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(1))
deleteImageRepository(imageRepository)
})
It("should do nothing if imageRepository for the component already exists, with different name", func() {
component := getComponent(resourceImageErrorKey)
imageRepositoryName := fmt.Sprintf("differently-named-%s-%s", component.Spec.Application, component.Name)
imageRepository := types.NamespacedName{Name: imageRepositoryName, Namespace: component.Namespace}
ownerReferences := []metav1.OwnerReference{
{Kind: "Component", Name: component.Name, UID: types.UID(component.UID), APIVersion: "appstudio.redhat.com/v1alpha1"},
}
createImageRepository(imageRepositoryConfig{
ResourceKey: &imageRepository,
OwnerReferences: ownerReferences,
})
// wait for imagerepository_controller to finish
waitImageRepositoryFinalizerOnImageRepository(imageRepository)
// add generate annotation and it will not create new ImageRepository
setComponentAnnotationValue(resourceImageErrorKey, GenerateImageAnnotationName, `{"visibility": "public"}`)
waitComponentAnnotationGone(resourceImageErrorKey, GenerateImageAnnotationName)
component = getComponent(resourceImageErrorKey)
Expect(component.Annotations[ImageAnnotationName]).To(BeEmpty())
// just to double check that new ImageRepository wasn't created, which would add ContainerImage
Expect(component.Spec.ContainerImage).To(BeEmpty())
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageErrorKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(1))
deleteImageRepository(imageRepository)
})
It("should do nothing and set error if generate annotation is invalid JSON", func() {
setComponentAnnotationValue(resourceImageErrorKey, GenerateImageAnnotationName, `{"visibility": "public"`)
waitComponentAnnotationGone(resourceImageErrorKey, GenerateImageAnnotationName)
waitComponentAnnotation(resourceImageErrorKey, ImageAnnotationName)
repoImageInfo := &ImageRepositoryStatus{}
component := getComponent(resourceImageErrorKey)
Expect(json.Unmarshal([]byte(component.Annotations[ImageAnnotationName]), repoImageInfo)).To(Succeed())
Expect(repoImageInfo.Message).To(ContainSubstring("invalid JSON"))
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageErrorKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(0))
})
It("should do nothing and set error if generate annotation has invalid visibility value", func() {
setComponentAnnotationValue(resourceImageErrorKey, GenerateImageAnnotationName, `{"visibility": "none"}`)
waitComponentAnnotationGone(resourceImageErrorKey, GenerateImageAnnotationName)
waitComponentAnnotation(resourceImageErrorKey, ImageAnnotationName)
repoImageInfo := &ImageRepositoryStatus{}
component := getComponent(resourceImageErrorKey)
Expect(json.Unmarshal([]byte(component.Annotations[ImageAnnotationName]), repoImageInfo)).To(Succeed())
Expect(repoImageInfo.Message).To(ContainSubstring("invalid value: none in visibility field"))
imageRepositoriesList := &imagerepositoryv1alpha1.ImageRepositoryList{}
Expect(k8sClient.List(ctx, imageRepositoriesList, &client.ListOptions{Namespace: resourceImageErrorKey.Namespace})).To(Succeed())
Expect(imageRepositoriesList.Items).To(HaveLen(0))
})
It("should clean environment", func() {
deleteComponent(resourceImageErrorKey)
deleteApplication(applicationKey)
deleteServiceAccount(types.NamespacedName{Name: buildPipelineServiceAccountName, Namespace: imageTestNamespace})
deleteServiceAccount(types.NamespacedName{Name: componentSaName, Namespace: imageTestNamespace})
deleteServiceAccount(types.NamespacedName{Name: applicationSaName, Namespace: imageTestNamespace})
})
})
})