forked from openshift/origin
/
helpers.go
439 lines (367 loc) · 13.2 KB
/
helpers.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
package templates
import (
"context"
"crypto/tls"
"fmt"
"net/http"
"strconv"
"strings"
g "github.com/onsi/ginkgo"
o "github.com/onsi/gomega"
kappsv1 "k8s.io/api/apps/v1"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
kerrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/validation"
deploymentutil "k8s.io/kubernetes/pkg/controller/deployment/util"
appsv1 "github.com/openshift/api/apps/v1"
authorizationv1 "github.com/openshift/api/authorization/v1"
buildv1 "github.com/openshift/api/build/v1"
routev1 "github.com/openshift/api/route/v1"
templatev1 "github.com/openshift/api/template/v1"
userv1 "github.com/openshift/api/user/v1"
"github.com/openshift/library-go/pkg/apps/appsutil"
buildv1client "github.com/openshift/client-go/build/clientset/versioned"
osbclient "github.com/openshift/origin/test/extended/templates/openservicebroker/client"
exutil "github.com/openshift/origin/test/extended/util"
)
var readinessScheme = runtime.NewScheme()
func init() {
kappsv1.AddToScheme(readinessScheme)
batchv1.AddToScheme(readinessScheme)
corev1.AddToScheme(readinessScheme)
appsv1.Install(readinessScheme)
buildv1.Install(readinessScheme)
routev1.Install(readinessScheme)
}
func createUser(cli *exutil.CLI, name, role string) *userv1.User {
name = cli.Namespace() + "-" + name
user, err := cli.AdminUserClient().UserV1().Users().Create(context.Background(), &userv1.User{
ObjectMeta: metav1.ObjectMeta{
Name: name,
},
}, metav1.CreateOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
if role != "" {
_, err = cli.AdminAuthorizationClient().AuthorizationV1().RoleBindings(cli.Namespace()).Create(context.Background(), &authorizationv1.RoleBinding{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("%s-%s-binding", name, role),
},
RoleRef: corev1.ObjectReference{
Name: role,
},
Subjects: []corev1.ObjectReference{
{
Kind: authorizationv1.UserKind,
Name: name,
},
},
}, metav1.CreateOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
}
return user
}
func createGroup(cli *exutil.CLI, name, role string) *userv1.Group {
name = cli.Namespace() + "-" + name
group, err := cli.AdminUserClient().UserV1().Groups().Create(context.Background(), &userv1.Group{
ObjectMeta: metav1.ObjectMeta{
Name: name,
},
}, metav1.CreateOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
if role != "" {
_, err = cli.AdminAuthorizationClient().AuthorizationV1().RoleBindings(cli.Namespace()).Create(context.Background(), &authorizationv1.RoleBinding{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("%s-%s-binding", name, role),
},
RoleRef: corev1.ObjectReference{
Name: role,
},
Subjects: []corev1.ObjectReference{
{
Kind: authorizationv1.GroupKind,
Name: name,
},
},
}, metav1.CreateOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
}
return group
}
func addUserToGroup(cli *exutil.CLI, username, groupname string) {
group, err := cli.AdminUserClient().UserV1().Groups().Get(context.Background(), groupname, metav1.GetOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
if group != nil {
group.Users = append(group.Users, username)
_, err = cli.AdminUserClient().UserV1().Groups().Update(context.Background(), group, metav1.UpdateOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
}
}
func deleteGroup(cli *exutil.CLI, group *userv1.Group) {
err := cli.AdminUserClient().UserV1().Groups().Delete(context.Background(), group.Name, metav1.DeleteOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
}
func deleteUser(cli *exutil.CLI, user *userv1.User) {
err := cli.AdminUserClient().UserV1().Users().Delete(context.Background(), user.Name, metav1.DeleteOptions{})
o.Expect(err).NotTo(o.HaveOccurred())
}
func setUser(cli *exutil.CLI, user *userv1.User) {
if user == nil {
g.By("testing as system:admin user")
*cli = *cli.AsAdmin()
} else {
g.By(fmt.Sprintf("testing as %s user", user.Name))
cli.ChangeUser(user.Name)
}
}
// TSBClient returns a client to the running template service broker
func TSBClient(oc *exutil.CLI) (osbclient.Client, error) {
svc, err := oc.AdminKubeClient().CoreV1().Services("openshift-template-service-broker").Get(context.Background(), "apiserver", metav1.GetOptions{})
if err != nil {
return nil, err
}
return osbclient.NewClient(&http.Client{
Transport: &http.Transport{
TLSClientConfig: &tls.Config{
InsecureSkipVerify: true,
},
},
}, "https://"+svc.Spec.ClusterIP+"/brokers/template.openshift.io"), nil
}
// readinessCheckers maps GroupKinds to the appropriate function. Note that in
// some cases more than one GK maps to the same function.
var readinessCheckers = map[schema.GroupVersionKind]func(runtime.Object) (bool, bool, error){
// OpenShift kinds:
groupVersionKind(buildv1.GroupVersion, "Build"): checkBuildReadiness,
groupVersionKind(appsv1.GroupVersion, "DeploymentConfig"): checkDeploymentConfigReadiness,
groupVersionKind(routev1.GroupVersion, "Route"): checkRouteReadiness,
// Legacy (/oapi) kinds:
{Group: "", Version: "v1", Kind: "Build"}: checkBuildReadiness,
{Group: "", Version: "v1", Kind: "DeploymentConfig"}: checkDeploymentConfigReadiness,
{Group: "", Version: "v1", Kind: "Route"}: checkRouteReadiness,
// Kubernetes kinds:
groupVersionKind(kappsv1.SchemeGroupVersion, "Deployment"): checkDeploymentReadiness,
groupVersionKind(kappsv1.SchemeGroupVersion, "StatefulSet"): checkStatefulSetReadiness,
groupVersionKind(batchv1.SchemeGroupVersion, "Job"): checkJobReadiness,
}
//TODO candidate for openshift/library-go
func isTerminalPhase(phase buildv1.BuildPhase) bool {
switch phase {
case buildv1.BuildPhaseNew,
buildv1.BuildPhasePending,
buildv1.BuildPhaseRunning:
return false
}
return true
}
//TODO candidate for openshift/library-go
func checkBuildReadiness(obj runtime.Object) (bool, bool, error) {
b, ok := obj.(*buildv1.Build)
if !ok {
return false, false, fmt.Errorf("object %T is not v1.Build", obj)
}
ready := isTerminalPhase(b.Status.Phase) &&
b.Status.Phase == buildv1.BuildPhaseComplete
failed := isTerminalPhase(b.Status.Phase) &&
b.Status.Phase != buildv1.BuildPhaseComplete
return ready, failed, nil
}
//TODO candidate for openshift/library-go
func labelValue(name string) string {
if len(name) <= validation.DNS1123LabelMaxLength {
return name
}
return name[:validation.DNS1123LabelMaxLength]
}
//TODO candidate for openshift/library-go
func buildConfigSelector(name string) labels.Selector {
return labels.Set{buildv1.BuildConfigLabel: labelValue(name)}.AsSelector()
}
func checkBuildConfigReadiness(oc buildv1client.Interface, obj runtime.Object) (bool, bool, error) {
bc, ok := obj.(*buildv1.BuildConfig)
if !ok {
return false, false, fmt.Errorf("object %T is not v1.BuildConfig", obj)
}
builds, err := oc.BuildV1().Builds(bc.Namespace).List(context.Background(), metav1.ListOptions{LabelSelector: buildConfigSelector(bc.Name).String()})
if err != nil {
return false, false, err
}
for _, item := range builds.Items {
if item.Annotations[buildv1.BuildNumberAnnotation] == strconv.FormatInt(bc.Status.LastVersion, 10) {
return checkBuildReadiness(&item)
}
}
return false, false, nil
}
type deploymentCondition struct {
status corev1.ConditionStatus
reason string
}
func newDeploymentCondition(status corev1.ConditionStatus, reason string) *deploymentCondition {
return &deploymentCondition{
status: status,
reason: reason,
}
}
// checkDeploymentReadiness determins if a Deployment is ready, failed or
// neither.
func checkDeploymentReadiness(obj runtime.Object) (bool, bool, error) {
var (
isSynced bool
progressing, available *deploymentCondition
)
switch d := obj.(type) {
case *kappsv1.Deployment:
isSynced = d.Status.ObservedGeneration == d.Generation
for _, condition := range d.Status.Conditions {
switch condition.Type {
case kappsv1.DeploymentProgressing:
progressing = newDeploymentCondition(condition.Status, condition.Reason)
case kappsv1.DeploymentAvailable:
available = newDeploymentCondition(condition.Status, condition.Reason)
}
}
default:
return false, false, fmt.Errorf("unsupported deployment version: %T", d)
}
if !isSynced || progressing == nil {
return false, false, nil
}
ready := progressing.status == corev1.ConditionTrue &&
progressing.reason == deploymentutil.NewRSAvailableReason &&
available != nil &&
available.status == corev1.ConditionTrue
failed := progressing.status == corev1.ConditionFalse
return ready, failed, nil
}
//TODO candidate for openshift/library-go
func checkDeploymentConfigReadiness(obj runtime.Object) (bool, bool, error) {
dc, ok := obj.(*appsv1.DeploymentConfig)
if !ok {
return false, false, fmt.Errorf("object %T is not v1.DeploymentConfig", obj)
}
var progressing, available *appsv1.DeploymentCondition
for i, condition := range dc.Status.Conditions {
switch condition.Type {
case appsv1.DeploymentProgressing:
progressing = &dc.Status.Conditions[i]
case appsv1.DeploymentAvailable:
available = &dc.Status.Conditions[i]
}
}
ready := dc.Status.ObservedGeneration == dc.Generation &&
progressing != nil &&
progressing.Status == corev1.ConditionTrue &&
progressing.Reason == appsutil.NewRcAvailableReason &&
available != nil &&
available.Status == corev1.ConditionTrue
failed := dc.Status.ObservedGeneration == dc.Generation &&
progressing != nil &&
progressing.Status == corev1.ConditionFalse
return ready, failed, nil
}
func checkJobReadiness(obj runtime.Object) (bool, bool, error) {
var (
hasCompletionTime bool
isJobFailed bool
)
switch j := obj.(type) {
case *batchv1.Job:
hasCompletionTime = j.Status.CompletionTime != nil
isJobFailed = j.Status.Failed > 0
default:
return false, false, fmt.Errorf("unsupported job version: %T", j)
}
return hasCompletionTime, isJobFailed, nil
}
func checkRouteReadiness(obj runtime.Object) (bool, bool, error) {
route, ok := obj.(*routev1.Route)
if !ok {
return false, false, fmt.Errorf("object %T is not v1.Route", obj)
}
return len(route.Spec.Host) > 0, false, nil
}
func checkStatefulSetReadiness(obj runtime.Object) (bool, bool, error) {
var (
isSynced bool
hasReplicasReady bool
)
switch s := obj.(type) {
case *kappsv1.StatefulSet:
isSynced = s.Status.ObservedGeneration == s.Generation
hasReplicasReady = s.Spec.Replicas != nil && s.Status.ReadyReplicas == *s.Spec.Replicas
default:
return false, false, fmt.Errorf("unsupported statefulset version: %T", s)
}
return isSynced && hasReplicasReady, false, nil
}
func groupVersionKind(gv schema.GroupVersion, kind string) schema.GroupVersionKind {
return schema.GroupVersionKind{
Group: gv.Group,
Version: gv.Version,
Kind: kind,
}
}
func canCheckReadiness(ref corev1.ObjectReference) bool {
switch ref.GroupVersionKind() {
case groupVersionKind(buildv1.GroupVersion, "BuildConfig"), schema.GroupVersionKind{Group: "", Version: "v1", Kind: "BuildConfig"}:
return true
}
_, found := readinessCheckers[ref.GroupVersionKind()]
return found
}
func checkReadiness(oc buildv1client.Interface, ref corev1.ObjectReference, obj *unstructured.Unstructured) (bool, bool, error) {
castObj, err := readinessScheme.New(ref.GroupVersionKind())
if err != nil {
return false, false, err
}
if err := runtime.DefaultUnstructuredConverter.FromUnstructured(obj.Object, castObj); err != nil {
return false, false, err
}
switch ref.GroupVersionKind() {
case groupVersionKind(buildv1.GroupVersion, "BuildConfig"), schema.GroupVersionKind{Group: "", Version: "v1", Kind: "BuildConfig"}:
return checkBuildConfigReadiness(oc, castObj)
}
readinessCheckFunc, ok := readinessCheckers[ref.GroupVersionKind()]
if !ok {
return false, false, fmt.Errorf("readiness check for %+v is not defined", ref.GroupVersionKind())
}
return readinessCheckFunc(castObj)
}
func dumpObjectReadiness(oc *exutil.CLI, templateInstance *templatev1.TemplateInstance) error {
restmapper := oc.RESTMapper()
fmt.Fprintf(g.GinkgoWriter, "dumping object readiness for %s/%s\n", templateInstance.Namespace, templateInstance.Name)
for _, object := range templateInstance.Status.Objects {
if !canCheckReadiness(object.Ref) {
continue
}
mapping, err := restmapper.RESTMapping(object.Ref.GroupVersionKind().GroupKind())
if err != nil {
return err
}
obj, err := oc.KubeFramework().DynamicClient.Resource(mapping.Resource).Namespace(object.Ref.Namespace).Get(context.Background(), object.Ref.Name, metav1.GetOptions{})
if err != nil {
return err
}
if obj.GetUID() != object.Ref.UID {
return kerrors.NewNotFound(mapping.Resource.GroupResource(), object.Ref.Name)
}
if strings.ToLower(obj.GetAnnotations()[templatev1.WaitForReadyAnnotation]) != "true" {
continue
}
ready, failed, err := checkReadiness(oc.BuildClient(), object.Ref, obj)
if err != nil {
return err
}
fmt.Fprintf(g.GinkgoWriter, "%s %s/%s: ready %v, failed %v\n", object.Ref.Kind, object.Ref.Namespace, object.Ref.Name, ready, failed)
if !ready || failed {
fmt.Fprintf(g.GinkgoWriter, "object: %#v\n", obj)
}
}
return nil
}