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
|
/*
Copyright 2017 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package spanner
import (
"context"
"errors"
"strings"
"testing"
"github.com/googleapis/gax-go/v2/apierror"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
type wrappedTestError struct {
wrapped error
msg string
}
func (w *wrappedTestError) Error() string {
return w.msg
}
func (w *wrappedTestError) Unwrap() error {
return w.wrapped
}
func TestToSpannerError(t *testing.T) {
for _, test := range []struct {
err error
wantCode codes.Code
wantMsg string
wantWrappedError error
}{
{errors.New("wha?"), codes.Unknown, `spanner: code = "Unknown", desc = "wha?"`, errors.New("wha?")},
{context.Canceled, codes.Canceled, `spanner: code = "Canceled", desc = "context canceled"`, status.Errorf(codes.Canceled, "context canceled")},
{context.DeadlineExceeded, codes.DeadlineExceeded, `spanner: code = "DeadlineExceeded", desc = "context deadline exceeded"`, status.Errorf(codes.DeadlineExceeded, "context deadline exceeded")},
{status.Errorf(codes.ResourceExhausted, "so tired"), codes.ResourceExhausted, `spanner: code = "ResourceExhausted", desc = "so tired"`, status.Errorf(codes.ResourceExhausted, "so tired")},
{spannerErrorf(codes.InvalidArgument, "bad"), codes.InvalidArgument, `spanner: code = "InvalidArgument", desc = "bad"`, status.Errorf(codes.InvalidArgument, "bad")},
{&wrappedTestError{
wrapped: spannerErrorf(codes.Aborted, "Transaction aborted"),
msg: "error with wrapped Spanner error",
}, codes.Aborted, `spanner: code = "Aborted", desc = "Transaction aborted"`, status.Errorf(codes.Aborted, "Transaction aborted")},
{&wrappedTestError{
wrapped: errors.New("wha?"),
msg: "error with wrapped non-gRPC and non-Spanner error",
}, codes.Unknown, `spanner: code = "Unknown", desc = "error with wrapped non-gRPC and non-Spanner error"`,
&wrappedTestError{
wrapped: errors.New("wha?"),
msg: "error with wrapped non-gRPC and non-Spanner error"}},
} {
err := ToSpannerError(test.err)
errDuringCommit := toSpannerErrorWithCommitInfo(test.err, true)
if got, want := ErrCode(err), test.wantCode; got != want {
t.Errorf("%v: got %s, want %s", test.err, got, want)
}
converted := status.Convert(err)
if converted.Code() != test.wantCode {
t.Errorf("%v: got status %v, want status %v", test.err, converted.Code(), test.wantCode)
}
if got, want := err.Error(), test.wantMsg; got != want {
t.Errorf("%v: got msg %s, want mgs %s", test.err, got, want)
}
if got, want := err.(*Error).err, test.wantWrappedError; got.Error() != want.Error() {
t.Errorf("%v: Wrapped mismatch\nGot: %v\nWant: %v", test.err, got, want)
}
code := status.Code(errDuringCommit)
gotWrappedDuringCommit := errDuringCommit.(*Error).err
// Only DEADLINE_EXCEEDED and CANCELED should indicate that the
// transaction outcome is unknown.
if code == codes.DeadlineExceeded || code == codes.Canceled {
if !strings.Contains(errDuringCommit.Error(), transactionOutcomeUnknownMsg) {
t.Errorf(`%v: Missing %q from error during commit.\nGot: %v`, test.err, transactionOutcomeUnknownMsg, errDuringCommit)
}
wantWrappedDuringCommit := &TransactionOutcomeUnknownError{}
if gotWrappedDuringCommit.Error() != wantWrappedDuringCommit.Error() {
t.Errorf("%v: Wrapped commit error mismatch\nGot: %v\nWant: %v", test.err, gotWrappedDuringCommit, wantWrappedDuringCommit)
}
} else {
if strings.Contains(errDuringCommit.Error(), transactionOutcomeUnknownMsg) {
t.Errorf(`%v: Got unexpected %q in error during commit.\nGot: %v`, test.err, transactionOutcomeUnknownMsg, errDuringCommit)
}
wantWrappedDuringCommit := test.wantWrappedError
if gotWrappedDuringCommit.Error() != wantWrappedDuringCommit.Error() {
t.Errorf("%v: Wrapped commit error mismatch\nGot: %v\nWant: %v", test.err, gotWrappedDuringCommit, wantWrappedDuringCommit)
}
}
}
}
func TestAPIErrorBackwardCompatibility(t *testing.T) {
apiError, _ := apierror.FromError(status.Error(codes.InvalidArgument, "bad"))
testCases := []struct {
name string
clientError error
want *apierror.APIError
}{
{
name: "when client returns spanner.Error",
clientError: spannerErrorf(codes.InvalidArgument, "bad"),
want: apiError,
},
{
name: "when client returns apierror.APIError",
clientError: apiError,
want: apiError,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
var got *apierror.APIError
ok := errorAs(tc.clientError, &got)
if !ok {
t.Error("error unwrapping spanner.Error to apierror.APIError")
}
if got.Error() != tc.want.Error() {
t.Errorf("Wrapped error mismatch\nGot: %v\nWant: %v", got, tc.want)
}
})
}
}
|
