/
test_utils.go
200 lines (174 loc) · 4.67 KB
/
test_utils.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
package kong
import (
"fmt"
"net/http"
"os"
"testing"
)
type RequiredFeatures struct {
Portal bool
RBAC bool
}
// RunWhenKong skips the current test if the version of Kong doesn't
// fall in the versionRange.
// This helper function can be used in tests to write version specific
// tests for Kong.
func RunWhenKong(t *testing.T, versionRange string) {
t.Helper()
client, err := NewTestClient(nil, nil)
if err != nil {
t.Error(err)
}
info, err := client.Root(defaultCtx)
if err != nil {
t.Error(err)
}
version := VersionFromInfo(info)
currentVersion, err := ParseSemanticVersion(version)
if err != nil {
t.Error(err)
}
r, err := NewRange(versionRange)
if err != nil {
t.Error(err)
}
if !r(currentVersion) {
t.Skipf("kong version %s not in range %s", version, versionRange)
}
}
// RunWhenEnterprise skips a test if the version
// of Kong running is not enterprise edition. Skips
// the current test if the version of Kong doesn't
// fall within the version range. If a test requires
// RBAC and RBAC is not enabled on Kong the test
// will be skipped
func RunWhenEnterprise(t *testing.T, versionRange string, required RequiredFeatures) {
t.Helper()
client, err := NewTestClient(nil, nil)
if err != nil {
t.Error(err)
}
info, err := client.Root(defaultCtx)
if err != nil {
t.Error(err)
}
version := VersionFromInfo(info)
currentVersion, err := ParseSemanticVersion(version)
if err != nil {
t.Error(err)
}
if !currentVersion.IsKongGatewayEnterprise() {
t.Skip("non-Enterprise test Kong instance, skipping")
}
configuration := info["configuration"].(map[string]interface{})
if required.RBAC && configuration["rbac"].(string) != "on" {
t.Skip("RBAC not enabled on test Kong instance, skipping")
}
if required.Portal && !configuration["portal"].(bool) {
t.Skip("Portal not enabled on test Kong instance, skipping")
}
r, err := NewRange(versionRange)
if err != nil {
t.Error(err)
}
if !r(currentVersion) {
t.Skipf("kong version %s not in range %s", version, versionRange)
}
}
// SkipWhenEnterprise skips a test if the Kong version is an Enterprise version
func SkipWhenEnterprise(t *testing.T) {
t.Helper()
client, err := NewTestClient(nil, nil)
if err != nil {
t.Error(err)
}
info, err := client.Root(defaultCtx)
if err != nil {
t.Error(err)
}
version := VersionFromInfo(info)
currentVersion, err := ParseSemanticVersion(version)
if err != nil {
t.Error(err)
}
if currentVersion.IsKongGatewayEnterprise() {
t.Skip("non-Enterprise test Kong instance, skipping")
}
}
func NewTestClient(baseURL *string, client *http.Client) (*Client, error) {
if value, exists := os.LookupEnv("KONG_ADMIN_TOKEN"); exists && value != "" {
c := &http.Client{}
defaultTransport := http.DefaultTransport.(*http.Transport)
c.Transport = defaultTransport
c.Transport = &headerRoundTripper{
headers: http.Header{
"kong-admin-token": []string{value},
},
rt: defaultTransport,
}
return NewClient(baseURL, c)
}
return NewClient(baseURL, client)
}
func RunWhenDBMode(t *testing.T, dbmode string) {
t.Helper()
dbMode, err := getKongConfigValue(t, "database")
if err != nil {
t.Skip(err.Error())
}
if dbMode != dbmode {
t.Skipf("detected Kong running in dbmode:%q but requested dbmode:%q", dbMode, dbmode)
}
}
type RouterFlavor string
const (
Traditional RouterFlavor = "traditional"
TraditionalCompatible RouterFlavor = "traditional_compatible"
Expressions RouterFlavor = "expressions"
)
func SkipWhenKongRouterFlavor(t *testing.T, flavor ...RouterFlavor) {
t.Helper()
routerFlavor, err := getKongConfigValue(t, "router_flavor")
if err != nil {
t.Skip(err.Error())
}
for _, f := range flavor {
if RouterFlavor(routerFlavor) == f {
t.Skipf("router flavor:%q skipping", f)
}
}
}
func RunWhenKongRouterFlavor(t *testing.T, flavor RouterFlavor) {
t.Helper()
routerFlavor, err := getKongConfigValue(t, "router_flavor")
if err != nil {
t.Skip(err.Error())
}
if RouterFlavor(routerFlavor) != flavor {
t.Skipf("router flavor:%q, expecting %q, skipping", routerFlavor, flavor)
}
}
func getKongConfigValue(t *testing.T, key string) (string, error) {
t.Helper()
client, err := NewTestClient(nil, nil)
if err != nil {
t.Error(err)
}
info, err := client.Root(defaultCtx)
if err != nil {
t.Error(err)
}
config, ok := info["configuration"]
if !ok {
return "", fmt.Errorf("failed to find %q config key in kong configuration", key)
}
configuration, ok := config.(map[string]any)
if !ok {
return "", fmt.Errorf("%q key is not a map but %T", key, config)
}
value, ok := configuration[key].(string)
if !ok {
return "", fmt.Errorf("failed to find %q config key in kong configuration", key)
}
return value, nil
}