-
Notifications
You must be signed in to change notification settings - Fork 0
/
e2h_test.go
322 lines (250 loc) · 12 KB
/
e2h_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
/*
Package e2h_test its the test package of the Enhanced Error Handling module
*/
package e2h_test
import (
"fmt"
"os"
"path/filepath"
"runtime"
"strings"
"testing"
"github.com/cdleo/go-commons/formatter"
"github.com/cdleo/go-e2h"
e2hformat "github.com/cdleo/go-e2h/formatter"
"github.com/stretchr/testify/require"
)
func TestEnhancedError_StdErr_RawFormatter_GetSource(t *testing.T) {
// Setup
stdErr := fmt.Errorf("This is a standard error")
rawFormatter, err := e2hformat.NewFormatter(e2hformat.Format_Raw)
require.Nil(t, err)
// Execute
output_raw := rawFormatter.Source(stdErr)
// Check
require.Equal(t, output_raw, stdErr.Error())
}
func TestEnhancedError_StdErr_JSONFormatter_GetSource(t *testing.T) {
// Setup
stdErr := fmt.Errorf("This is a standard error")
jsonFormatter, err := e2hformat.NewFormatter(e2hformat.Format_JSON)
require.Nil(t, err)
// Execute
output_json := jsonFormatter.Source(stdErr)
// Check
require.Equal(t, output_json, "{\"error\":\"This is a standard error\"}")
}
func TestEnhancedError_StdErr_RawFormatter_Format(t *testing.T) {
// Setup
stdErr := fmt.Errorf("This is a standard error")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
params := e2hformat.Params{}
// Execute
output := rawFormatter.Format(stdErr, params)
// Check
require.Equal(t, output, "This is a standard error")
}
func TestEnhancedError_StdErr_JSONFormatter_Format(t *testing.T) {
// Setup
stdErr := fmt.Errorf("This is a standard error")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
params := e2hformat.Params{}
// Execute
outputJSON := jsonFormatter.Format(stdErr, params)
// Check
require.Equal(t, outputJSON, "{\"error\":\"This is a standard error\",\"stack_trace\":[]}")
}
func TestEnhancedError_EnhErr_RawFormatter_GetCause(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
// Execute
output := rawFormatter.Source(enhancedErr)
// Check
require.Equal(t, output, "This is a standard error [Error wrapped with additional info]")
}
func TestEnhancedError_EnhErr_JSONFormatter_GetCause(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
// Execute
output := jsonFormatter.Source(enhancedErr)
// Check
require.Equal(t, output, "{\"error\":\"This is a standard error\",\"context\":\"Error wrapped with additional info\"}")
}
func TestEnhancedError_EnhErr_RawFormatter_Format(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
}
// Execute
output := rawFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "This is a standard error; github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_RawFormatter_Format (e2h_test.go:105) [Error wrapped with additional info];")
}
func TestEnhancedError_EnhErr_JSONFormatter_Format(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
}
// Execute
output := jsonFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "{\"error\":\"This is a standard error\",\"stack_trace\":[{\"func\":\"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_JSONFormatter_Format\",\"caller\":\"e2h_test.go:124\",\"context\":\"Error wrapped with additional info\"}]}")
}
func TestEnhancedError_EnhErr_RawFormatter_Format_Beautified(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
Beautify: true,
}
// Execute
output := rawFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "This is a standard error\ngit.luolix.top/cdleo/go-e2h_test.TestEnhancedError_EnhErr_RawFormatter_Format_Beautified (e2h_test.go:143)\n\tError wrapped with additional info")
}
func TestEnhancedError_EnhErr_JSONFormatter_Format_Beautified(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
Beautify: true,
}
// Execute
output := jsonFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "{\n\t\"error\": \"This is a standard error\",\n\t\"stack_trace\": [\n\t\t{\n\t\t\t\"func\": \"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_JSONFormatter_Format_Beautified\",\n\t\t\t\"caller\": \"e2h_test.go:163\",\n\t\t\t\"context\": \"Error wrapped with additional info\"\n\t\t}\n\t]\n}")
}
func TestEnhancedError_EnhErr_RawFormatter_Format_Inverted(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
InvertCallstack: true,
}
// Execute
output := rawFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_RawFormatter_Format_Inverted (e2h_test.go:183) [Error wrapped with additional info]; This is a standard error;")
}
func TestEnhancedError_EnhErr_JSONFormatter_Format_Inverted(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
InvertCallstack: true,
}
// Execute
output := jsonFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "{\"error\":\"This is a standard error\",\"stack_trace\":[{\"func\":\"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_JSONFormatter_Format_Inverted\",\"caller\":\"e2h_test.go:203\",\"context\":\"Error wrapped with additional info\"}]}")
}
func TestEnhancedError_EnhErr_RawFormatter_Format_FullPathHidden(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
}
// Execute
output := rawFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "This is a standard error; github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_RawFormatter_Format_FullPathHidden (e2h_test.go:223) [Error wrapped with additional info];")
}
func TestEnhancedError_EnhErr_JSONFormatter_Format_FullPathHidden(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
}
// Execute
output := jsonFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "{\"error\":\"This is a standard error\",\"stack_trace\":[{\"func\":\"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_JSONFormatter_Format_FullPathHidden\",\"caller\":\"e2h_test.go:242\",\"context\":\"Error wrapped with additional info\"}]}")
}
func TestEnhancedError_EnhErr_RawFormatter_Format_PartialPathHidden(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
rawFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_Raw)
_, b, _, _ := runtime.Caller(0)
path := strings.Split(filepath.Dir(b), string(os.PathSeparator))
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_ToFolder,
PathHidingValue: path[len(path)-1],
}
// Execute
output := rawFormatter.Format(enhancedErr, params)
want := strings.ReplaceAll("This is a standard error; github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_RawFormatter_Format_PartialPathHidden (<LAST_DIR>/e2h_test.go:261) [Error wrapped with additional info];",
"<LAST_DIR>", params.PathHidingValue)
// Check
require.Equal(t, want, output)
}
func TestEnhancedError_EnhErr_JSONFormatter_Format_PartialPathHidden(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
_, b, _, _ := runtime.Caller(0)
path := strings.Split(filepath.Dir(b), string(os.PathSeparator))
params := e2hformat.Params{
PathHidingMethod: formatter.HidingMethod_ToFolder,
PathHidingValue: path[len(path)-1],
}
// Execute
output := jsonFormatter.Format(enhancedErr, params)
want := strings.ReplaceAll("{\"error\":\"This is a standard error\",\"stack_trace\":[{\"func\":\"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhErr_JSONFormatter_Format_PartialPathHidden\",\"caller\":\"<LAST_DIR>/e2h_test.go:283\",\"context\":\"Error wrapped with additional info\"}]}",
"<LAST_DIR>", params.PathHidingValue)
// Check
require.Equal(t, want, output)
}
func TestEnhancedError_EnhError_JSONFormatter_Format_MultipleTraces(t *testing.T) {
// Setup
enhancedErr := e2h.Tracem(fmt.Errorf("This is a standard error"), "Error wrapped with additional info")
enhancedErr = e2h.Tracef(enhancedErr, "This is the %dnd. stack level", 2)
enhancedErr = e2h.Trace(enhancedErr)
jsonFormatter, _ := e2hformat.NewFormatter(e2hformat.Format_JSON)
_, b, _, _ := runtime.Caller(0)
hideThisPath := filepath.Dir(b) + string(os.PathSeparator)
params := e2hformat.Params{
Beautify: true,
PathHidingMethod: formatter.HidingMethod_FullBaseline,
PathHidingValue: hideThisPath,
}
// Execute
output := jsonFormatter.Format(enhancedErr, params)
// Check
require.Equal(t, output, "{\n\t\"error\": \"This is a standard error\",\n\t\"stack_trace\": [\n\t\t{\n\t\t\t\"func\": \"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhError_JSONFormatter_Format_MultipleTraces\",\n\t\t\t\"caller\": \"e2h_test.go:305\",\n\t\t\t\"context\": \"Error wrapped with additional info\"\n\t\t},\n\t\t{\n\t\t\t\"func\": \"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhError_JSONFormatter_Format_MultipleTraces\",\n\t\t\t\"caller\": \"e2h_test.go:306\",\n\t\t\t\"context\": \"This is the 2nd. stack level\"\n\t\t},\n\t\t{\n\t\t\t\"func\": \"github.com/cdleo/go-e2h_test.TestEnhancedError_EnhError_JSONFormatter_Format_MultipleTraces\",\n\t\t\t\"caller\": \"e2h_test.go:307\"\n\t\t}\n\t]\n}")
}