mirror of
https://github.com/protocolbuffers/protobuf-go.git
synced 2024-12-29 12:17:48 +00:00
9834a7df51
This adds package errors, which provides error handling constructs that are
specific to the protobuf repo. In particular, it provides a NonFatal type
which is useful for capturing non-fatal errors like invalid UTF-8 and required
fields not set.
High-level API:
type NonFatalErrors []error
func (NonFatalErrors) Error() string
type NonFatal struct{ ... }
func (*NonFatal) Merge(err error) (ok bool)
func (*NonFatal) AppendInvalidUTF8(field string)
func (*NonFatal) AppendRequiredNotSet(field string)
func New(string, ...interface{}) error
Change-Id: I9448c586008240e8987573fe79e0ffb024e7629d
Reviewed-on: https://go-review.googlesource.com/127338
Reviewed-by: Damien Neil <dneil@google.com>
Reviewed-by: Herbie Ong <herbie@google.com>
94 lines
2.3 KiB
Go
94 lines
2.3 KiB
Go
// Copyright 2018 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package errors
|
|
|
|
import (
|
|
"errors"
|
|
"reflect"
|
|
"testing"
|
|
)
|
|
|
|
func TestNonFatal(t *testing.T) {
|
|
type (
|
|
method = interface{} // merge | appendRequiredNotSet | appendInvalidUTF8
|
|
merge struct {
|
|
inErr error
|
|
wantOk bool
|
|
}
|
|
appendRequiredNotSet struct{ inField string }
|
|
appendInvalidUTF8 struct{ inField string }
|
|
)
|
|
|
|
tests := []struct {
|
|
label string
|
|
methods []method
|
|
wantErr error
|
|
}{{
|
|
label: "IgnoreNil",
|
|
methods: []method{
|
|
merge{inErr: nil, wantOk: true},
|
|
},
|
|
}, {
|
|
label: "IgnoreFatal",
|
|
methods: []method{
|
|
merge{inErr: errors.New("fatal error")},
|
|
},
|
|
}, {
|
|
label: "MergeNonFatal",
|
|
methods: []method{
|
|
appendRequiredNotSet{"foo"},
|
|
merge{inErr: customRequiredNotSetError{}, wantOk: true},
|
|
appendInvalidUTF8{"bar"},
|
|
merge{inErr: customInvalidUTF8Error{}, wantOk: true},
|
|
merge{inErr: NonFatalErrors{
|
|
requiredNotSetError("fizz"),
|
|
invalidUTF8Error("buzz"),
|
|
}, wantOk: true},
|
|
merge{inErr: errors.New("fatal error")}, // not stored
|
|
},
|
|
wantErr: NonFatalErrors{
|
|
requiredNotSetError("foo"),
|
|
customRequiredNotSetError{},
|
|
invalidUTF8Error("bar"),
|
|
customInvalidUTF8Error{},
|
|
requiredNotSetError("fizz"),
|
|
invalidUTF8Error("buzz"),
|
|
},
|
|
}}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.label, func(t *testing.T) {
|
|
var nerr NonFatal
|
|
for _, m := range tt.methods {
|
|
switch m := m.(type) {
|
|
case merge:
|
|
if gotOk := nerr.Merge(m.inErr); gotOk != m.wantOk {
|
|
t.Errorf("Merge() = %v, want %v", gotOk, m.wantOk)
|
|
}
|
|
case appendRequiredNotSet:
|
|
nerr.AppendRequiredNotSet(m.inField)
|
|
case appendInvalidUTF8:
|
|
nerr.AppendInvalidUTF8(m.inField)
|
|
default:
|
|
t.Fatalf("invalid method: %T", m)
|
|
}
|
|
}
|
|
if !reflect.DeepEqual(nerr.E, tt.wantErr) {
|
|
t.Errorf("NonFatal.E = %v, want %v", nerr.E, tt.wantErr)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
type customInvalidUTF8Error struct{}
|
|
|
|
func (customInvalidUTF8Error) Error() string { return "invalid UTF-8 detected" }
|
|
func (customInvalidUTF8Error) InvalidUTF8() bool { return true }
|
|
|
|
type customRequiredNotSetError struct{}
|
|
|
|
func (customRequiredNotSetError) Error() string { return "required field not set" }
|
|
func (customRequiredNotSetError) RequiredNotSet() bool { return true }
|