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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
package helper
import (
"errors"
"fmt"
"strings"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v15/proto/go/gitalypb"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/proto"
)
func TestError(t *testing.T) {
errorMessage := "sentinel error"
input := errors.New(errorMessage)
inputGRPCCode := codes.Unauthenticated
inputGRPC := status.Error(inputGRPCCode, errorMessage)
for _, tc := range []struct {
desc string
errorf func(err error) error
code codes.Code
}{
{
desc: "Canceled",
errorf: ErrCanceled,
code: codes.Canceled,
},
{
desc: "Internal",
errorf: ErrInternal,
code: codes.Internal,
},
{
desc: "InvalidArgument",
errorf: ErrInvalidArgument,
code: codes.InvalidArgument,
},
{
desc: "FailedPrecondition",
errorf: ErrFailedPrecondition,
code: codes.FailedPrecondition,
},
{
desc: "NotFound",
errorf: ErrNotFound,
code: codes.NotFound,
},
{
desc: "Unavailable",
errorf: ErrUnavailable,
code: codes.Unavailable,
},
{
desc: "AlreadyExists",
errorf: ErrAlreadyExists,
code: codes.AlreadyExists,
},
{
desc: "Aborted",
errorf: ErrAborted,
code: codes.Aborted,
},
} {
t.Run(tc.desc, func(t *testing.T) {
// tc.code and our canary test code must not
// clash!
require.NotEqual(t, tc.code, inputGRPCCode)
// When not re-throwing an error we get the
// GRPC error code corresponding to the
// function's name.
err := tc.errorf(input)
require.EqualError(t, err, errorMessage)
require.False(t, errors.Is(err, inputGRPC))
require.Equal(t, tc.code, status.Code(err))
// When re-throwing an error an existing GRPC
// error code will get preserved, instead of
// the one corresponding to the function's
// name.
err = tc.errorf(inputGRPC)
require.True(t, errors.Is(err, inputGRPC))
require.False(t, errors.Is(err, input))
require.Equal(t, inputGRPCCode, status.Code(err))
require.NotEqual(t, tc.code, status.Code(inputGRPC))
})
}
}
func TestErrorF_withVFormat(t *testing.T) {
testErrorfFormat(t, "expected %v", "expected %v")
}
func TestErrorF_withWFormat(t *testing.T) {
testErrorfFormat(t, "expected %w", "expected %s")
}
func testErrorfFormat(t *testing.T, errorFormat, errorFormatEqual string) {
isFormatW := strings.Contains(errorFormat, "%w")
errorMessage := "sentinel error"
input := errors.New(errorMessage)
inputGRPCCode := codes.Unauthenticated
inputGRPC := status.Error(inputGRPCCode, errorMessage)
inputGRPCFmt := status.Errorf(inputGRPCCode, errorFormat, errorMessage)
for _, tc := range []struct {
desc string
errorf func(format string, a ...interface{}) error
code codes.Code
}{
{
desc: "Internalf",
errorf: ErrInternalf,
code: codes.Internal,
},
{
desc: "InvalidArgumentf",
errorf: ErrInvalidArgumentf,
code: codes.InvalidArgument,
},
{
desc: "FailedPreconditionf",
errorf: ErrFailedPreconditionf,
code: codes.FailedPrecondition,
},
{
desc: "NotFoundf",
errorf: ErrNotFoundf,
code: codes.NotFound,
},
{
desc: "ErrUnavailablef",
errorf: ErrUnavailablef,
code: codes.Unavailable,
},
{
desc: "ErrAbortedf",
errorf: ErrAbortedf,
code: codes.Aborted,
},
} {
t.Run(tc.desc, func(t *testing.T) {
require.NotEqual(t, tc.code, inputGRPCCode, "canary test code and tc.code may not be the same")
// When not re-throwing an error we get the GRPC error code corresponding to
// the function's name. Just like the non-f functions.
err := tc.errorf(errorFormat, input)
require.EqualError(t, err, fmt.Sprintf(errorFormatEqual, errorMessage))
require.False(t, errors.Is(err, inputGRPC))
require.Equal(t, tc.code, status.Code(err))
// When wrapping an existing gRPC error, then the error code will stay the
// same.
err = tc.errorf(errorFormat, inputGRPCFmt)
require.False(t, errors.Is(err, input))
if isFormatW {
require.Equal(t, inputGRPCCode, status.Code(err))
} else {
require.Equal(t, tc.code, status.Code(err))
}
require.NotEqual(t, tc.code, status.Code(inputGRPC))
// The same as above, except that we test with an error returned by
// `status.Error()`.
errX := tc.errorf(errorFormat, inputGRPC)
require.Equal(t, errors.Is(errX, inputGRPC), isFormatW) // .True() for non-f
require.False(t, errors.Is(errX, input))
if isFormatW {
require.Equal(t, inputGRPCCode, status.Code(errX))
} else {
require.Equal(t, tc.code, status.Code(errX))
}
require.Equal(t, inputGRPCCode, status.Code(inputGRPC))
})
}
}
func TestErrWithDetails(t *testing.T) {
for _, tc := range []struct {
desc string
err error
details []proto.Message
expectedErr error
expectedMessage string
expectedDetails []proto.Message
expectedCode codes.Code
}{
{
desc: "no error",
expectedErr: errors.New("no error given"),
},
{
desc: "status with OK code",
err: status.Error(codes.OK, "message"),
expectedErr: errors.New("no error given"),
},
{
desc: "normal error",
err: errors.New("message"),
expectedErr: errors.New("error is not a gRPC status"),
},
{
desc: "status",
err: status.Error(codes.FailedPrecondition, "message"),
expectedMessage: "rpc error: code = FailedPrecondition desc = message",
expectedCode: codes.FailedPrecondition,
},
{
desc: "status with details",
err: status.Error(codes.FailedPrecondition, "message"),
details: []proto.Message{
&gitalypb.Repository{},
},
expectedMessage: "rpc error: code = FailedPrecondition desc = message",
expectedCode: codes.FailedPrecondition,
expectedDetails: []proto.Message{
&gitalypb.Repository{},
},
},
{
desc: "status with multiple details",
err: status.Error(codes.FailedPrecondition, "message"),
details: []proto.Message{
&gitalypb.Repository{RelativePath: "a"},
&gitalypb.Repository{RelativePath: "b"},
},
expectedMessage: "rpc error: code = FailedPrecondition desc = message",
expectedCode: codes.FailedPrecondition,
expectedDetails: []proto.Message{
&gitalypb.Repository{RelativePath: "a"},
&gitalypb.Repository{RelativePath: "b"},
},
},
{
desc: "status with mixed type details",
err: status.Error(codes.FailedPrecondition, "message"),
details: []proto.Message{
&gitalypb.Repository{},
&gitalypb.GitCommit{},
},
expectedMessage: "rpc error: code = FailedPrecondition desc = message",
expectedCode: codes.FailedPrecondition,
expectedDetails: []proto.Message{
&gitalypb.Repository{},
&gitalypb.GitCommit{},
},
},
} {
t.Run(tc.desc, func(t *testing.T) {
detailedErr, err := ErrWithDetails(tc.err, tc.details...)
require.Equal(t, tc.expectedErr, err)
if err != nil {
return
}
require.Equal(t, tc.expectedMessage, detailedErr.Error())
st, ok := status.FromError(detailedErr)
require.True(t, ok, "error should be a status")
require.Equal(t, tc.expectedCode, st.Code())
statusProto := st.Proto()
require.NotNil(t, statusProto)
var details []proto.Message
for _, detail := range statusProto.GetDetails() {
detailProto, err := detail.UnmarshalNew()
require.NoError(t, err)
details = append(details, detailProto)
}
testhelper.ProtoEqual(t, tc.expectedDetails, details)
})
}
}
|