-
Notifications
You must be signed in to change notification settings - Fork 782
/
dependency.go
297 lines (246 loc) · 6.44 KB
/
dependency.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
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package dependency
import (
"fmt"
"net/url"
"regexp"
"sort"
"strconv"
"time"
consulapi "github.com/hashicorp/consul/api"
nomadapi "github.com/hashicorp/nomad/api"
)
const (
dcRe = `(@(?P<dc>[[:word:]\.\-\_]+))?`
keyRe = `/?(?P<key>[^@\?]+)`
filterRe = `(\|(?P<filter>[[:word:]\,]+))?`
serviceNameRe = `(?P<name>[[:word:]\-\_]+)`
queryRe = `(\?(?P<query>[[:word:]\-\_\=\&]+))?`
nodeNameRe = `(?P<name>[[:word:]\.\-\_]+)`
nearRe = `(~(?P<near>[[:word:]\.\-\_]+))?`
prefixRe = `/?(?P<prefix>[^@\?]+)`
tagRe = `((?P<tag>[[:word:]=:\.\-\_]+)\.)?`
regionRe = `(@(?P<region>[[:word:]\.\-\_]+))?`
nvPathRe = `/?(?P<path>[^@]+)`
nvNamespaceRe = `(@(?P<namespace>[[:word:]\-\_]+))?`
nvListPrefixRe = `/?(?P<prefix>[^@]*)`
nvListNSRe = `(@(?P<namespace>([[:word:]\-\_]+|\*)))?`
nvRegionRe = `(\.(?P<region>[[:word:]\-\_]+))?`
)
type Type int
const (
TypeConsul Type = iota
TypeVault
TypeLocal
TypeNomad
)
const (
// DefaultContextTimeout context wait timeout for blocking queries.
DefaultContextTimeout = 60 * time.Second
)
// Dependency is an interface for a dependency that Consul Template is capable
// of watching.
type Dependency interface {
Fetch(*ClientSet, *QueryOptions) (interface{}, *ResponseMetadata, error)
CanShare() bool
String() string
Stop()
Type() Type
}
// ServiceTags is a slice of tags assigned to a Service
type ServiceTags []string
// QueryOptions is a list of options to send with the query. These options are
// client-agnostic, and the dependency determines which, if any, of the options
// to use.
type QueryOptions struct {
AllowStale bool
Datacenter string
Region string
Near string
Choose string
RequireConsistent bool
VaultGrace time.Duration
WaitIndex uint64
WaitTime time.Duration
ConsulPeer string
ConsulPartition string
ConsulNamespace string
}
func (q *QueryOptions) Merge(o *QueryOptions) *QueryOptions {
var r QueryOptions
if q == nil {
if o == nil {
return &QueryOptions{}
}
r = *o
return &r
}
r = *q
if o == nil {
return &r
}
if o.AllowStale {
r.AllowStale = o.AllowStale
}
if o.Datacenter != "" {
r.Datacenter = o.Datacenter
}
if o.Region != "" {
r.Region = o.Region
}
if o.Near != "" {
r.Near = o.Near
}
if o.Choose != "" {
r.Choose = o.Choose
}
if o.RequireConsistent {
r.RequireConsistent = o.RequireConsistent
}
if o.WaitIndex != 0 {
r.WaitIndex = o.WaitIndex
}
if o.WaitTime != 0 {
r.WaitTime = o.WaitTime
}
if o.ConsulNamespace != "" {
r.ConsulNamespace = o.ConsulNamespace
}
if o.ConsulPartition != "" {
r.ConsulPartition = o.ConsulPartition
}
if o.ConsulPeer != "" {
r.ConsulPeer = o.ConsulPeer
}
return &r
}
func (q *QueryOptions) ToConsulOpts() *consulapi.QueryOptions {
return &consulapi.QueryOptions{
AllowStale: q.AllowStale,
Datacenter: q.Datacenter,
Namespace: q.ConsulNamespace,
Partition: q.ConsulPartition,
Peer: q.ConsulPeer,
Near: q.Near,
RequireConsistent: q.RequireConsistent,
WaitIndex: q.WaitIndex,
WaitTime: q.WaitTime,
}
}
// GetConsulQueryOpts parses optional consul query params into key pairs.
// supports namespace, peer and partition params
func GetConsulQueryOpts(queryMap map[string]string, endpointLabel string) (url.Values, error) {
queryParams := url.Values{}
if queryRaw := queryMap["query"]; queryRaw != "" {
var err error
queryParams, err = url.ParseQuery(queryRaw)
if err != nil {
return nil, fmt.Errorf(
"%s: invalid query: %q: %s", endpointLabel, queryRaw, err)
}
// Validate keys.
for key := range queryParams {
switch key {
case QueryNamespace,
QueryPeer,
QueryPartition:
default:
return nil,
fmt.Errorf("%s: invalid query parameter key %q in query %q: supported keys: %s,%s,%s", endpointLabel, key, queryRaw, QueryNamespace, QueryPeer, QueryPartition)
}
}
}
return queryParams, nil
}
func (q *QueryOptions) ToNomadOpts() *nomadapi.QueryOptions {
var params map[string]string
if q.Choose != "" {
params = map[string]string{
"choose": q.Choose,
}
}
return &nomadapi.QueryOptions{
AllowStale: q.AllowStale,
Region: q.Region,
Params: params,
WaitIndex: q.WaitIndex,
WaitTime: q.WaitTime,
}
}
func (q *QueryOptions) String() string {
u := &url.Values{}
if q.AllowStale {
u.Add("stale", strconv.FormatBool(q.AllowStale))
}
if q.Datacenter != "" {
u.Add("dc", q.Datacenter)
}
if q.Region != "" {
u.Add("region", q.Region)
}
if q.ConsulNamespace != "" {
u.Add(QueryNamespace, q.ConsulNamespace)
}
if q.ConsulPeer != "" {
u.Add(QueryPeer, q.ConsulPeer)
}
if q.ConsulPartition != "" {
u.Add(QueryPartition, q.ConsulPartition)
}
if q.Near != "" {
u.Add("near", q.Near)
}
if q.Choose != "" {
u.Add("choose", q.Choose)
}
if q.RequireConsistent {
u.Add("consistent", strconv.FormatBool(q.RequireConsistent))
}
if q.WaitIndex != 0 {
u.Add("index", strconv.FormatUint(q.WaitIndex, 10))
}
if q.WaitTime != 0 {
u.Add("wait", q.WaitTime.String())
}
return u.Encode()
}
// ResponseMetadata is a struct that contains metadata about the response. This
// is returned from a Fetch function call.
type ResponseMetadata struct {
LastIndex uint64
LastContact time.Duration
BlockOnNil bool // keep blocking on `nil` data returns
}
// deepCopyAndSortTags deep copies the tags in the given string slice and then
// sorts and returns the copied result.
func deepCopyAndSortTags(tags []string) []string {
newTags := make([]string, 0, len(tags))
newTags = append(newTags, tags...)
sort.Strings(newTags)
return newTags
}
// respWithMetadata is a short wrapper to return the given interface with fake
// response metadata for non-Consul dependencies.
func respWithMetadata(i interface{}) (interface{}, *ResponseMetadata, error) {
return i, &ResponseMetadata{
LastContact: 0,
LastIndex: uint64(time.Now().Unix()),
}, nil
}
// regexpMatch matches the given regexp and extracts the match groups into a
// named map.
func regexpMatch(re *regexp.Regexp, q string) map[string]string {
names := re.SubexpNames()
match := re.FindAllStringSubmatch(q, -1)
if len(match) == 0 {
return map[string]string{}
}
m := map[string]string{}
for i, n := range match[0] {
if names[i] != "" {
m[names[i]] = n
}
}
return m
}