forked from kyma-project/kyma
/
runner.go
281 lines (239 loc) · 7.4 KB
/
runner.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
package runner
import (
"bytes"
"fmt"
"regexp"
"strings"
"sync"
"time"
"github.com/kyma-project/kyma/tests/end-to-end/upgrade/internal/platform/logger"
"github.com/gofrs/uuid"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
v1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
const (
gracefulTimeout = time.Second * 10
createdByLabelName = "kyma-project.io/created-by"
// negative value for regex used for name validation in k8s:
// https://github.com/kubernetes/apimachinery/blob/98853ca904e81a25e2000cae7f077dc30f81b85f/pkg/util/validation/validation.go#L110
regexSanitize = "[^a-z0-9]([^-a-z0-9]*[^a-z0-9])?"
)
// NamespaceCreator has methods required to create k8s ns.
type NamespaceCreator interface {
Create(*v1.Namespace) (*v1.Namespace, error)
}
type TestRegistry interface {
IsTestPassed(name string) bool
MarkTestPassed(name string) error
}
// TestRunner executes registered tests
type TestRunner struct {
log *logrus.Entry
nsCreator NamespaceCreator
testRegistry TestRegistry
tests map[string]UpgradeTest
maxConcurrencyLevel int
sanitizeRegex *regexp.Regexp
verbose bool
}
// NewTestRunner is a constructor for TestRunner
func NewTestRunner(log *logrus.Entry, nsCreator NamespaceCreator, testRegistry TestRegistry, tests map[string]UpgradeTest, maxConcurrencyLevel int, verbose bool) (*TestRunner, error) {
sanitizeRegex, err := regexp.Compile(regexSanitize)
if err != nil {
return nil, errors.Wrap(err, "while compiling sanitize regexp")
}
return &TestRunner{
log: log.WithField("service", "test:runner"),
nsCreator: nsCreator,
testRegistry: testRegistry,
tests: tests,
maxConcurrencyLevel: maxConcurrencyLevel,
sanitizeRegex: sanitizeRegex,
verbose: verbose,
}, nil
}
// PrepareData executes CreateResources method for each registered test.
// Test are run in parallel with given maxConcurrencyLevel
func (r *TestRunner) PrepareData(stopCh <-chan struct{}) error {
wg := sync.WaitGroup{}
queue := make(chan task)
failedTaskCnt := 0
// spawn workers
for i := 0; i < r.maxConcurrencyLevel; i++ {
wg.Add(1)
go func() {
for test := range queue {
failed := r.executeTaskFunc(test.CreateResources, stopCh, "CreateResources", test.Name(), true)
if failed {
failedTaskCnt++
}
}
wg.Done()
}()
}
// populate all tests
for name, test := range r.tests {
queue <- task{name, test}
}
close(queue)
// wait for the workers to finish
r.wgWait(stopCh, &wg)
if failedTaskCnt > 0 {
return fmt.Errorf("executed %d task and %d of them failed", len(r.tests), failedTaskCnt)
}
return nil
}
// ExecuteTests executes TestResources method for each registered test.
// Test are run in parallel with given maxConcurrencyLevel
func (r *TestRunner) ExecuteTests(stopCh <-chan struct{}) error {
wg := sync.WaitGroup{}
queue := make(chan task)
failedTaskCnt := 0
// spawn workers
for i := 0; i < r.maxConcurrencyLevel; i++ {
wg.Add(1)
go func() {
for test := range queue {
failed := r.executeTaskFunc(test.TestResources, stopCh, "TestResources", test.Name(), false)
if failed {
failedTaskCnt++
} else {
err := r.testRegistry.MarkTestPassed(test.Name())
if err != nil {
r.log.Errorf("Unable to mark test passed: %s", err.Error())
}
}
}
wg.Done()
}()
}
// populate all tests
numOfTests := 0
for name, test := range r.tests {
if r.testRegistry.IsTestPassed(name) {
continue
}
numOfTests++
queue <- task{name, test}
}
close(queue)
// wait for the workers to finish
r.wgWait(stopCh, &wg)
if failedTaskCnt > 0 {
return fmt.Errorf("executed %d task and %d of them failed", numOfTests, failedTaskCnt)
}
return nil
}
func (r *TestRunner) executeTaskFunc(taskHandler taskFn, stopCh <-chan struct{}, header, taskName string, createNs bool) bool {
fullHeader := fmt.Sprintf("[%s: %s]", header, taskName)
taskLog, err := r.newLoggerForTask()
if err != nil {
r.log.Errorf("%s Cannot create uuid, the task won't be started, got err: %v", fullHeader, err)
return true
}
if r.shutdownRequested(stopCh) {
taskLog.Debugf("Stop channel called. Not executing %s", fullHeader)
return true
}
taskLog.Infof("%s Starting execution", fullHeader)
nsName := r.sanitizedNamespaceName(taskName)
if createNs {
if err := r.ensureNamespaceExists(nsName); err != nil {
taskLog.Errorf("Cannot create namespace %q: %v", nsName, err)
return true
}
}
sink := &bytes.Buffer{}
originalOutput := taskLog.Logger.Out
// verbose means "do not suppress logs"
if !r.verbose {
taskLog.Logger.SetOutput(sink)
}
startTime := time.Now()
if err := taskHandler(stopCh, taskLog, nsName); err != nil {
taskLog.Errorf("%s End with error [start time: %v, duration: %v]: %v", fullHeader, startTime.Format(time.RFC1123), time.Since(startTime), err)
fmt.Fprint(originalOutput, sink.String())
return true
}
sink.Reset() // if task succeeded then do not print data logged internally in that test
taskLog.Infof("%s End with success [start time: %v, duration: %v]", fullHeader, startTime.Format(time.RFC1123), time.Since(startTime))
fmt.Fprint(originalOutput, sink.String())
return false
}
// sanitizedNamespaceName returns sanitized name base on rules from this site:
// https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
func (r *TestRunner) sanitizedNamespaceName(nameToSanitize string) string {
nsName := strings.ToLower(nameToSanitize)
nsName = r.sanitizeRegex.ReplaceAllString(nsName, "-")
if len(nsName) > 253 {
nsName = nsName[:253]
}
return nsName
}
func (r *TestRunner) ensureNamespaceExists(name string) error {
_, err := r.nsCreator.Create(&v1.Namespace{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Labels: map[string]string{
"env": "true",
"istio-injection": "enabled",
createdByLabelName: "e2e-upgrade-test-runner",
},
},
})
if err != nil && !apierrors.IsAlreadyExists(err) {
return err
}
return nil
}
func (r *TestRunner) shutdownRequested(stopCh <-chan struct{}) bool {
select {
case <-stopCh:
return true
default:
}
return false
}
func (r *TestRunner) generateTaskID() (string, error) {
uuidInstance, err := uuid.NewV4()
if err != nil {
return "", err
}
return uuidInstance.String(), nil
}
// wgWait waits for wg with respection to stopCh
func (r *TestRunner) wgWait(stopCh <-chan struct{}, wg *sync.WaitGroup) {
done := make(chan struct{})
go func() {
wg.Wait()
close(done)
}()
select {
case <-done:
r.log.Debug("All task finished.")
case <-stopCh:
r.log.Infof("Stop channel called. Waiting %v for task to finish their job.", gracefulTimeout)
select {
case <-done:
case <-time.After(gracefulTimeout):
r.log.Errorf("Task didn't finished in %v after calling stop channel.", gracefulTimeout)
}
}
}
// newLoggerForTask returns new logger which can be used in given task.
// We need to create new instance of logger otherwise we will start
// mix logs between each task cause they will share same instance.
func (r *TestRunner) newLoggerForTask() (*logrus.Entry, error) {
taskID, err := r.generateTaskID()
if err != nil {
return nil, errors.Wrap(err, "while generating ID for task logger")
}
cfg := &logger.Config{
Level: logger.LogLevel(r.log.Logger.Level),
}
taskLog := logger.New(cfg).WithField("taskID", taskID)
return taskLog, nil
}