/
context.go
116 lines (99 loc) · 3.02 KB
/
context.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
// Copyright 2018 The Operator-SDK 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 test
import (
"testing"
"time"
"github.com/pborman/uuid"
log "github.com/sirupsen/logrus"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/restmapper"
)
type Context struct {
id string
cleanupFns []cleanupFn
namespace string
t *testing.T
namespacedManPath string
client *frameworkClient
kubeclient kubernetes.Interface
restMapper *restmapper.DeferredDiscoveryRESTMapper
skipCleanupOnError bool
}
// todo(camilamacedo86): Remove the following line just added for we are able to deprecated TestCtx
// need to be done before: 1.0.0
// Deprecated: TestCtx exists for historical compatibility. Use Context instead.
type TestCtx = Context //nolint:golint
type CleanupOptions struct {
TestContext *Context
Timeout time.Duration
RetryInterval time.Duration
}
type cleanupFn func() error
func (f *Framework) newContext(t *testing.T) *Context {
// Context is used among others for namespace names where '/' is forbidden and must be 63 characters or less
id := "osdk-e2e-" + uuid.New()
var namespace string
if f.singleNamespaceMode {
namespace = f.Namespace
}
return &Context{
id: id,
t: t,
namespace: namespace,
namespacedManPath: *f.NamespacedManPath,
client: f.Client,
kubeclient: f.KubeClient,
restMapper: f.restMapper,
skipCleanupOnError: f.skipCleanupOnError,
}
}
// Deprecated: NewTestCtx exists for historical compatibility. Use NewContext instead.
func NewTestCtx(t *testing.T) *TestCtx {
return Global.newContext(t)
}
func NewContext(t *testing.T) *Context {
return Global.newContext(t)
}
func (ctx *Context) GetID() string {
return ctx.id
}
func (ctx *Context) Cleanup() {
if ctx.t != nil {
// The cleanup function will be skipped
if ctx.t.Failed() && ctx.skipCleanupOnError {
// Also, could we log the error here?
log.Info("Skipping cleanup function since --skip-cleanup-error is true")
return
}
}
failed := false
for i := len(ctx.cleanupFns) - 1; i >= 0; i-- {
err := ctx.cleanupFns[i]()
if err != nil {
failed = true
if ctx.t != nil {
ctx.t.Errorf("A cleanup function failed with error: (%v)\n", err)
} else {
log.Errorf("A cleanup function failed with error: (%v)", err)
}
}
}
if ctx.t == nil && failed {
log.Fatal("A cleanup function failed")
}
}
func (ctx *Context) AddCleanupFn(fn cleanupFn) {
ctx.cleanupFns = append(ctx.cleanupFns, fn)
}