forked from grpc-ecosystem/go-grpc-middleware
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server_interceptors_test.go
211 lines (195 loc) · 9.53 KB
/
server_interceptors_test.go
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
// Copyright 2017 Michal Witkowski. All Rights Reserved.
// See LICENSE for licensing terms.
package grpc_logrus_test
import (
"runtime"
"testing"
"github.com/stretchr/testify/suite"
"google.golang.org/grpc"
"io"
"fmt"
"strings"
"github.com/sirupsen/logrus"
"github.com/grpc-ecosystem/go-grpc-middleware"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
"github.com/grpc-ecosystem/go-grpc-middleware/tags"
pb_testproto "github.com/grpc-ecosystem/go-grpc-middleware/testing/testproto"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/grpc/codes"
)
func TestLogrusServerSuite(t *testing.T) {
if strings.HasPrefix(runtime.Version(), "go1.7") {
t.Skipf("Skipping due to json.RawMessage incompatibility with go1.7")
return
}
opts := []grpc_logrus.Option{
grpc_logrus.WithLevels(customCodeToLevel),
}
b := newLogrusBaseSuite(t)
b.InterceptorTestSuite.ServerOpts = []grpc.ServerOption{
grpc_middleware.WithStreamServerChain(
grpc_ctxtags.StreamServerInterceptor(grpc_ctxtags.WithFieldExtractor(grpc_ctxtags.CodeGenRequestFieldExtractor)),
grpc_logrus.StreamServerInterceptor(logrus.NewEntry(b.logger), opts...)),
grpc_middleware.WithUnaryServerChain(
grpc_ctxtags.UnaryServerInterceptor(grpc_ctxtags.WithFieldExtractor(grpc_ctxtags.CodeGenRequestFieldExtractor)),
grpc_logrus.UnaryServerInterceptor(logrus.NewEntry(b.logger), opts...)),
}
suite.Run(t, &logrusServerSuite{b})
}
type logrusServerSuite struct {
*logrusBaseSuite
}
func (s *logrusServerSuite) TestPing_WithCustomTags() {
_, err := s.Client.Ping(s.SimpleCtx(), goodPing)
assert.NoError(s.T(), err, "there must be not be an on a successful call")
msgs := s.getOutputJSONs()
assert.Len(s.T(), msgs, 2, "two log statements should be logged")
for _, m := range msgs {
s.T()
assert.Contains(s.T(), m, `"grpc.service": "mwitkow.testproto.TestService"`, "all lines must contain service name")
assert.Contains(s.T(), m, `"grpc.method": "Ping"`, "all lines must contain method name")
assert.Contains(s.T(), m, `"custom_tags.string": "something"`, "all lines must contain `custom_tags.string` set by AddFields")
assert.Contains(s.T(), m, `"custom_tags.int": 1337`, "all lines must contain `custom_tags.int` set by AddFields")
assert.Contains(s.T(), m, `"span.kind": "server"`, "all lines must contain the kind of call (server)")
// request field extraction
assert.Contains(s.T(), m, `"grpc.request.value": "something"`, "all lines must contain fields extracted from goodPing because of test.manual_extractfields.pb")
}
assert.Contains(s.T(), msgs[0], `"msg": "some ping"`, "handler's message must contain user message")
assert.Contains(s.T(), msgs[1], `"msg": "finished unary call"`, "interceptor message must contain string")
assert.Contains(s.T(), msgs[1], `"level": "info"`, "OK error codes must be logged on info level.")
assert.Contains(s.T(), msgs[1], `"grpc.time_ms":`, "interceptor log statement should contain execution time")
}
func (s *logrusServerSuite) TestPingError_WithCustomLevels() {
for _, tcase := range []struct {
code codes.Code
level logrus.Level
msg string
}{
{
code: codes.Internal,
level: logrus.ErrorLevel,
msg: "Internal must remap to ErrorLevel in DefaultCodeToLevel",
},
{
code: codes.NotFound,
level: logrus.InfoLevel,
msg: "NotFound must remap to InfoLevel in DefaultCodeToLevel",
},
{
code: codes.FailedPrecondition,
level: logrus.WarnLevel,
msg: "FailedPrecondition must remap to WarnLevel in DefaultCodeToLevel",
},
{
code: codes.Unauthenticated,
level: logrus.ErrorLevel,
msg: "Unauthenticated is overwritten to ErrorLevel with customCodeToLevel override, which probably didn't work",
},
} {
s.buffer.Reset()
_, err := s.Client.PingError(
s.SimpleCtx(),
&pb_testproto.PingRequest{Value: "something", ErrorCodeReturned: uint32(tcase.code)})
assert.Error(s.T(), err, "each call here must return an error")
msgs := s.getOutputJSONs()
require.Len(s.T(), msgs, 1, "only the interceptor log message is printed in PingErr")
m := msgs[0]
assert.Contains(s.T(), m, `"grpc.service": "mwitkow.testproto.TestService"`, "all lines must contain service name")
assert.Contains(s.T(), m, `"grpc.method": "PingError"`, "all lines must contain method name")
assert.Contains(s.T(), m, fmt.Sprintf(`"grpc.code": "%s"`, tcase.code.String()), "all lines must contain method name")
assert.Contains(s.T(), m, fmt.Sprintf(`"level": "%s"`, tcase.level.String()), tcase.msg)
}
}
func (s *logrusServerSuite) TestPingList_WithCustomTags() {
stream, err := s.Client.PingList(s.SimpleCtx(), goodPing)
require.NoError(s.T(), err, "should not fail on establishing the stream")
for {
_, err := stream.Recv()
if err == io.EOF {
break
}
require.NoError(s.T(), err, "reading stream should not fail")
}
msgs := s.getOutputJSONs()
assert.Len(s.T(), msgs, 2, "two log statements should be logged")
for _, m := range msgs {
s.T()
assert.Contains(s.T(), m, `"grpc.service": "mwitkow.testproto.TestService"`, "all lines must contain service name")
assert.Contains(s.T(), m, `"grpc.method": "PingList"`, "all lines must contain method name")
assert.Contains(s.T(), m, `"span.kind": "server"`, "all lines must contain the kind of call (server)")
assert.Contains(s.T(), m, `"custom_tags.string": "something"`, "all lines must contain `custom_tags.string` set by AddFields")
assert.Contains(s.T(), m, `"custom_tags.int": 1337`, "all lines must contain `custom_tags.int` set by AddFields")
// request field extraction
assert.Contains(s.T(), m, `"grpc.request.value": "something"`, "all lines must contain fields extracted from goodPing because of test.manual_extractfields.pb")
}
assert.Contains(s.T(), msgs[0], `"msg": "some pinglist"`, "handler's message must contain user message")
assert.Contains(s.T(), msgs[1], `"msg": "finished streaming call"`, "interceptor message must contain string")
assert.Contains(s.T(), msgs[1], `"level": "info"`, "OK error codes must be logged on info level.")
assert.Contains(s.T(), msgs[1], `"grpc.time_ms":`, "interceptor log statement should contain execution time")
}
func TestLogrusServerOverrideSuite(t *testing.T) {
if strings.HasPrefix(runtime.Version(), "go1.7") {
t.Skip("Skipping due to json.RawMessage incompatibility with go1.7")
return
}
opts := []grpc_logrus.Option{
grpc_logrus.WithDurationField(grpc_logrus.DurationToDurationField),
}
b := newLogrusBaseSuite(t)
b.InterceptorTestSuite.ServerOpts = []grpc.ServerOption{
grpc_middleware.WithStreamServerChain(
grpc_ctxtags.StreamServerInterceptor(),
grpc_logrus.StreamServerInterceptor(logrus.NewEntry(b.logger), opts...)),
grpc_middleware.WithUnaryServerChain(
grpc_ctxtags.UnaryServerInterceptor(),
grpc_logrus.UnaryServerInterceptor(logrus.NewEntry(b.logger), opts...)),
}
suite.Run(t, &logrusServerOverrideSuite{b})
}
type logrusServerOverrideSuite struct {
*logrusBaseSuite
}
func (s *logrusServerOverrideSuite) TestPing_HasOverriddenDuration() {
_, err := s.Client.Ping(s.SimpleCtx(), goodPing)
assert.NoError(s.T(), err, "there must be not be an on a successful call")
msgs := s.getOutputJSONs()
assert.Len(s.T(), msgs, 2, "two log statements should be logged")
for _, m := range msgs {
s.T()
assert.Contains(s.T(), m, `"grpc.service": "mwitkow.testproto.TestService"`, "all lines must contain service name")
assert.Contains(s.T(), m, `"grpc.method": "Ping"`, "all lines must contain method name")
}
assert.Contains(s.T(), msgs[0], `"msg": "some ping"`, "handler's message must contain user message")
assert.NotContains(s.T(), msgs[0], "grpc.time_ms", "handler's message must not contain default duration")
assert.NotContains(s.T(), msgs[0], "grpc.duration", "handler's message must not contain overridden duration")
assert.Contains(s.T(), msgs[1], `"msg": "finished unary call"`, "interceptor message must contain string")
assert.Contains(s.T(), msgs[1], `"level": "info"`, "OK error codes must be logged on info level.")
assert.NotContains(s.T(), msgs[1], "grpc.time_ms", "interceptor message must not contain default duration")
assert.Contains(s.T(), msgs[1], "grpc.duration", "interceptor message must contain overridden duration")
}
func (s *logrusServerOverrideSuite) TestPingList_HasOverriddenDuration() {
stream, err := s.Client.PingList(s.SimpleCtx(), goodPing)
require.NoError(s.T(), err, "should not fail on establishing the stream")
for {
_, err := stream.Recv()
if err == io.EOF {
break
}
require.NoError(s.T(), err, "reading stream should not fail")
}
msgs := s.getOutputJSONs()
assert.Len(s.T(), msgs, 2, "two log statements should be logged")
for _, m := range msgs {
s.T()
assert.Contains(s.T(), m, `"grpc.service": "mwitkow.testproto.TestService"`, "all lines must contain service name")
assert.Contains(s.T(), m, `"grpc.method": "PingList"`, "all lines must contain method name")
}
assert.Contains(s.T(), msgs[0], `"msg": "some pinglist"`, "handler's message must contain user message")
assert.NotContains(s.T(), msgs[0], "grpc.time_ms", "handler's message must not contain default duration")
assert.NotContains(s.T(), msgs[0], "grpc.duration", "handler's message must not contain overridden duration")
assert.Contains(s.T(), msgs[1], `"msg": "finished streaming call"`, "interceptor message must contain string")
assert.Contains(s.T(), msgs[1], `"level": "info"`, "OK error codes must be logged on info level.")
assert.NotContains(s.T(), msgs[1], "grpc.time_ms", "interceptor message must not contain default duration")
assert.Contains(s.T(), msgs[1], "grpc.duration", "interceptor message must contain overridden duration")
}