-
Notifications
You must be signed in to change notification settings - Fork 103
/
config_test.go
375 lines (344 loc) · 10.6 KB
/
config_test.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
// Copyright (c) 2022 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package tchannel
import (
"crypto/tls"
"errors"
"fmt"
"reflect"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
tchanneltest "github.com/uber/tchannel-go/testutils"
"go.uber.org/yarpc"
yarpctls "go.uber.org/yarpc/api/transport/tls"
"go.uber.org/yarpc/yarpcconfig"
)
type badOption struct{}
func (badOption) tchannelOption() {}
func TestTransportSpecInvalidOption(t *testing.T) {
assert.Panics(t, func() {
TransportSpec(badOption{})
})
}
type fakeOutboundTLSConfigProvider struct {
returnErr error
expectedSpiffeIDs []string
}
func (f fakeOutboundTLSConfigProvider) ClientTLSConfig(spiffeIDs []string) (*tls.Config, error) {
if f.returnErr != nil {
return nil, f.returnErr
}
if !reflect.DeepEqual(f.expectedSpiffeIDs, spiffeIDs) {
return nil, errors.New("spiffe IDs do not match")
}
return &tls.Config{}, nil
}
func TestTransportSpec(t *testing.T) {
someChannel := tchanneltest.NewServer(t, nil)
defer someChannel.Close()
type attrs map[string]interface{}
type wantTransport struct {
Address string
TLSMode yarpctls.Mode
}
type inboundTest struct {
desc string // description
cfg attrs // inbounds section of the config
env map[string]string // environment variables
opts []Option // transport spec options
empty bool // whether this test case is empty
wantErrors []string
// Inbounds don't have any properties that affect the Inbound object.
// We'll assert things about the transport only.
wantTransport *wantTransport
}
type outboundTest struct {
desc string // description
cfg attrs // outbounds section of the config
env map[string]string // environment variables
opts []Option // transport spec options
empty bool // whether this test case is empty
wantErrors []string
wantOutbounds []string
}
inboundTests := []inboundTest{
{desc: "no inbound", empty: true},
{
desc: "simple inbound",
cfg: attrs{"tchannel": attrs{"address": ":4040"}},
wantTransport: &wantTransport{Address: ":4040"},
},
{
desc: "inbound tls",
cfg: attrs{"tchannel": attrs{
"address": ":4040",
"tls": attrs{"mode": "permissive"},
}},
opts: []Option{InboundTLSConfiguration(&tls.Config{})},
wantTransport: &wantTransport{Address: ":4040", TLSMode: yarpctls.Permissive},
},
{
desc: "inbound tls mode override with option",
cfg: attrs{"tchannel": attrs{
"address": ":4040",
"tls": attrs{"mode": "permissive"},
}},
opts: []Option{InboundTLSMode(yarpctls.Disabled)},
wantTransport: &wantTransport{Address: ":4040", TLSMode: yarpctls.Disabled},
},
{
desc: "inbound interpolation",
cfg: attrs{"tchannel": attrs{"address": ":${PORT}"}},
env: map[string]string{"PORT": "4041"},
wantTransport: &wantTransport{Address: ":4041"},
},
{
desc: "empty address",
cfg: attrs{"tchannel": attrs{"address": ""}},
wantErrors: []string{"inbound address is required"},
},
{
desc: "missing address",
cfg: attrs{"tchannel": attrs{}},
wantErrors: []string{"inbound address is required"},
},
{
desc: "too many inbounds",
cfg: attrs{
"tchannel": attrs{"address": ":4040"},
"tchannel2": attrs{"address": ":4041", "type": "tchannel"},
},
wantErrors: []string{"at most one TChannel inbound may be specified"},
},
{
desc: "WithChannel fails",
cfg: attrs{"tchannel": attrs{"address": ":4040"}},
opts: []Option{WithChannel(someChannel)},
wantErrors: []string{"TChannel TransportSpec does not accept WithChannel"},
},
{
desc: "ServiceName fails",
cfg: attrs{"tchannel": attrs{"address": ":4040"}},
opts: []Option{ServiceName("zzzzzzzzz")},
wantErrors: []string{"TChannel TransportSpec does not accept ServiceName"},
},
{
desc: "ListenAddr fails",
cfg: attrs{"tchannel": attrs{"address": ":4040"}},
opts: []Option{ListenAddr(":8080")},
wantErrors: []string{"TChannel TransportSpec does not accept ListenAddr"},
},
}
outboundTests := []outboundTest{
{desc: "no outbound", empty: true},
{
desc: "simple outbound",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:4040",
},
},
},
},
{
desc: "outbound interpolation",
env: map[string]string{"SERVICE_PORT": "4040"},
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:${SERVICE_PORT}",
},
},
},
},
{
desc: "outbound bad peer list",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{"least-pending": "wat"},
},
},
wantErrors: []string{
`failed to configure unary outbound for "myservice"`,
`failed to read attribute "least-pending": wat`,
},
},
{
desc: "fail TLS outbound with invalid tls mode",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:4040",
"tls": attrs{
"mode": "permissive",
},
},
},
},
wantErrors: []string{"outbound does not support permissive TLS mode"},
},
{
desc: "fail TLS outbound without outbound tls config provider",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:4040",
"tls": attrs{
"mode": "enforced",
"spiffe-ids": []string{"test-spiffe"},
},
},
},
},
wantErrors: []string{"outbound TLS enforced but outbound TLS config provider is nil"},
},
{
desc: "fail TLS outbound without spiffe id",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:4040",
"tls": attrs{
"mode": "enforced",
},
},
},
},
opts: []Option{OutboundTLSConfigProvider(&fakeOutboundTLSConfigProvider{})},
wantErrors: []string{"outbound TLS enforced but no spiffe id is provided"},
},
{
desc: "fail TLS outbound when tls config provider returns error",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:4040",
"tls": attrs{
"mode": "enforced",
"spiffe-ids": []string{"test-spiffe"},
},
},
},
},
opts: []Option{OutboundTLSConfigProvider(&fakeOutboundTLSConfigProvider{returnErr: errors.New("test error")})},
wantErrors: []string{"test error"},
},
{
desc: "simple TLS outbound",
cfg: attrs{
"myservice": attrs{
"tchannel": attrs{
"peer": "127.0.0.1:4040",
"tls": attrs{
"mode": "enforced",
"spiffe-ids": []string{"test-spiffe"},
},
},
},
},
opts: []Option{OutboundTLSConfigProvider(
&fakeOutboundTLSConfigProvider{
expectedSpiffeIDs: []string{"test-spiffe"},
},
)},
wantOutbounds: []string{"myservice"},
},
}
runTest := func(t *testing.T, inbound inboundTest, outbound outboundTest) {
env := make(map[string]string)
for k, v := range inbound.env {
env[k] = v
}
for k, v := range outbound.env {
_, ok := env[k]
require.False(t, ok,
"invalid test: environment variable %q is defined multiple times", k)
env[k] = v
}
configurator := yarpcconfig.New(yarpcconfig.InterpolationResolver(mapResolver(env)))
opts := append(inbound.opts, outbound.opts...)
err := configurator.RegisterTransport(TransportSpec(opts...))
require.NoError(t, err, "failed to register transport spec")
cfgData := make(attrs)
if inbound.cfg != nil {
cfgData["inbounds"] = inbound.cfg
}
if outbound.cfg != nil {
cfgData["outbounds"] = outbound.cfg
}
cfg, err := configurator.LoadConfig("foo", cfgData)
if len(inbound.wantErrors) > 0 {
require.Error(t, err, "expected failure while loading config %+v", cfgData)
for _, msg := range inbound.wantErrors {
assert.Contains(t, err.Error(), msg)
}
return
}
if len(outbound.wantErrors) > 0 {
require.Error(t, err, "expected failure while loading config %+v", cfgData)
for _, msg := range outbound.wantErrors {
assert.Contains(t, err.Error(), msg)
}
return
}
require.NoError(t, err, "expected success while loading config %+v", cfgData)
if want := inbound.wantTransport; want != nil {
assert.Len(t, cfg.Inbounds, 1, "expected exactly one inbound in %+v", cfgData)
ib, ok := cfg.Inbounds[0].(*Inbound)
if assert.True(t, ok, "expected *Inbound, got %T", cfg.Inbounds[0]) {
trans := ib.transport
assert.Equal(t, "foo", trans.name, "service name must match")
assert.Equal(t, want.Address, trans.addr, "transport address must match")
require.NotNil(t, trans.inboundTLSMode, "tls mode is nil")
assert.Equal(t, want.TLSMode, *trans.inboundTLSMode, "tls mode must match")
}
}
for _, svc := range outbound.wantOutbounds {
_, ok := cfg.Outbounds[svc].Unary.(*Outbound)
assert.True(t, ok, "expected *Outbound for %q, got %T", svc, cfg.Outbounds[svc].Unary)
}
d := yarpc.NewDispatcher(cfg)
require.NoError(t, d.Start(), "failed to start dispatcher")
require.NoError(t, d.Stop(), "failed to stop dispatcher")
}
for _, inboundTT := range inboundTests {
for _, outboundTT := range outboundTests {
// Special case: No inbounds or outbounds so we have nothing to
// test.
if inboundTT.empty && outboundTT.empty {
continue
}
desc := fmt.Sprintf("%v/%v", inboundTT.desc, outboundTT.desc)
t.Run(desc, func(t *testing.T) {
runTest(t, inboundTT, outboundTT)
})
}
}
}
func mapResolver(m map[string]string) func(string) (string, bool) {
return func(k string) (v string, ok bool) {
if m != nil {
v, ok = m[k]
}
return
}
}