summaryrefslogtreecommitdiffstats
path: root/dependencies/pkg/mod/go.uber.org/zap@v1.23.0/zapcore/error_test.go
diff options
context:
space:
mode:
Diffstat (limited to 'dependencies/pkg/mod/go.uber.org/zap@v1.23.0/zapcore/error_test.go')
-rw-r--r--dependencies/pkg/mod/go.uber.org/zap@v1.23.0/zapcore/error_test.go177
1 files changed, 177 insertions, 0 deletions
diff --git a/dependencies/pkg/mod/go.uber.org/zap@v1.23.0/zapcore/error_test.go b/dependencies/pkg/mod/go.uber.org/zap@v1.23.0/zapcore/error_test.go
new file mode 100644
index 0000000..900f520
--- /dev/null
+++ b/dependencies/pkg/mod/go.uber.org/zap@v1.23.0/zapcore/error_test.go
@@ -0,0 +1,177 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package zapcore_test
+
+import (
+ "errors"
+ "fmt"
+ "io"
+ "testing"
+
+ richErrors "github.com/pkg/errors"
+ "github.com/stretchr/testify/assert"
+
+ "go.uber.org/multierr"
+ . "go.uber.org/zap/zapcore"
+)
+
+type errTooManyUsers int
+
+func (e errTooManyUsers) Error() string {
+ return fmt.Sprintf("%d too many users", int(e))
+}
+
+func (e errTooManyUsers) Format(s fmt.State, verb rune) {
+ // Implement fmt.Formatter, but don't add any information beyond the basic
+ // Error method.
+ if verb == 'v' && s.Flag('+') {
+ io.WriteString(s, e.Error())
+ }
+}
+
+type customMultierr struct{}
+
+func (e customMultierr) Error() string {
+ return "great sadness"
+}
+
+func (e customMultierr) Errors() []error {
+ return []error{
+ errors.New("foo"),
+ nil,
+ multierr.Append(
+ errors.New("bar"),
+ errors.New("baz"),
+ ),
+ }
+}
+
+func TestErrorEncoding(t *testing.T) {
+ tests := []struct {
+ k string
+ t FieldType // defaults to ErrorType
+ iface interface{}
+ want map[string]interface{}
+ }{
+ {
+ k: "k",
+ iface: errTooManyUsers(2),
+ want: map[string]interface{}{
+ "k": "2 too many users",
+ },
+ },
+ {
+ k: "err",
+ iface: multierr.Combine(
+ errors.New("foo"),
+ errors.New("bar"),
+ errors.New("baz"),
+ ),
+ want: map[string]interface{}{
+ "err": "foo; bar; baz",
+ "errCauses": []interface{}{
+ map[string]interface{}{"error": "foo"},
+ map[string]interface{}{"error": "bar"},
+ map[string]interface{}{"error": "baz"},
+ },
+ },
+ },
+ {
+ k: "e",
+ iface: customMultierr{},
+ want: map[string]interface{}{
+ "e": "great sadness",
+ "eCauses": []interface{}{
+ map[string]interface{}{"error": "foo"},
+ map[string]interface{}{
+ "error": "bar; baz",
+ "errorCauses": []interface{}{
+ map[string]interface{}{"error": "bar"},
+ map[string]interface{}{"error": "baz"},
+ },
+ },
+ },
+ },
+ },
+ {
+ k: "k",
+ iface: richErrors.WithMessage(errors.New("egad"), "failed"),
+ want: map[string]interface{}{
+ "k": "failed: egad",
+ "kVerbose": "egad\nfailed",
+ },
+ },
+ {
+ k: "error",
+ iface: multierr.Combine(
+ richErrors.WithMessage(
+ multierr.Combine(errors.New("foo"), errors.New("bar")),
+ "hello",
+ ),
+ errors.New("baz"),
+ richErrors.WithMessage(errors.New("qux"), "world"),
+ ),
+ want: map[string]interface{}{
+ "error": "hello: foo; bar; baz; world: qux",
+ "errorCauses": []interface{}{
+ map[string]interface{}{
+ "error": "hello: foo; bar",
+ "errorVerbose": "the following errors occurred:\n" +
+ " - foo\n" +
+ " - bar\n" +
+ "hello",
+ },
+ map[string]interface{}{"error": "baz"},
+ map[string]interface{}{"error": "world: qux", "errorVerbose": "qux\nworld"},
+ },
+ },
+ },
+ }
+
+ for _, tt := range tests {
+ if tt.t == UnknownType {
+ tt.t = ErrorType
+ }
+
+ enc := NewMapObjectEncoder()
+ f := Field{Key: tt.k, Type: tt.t, Interface: tt.iface}
+ f.AddTo(enc)
+ assert.Equal(t, tt.want, enc.Fields, "Unexpected output from field %+v.", f)
+ }
+}
+
+func TestRichErrorSupport(t *testing.T) {
+ f := Field{
+ Type: ErrorType,
+ Interface: richErrors.WithMessage(richErrors.New("egad"), "failed"),
+ Key: "k",
+ }
+ enc := NewMapObjectEncoder()
+ f.AddTo(enc)
+ assert.Equal(t, "failed: egad", enc.Fields["k"], "Unexpected basic error message.")
+
+ serialized := enc.Fields["kVerbose"]
+ // Don't assert the exact format used by a third-party package, but ensure
+ // that some critical elements are present.
+ assert.Regexp(t, `egad`, serialized, "Expected original error message to be present.")
+ assert.Regexp(t, `failed`, serialized, "Expected error annotation to be present.")
+ assert.Regexp(t, `TestRichErrorSupport`, serialized, "Expected calling function to be present in stacktrace.")
+}