-
Notifications
You must be signed in to change notification settings - Fork 472
/
test_description.go
113 lines (92 loc) · 3.1 KB
/
test_description.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
// SPDX-FileCopyrightText: 2024 SAP SE or an SAP affiliate company and Gardener contributors
//
// SPDX-License-Identifier: Apache-2.0
package framework
import (
"context"
"fmt"
"time"
"github.com/onsi/ginkgo/v2"
"k8s.io/apimachinery/pkg/util/sets"
)
// TestDescription labels tests according to the provided labels in the expected order.
type TestDescription struct {
labels sets.Set[string]
}
// NewTestDescription creates a new test description
func NewTestDescription(baseLabel string) TestDescription {
return TestDescription{
labels: sets.New(baseLabel),
}
}
// Beta labels a test as beta test
func (t TestDescription) Beta() TestDescription {
return t.newLabel("BETA")
}
// Default labels a test as default test
func (t TestDescription) Default() TestDescription {
return t.newLabel("DEFAULT")
}
// Release labels a test as release relevant test
func (t TestDescription) Release() TestDescription {
return t.newLabel("RELEASE")
}
// Serial labels a test to be run as serial step
func (t TestDescription) Serial() TestDescription {
return t.newLabel("SERIAL")
}
// Disruptive labels a test as disruptive.
// This kind of test should run with care.
func (t TestDescription) Disruptive() TestDescription {
return t.newLabel("DISRUPTIVE")
}
func (t TestDescription) newLabel(label string) TestDescription {
labels := t.labels.Union(nil)
labels.Insert(label)
return TestDescription{
labels: labels,
}
}
// It defines a ginkgo It block and enhances the test description with the provided labels
func (t TestDescription) It(text string, body func(), opts ...TestOption) {
testOptions := &TestOptions{}
testOptions.ApplyOptions(opts)
testOptions.Complete(func() {
ginkgo.It(fmt.Sprintf("%s %s", t.String(), text), body)
})
}
// FIt defines a ginkgo FIt block and enhances the test description with the provided labels
func (t TestDescription) FIt(text string, body func(), opts ...TestOption) {
testOptions := &TestOptions{}
testOptions.ApplyOptions(opts)
testOptions.Complete(func() {
ginkgo.FIt(fmt.Sprintf("%s %s", t.String(), text), body)
})
}
// CIt defines a contextified ginkgo It block and enhances the test description with the provided labels
func (t TestDescription) CIt(text string, body func(context.Context), timeout time.Duration, opts ...TestOption) {
testOptions := &TestOptions{}
testOptions.ApplyOptions(opts)
testOptions.Complete(func() {
CIt(fmt.Sprintf("%s %s", t.String(), text), body, timeout)
})
}
// FCIt defines a contextified ginkgo FIt block and enhances the test description with the provided labels
func (t TestDescription) FCIt(text string, body func(context.Context), timeout time.Duration, opts ...TestOption) {
testOptions := &TestOptions{}
testOptions.ApplyOptions(opts)
testOptions.Complete(func() {
FCIt(fmt.Sprintf("%s %s", t.String(), text), body, timeout)
})
}
// String returns the test description labels
func (t TestDescription) String() string {
var (
labelsList = sets.List(t.labels)
testText = fmt.Sprintf("[%s]", labelsList[0])
)
for i := 1; i < len(labelsList); i++ {
testText = fmt.Sprintf("%s [%s]", testText, labelsList[i])
}
return testText
}