forked from linkerd/linkerd2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_helper.go
342 lines (304 loc) · 9.76 KB
/
test_helper.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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
package api
import (
"context"
"fmt"
"sort"
"github.com/go-test/deep"
"github.com/linkerd/linkerd2/controller/k8s"
"github.com/linkerd/linkerd2/pkg/prometheus"
pb "github.com/linkerd/linkerd2/viz/metrics-api/gen/viz"
"github.com/prometheus/common/model"
"google.golang.org/grpc"
)
// MockAPIClient satisfies the metrics-api gRPC interfaces
type MockAPIClient struct {
ErrorToReturn error
ListPodsResponseToReturn *pb.ListPodsResponse
ListServicesResponseToReturn *pb.ListServicesResponse
StatSummaryResponseToReturn *pb.StatSummaryResponse
AuthzResponseToReturn *pb.AuthzResponse
GatewaysResponseToReturn *pb.GatewaysResponse
TopRoutesResponseToReturn *pb.TopRoutesResponse
EdgesResponseToReturn *pb.EdgesResponse
SelfCheckResponseToReturn *pb.SelfCheckResponse
}
// StatSummary provides a mock of a metrics-api method.
func (c *MockAPIClient) StatSummary(ctx context.Context, in *pb.StatSummaryRequest, opts ...grpc.CallOption) (*pb.StatSummaryResponse, error) {
return c.StatSummaryResponseToReturn, c.ErrorToReturn
}
// Authz provides a mock of a metrics-api method.
func (c *MockAPIClient) Authz(ctx context.Context, in *pb.AuthzRequest, opts ...grpc.CallOption) (*pb.AuthzResponse, error) {
return c.AuthzResponseToReturn, c.ErrorToReturn
}
// Gateways provides a mock of a metrics-api method.
func (c *MockAPIClient) Gateways(ctx context.Context, in *pb.GatewaysRequest, opts ...grpc.CallOption) (*pb.GatewaysResponse, error) {
return c.GatewaysResponseToReturn, c.ErrorToReturn
}
// TopRoutes provides a mock of a metrics-api method.
func (c *MockAPIClient) TopRoutes(ctx context.Context, in *pb.TopRoutesRequest, opts ...grpc.CallOption) (*pb.TopRoutesResponse, error) {
return c.TopRoutesResponseToReturn, c.ErrorToReturn
}
// Edges provides a mock of a metrics-api method.
func (c *MockAPIClient) Edges(ctx context.Context, in *pb.EdgesRequest, opts ...grpc.CallOption) (*pb.EdgesResponse, error) {
return c.EdgesResponseToReturn, c.ErrorToReturn
}
// ListPods provides a mock of a metrics-api method.
func (c *MockAPIClient) ListPods(ctx context.Context, in *pb.ListPodsRequest, opts ...grpc.CallOption) (*pb.ListPodsResponse, error) {
return c.ListPodsResponseToReturn, c.ErrorToReturn
}
// ListServices provides a mock of a metrics-api method.
func (c *MockAPIClient) ListServices(ctx context.Context, in *pb.ListServicesRequest, opts ...grpc.CallOption) (*pb.ListServicesResponse, error) {
return c.ListServicesResponseToReturn, c.ErrorToReturn
}
// SelfCheck provides a mock of a metrics-api method.
func (c *MockAPIClient) SelfCheck(ctx context.Context, in *pb.SelfCheckRequest, _ ...grpc.CallOption) (*pb.SelfCheckResponse, error) {
return c.SelfCheckResponseToReturn, c.ErrorToReturn
}
// PodCounts is a test helper struct that is used for representing data in a
// StatTable.PodGroup.Row.
type PodCounts struct {
Status string
MeshedPods uint64
RunningPods uint64
FailedPods uint64
Errors map[string]*pb.PodErrors
}
// GenStatSummaryResponse generates a mock metrics-api StatSummaryResponse
// object.
func GenStatSummaryResponse(resName, resType string, resNs []string, counts *PodCounts, basicStats bool, tcpStats bool) *pb.StatSummaryResponse {
rows := []*pb.StatTable_PodGroup_Row{}
for _, ns := range resNs {
statTableRow := &pb.StatTable_PodGroup_Row{
Resource: &pb.Resource{
Namespace: ns,
Type: resType,
Name: resName,
},
TimeWindow: "1m",
}
if basicStats {
statTableRow.Stats = &pb.BasicStats{
SuccessCount: 123,
FailureCount: 0,
LatencyMsP50: 123,
LatencyMsP95: 123,
LatencyMsP99: 123,
}
}
if tcpStats {
statTableRow.TcpStats = &pb.TcpStats{
OpenConnections: 123,
ReadBytesTotal: 123,
WriteBytesTotal: 123,
}
}
if counts != nil {
statTableRow.MeshedPodCount = counts.MeshedPods
statTableRow.RunningPodCount = counts.RunningPods
statTableRow.FailedPodCount = counts.FailedPods
statTableRow.Status = counts.Status
statTableRow.ErrorsByPod = counts.Errors
}
rows = append(rows, statTableRow)
}
resp := &pb.StatSummaryResponse{
Response: &pb.StatSummaryResponse_Ok_{ // https://github.com/golang/protobuf/issues/205
Ok: &pb.StatSummaryResponse_Ok{
StatTables: []*pb.StatTable{
{
Table: &pb.StatTable_PodGroup_{
PodGroup: &pb.StatTable_PodGroup{
Rows: rows,
},
},
},
},
},
},
}
return resp
}
type mockEdgeRow struct {
resourceType string
src string
dst string
srcNamespace string
dstNamespace string
clientID string
serverID string
msg string
}
// a slice of edge rows to generate mock results
var emojivotoEdgeRows = []*mockEdgeRow{
{
resourceType: "deployment",
src: "web",
dst: "voting",
srcNamespace: "emojivoto",
dstNamespace: "emojivoto",
clientID: "web.emojivoto.serviceaccount.identity.linkerd.cluster.local",
serverID: "voting.emojivoto.serviceaccount.identity.linkerd.cluster.local",
msg: "",
},
{
resourceType: "deployment",
src: "vote-bot",
dst: "web",
srcNamespace: "emojivoto",
dstNamespace: "emojivoto",
clientID: "default.emojivoto.serviceaccount.identity.linkerd.cluster.local",
serverID: "web.emojivoto.serviceaccount.identity.linkerd.cluster.local",
msg: "",
},
{
resourceType: "deployment",
src: "web",
dst: "emoji",
srcNamespace: "emojivoto",
dstNamespace: "emojivoto",
clientID: "web.emojivoto.serviceaccount.identity.linkerd.cluster.local",
serverID: "emoji.emojivoto.serviceaccount.identity.linkerd.cluster.local",
msg: "",
},
}
// a slice of edge rows to generate mock results
var linkerdEdgeRows = []*mockEdgeRow{
{
resourceType: "deployment",
src: "linkerd-identity",
dst: "linkerd-prometheus",
srcNamespace: "linkerd",
dstNamespace: "linkerd",
clientID: "linkerd-identity.linkerd.serviceaccount.identity.linkerd.cluster.local",
serverID: "linkerd-prometheus.linkerd.serviceaccount.identity.linkerd.cluster.local",
msg: "",
},
}
// GenEdgesResponse generates a mock metrics-api EdgesResponse
// object.
func GenEdgesResponse(resourceType string, edgeRowNamespace string) *pb.EdgesResponse {
edgeRows := emojivotoEdgeRows
if edgeRowNamespace == "linkerd" {
edgeRows = linkerdEdgeRows
} else if edgeRowNamespace == "all" {
// combine emojivotoEdgeRows and linkerdEdgeRows
edgeRows = append(edgeRows, linkerdEdgeRows...)
}
edges := []*pb.Edge{}
for _, row := range edgeRows {
edge := &pb.Edge{
Src: &pb.Resource{
Name: row.src,
Namespace: row.srcNamespace,
Type: row.resourceType,
},
Dst: &pb.Resource{
Name: row.dst,
Namespace: row.dstNamespace,
Type: row.resourceType,
},
ClientId: row.clientID,
ServerId: row.serverID,
NoIdentityMsg: row.msg,
}
edges = append(edges, edge)
}
// sorting to retain consistent order for tests
edges = sortEdgeRows(edges)
resp := &pb.EdgesResponse{
Response: &pb.EdgesResponse_Ok_{
Ok: &pb.EdgesResponse_Ok{
Edges: edges,
},
},
}
return resp
}
// GenTopRoutesResponse generates a mock metrics-api TopRoutesResponse object.
func GenTopRoutesResponse(routes []string, counts []uint64, outbound bool, authority string) *pb.TopRoutesResponse {
rows := []*pb.RouteTable_Row{}
for i, route := range routes {
row := &pb.RouteTable_Row{
Route: route,
Authority: authority,
Stats: &pb.BasicStats{
SuccessCount: counts[i],
FailureCount: 0,
LatencyMsP50: 123,
LatencyMsP95: 123,
LatencyMsP99: 123,
},
TimeWindow: "1m",
}
if outbound {
row.Stats.ActualSuccessCount = counts[i]
}
rows = append(rows, row)
}
defaultRow := &pb.RouteTable_Row{
Route: "[DEFAULT]",
Authority: authority,
Stats: &pb.BasicStats{
SuccessCount: counts[len(counts)-1],
FailureCount: 0,
LatencyMsP50: 123,
LatencyMsP95: 123,
LatencyMsP99: 123,
},
TimeWindow: "1m",
}
if outbound {
defaultRow.Stats.ActualSuccessCount = counts[len(counts)-1]
}
rows = append(rows, defaultRow)
resp := &pb.TopRoutesResponse{
Response: &pb.TopRoutesResponse_Ok_{
Ok: &pb.TopRoutesResponse_Ok{
Routes: []*pb.RouteTable{
{
Rows: rows,
Resource: "deploy/foobar",
},
},
},
},
}
return resp
}
type expectedStatRPC struct {
err error
k8sConfigs []string // k8s objects to seed the API
mockPromResponse model.Value // mock out a prometheus query response
expectedPrometheusQueries []string // queries we expect metrics-api to issue to prometheus
}
func newMockGrpcServer(exp expectedStatRPC) (*prometheus.MockProm, *grpcServer, error) {
k8sAPI, err := k8s.NewFakeAPI(exp.k8sConfigs...)
if err != nil {
return nil, nil, err
}
mockProm := &prometheus.MockProm{Res: exp.mockPromResponse}
fakeGrpcServer := &grpcServer{
prometheusAPI: mockProm,
k8sAPI: k8sAPI,
controllerNamespace: "linkerd",
clusterDomain: "cluster.local",
ignoredNamespaces: []string{},
}
k8sAPI.Sync(nil)
return mockProm, fakeGrpcServer, nil
}
func (exp expectedStatRPC) verifyPromQueries(mockProm *prometheus.MockProm) error {
// if exp.expectedPrometheusQueries is an empty slice we still want to check no queries were executed.
if exp.expectedPrometheusQueries != nil {
sort.Strings(exp.expectedPrometheusQueries)
sort.Strings(mockProm.QueriesExecuted)
// because reflect.DeepEqual([]string{}, nil) is false
if len(exp.expectedPrometheusQueries) == 0 && len(mockProm.QueriesExecuted) == 0 {
return nil
}
if diff := deep.Equal(exp.expectedPrometheusQueries, mockProm.QueriesExecuted); diff != nil {
return fmt.Errorf("Prometheus queries incorrect: %+v", diff)
}
}
return nil
}