-
Notifications
You must be signed in to change notification settings - Fork 472
/
test_options.go
125 lines (107 loc) · 3.91 KB
/
test_options.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
// Copyright 2020 Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.
//
// 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 framework
import (
"context"
"time"
"github.com/onsi/ginkgo"
)
// TestOptions contains options to add additional functionality
// or cleanup handlers to a testcase.
type TestOptions struct {
// afterTests holds a list of all registered AfterTest functions
// that are executed when the test has finished.
AfterTests afterTests
// CAfterTests holds a list of all registered contextified AfterTest functions
// that are executed when the test has finished.
CAfterTests []cAfterTestOption
}
// ApplyOptions applies the given test options on these options.
func (o *TestOptions) ApplyOptions(opts []TestOption) *TestOptions {
for _, opt := range opts {
opt.ApplyToTestOptions(o)
}
return o
}
// Complete registers all test options that are configured.
// it should be a function that configures a ginkgo test case
// This should get called when all options are applied.
func (o *TestOptions) Complete(it func()) {
if len(o.AfterTests) == 0 && len(o.CAfterTests) == 0 {
it()
return
}
// Create a new context so that the afterTests function only runs once after this one testcase.
// Otherwise the after tests would run after every test case in the outer context.
ginkgo.Context("", func() {
it()
for _, aftertest := range o.AfterTests {
// register afterTest to global aftersuite in case the test interrupts
var h CleanupActionHandle
ginkgo.BeforeEach(func() {
h = AddCleanupAction(aftertest)
})
ginkgo.AfterEach(func() {
RemoveCleanupAction(h)
aftertest()
})
}
for _, caftertest := range o.CAfterTests {
// register afterTest to global aftersuite in case the test interrupts
var h CleanupActionHandle
ginkgo.BeforeEach(func() {
h = AddCleanupAction(func() {
contextify(caftertest.Body, caftertest.Timeout)()
})
})
CAfterEach(func(ctx context.Context) {
RemoveCleanupAction(h)
caftertest.Body(ctx)
}, caftertest.Timeout)
}
})
}
// cAfterTestOption contains options for contextified after test function.
type cAfterTestOption struct {
Body func(ctx context.Context)
Timeout time.Duration
}
// ApplyToTestOptions adds contextified after test functions to test options
func (at *cAfterTestOption) ApplyToTestOptions(opts *TestOptions) {
opts.CAfterTests = append(opts.CAfterTests, *at)
}
// TestOption is some configuration that modifies options for testcase.
type TestOption interface {
// ApplyToTestOptions applies this configuration to the given test options.
ApplyToTestOptions(*TestOptions)
}
// afterTests are functions that should run when a test has finished
type afterTests []func()
// ApplyToTestOptions adds after test functions to test options
func (at afterTests) ApplyToTestOptions(opts *TestOptions) {
opts.AfterTests = append(opts.AfterTests, at...)
}
// WithAfterTests adds functions to the current test that are called
// when the test has finished
func WithAfterTests(funcs ...func()) TestOption {
return afterTests(funcs)
}
// WithCAfterTest adds contextified functions to the current test that are called
// when the test has finished
func WithCAfterTest(body func(ctx context.Context), timeout time.Duration) TestOption {
return &cAfterTestOption{
Body: body,
Timeout: timeout,
}
}