/
jrpc_test.go
491 lines (472 loc) · 14.1 KB
/
jrpc_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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
// Copyright 2022 Fortio Authors.
//
// 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 jrpc_test
import (
"errors"
"fmt"
"net"
"net/http"
"strings"
"testing"
"time"
"fortio.org/assert"
"fortio.org/fortio/fhttp"
"fortio.org/fortio/jrpc"
)
func TestDebugSummary(t *testing.T) {
tests := []struct {
input string
expected string
}{
{"12345678", "12345678"},
{"123456789", "123456789"},
{"1234567890", "1234567890"},
{"12345678901", "12345678901"},
{"123456789012", "12: 1234...9012"},
{"1234567890123", "13: 1234...0123"},
{"12345678901234", "14: 1234...1234"},
{"A\r\000\001\x80\nB", `A\r\x00\x01\x80\nB`}, // escaping
{"A\r\000Xyyyyyyyyy\001\x80\nB", `17: A\r\x00X...\x01\x80\nB`}, // escaping
}
for _, tst := range tests {
if actual := jrpc.DebugSummary([]byte(tst.input), 8); actual != tst.expected {
t.Errorf("Got '%s', expected '%s' for DebugSummary(%q)", actual, tst.expected, tst.input)
}
}
}
// Rest is also tested in rapi/restHandler_tests.go but that doesn't count for coverage
type Request struct {
SomeInt int
SomeString []string
}
type Response struct {
jrpc.ServerReply
InputInt int
ConcatenatedStrings string
}
//nolint:funlen,gocognit,maintidx // lots of tests using same server setup
func TestJPRC(t *testing.T) {
prev := jrpc.SetCallTimeout(5 * time.Second)
if prev != 60*time.Second {
t.Errorf("Expected default call timeout to be 60 seconds, got %v", prev)
}
mux, addr := fhttp.HTTPServer("test1", "0")
port := addr.(*net.TCPAddr).Port
var bad chan struct{}
mux.HandleFunc("/test-api", func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodPost {
err := jrpc.ReplyError(w, "should be a POST", nil)
if err != nil {
t.Errorf("Error in replying error: %v", err)
}
return
}
req, err := jrpc.HandleCall[Request](w, r)
if err != nil {
err = jrpc.ReplyError(w, "request error", err)
if err != nil {
t.Errorf("Error in replying error: %v", err)
}
return
}
if req.SomeInt == -7 {
jrpc.ReplyNoPayload(w, 777)
return
}
resp := Response{}
if req.SomeInt == -8 {
resp.Error = true
resp.Message = "simulated server error"
jrpc.ReplyServerError(w, &resp)
return
}
if req.SomeInt == -9 {
// simulate a bad reply, invalid json
w.WriteHeader(747)
w.Write([]byte(`{bad}`))
return
}
if req.SomeInt == -10 {
// simulate a bad reply, invalid json but ok status
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{notjson}`))
return
}
if req.SomeInt == -11 {
// server error using unserializable struct
err = jrpc.Reply(w, 200, &bad)
if err == nil {
t.Errorf("Expected bad serialization error")
}
return
}
resp.Message = "works"
resp.InputInt = req.SomeInt
// inefficient but this is just to test
for _, s := range req.SomeString {
resp.ConcatenatedStrings += s
}
jrpc.ReplyOk(w, &resp)
})
url := fmt.Sprintf("http://localhost:%d/test-api", port)
req := Request{42, []string{"ab", "cd"}}
res, err := jrpc.CallURL[Response](url, &req)
if err != nil {
t.Errorf("failed Call: %v", err)
}
if res.Error {
t.Errorf("response unexpectedly marked as failed: %+v", res)
}
if res.InputInt != 42 {
t.Errorf("response doesn't contain expected int: %+v", res)
}
if res.ConcatenatedStrings != "abcd" {
t.Errorf("response doesn't contain expected string: %+v", res)
}
// OK case: empty POST
dest := &jrpc.Destination{
URL: url,
Method: http.MethodPost, // force post (default is get when no payload)
}
res, err = jrpc.Fetch[Response](dest, []byte{})
if err != nil {
t.Errorf("failed Fetch with POST and empty body: %v", err)
}
if res.Error {
t.Errorf("response unexpectedly marked as failed: %+v", res)
}
// Error cases
// Empty request, using FetchBytes()
code, bytes, err := jrpc.FetchBytes(jrpc.NewDestination(url))
if err != nil {
t.Errorf("failed Fetch: %v - %s", err, jrpc.DebugSummary(bytes, 256))
}
if code != http.StatusBadRequest {
t.Errorf("expected status code 400, got %d - %s", code, jrpc.DebugSummary(bytes, 256))
}
res, err = jrpc.Deserialize[Response](bytes)
if err != nil {
t.Errorf("failed Deserialize: %v - %s", err, jrpc.DebugSummary(bytes, 256))
}
if !res.Error {
t.Errorf("response unexpectedly marked as not failed: %+v", res)
}
if res.Message != "should be a POST" {
t.Errorf("response doesn't contain expected message: %+v", res)
}
// bad url
badURL := "http://doesnotexist.fortio.org/"
_, err = jrpc.CallURL[Response](badURL, &req)
if err == nil {
t.Errorf("expected error for bad url")
}
var de *net.DNSError
if !errors.As(err, &de) {
t.Errorf("expected dns error, got %v", err)
}
expected := "lookup doesnotexist.fortio.org"
if de != nil && !strings.HasPrefix(de.Error(), expected) {
t.Errorf("expected dns error to start with %q, got %q", expected, de.Error())
}
// bad json payload sent - call deprecated one for coverage for now, replace with Fetch() when it's gone:
errReply, err := jrpc.CallWithPayload[Response](jrpc.NewDestination(url), []byte(`{foo: missing-quotes}`))
if err == nil {
t.Errorf("expected error, got nil and %v", res)
}
var fe *jrpc.FetchError
if !errors.As(err, &fe) {
t.Fatalf("error supposed to be FetchError %v: %v", res, err)
}
if fe.Code != http.StatusBadRequest {
t.Errorf("expected status code %d, got %d", http.StatusBadRequest, fe.Code)
}
if errReply.Message != "request error" {
t.Errorf("unexpected Message in %+v", errReply.Message)
}
expected = "invalid character 'f' looking for beginning of object key string"
if errReply.Exception != expected {
t.Errorf("expected Exception in body to be %q, got %+v", expected, errReply)
}
// bad json response, using GetURL()
errReply, err = jrpc.GetURL[Response](url)
if err == nil {
t.Errorf("expected error %v", errReply)
}
if code != http.StatusBadRequest {
t.Errorf("expected status code 400, got %d - %v - %v", code, err, errReply)
}
if !errReply.Error {
t.Errorf("response unexpectedly marked as not failed: %+v", res)
}
// trigger empty reply
req.SomeInt = -7
res, err = jrpc.CallURL[Response](url, &req)
if err == nil {
t.Errorf("error expected %v: %v", res, err)
}
if !errors.As(err, &fe) {
t.Errorf("error supposed to be FetchError %v: %v", res, err)
}
if fe != nil && fe.Code != 777 {
t.Errorf("error code expected for -7 to be 777: %v: %v", res, err)
}
// trigger server error
req.SomeInt = -8
res, err = jrpc.CallURL[Response](url, &req)
if err == nil {
t.Errorf("error expected %v: %v", res, err)
}
fe = nil
if !errors.As(err, &fe) {
t.Errorf("error supposed to be FetchError %v: %v", res, err)
}
if fe != nil && fe.Code != http.StatusServiceUnavailable {
t.Errorf("error code expected for -8 to be 503: %v: %v", res, err)
}
if !res.Error {
t.Errorf("response supposed to be marked as failed: %+v", res)
}
if res.Message != "simulated server error" {
t.Errorf("didn't get the error message expected for -8: %v: %v", res, err)
}
// trigger bad json response - and non ok code
req.SomeInt = -9
res, err = jrpc.CallURL[Response](url, &req)
if err == nil {
t.Errorf("error expected %v: %v", res, err)
}
fe = nil
if !errors.As(err, &fe) {
t.Errorf("error supposed to be FetchError %v: %v", res, err)
}
if fe != nil && fe.Code != 747 {
t.Errorf("error code expected for -9 to be 747: %v: %v", res, err)
}
unwrap := fe.Unwrap()
if unwrap == nil {
t.Errorf("unwrapped error is nil: %+v", fe)
}
expected = "invalid character 'b' looking for beginning of object key string"
if unwrap.Error() != expected {
t.Errorf("unwrapped error expected to be %q, got %v", expected, unwrap.Error())
}
expected = "non ok http result and deserialization error, code 747: " + expected + " (raw reply: {bad})"
if err.Error() != expected {
t.Errorf("error string expected %q, got %q", expected, err.Error())
}
// trigger bad json response - and ok http code
req.SomeInt = -10
res, err = jrpc.CallURL[Response](url, &req)
if err == nil {
t.Errorf("error expected %v: %v", res, err)
}
expected = "invalid character 'n' looking for beginning of object key string"
if err.Error() != expected {
t.Errorf("error string expected %q, got %q", expected, err.Error())
}
// trigger reply bad serialization
req.SomeInt = -11
res, err = jrpc.CallURL[Response](url, &req)
if err == nil {
t.Errorf("error expected %v", res)
}
expected = "non ok http result, code 500: <nil> (raw reply: )"
if err.Error() != expected {
t.Errorf("error string expected %q, got %q, %+v", expected, err.Error(), res)
}
// Unserializable client side
res, err = jrpc.CallURL[Response](url, &bad)
if err == nil {
t.Errorf("error expected %v", res)
}
expected = "json: unsupported type: chan struct {}"
if err.Error() != expected {
t.Errorf("error string expected %q, got %q, %+v", expected, err.Error(), res)
}
}
func TestJPRCHeaders(t *testing.T) {
mux, addr := fhttp.HTTPServer("test2", "0")
port := addr.(*net.TCPAddr).Port
mux.HandleFunc("/test-headers", func(w http.ResponseWriter, r *http.Request) {
// Send back the headers
jrpc.ReplyOk(w, &r.Header)
})
url := fmt.Sprintf("http://localhost:%d/test-headers", port)
inp := make(http.Header)
inp.Set("Test1", "ValT1.1")
inp.Add("Test1", "ValT1.2")
inp.Set("Test2", "ValT2")
jrpc.SetHeaderIfMissing(inp, "Test2", "ShouldNotSet") // test along the way
dest := &jrpc.Destination{
URL: url,
Headers: &inp,
}
// use the deprecated for coverage. switch to jrpc.Get() in next version
res, err := jrpc.CallNoPayload[http.Header](dest)
if err != nil {
t.Errorf("failed Call: %v", err)
}
// order etc is preserved, keys are not case sensitive (kinda tests go http api too)
assert.Equal(t, res.Values("test1"), []string{"ValT1.1", "ValT1.2"}, "Expecting echoed back Test1 multi valued header")
assert.CheckEquals(t, res.Get("test2"), "ValT2", "Expecting echoed back Test2 header")
}
type ErrReader struct{}
const ErrReaderMessage = "simulated IO error"
func (ErrReader) Read(p []byte) (n int, err error) {
return 0, errors.New(ErrReaderMessage)
}
func TestHandleCallError(t *testing.T) {
r, _ := http.NewRequest(http.MethodGet, "/", ErrReader{})
_, err := jrpc.HandleCall[jrpc.ServerReply](nil, r)
if err == nil {
t.Errorf("expected error, got nil")
}
if err.Error() != ErrReaderMessage {
t.Errorf("expected error %q, got %q", ErrReaderMessage, err.Error())
}
}
func TestSendBadURL(t *testing.T) {
badURL := "bad\001url" // something caught in NewRequest
_, _, err := jrpc.FetchURL(badURL)
if err == nil {
t.Errorf("expected error, got nil")
}
expected := `parse "bad\x01url": net/url: invalid control character in URL`
if err.Error() != expected {
t.Errorf("expected error %q, got %q", expected, err.Error())
}
}
func TestSerializeServerReply(t *testing.T) {
o := &jrpc.ServerReply{}
bytes, err := jrpc.Serialize(o)
if err != nil {
t.Errorf("expected no error, got %v", err)
}
str := string(bytes)
expected := `{}`
if str != expected {
t.Errorf("expected %s, got %s", expected, str)
}
o = jrpc.NewErrorReply("a message", nil)
bytes, err = jrpc.Serialize(o)
if err != nil {
t.Errorf("expected no error, got %v", err)
}
str = string(bytes)
expected = `{"error":true,"message":"a message"}`
if str != expected {
t.Errorf("expected %s, got %s", expected, str)
}
e := errors.New("an error")
o = jrpc.NewErrorReply("a message", e)
bytes, err = jrpc.Serialize(o)
if err != nil {
t.Errorf("expected no error, got %v", err)
}
str = string(bytes)
expected = `{"error":true,"message":"a message","exception":"an error"}`
if str != expected {
t.Errorf("expected %s, got %s", expected, str)
}
}
// Testing slices
type SliceRequest struct {
HowMany int
}
type SliceOneResponse struct {
Index int
Data string
}
func TestJPRCSlices(t *testing.T) {
mux, addr := fhttp.HTTPServer("test3", "0")
port := addr.(*net.TCPAddr).Port
mux.HandleFunc("/test-api-array", func(w http.ResponseWriter, r *http.Request) {
req, err := jrpc.HandleCall[SliceRequest](w, r)
if err != nil {
err = jrpc.ReplyError(w, "request error", err)
if err != nil {
t.Errorf("Error in replying error: %v", err)
}
return
}
n := req.HowMany
if n < 0 {
jrpc.ReplyError(w, "invalid negative count", nil)
return
}
if r.FormValue("errror") != "" {
jrpc.ReplyError(w, "error requested", nil)
return
}
if n == 0 {
n = 42 // for testing of GetArray
}
resp := make([]SliceOneResponse, n)
for i := 0; i < n; i++ {
resp[i] = SliceOneResponse{
Index: i,
Data: fmt.Sprintf("data %d", i),
}
}
jrpc.ReplyOk(w, &resp)
})
url := fmt.Sprintf("http://localhost:%d/test-api-array", port)
req := SliceRequest{10}
res, err := jrpc.CallURL[[]SliceOneResponse](url, &req)
if err != nil {
t.Errorf("failed Call: %v", err)
}
if res == nil {
t.Errorf("nil response")
return
}
slice := *res
if len(slice) != 10 {
t.Errorf("expected 10 results, got %d", len(slice))
}
for i := 0; i < len(slice); i++ {
el := slice[i]
if el.Index != i {
t.Errorf("expected index %d, got %d", i, el.Index)
}
if el.Data != fmt.Sprintf("data %d", i) {
t.Errorf("expected data %d, got %s", i, el.Data)
}
}
slice, err = jrpc.GetArray[SliceOneResponse](jrpc.NewDestination(url))
if err != nil {
t.Errorf("failed GetArray: %v", err)
}
if len(slice) != 42 {
t.Errorf("expected 42 results, got %d", len(slice))
}
for i := 0; i < len(slice); i++ {
el := slice[i]
if el.Index != i {
t.Errorf("expected index %d, got %d", i, el.Index)
}
if el.Data != fmt.Sprintf("data %d", i) {
t.Errorf("expected data %d, got %s", i, el.Data)
}
}
// Empty slice/error
slice, err = jrpc.GetArray[SliceOneResponse](jrpc.NewDestination(url + "?errror=true"))
if err == nil {
t.Errorf("expected error, got nil")
}
if slice != nil {
t.Errorf("expected nil slice, got %v", slice)
}
}