-
Notifications
You must be signed in to change notification settings - Fork 460
/
server_test.go
355 lines (305 loc) · 7.86 KB
/
server_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
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package plugin
import (
"bytes"
"context"
"log"
"net"
"os"
"path"
"runtime"
"strings"
"testing"
"time"
hclog "github.com/hashicorp/go-hclog"
)
func TestServer_testMode(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
ch := make(chan *ReattachConfig, 1)
closeCh := make(chan struct{})
go Serve(&ServeConfig{
HandshakeConfig: testHandshake,
Plugins: testGRPCPluginMap,
GRPCServer: DefaultGRPCServer,
Test: &ServeTestConfig{
Context: ctx,
ReattachConfigCh: ch,
CloseCh: closeCh,
},
})
// We should get a config
var config *ReattachConfig
select {
case config = <-ch:
case <-time.After(2000 * time.Millisecond):
t.Fatal("should've received reattach")
}
if config == nil {
t.Fatal("config should not be nil")
}
// Check that the reattach config includes the negotiated protocol version
if config.ProtocolVersion != int(testHandshake.ProtocolVersion) {
t.Fatalf("wrong protocol version in reattach config. got %d, expected %d", config.ProtocolVersion, testHandshake.ProtocolVersion)
}
// Connect!
c := NewClient(&ClientConfig{
Cmd: nil,
HandshakeConfig: testHandshake,
Plugins: testGRPCPluginMap,
Reattach: config,
AllowedProtocols: []Protocol{ProtocolGRPC},
})
client, err := c.Client()
if err != nil {
t.Fatalf("err: %s", err)
}
// Pinging should work
if err := client.Ping(); err != nil {
t.Fatalf("should not err: %s", err)
}
// Kill which should do nothing
c.Kill()
if err := client.Ping(); err != nil {
t.Fatalf("should not err: %s", err)
}
// Canceling should cause an exit
cancel()
<-closeCh
if err := client.Ping(); err == nil {
t.Fatal("should error")
}
// Try logging, this should show out in tests. We have to manually verify.
t.Logf("HELLO")
}
func TestServer_testMode_AutoMTLS(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
closeCh := make(chan struct{})
go Serve(&ServeConfig{
HandshakeConfig: testVersionedHandshake,
VersionedPlugins: map[int]PluginSet{
2: testGRPCPluginMap,
},
GRPCServer: DefaultGRPCServer,
Logger: hclog.NewNullLogger(),
Test: &ServeTestConfig{
Context: ctx,
ReattachConfigCh: nil,
CloseCh: closeCh,
},
})
// Connect!
process := helperProcess("test-mtls")
c := NewClient(&ClientConfig{
Cmd: process,
HandshakeConfig: testVersionedHandshake,
VersionedPlugins: map[int]PluginSet{
2: testGRPCPluginMap,
},
AllowedProtocols: []Protocol{ProtocolGRPC},
AutoMTLS: true,
})
client, err := c.Client()
if err != nil {
t.Fatalf("err: %s", err)
}
// Pinging should work
if err := client.Ping(); err != nil {
t.Fatalf("should not err: %s", err)
}
// Grab the impl
raw, err := client.Dispense("test")
if err != nil {
t.Fatalf("err should be nil, got %s", err)
}
tester, ok := raw.(testInterface)
if !ok {
t.Fatalf("bad: %#v", raw)
}
n := tester.Double(3)
if n != 6 {
t.Fatal("invalid response", n)
}
// ensure we can make use of bidirectional communication with AutoMTLS
// enabled
err = tester.Bidirectional()
if err != nil {
t.Fatal("invalid response", err)
}
c.Kill()
// Canceling should cause an exit
cancel()
<-closeCh
}
func TestServer_RPC(t *testing.T) {
closeCh := make(chan struct{})
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// make a server, but we don't need to attach to it
ch := make(chan *ReattachConfig, 1)
go Serve(&ServeConfig{
HandshakeConfig: testHandshake,
Plugins: testPluginMap,
Test: &ServeTestConfig{
Context: ctx,
CloseCh: closeCh,
ReattachConfigCh: ch,
},
})
// Wait for the server
select {
case cfg := <-ch:
if cfg == nil {
t.Fatal("attach config should not be nil")
}
case <-time.After(2000 * time.Millisecond):
t.Fatal("should've received reattach")
}
cancel()
<-closeCh
}
func TestRmListener_impl(t *testing.T) {
var _ net.Listener = new(rmListener)
}
func TestRmListener(t *testing.T) {
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("err: %s", err)
}
tf, err := os.CreateTemp("", "plugin")
if err != nil {
t.Fatalf("err: %s", err)
}
path := tf.Name()
// Close the file
if err := tf.Close(); err != nil {
t.Fatalf("err: %s", err)
}
// Create the listener and test close
rmL := newDeleteFileListener(l, path)
if err := rmL.Close(); err != nil {
t.Fatalf("err: %s", err)
}
// File should be goe
if _, err := os.Stat(path); err == nil || !os.IsNotExist(err) {
t.Fatalf("err: %s", err)
}
}
func TestProtocolSelection_no_server(t *testing.T) {
conf := &ServeConfig{
HandshakeConfig: testVersionedHandshake,
VersionedPlugins: map[int]PluginSet{
2: testGRPCPluginMap,
},
GRPCServer: DefaultGRPCServer,
TLSProvider: helperTLSProvider,
}
_, protocol, _ := protocolVersion(conf)
if protocol != ProtocolGRPC {
t.Fatalf("bad protocol %s", protocol)
}
conf = &ServeConfig{
HandshakeConfig: testVersionedHandshake,
VersionedPlugins: map[int]PluginSet{
2: testGRPCPluginMap,
},
TLSProvider: helperTLSProvider,
}
_, protocol, _ = protocolVersion(conf)
if protocol != ProtocolNetRPC {
t.Fatalf("bad protocol %s", protocol)
}
}
func TestServer_testStdLogger(t *testing.T) {
closeCh := make(chan struct{})
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
var logOut bytes.Buffer
hclogger := hclog.New(&hclog.LoggerOptions{
Name: "test",
Level: hclog.Trace,
Output: &logOut,
JSONFormat: true,
})
// Wrap the hclog.Logger to use it from the default std library logger
// (and restore the original logger)
defer func() {
log.SetOutput(os.Stderr)
log.SetFlags(log.LstdFlags)
log.SetPrefix(log.Prefix())
}()
log.SetOutput(hclogger.StandardWriter(&hclog.StandardLoggerOptions{InferLevels: true}))
log.SetFlags(0)
log.SetPrefix("")
// make a server, but we don't need to attach to it
ch := make(chan *ReattachConfig, 1)
go Serve(&ServeConfig{
HandshakeConfig: testHandshake,
Plugins: testGRPCPluginMap,
GRPCServer: DefaultGRPCServer,
Logger: hclog.NewNullLogger(),
Test: &ServeTestConfig{
Context: ctx,
CloseCh: closeCh,
ReattachConfigCh: ch,
},
})
// Wait for the server
select {
case cfg := <-ch:
if cfg == nil {
t.Fatal("attach config should not be nil")
}
case <-time.After(2000 * time.Millisecond):
t.Fatal("should've received reattach")
}
log.Println("[DEBUG] test log")
// shut down the server so there's no race on the buffer
cancel()
<-closeCh
if !strings.Contains(logOut.String(), "test log") {
t.Fatalf("expected: %q\ngot: %q", "test log", logOut.String())
}
}
func TestUnixSocketDir(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("go-plugin doesn't support unix sockets on Windows")
}
tmpDir := t.TempDir()
t.Setenv(EnvUnixSocketDir, tmpDir)
closeCh := make(chan struct{})
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// make a server, but we don't need to attach to it
ch := make(chan *ReattachConfig, 1)
go Serve(&ServeConfig{
HandshakeConfig: testHandshake,
Plugins: testGRPCPluginMap,
GRPCServer: DefaultGRPCServer,
Logger: hclog.NewNullLogger(),
Test: &ServeTestConfig{
Context: ctx,
CloseCh: closeCh,
ReattachConfigCh: ch,
},
})
// Wait for the server
var cfg *ReattachConfig
select {
case cfg = <-ch:
if cfg == nil {
t.Fatal("attach config should not be nil")
}
case <-time.After(2000 * time.Millisecond):
t.Fatal("should've received reattach")
}
actualDir := path.Clean(path.Dir(cfg.Addr.String()))
expectedDir := path.Clean(tmpDir)
if actualDir != expectedDir {
t.Fatalf("Expected socket in dir: %s, but was in %s", expectedDir, actualDir)
}
cancel()
<-closeCh
}