-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
catalog_testing.go
378 lines (315 loc) · 9.23 KB
/
catalog_testing.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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
package consul
import (
"fmt"
"sort"
"sync"
"github.com/hashicorp/consul/api"
"github.com/hashicorp/go-hclog"
"golang.org/x/exp/maps"
"golang.org/x/exp/slices"
)
// MockNamespaces is a mock implementation of NamespaceAPI.
type MockNamespaces struct {
namespaces []*api.Namespace
}
var _ NamespaceAPI = (*MockNamespaces)(nil)
// NewMockNamespaces creates a MockNamespaces with the given namespaces, and
// will automatically add the "default" namespace if not included.
func NewMockNamespaces(namespaces []string) *MockNamespaces {
list := slices.Clone(namespaces)
if !slices.Contains(list, "default") {
list = append(list, "default")
}
sort.Strings(list)
data := make([]*api.Namespace, 0, len(list))
for _, namespace := range list {
data = append(data, &api.Namespace{
Name: namespace,
})
}
return &MockNamespaces{
namespaces: data,
}
}
// List implements NamespaceAPI
func (m *MockNamespaces) List(*api.QueryOptions) ([]*api.Namespace, *api.QueryMeta, error) {
result := make([]*api.Namespace, len(m.namespaces))
copy(result, m.namespaces)
return result, new(api.QueryMeta), nil
}
// MockCatalog can be used for testing where the CatalogAPI is needed.
type MockCatalog struct {
logger hclog.Logger
}
var _ CatalogAPI = (*MockCatalog)(nil)
func NewMockCatalog(l hclog.Logger) *MockCatalog {
return &MockCatalog{logger: l.Named("mock_consul")}
}
func (m *MockCatalog) Datacenters() ([]string, error) {
dcs := []string{"dc1"}
m.logger.Trace("Datacenters()", "dcs", dcs, "error", "nil")
return dcs, nil
}
func (m *MockCatalog) Service(service, tag string, q *api.QueryOptions) ([]*api.CatalogService, *api.QueryMeta, error) {
m.logger.Trace("Services()", "service", service, "tag", tag, "query_options", q)
return nil, nil, nil
}
// MockAgent is a fake in-memory Consul backend for ServiceClient.
type MockAgent struct {
// services tracks what services have been registered, per namespace
services map[string]map[string]*api.AgentServiceRegistration
// checks tracks what checks have been registered, per namespace
checks map[string]map[string]*api.AgentCheckRegistration
// hits is the total number of times agent methods have been called
hits int
// ent indicates whether the agent is mocking an enterprise consul
ent bool
// namespaces indicates whether the agent is mocking consul with namespaces
// feature enabled
namespaces bool
// mu guards above fields
mu sync.Mutex
// checkTTLS counts calls to UpdateTTL for each check, per namespace
checkTTLs map[string]map[string]int
// What check status to return from Checks()
checkStatus string
}
var _ AgentAPI = (*MockAgent)(nil)
type Features struct {
Enterprise bool
Namespaces bool
}
// NewMockAgent that returns all checks as passing.
func NewMockAgent(f Features) *MockAgent {
return &MockAgent{
services: make(map[string]map[string]*api.AgentServiceRegistration),
checks: make(map[string]map[string]*api.AgentCheckRegistration),
checkTTLs: make(map[string]map[string]int),
checkStatus: api.HealthPassing,
ent: f.Enterprise,
namespaces: f.Namespaces,
}
}
// getHits returns how many Consul Agent API calls have been made.
func (c *MockAgent) getHits() int {
c.mu.Lock()
defer c.mu.Unlock()
return c.hits
}
// SetStatus that Checks() should return. Returns old status value.
func (c *MockAgent) SetStatus(s string) string {
c.mu.Lock()
old := c.checkStatus
c.checkStatus = s
c.mu.Unlock()
return old
}
func (c *MockAgent) Self() (map[string]map[string]interface{}, error) {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
version := "1.9.5"
build := "1.9.5:22ce6c6a"
if c.ent {
version = "1.9.5+ent"
build = "1.9.5+ent:22ce6c6a"
}
stats := make(map[string]interface{})
if c.ent {
if c.namespaces {
stats = map[string]interface{}{
"license": map[string]interface{}{
"features": "Namespaces,",
},
}
}
}
return map[string]map[string]interface{}{
"Config": {
"Datacenter": "dc1",
"NodeName": "x52",
"NodeID": "9e7bf42e-a0b4-61b7-24f9-66dead411f0f",
"Revision": "22ce6c6ad",
"Server": true,
"Version": version,
},
"Stats": stats,
"Member": {
"Addr": "127.0.0.1",
"DelegateCur": 4,
"DelegateMax": 5,
"DelegateMin": 2,
"Name": "rusty",
"Port": 8301,
"ProtocolCur": 2,
"ProtocolMax": 5,
"ProtocolMin": 1,
"Status": 1,
"Tags": map[string]interface{}{
"build": build,
},
},
"xDS": {
"SupportedProxies": map[string]interface{}{
"envoy": []interface{}{
"1.14.2",
"1.13.2",
"1.12.4",
"1.11.2",
},
},
},
}, nil
}
func getNamespace(q *api.QueryOptions) string {
if q == nil || q.Namespace == "" {
return "default"
}
return q.Namespace
}
// ServicesWithFilterOpts implements AgentAPI
func (c *MockAgent) ServicesWithFilterOpts(_ string, q *api.QueryOptions) (map[string]*api.AgentService, error) {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
namespace := getNamespace(q)
r := make(map[string]*api.AgentService, len(c.services))
for k, v := range c.services[namespace] {
r[k] = &api.AgentService{
ID: v.ID,
Service: v.Name,
Tags: make([]string, len(v.Tags)),
Meta: maps.Clone(v.Meta),
Port: v.Port,
Address: v.Address,
EnableTagOverride: v.EnableTagOverride,
}
copy(r[k].Tags, v.Tags)
}
return r, nil
}
// ChecksWithFilterOpts implements AgentAPI
func (c *MockAgent) ChecksWithFilterOpts(_ string, q *api.QueryOptions) (map[string]*api.AgentCheck, error) {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
namespace := getNamespace(q)
r := make(map[string]*api.AgentCheck, len(c.checks))
for k, v := range c.checks[namespace] {
r[k] = &api.AgentCheck{
CheckID: v.ID,
Name: v.Name,
Status: c.checkStatus,
Notes: v.Notes,
ServiceID: v.ServiceID,
ServiceName: c.services[namespace][v.ServiceID].Name,
}
}
return r, nil
}
// CheckRegs returns the raw AgentCheckRegistrations registered with this mock
// agent, across all namespaces.
func (c *MockAgent) CheckRegs() []*api.AgentCheckRegistration {
c.mu.Lock()
defer c.mu.Unlock()
regs := make([]*api.AgentCheckRegistration, 0, len(c.checks))
for namespace := range c.checks {
for _, check := range c.checks[namespace] {
regs = append(regs, check)
}
}
return regs
}
// CheckRegister implements AgentAPI
func (c *MockAgent) CheckRegister(check *api.AgentCheckRegistration) error {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
// Consul will set empty Namespace to default, do the same here
if check.Namespace == "" {
check.Namespace = "default"
}
if c.checks[check.Namespace] == nil {
c.checks[check.Namespace] = make(map[string]*api.AgentCheckRegistration)
}
c.checks[check.Namespace][check.ID] = check
// Be nice and make checks reachable-by-service
serviceCheck := check.AgentServiceCheck
if c.services[check.Namespace] == nil {
c.services[check.Namespace] = make(map[string]*api.AgentServiceRegistration)
}
c.services[check.Namespace][check.ServiceID].Checks = append(c.services[check.Namespace][check.ServiceID].Checks, &serviceCheck)
return nil
}
// CheckDeregisterOpts implements AgentAPI
func (c *MockAgent) CheckDeregisterOpts(checkID string, q *api.QueryOptions) error {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
namespace := getNamespace(q)
delete(c.checks[namespace], checkID)
delete(c.checkTTLs[namespace], checkID)
return nil
}
// ServiceRegister implements AgentAPI
func (c *MockAgent) ServiceRegister(service *api.AgentServiceRegistration) error {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
// Consul will set empty Namespace to default, do the same here
if service.Namespace == "" {
service.Namespace = "default"
}
if c.services[service.Namespace] == nil {
c.services[service.Namespace] = make(map[string]*api.AgentServiceRegistration)
}
c.services[service.Namespace][service.ID] = service
return nil
}
// ServiceDeregisterOpts implements AgentAPI
func (c *MockAgent) ServiceDeregisterOpts(serviceID string, q *api.QueryOptions) error {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
namespace := getNamespace(q)
delete(c.services[namespace], serviceID)
for k, v := range c.checks[namespace] {
if v.ServiceID == serviceID {
delete(c.checks[namespace], k)
delete(c.checkTTLs[namespace], k)
}
}
return nil
}
// UpdateTTLOpts implements AgentAPI
func (c *MockAgent) UpdateTTLOpts(id string, output string, status string, q *api.QueryOptions) error {
c.mu.Lock()
defer c.mu.Unlock()
c.hits++
namespace := getNamespace(q)
checks, nsExists := c.checks[namespace]
if !nsExists {
return fmt.Errorf("unknown checks namespace: %q", namespace)
}
check, checkExists := checks[id]
if !checkExists {
return fmt.Errorf("unknown check: %s/%s", namespace, id)
}
// Flip initial status to passing
// todo(shoenig) why not just set to the given status?
check.Status = "passing"
c.checkTTLs[namespace][id]++
return nil
}
// a convenience method for looking up a registered service by name
func (c *MockAgent) lookupService(namespace, name string) []*api.AgentServiceRegistration {
c.mu.Lock()
defer c.mu.Unlock()
var services []*api.AgentServiceRegistration
for _, service := range c.services[namespace] {
if service.Name == name {
services = append(services, service)
}
}
return services
}