helium/errorhandler_test.go at main · lestrrat-go/helium · 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
148
149
150
151
152
153
154
155
package helium_test

import (
	"errors"
	"io"
	"testing"

	helium "github.com/lestrrat-go/helium"
	"github.com/lestrrat-go/helium/sink"
	"github.com/stretchr/testify/require"
)

// compile-time assertions
var (
	_ helium.ErrorHandler = helium.NilErrorHandler{}
	_ helium.ErrorHandler = (*helium.ErrorCollector)(nil)
	_ io.Closer           = (*helium.ErrorCollector)(nil)
	_ helium.ErrorHandler = (*sink.Sink[error])(nil)
	_ helium.ErrorLeveler = helium.ErrParseError{}
	_ helium.ErrorLeveler = (*helium.DTDValidationError)(nil)
)

func TestNilErrorHandler(t *testing.T) {
	t.Parallel()

	t.Run("handle does not panic", func(t *testing.T) {
		t.Parallel()

		helium.NilErrorHandler{}.Handle(t.Context(), errors.New("should not panic"))
	})

	// NilErrorHandler discards without panicking.
	t.Run("discards a leveled error", func(t *testing.T) {
		t.Parallel()
		var h helium.NilErrorHandler
		h.Handle(t.Context(), helium.NewLeveledError("ignored", helium.ErrorLevelWarning))
	})
}

func TestErrorCollector(t *testing.T) {
	t.Parallel()

	t.Run("collects all", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()
		ec := helium.NewErrorCollector(ctx, helium.ErrorLevelNone)

		want := []string{"one", "two", "three"}
		for _, msg := range want {
			ec.Handle(ctx, errors.New(msg))
		}

		require.NoError(t, ec.Close())

		errs := ec.Errors()
		require.Len(t, errs, len(want))
		for i, err := range errs {
			require.Equal(t, want[i], err.Error())
		}
	})

	t.Run("filters level", func(t *testing.T) {
		t.Parallel()

		tests := []struct {
			name     string
			level    helium.ErrorLevel
			inputs   []error
			wantLen  int
			contains string
		}{
			{
				name:  "warnings only",
				level: helium.ErrorLevelWarning,
				inputs: []error{
					helium.ErrParseError{Err: errors.New("warn"), Level: helium.ErrorLevelWarning},
					helium.ErrParseError{Err: errors.New("err"), Level: helium.ErrorLevelError},
					helium.ErrParseError{Err: errors.New("fatal"), Level: helium.ErrorLevelFatal},
					errors.New("plain"),
				},
				wantLen: 2,
			},
			{
				name:  "fatal only",
				level: helium.ErrorLevelFatal,
				inputs: []error{
					helium.ErrParseError{Err: errors.New("warn"), Level: helium.ErrorLevelWarning},
					helium.ErrParseError{Err: errors.New("fatal"), Level: helium.ErrorLevelFatal},
					errors.New("plain"),
				},
				wantLen:  1,
				contains: "fatal",
			},
		}

		for _, tc := range tests {
			t.Run(tc.name, func(t *testing.T) {
				t.Parallel()

				ctx := t.Context()
				ec := helium.NewErrorCollector(ctx, tc.level)
				for _, in := range tc.inputs {
					ec.Handle(ctx, in)
				}

				require.NoError(t, ec.Close())

				errs := ec.Errors()
				require.Len(t, errs, tc.wantLen)
				if tc.contains != "" {
					require.Contains(t, errs[0].Error(), tc.contains)
				}
			})
		}
	})

	t.Run("returns copy", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()
		ec := helium.NewErrorCollector(ctx, helium.ErrorLevelNone)

		ec.Handle(ctx, errors.New("one"))
		require.NoError(t, ec.Close())

		errs1 := ec.Errors()
		errs2 := ec.Errors()
		require.Equal(t, errs1, errs2)

		errs1[0] = errors.New("modified")
		require.NotEqual(t, errs1[0], ec.Errors()[0])
	})

	t.Run("close idempotent", func(t *testing.T) {
		t.Parallel()

		ec := helium.NewErrorCollector(t.Context(), helium.ErrorLevelNone)
		require.NoError(t, ec.Close())
		require.NoError(t, ec.Close())
	})

	t.Run("plain errors default to warning", func(t *testing.T) {
		t.Parallel()

		ctx := t.Context()

		ec := helium.NewErrorCollector(ctx, helium.ErrorLevelWarning)
		ec.Handle(ctx, errors.New("plain error without ErrorLeveler"))
		require.NoError(t, ec.Close())

		errs := ec.Errors()
		require.Len(t, errs, 1)
	})
}