forked from grpc-ecosystem/go-grpc-middleware
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server_test.go
296 lines (257 loc) · 10.8 KB
/
server_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
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
// Copyright (c) The go-grpc-middleware Authors.
// Licensed under the Apache License 2.0.
package prometheus
import (
"bufio"
"context"
"fmt"
"io"
"net/http"
"net/http/httptest"
"reflect"
"strings"
"testing"
"time"
"github.com/grpc-ecosystem/go-grpc-middleware/v2/testing/testpb"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/client_golang/prometheus/testutil"
dto "github.com/prometheus/client_model/go"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
)
func TestServerInterceptorSuite(t *testing.T) {
s := NewServerMetrics(WithServerHandlingTimeHistogram())
suite.Run(t, &ServerInterceptorTestSuite{
InterceptorTestSuite: &testpb.InterceptorTestSuite{
TestService: &testpb.TestPingService{},
ServerOpts: []grpc.ServerOption{
grpc.StreamInterceptor(s.StreamServerInterceptor()),
grpc.UnaryInterceptor(s.UnaryServerInterceptor()),
},
},
serverMetrics: s,
})
}
type ServerInterceptorTestSuite struct {
*testpb.InterceptorTestSuite
serverMetrics *ServerMetrics
}
func (s *ServerInterceptorTestSuite) SetupTest() {
s.serverMetrics.serverStartedCounter.Reset()
s.serverMetrics.serverHandledCounter.Reset()
s.serverMetrics.serverHandledHistogram.Reset()
s.serverMetrics.serverStreamMsgReceived.Reset()
s.serverMetrics.serverStreamMsgSent.Reset()
s.serverMetrics.InitializeMetrics(s.Server)
}
func (s *ServerInterceptorTestSuite) TestRegisterPresetsStuff() {
registry := prometheus.NewPedanticRegistry()
s.Require().NoError(registry.Register(s.serverMetrics))
for testID, testCase := range []struct {
metricName string
existingLabels []string
}{
// Order of label is irrelevant.
{"grpc_server_started_total", []string{testpb.TestServiceFullName, "PingEmpty", "unary"}},
{"grpc_server_started_total", []string{testpb.TestServiceFullName, "PingList", "server_stream"}},
{"grpc_server_msg_received_total", []string{testpb.TestServiceFullName, "PingList", "server_stream"}},
{"grpc_server_msg_sent_total", []string{testpb.TestServiceFullName, "PingEmpty", "unary"}},
{"grpc_server_handling_seconds_sum", []string{testpb.TestServiceFullName, "PingEmpty", "unary"}},
{"grpc_server_handling_seconds_count", []string{testpb.TestServiceFullName, "PingList", "server_stream"}},
{"grpc_server_handled_total", []string{testpb.TestServiceFullName, "PingList", "server_stream", "OutOfRange"}},
{"grpc_server_handled_total", []string{testpb.TestServiceFullName, "PingList", "server_stream", "Aborted"}},
{"grpc_server_handled_total", []string{testpb.TestServiceFullName, "PingEmpty", "unary", "FailedPrecondition"}},
{"grpc_server_handled_total", []string{testpb.TestServiceFullName, "PingEmpty", "unary", "ResourceExhausted"}},
} {
lineCount := len(fetchPrometheusLines(s.T(), registry, testCase.metricName, testCase.existingLabels...))
assert.NotZero(s.T(), lineCount, "metrics must exist for test case %d", testID)
}
}
func (s *ServerInterceptorTestSuite) TestUnaryIncrementsMetrics() {
_, err := s.Client.PingEmpty(s.SimpleCtx(), &testpb.PingEmptyRequest{})
require.NoError(s.T(), err)
requireValue(s.T(), 1, s.serverMetrics.serverStartedCounter.WithLabelValues("unary", testpb.TestServiceFullName, "PingEmpty"))
requireValue(s.T(), 1, s.serverMetrics.serverHandledCounter.WithLabelValues("unary", testpb.TestServiceFullName, "PingEmpty", "OK"))
requireValueHistCount(s.T(), 1, s.serverMetrics.serverHandledHistogram.WithLabelValues("unary", testpb.TestServiceFullName, "PingEmpty"))
_, err = s.Client.PingError(s.SimpleCtx(), &testpb.PingErrorRequest{ErrorCodeReturned: uint32(codes.FailedPrecondition)})
require.Error(s.T(), err)
requireValue(s.T(), 1, s.serverMetrics.serverStartedCounter.WithLabelValues("unary", testpb.TestServiceFullName, "PingError"))
requireValue(s.T(), 1, s.serverMetrics.serverHandledCounter.WithLabelValues("unary", testpb.TestServiceFullName, "PingError", "FailedPrecondition"))
requireValueHistCount(s.T(), 1, s.serverMetrics.serverHandledHistogram.WithLabelValues("unary", testpb.TestServiceFullName, "PingError"))
}
func (s *ServerInterceptorTestSuite) TestStartedStreamingIncrementsStarted() {
_, err := s.Client.PingList(s.SimpleCtx(), &testpb.PingListRequest{})
require.NoError(s.T(), err)
requireValueWithRetry(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverStartedCounter.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
_, err = s.Client.PingList(s.SimpleCtx(), &testpb.PingListRequest{ErrorCodeReturned: uint32(codes.FailedPrecondition)})
require.NoError(s.T(), err, "PingList must not fail immediately")
requireValueWithRetry(s.SimpleCtx(), s.T(), 2,
s.serverMetrics.serverStartedCounter.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
}
func (s *ServerInterceptorTestSuite) TestStreamingIncrementsMetrics() {
ss, _ := s.Client.PingList(s.SimpleCtx(), &testpb.PingListRequest{})
// Do a read, just for kicks.
count := 0
for {
_, err := ss.Recv()
if err == io.EOF {
break
}
require.NoError(s.T(), err, "reading pingList shouldn't fail")
count++
}
require.EqualValues(s.T(), testpb.ListResponseCount, count, "Number of received msg on the wire must match")
requireValueWithRetry(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverStartedCounter.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
requireValueWithRetry(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverHandledCounter.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList", "OK"))
requireValueWithRetry(s.SimpleCtx(), s.T(), testpb.ListResponseCount,
s.serverMetrics.serverStreamMsgSent.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
requireValueWithRetry(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverStreamMsgReceived.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
requireValueWithRetryHistCount(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverHandledHistogram.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
_, err := s.Client.PingList(s.SimpleCtx(), &testpb.PingListRequest{ErrorCodeReturned: uint32(codes.FailedPrecondition)}) // should return with code=FailedPrecondition
require.NoError(s.T(), err, "PingList must not fail immediately")
requireValueWithRetry(s.SimpleCtx(), s.T(), 2,
s.serverMetrics.serverStartedCounter.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
requireValueWithRetry(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverHandledCounter.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList", "FailedPrecondition"))
requireValueWithRetryHistCount(s.SimpleCtx(), s.T(), 2,
s.serverMetrics.serverHandledHistogram.WithLabelValues("server_stream", testpb.TestServiceFullName, "PingList"))
}
func (s *ServerInterceptorTestSuite) TestContextCancelledTreatedAsStatus() {
ctx, cancel := context.WithCancel(context.TODO())
defer cancel()
stream, _ := s.Client.PingStream(ctx)
err := stream.Send(&testpb.PingStreamRequest{})
require.NoError(s.T(), err)
cancel()
requireValueWithRetry(s.SimpleCtx(), s.T(), 1,
s.serverMetrics.serverHandledCounter.WithLabelValues("bidi_stream", testpb.TestServiceFullName, "PingStream", "Canceled"))
}
// fetchPrometheusLines does mocked HTTP GET request against real prometheus handler to get the same view that Prometheus
// would have while scraping this endpoint.
// Order of matching label vales does not matter.
func fetchPrometheusLines(t *testing.T, reg prometheus.Gatherer, metricName string, matchingLabelValues ...string) []string {
resp := httptest.NewRecorder()
req, err := http.NewRequest("GET", "/", nil)
require.NoError(t, err, "failed creating request for Prometheus handler")
promhttp.HandlerFor(reg, promhttp.HandlerOpts{}).ServeHTTP(resp, req)
reader := bufio.NewReader(resp.Body)
var ret []string
for {
line, err := reader.ReadString('\n')
if err == io.EOF {
break
} else {
require.NoError(t, err, "error reading stuff")
}
if !strings.HasPrefix(line, metricName) {
continue
}
matches := true
for _, labelValue := range matchingLabelValues {
if !strings.Contains(line, `"`+labelValue+`"`) {
matches = false
}
}
if matches {
ret = append(ret, line)
}
}
return ret
}
// toFloat64HistCount does the same thing as prometheus go client testutil.ToFloat64, but for histograms.
// TODO(bwplotka): Upstream this function to prometheus client.
func toFloat64HistCount(h prometheus.Observer) uint64 {
var (
m prometheus.Metric
mCount int
mChan = make(chan prometheus.Metric)
done = make(chan struct{})
)
go func() {
for m = range mChan {
mCount++
}
close(done)
}()
c, ok := h.(prometheus.Collector)
if !ok {
panic(fmt.Errorf("observer is not a collector; got: %T", h))
}
c.Collect(mChan)
close(mChan)
<-done
if mCount != 1 {
panic(fmt.Errorf("collected %d metrics instead of exactly 1", mCount))
}
pb := &dto.Metric{}
if err := m.Write(pb); err != nil {
panic(fmt.Errorf("metric write failed, err=%v", err))
}
if pb.Histogram != nil {
return pb.Histogram.GetSampleCount()
}
panic(fmt.Errorf("collected a non-histogram metric: %s", pb))
}
func requireValue(t *testing.T, expect int, c prometheus.Collector) {
t.Helper()
v := int(testutil.ToFloat64(c))
if v == expect {
return
}
metricFullName := reflect.ValueOf(*c.(prometheus.Metric).Desc()).FieldByName("fqName").String()
t.Errorf("expected %d %s value; got %d; ", expect, metricFullName, v)
t.Fail()
}
func requireValueHistCount(t *testing.T, expect int, o prometheus.Observer) {
t.Helper()
v := int(toFloat64HistCount(o))
if v == expect {
return
}
metricFullName := reflect.ValueOf(*o.(prometheus.Metric).Desc()).FieldByName("fqName").String()
t.Errorf("expected %d %s value; got %d; ", expect, metricFullName, v)
t.Fail()
}
func requireValueWithRetry(ctx context.Context, t *testing.T, expect int, c prometheus.Collector) {
t.Helper()
for {
v := int(testutil.ToFloat64(c))
if v == expect {
return
}
select {
case <-ctx.Done():
metricFullName := reflect.ValueOf(*c.(prometheus.Metric).Desc()).FieldByName("fqName").String()
t.Errorf("timeout while expecting %d %s value; got %d; ", expect, metricFullName, v)
t.Fail()
return
case <-time.After(100 * time.Millisecond):
}
}
}
func requireValueWithRetryHistCount(ctx context.Context, t *testing.T, expect int, o prometheus.Observer) {
t.Helper()
for {
v := int(toFloat64HistCount(o))
if v == expect {
return
}
select {
case <-ctx.Done():
metricFullName := reflect.ValueOf(*o.(prometheus.Metric).Desc()).FieldByName("fqName").String()
t.Errorf("timeout while expecting %d %s histogram count value; got %d; ", expect, metricFullName, v)
t.Fail()
return
case <-time.After(100 * time.Millisecond):
}
}
}