forked from trpc-group/trpc-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy patherrs_test.go
381 lines (310 loc) · 10.3 KB
/
errs_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
//
//
// Tencent is pleased to support the open source community by making tRPC available.
//
// Copyright (C) 2023 THL A29 Limited, a Tencent company.
// All rights reserved.
//
// If you have downloaded a copy of the tRPC source code from Tencent,
// please note that tRPC source code is licensed under the Apache 2.0 License,
// A copy of the Apache 2.0 License is included in this file.
//
//
package errs_test
import (
"bufio"
"bytes"
"errors"
"fmt"
"os"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"trpc.group/trpc/trpc-protocol/pb/go/trpc"
"trpc.group/trpc-go/trpc-go/errs"
)
// go test -v -coverprofile=cover.out
// go tool cover -func=cover.out
func TestErrs(t *testing.T) {
var err *errs.Error
str := err.Error()
assert.Contains(t, str, "success")
e := errs.New(111, "inner fail")
assert.NotNil(t, e)
assert.EqualValues(t, 111, errs.Code(e))
assert.Equal(t, "inner fail", errs.Msg(e))
err, ok := e.(*errs.Error)
assert.Equal(t, true, ok)
assert.NotNil(t, err)
assert.Equal(t, errs.ErrorTypeBusiness, err.Type)
str = err.Error()
assert.Contains(t, str, "business")
e = errs.NewFrameError(111, "inner fail")
assert.NotNil(t, e)
assert.EqualValues(t, 111, errs.Code(e))
assert.Equal(t, "inner fail", errs.Msg(e))
err, ok = e.(*errs.Error)
assert.Equal(t, true, ok)
assert.NotNil(t, err)
assert.Equal(t, errs.ErrorTypeFramework, err.Type)
str = err.Error()
assert.Contains(t, str, "framework")
assert.EqualValues(t, 0, errs.Code(nil))
assert.Equal(t, "success", errs.Msg(nil))
assert.EqualValues(t, 0, errs.Code((*errs.Error)(nil)))
assert.Equal(t, "success", errs.Msg((*errs.Error)(nil)))
e = errors.New("unknown error")
assert.Equal(t, errs.RetUnknown, errs.Code(e))
assert.Equal(t, "unknown error", errs.Msg(e))
err.Type = errs.ErrorTypeCalleeFramework
assert.Contains(t, err.Error(), "type:callee framework")
}
func TestNonEmptyStringOnEmptyMsg(t *testing.T) {
e := errs.New(errs.RetServerSystemErr, "")
require.Contains(t, e.Error(), "code:")
require.Contains(t, e.Error(), "type:")
}
func TestErrsFormat(t *testing.T) {
err := errs.New(10000, "test error")
s := fmt.Sprintf("%s", err)
assert.Equal(t, "type:business, code:10000, msg:test error", s)
s = fmt.Sprintf("%q", err)
assert.Equal(t, `"type:business, code:10000, msg:test error"`, s)
s = fmt.Sprintf("%v", err)
assert.Equal(t, "type:business, code:10000, msg:test error", s)
s = fmt.Sprintf("%d", err)
assert.Equal(t, "%!d(errs.Error=type:business, code:10000, msg:test error)", s)
}
func TestNewFrameError(t *testing.T) {
ok := true
errs.SetTraceable(ok)
e := errs.NewFrameError(111, "inner fail")
assert.NotNil(t, e)
}
func TestWrapFrameError(t *testing.T) {
ok := true
errs.SetTraceable(ok)
e := errs.WrapFrameError(errs.New(123, "inner fail"), 456, "wrap frame error")
assert.NotNil(t, e)
e = errs.WrapFrameError(nil, 456, "wrap frame error")
assert.Nil(t, e)
}
func TestTraceError(t *testing.T) {
errs.SetTraceable(true)
err := parent()
assert.NotNil(t, err)
s := fmt.Sprintf("%+v", err)
br := bufio.NewReader(strings.NewReader(s))
line, isPrefix, err := br.ReadLine()
assert.Equal(t, "type:business, code:111, msg:inner fail", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.grandson", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
_, _, _ = br.ReadLine()
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.child", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
_, _, _ = br.ReadLine()
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.parent", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
}
func TestTraceErrorSetStackSkip(t *testing.T) {
errs.SetTraceable(true)
errs.SetStackSkip(4)
err := func() error {
return func() error {
return newMyErr(11, "TestTraceErrorSetStackSkip error")
}()
}()
assert.NotNil(t, err)
s := fmt.Sprintf("%+v", err)
br := bufio.NewReader(strings.NewReader(s))
line, isPrefix, err := br.ReadLine()
assert.Equal(t, "type:business, code:11, msg:TestTraceErrorSetStackSkip error", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
t.Log(string(line))
assert.Contains(t, string(line), "trpc.group/trpc-go/trpc-go/errs_test.TestTraceErrorSetStackSkip")
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
_, _, _ = br.ReadLine()
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.TestTraceErrorSetStackSkip.func1", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
_, _, _ = br.ReadLine()
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.TestTraceErrorSetStackSkip", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
}
func newMyErr(code int, msg string) error {
return errs.New(code, msg)
}
// TestSetTraceableWithContent SetTraceableWithContent interface test case,
// filter and print stack information according to Content.
func TestSetTraceableWithContent(t *testing.T) {
errs.SetTraceableWithContent("child")
err := parent()
assert.NotNil(t, err)
s := fmt.Sprintf("%+v", err)
br := bufio.NewReader(strings.NewReader(s))
line, isPrefix, err := br.ReadLine()
assert.Equal(t, "type:business, code:111, msg:inner fail", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.child", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
}
func TestErrorChain(t *testing.T) {
var e error = errs.Wrap(os.ErrDeadlineExceeded, int(trpc.TrpcRetCode_TRPC_CLIENT_INVOKE_TIMEOUT_ERR), "just wrap")
require.Contains(t, errs.Msg(e), os.ErrDeadlineExceeded.Error())
e = fmt.Errorf("%w", e)
require.Equal(t, trpc.TrpcRetCode_TRPC_CLIENT_INVOKE_TIMEOUT_ERR, errs.Code(e))
require.True(t, errors.Is(e, os.ErrDeadlineExceeded))
require.Contains(t, e.Error(), os.ErrDeadlineExceeded.Error())
}
func TestWrap(t *testing.T) {
err := parent()
assert.NotNil(t, err)
err = errs.Wrap(err, 222, "wrap err")
assert.NotNil(t, err)
s := fmt.Sprintf("%v", err)
assert.Contains(t, s, "type:business, code:222, msg:wrap err")
s = fmt.Sprintf("%s", err)
assert.Contains(t, s, "type:business, code:222, msg:wrap err")
s = fmt.Sprintf("%+v", err)
br := bufio.NewReader(strings.NewReader(s))
line, isPrefix, err := br.ReadLine()
assert.Equal(t, "type:business, code:222, msg:wrap err", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "Cause by type:business, code:111, msg:inner fail", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
}
func TestWrapf(t *testing.T) {
err := parent()
assert.NotNil(t, err)
err = errs.Wrapf(err, 222, "wrap %v", "err")
assert.NotNil(t, err)
s := fmt.Sprintf("%+v", err)
br := bufio.NewReader(strings.NewReader(s))
line, isPrefix, err := br.ReadLine()
assert.Equal(t, "type:business, code:222, msg:wrap err", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "Cause by type:business, code:111, msg:inner fail", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
}
func TestWrapSetTraceable(t *testing.T) {
// reset
errs.SetStackSkip(3)
errs.SetTraceableWithContent("")
err := parent()
assert.NotNil(t, err)
err = errs.Wrap(err, 222, "wrap err")
assert.NotNil(t, err)
s := fmt.Sprintf("%+v", err)
br := bufio.NewReader(strings.NewReader(s))
line, isPrefix, err := br.ReadLine()
assert.Equal(t, "type:business, code:222, msg:wrap err", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "Cause by type:business, code:111, msg:inner fail", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
line, isPrefix, err = br.ReadLine()
assert.Equal(t, "trpc.group/trpc-go/trpc-go/errs_test.grandson", string(line))
assert.Equal(t, isPrefix, false)
assert.Nil(t, err)
}
func TestIsTimeout(t *testing.T) {
require.True(t, (&errs.Error{
Type: errs.ErrorTypeFramework,
Code: trpc.TrpcRetCode_TRPC_CLIENT_INVOKE_TIMEOUT_ERR,
}).IsTimeout(errs.ErrorTypeFramework))
require.True(t, (&errs.Error{
Type: errs.ErrorTypeCalleeFramework,
Code: trpc.TrpcRetCode_TRPC_CLIENT_INVOKE_TIMEOUT_ERR,
}).IsTimeout(errs.ErrorTypeCalleeFramework))
require.False(t, (&errs.Error{
Type: errs.ErrorTypeBusiness,
Code: trpc.TrpcRetCode_TRPC_CLIENT_INVOKE_TIMEOUT_ERR,
}).IsTimeout(errs.ErrorTypeFramework))
require.True(t, (&errs.Error{
Type: errs.ErrorTypeFramework,
Code: trpc.TrpcRetCode_TRPC_CLIENT_FULL_LINK_TIMEOUT_ERR,
}).IsTimeout(errs.ErrorTypeFramework))
require.True(t, (&errs.Error{
Type: errs.ErrorTypeFramework,
Code: trpc.TrpcRetCode_TRPC_SERVER_TIMEOUT_ERR,
}).IsTimeout(errs.ErrorTypeFramework))
require.True(t, (&errs.Error{
Type: errs.ErrorTypeFramework,
Code: trpc.TrpcRetCode_TRPC_SERVER_FULL_LINK_TIMEOUT_ERR,
}).IsTimeout(errs.ErrorTypeFramework))
require.False(t, (&errs.Error{
Type: errs.ErrorTypeFramework,
Code: errs.RetServerNoService,
}).IsTimeout(errs.ErrorTypeFramework))
}
func TestErrorFormatPrint(t *testing.T) {
errs.SetTraceable(false)
defer errs.SetTraceable(true)
err := errs.New(errs.ErrorTypeFramework, "")
var buf bytes.Buffer
fmt.Fprintf(&buf, "%+v", err)
require.Equal(t, "type:business, code:1, msg:", buf.String())
}
func TestNestErrors(t *testing.T) {
errs.SetTraceable(false)
defer errs.SetTraceable(true)
const (
code trpc.TrpcRetCode = 101
msg = "test error"
)
require.Equal(t, code, errs.Code(&testError{Err: errs.New(code, msg)}))
require.Equal(t, msg, errs.Msg(&testError{Err: errs.New(code, msg)}))
}
type testError struct {
Err error
}
func (te *testError) Error() string {
return te.Err.Error()
}
func (te *testError) Unwrap() error {
return te.Err
}
//go:noinline
func parent() error {
if err := child(); err != nil {
return err
}
return nil
}
//go:noinline
func child() error {
if err := grandson(); err != nil {
return err
}
return nil
}
//go:noinline
func grandson() error {
return errs.Newf(111, "%s", "inner fail")
}