stack/error_test.go at master · weisbartb/stack · GitHub

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
package stack_test

import (
	"bytes"
	"fmt"
	"github.com/pkg/errors"
	"github.com/rs/zerolog"
	"github.com/stretchr/testify/require"
	"github.com/weisbartb/stack"
	"testing"
)

func TestHasTrace(t *testing.T) {
	var err error = &stack.Error{}
	require.False(t, stack.HasTrace(nil))
	require.False(t, stack.HasTrace(err))
	err = stack.Trace(errors.New("test"))
	require.True(t, stack.HasTrace(err))
	err = errors.New("test")
	require.False(t, stack.HasTrace(err))
}

func TestError_Cause(t *testing.T) {
	var err = &stack.Error{}
	require.Nil(t, err.Cause())
	e := errors.New("test")
	errors.As(stack.Trace(e), &err)
	require.Equal(t, e, err.Cause())
}

func TestError_TopLine(t *testing.T) {
	var err = &stack.Error{}
	_, topLine := err.TopLine()
	require.Empty(t, topLine)
	errors.As(stack.Trace(errors.New("test")), &err)
	_, topLine = err.TopLine()
	require.NotEmpty(t, topLine)
}

func TestError_RawStack(t *testing.T) {
	var err = &stack.Error{}
	require.Nil(t, err.RawStack())
	errors.As(stack.Trace(errors.New("test")), &err)
	require.NotEmpty(t, err.RawStack())
}

func TestError_StackTrace(t *testing.T) {
	var err = &stack.Error{}
	require.Nil(t, err.StackTrace())
	errors.As(stack.Trace(errors.New("test")), &err)
	require.NotEmpty(t, err.StackTrace())
}

func TestWrap(t *testing.T) {
	err := stack.Wrap(nil, "test", stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})
	require.Nil(t, err)
	err = stack.Wrap(errors.New("test error"), "test", stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})
	var typedError *stack.Error
	errors.As(err, &typedError)
	require.NotNil(t, typedError)
	require.Equal(t, "test: test error", typedError.Error())
	require.Len(t, typedError.Extra(), 1)
	err = stack.Wrap(err, "test", stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})
	require.NotNil(t, typedError)
	require.Equal(t, "test: test: test error", typedError.Error())
	require.Len(t, typedError.Extra(), 2)
}

func TestError_Is(t *testing.T) {
	tmpErr := errors.New("test error")
	err := stack.Wrap(tmpErr, "test")
	require.NotNil(t, err)
	require.True(t, errors.Is(err, tmpErr))
	require.False(t, errors.Is(err, errors.New("tmp")))
}
func TestTrace(t *testing.T) {
	err := stack.Trace(nil, stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})
	require.Nil(t, err)
	err = stack.Trace(errors.New("test error"), stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})
	var typedError *stack.Error
	errors.As(err, &typedError)
	require.NotNil(t, typedError)
	require.Equal(t, "test error", typedError.Error())
	require.Len(t, typedError.Extra(), 1)
	err2 := stack.Trace(err, stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})
	require.NotNil(t, typedError)
	require.Equal(t, "test error", typedError.Error())
	require.Len(t, typedError.Extra(), 2)
	require.Equal(t, typedError, err2)
}

func TestZeroLogIntegration(t *testing.T) {
	buf := bytes.Buffer{}
	log := zerolog.New(&buf)
	log.Error().Err(stack.Trace(errors.New("string"), stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	})).Send()
	require.Contains(t, buf.String(), `"extra":[{"test":"val"}]}}`)
	buf2 := bytes.Buffer{}
	log2 := zerolog.New(&buf2)
	log2.Error().Object("embed", stack.ToTypedError(stack.Trace(errors.New("string"), stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	}))).Send()
	require.Contains(t, buf.String(), `"extra":[{"test":"val"}]}}`)
}

func TestError_Format(t *testing.T) {
	val := fmt.Sprintf("%+v", stack.Trace(errors.New("test"), stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	}))
	require.Contains(t, val, "Extra:")
	require.Contains(t, val, "github.com/weisbartb/stack_test.TestError_Format")
	val2 := fmt.Sprintf("%v", stack.Trace(errors.New("test"), stack.ErrorKVP{
		Key:   "test",
		Value: "val",
	}))
	require.NotContains(t, val2, "Extra:")
	require.Contains(t, val, "github.com/weisbartb/stack_test.TestError_Format")
}

func TestTraceToString(t *testing.T) {
	msg := stack.TraceToString(errors.New("test"))
	require.Contains(t, msg, "stack_test.TestTraceToString")
	msg = stack.TraceToString(stack.Trace(errors.New("test")))
	require.Contains(t, msg, "stack_test.TestTraceToString")
}