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
|
package structerr_tests
import (
"context"
"errors"
"fmt"
"net"
"testing"
grpcmw "github.com/grpc-ecosystem/go-grpc-middleware"
grpcmwlogrus "github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
"github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/proto/v15/go/gitalypb/testproto"
"gitlab.com/gitlab-org/gitaly/v15/internal/log"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v15/structerr"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/status"
"google.golang.org/grpc/test/grpc_testing"
)
func TestInterceptedError(t *testing.T) {
t.Parallel()
for _, tc := range []struct {
desc string
err error
expectedErr error
}{
{
desc: "normal error",
err: fmt.Errorf("test"),
expectedErr: fmt.Errorf("test"),
},
{
desc: "structured error",
err: structerr.NewNotFound("not found"),
expectedErr: structerr.NewNotFound("not found"),
},
{
desc: "wrapped structured error",
err: fmt.Errorf("wrapped: %w", structerr.NewNotFound("not found")),
expectedErr: fmt.Errorf("wrapped: %w", structerr.NewNotFound("not found")),
},
{
desc: "metadata",
err: structerr.NewNotFound("not found").WithMetadata("key", "value"),
expectedErr: structerr.NewNotFound("not found").WithDetail(
&testproto.ErrorMetadata{
Key: []byte("key"),
Value: []byte("value"),
},
),
},
{
desc: "wrapped error with metadata",
err: fmt.Errorf("wrapped: %w", structerr.NewNotFound("not found").WithMetadata("key", "value")),
expectedErr: structerr.NewNotFound("wrapped: not found").WithDetail(
&testproto.ErrorMetadata{
Key: []byte("key"),
Value: []byte("value"),
},
),
},
} {
t.Run(tc.desc, func(t *testing.T) {
err := structerr.StreamInterceptor(nil, nil, nil, func(srv interface{}, stream grpc.ServerStream) error {
return tc.err
})
testhelper.RequireGrpcError(t, tc.expectedErr, err)
})
}
}
type mockService struct {
grpc_testing.UnimplementedTestServiceServer
err error
}
func (m *mockService) UnaryCall(
context.Context, *grpc_testing.SimpleRequest,
) (*grpc_testing.SimpleResponse, error) {
return &grpc_testing.SimpleResponse{}, m.err
}
func TestFieldsProducer(t *testing.T) {
t.Parallel()
ctx := testhelper.Context(t)
logger, loggerHook := test.NewNullLogger()
logger.SetLevel(logrus.ErrorLevel)
listener, err := net.Listen("tcp", "localhost:0")
require.NoError(t, err)
service := &mockService{}
server := grpc.NewServer(
grpcmw.WithUnaryServerChain(
grpcmwlogrus.UnaryServerInterceptor(
logrus.NewEntry(logger),
grpcmwlogrus.WithMessageProducer(
log.MessageProducer(
grpcmwlogrus.DefaultMessageProducer,
structerr.FieldsProducer,
),
),
),
),
)
grpc_testing.RegisterTestServiceServer(server, service)
go testhelper.MustServe(t, server, listener)
defer server.Stop()
conn, err := grpc.Dial(listener.Addr().String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
)
require.NoError(t, err)
defer testhelper.MustClose(t, conn)
client := grpc_testing.NewTestServiceClient(conn)
for _, tc := range []struct {
desc string
returnedErr error
expectedErr error
expectedMetadata []map[string]any
}{
{
desc: "no error",
returnedErr: nil,
},
{
desc: "plain error",
returnedErr: errors.New("message"),
expectedErr: status.Error(codes.Unknown, "message"),
},
{
desc: "structured error",
returnedErr: structerr.New("message"),
expectedErr: status.Error(codes.Internal, "message"),
},
{
desc: "structured error with metadata",
returnedErr: structerr.New("message").WithMetadata("key", "value"),
expectedErr: status.Error(codes.Internal, "message"),
expectedMetadata: []map[string]any{
{
"key": "value",
},
},
},
{
desc: "structured error with nested metadata",
returnedErr: structerr.New("message: %w", structerr.New("nested").WithMetadata("nested", "value")).WithMetadata("key", "value"),
expectedErr: status.Error(codes.Internal, "message: nested"),
expectedMetadata: []map[string]any{
{
"key": "value",
"nested": "value",
},
},
},
} {
t.Run(tc.desc, func(t *testing.T) {
loggerHook.Reset()
service.err = tc.returnedErr
_, err := client.UnaryCall(ctx, &grpc_testing.SimpleRequest{})
testhelper.ProtoEqual(t, tc.expectedErr, err)
var metadata []map[string]any
for _, entry := range loggerHook.AllEntries() {
if untypedMetadata := entry.Data["error_metadata"]; untypedMetadata != nil {
require.IsType(t, untypedMetadata, map[string]any{})
metadata = append(metadata, untypedMetadata.(map[string]any))
}
}
require.Equal(t, tc.expectedMetadata, metadata)
})
}
}
|
