forked from googleapis/google-cloud-go
/
fake.go
408 lines (360 loc) · 12.2 KB
/
fake.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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
/*
Copyright 2016 Google Inc. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Package testing provides support for testing the logging client.
package testing
import (
"errors"
"fmt"
"regexp"
"sort"
"strconv"
"strings"
"sync"
"time"
emptypb "github.com/golang/protobuf/ptypes/empty"
tspb "github.com/golang/protobuf/ptypes/timestamp"
"cloud.google.com/go/internal/testutil"
context "golang.org/x/net/context"
lpb "google.golang.org/genproto/googleapis/api/label"
mrpb "google.golang.org/genproto/googleapis/api/monitoredres"
logpb "google.golang.org/genproto/googleapis/logging/v2"
)
type loggingHandler struct {
logpb.LoggingServiceV2Server
mu sync.Mutex
logs map[string][]*logpb.LogEntry // indexed by log name
}
type configHandler struct {
logpb.ConfigServiceV2Server
mu sync.Mutex
sinks map[string]*logpb.LogSink // indexed by (full) sink name
}
type metricHandler struct {
logpb.MetricsServiceV2Server
mu sync.Mutex
metrics map[string]*logpb.LogMetric // indexed by (full) metric name
}
// NewServer creates a new in-memory fake server implementing the logging service.
// It returns the address of the server.
func NewServer() (string, error) {
srv, err := testutil.NewServer()
if err != nil {
return "", err
}
logpb.RegisterLoggingServiceV2Server(srv.Gsrv, &loggingHandler{
logs: make(map[string][]*logpb.LogEntry),
})
logpb.RegisterConfigServiceV2Server(srv.Gsrv, &configHandler{
sinks: make(map[string]*logpb.LogSink),
})
logpb.RegisterMetricsServiceV2Server(srv.Gsrv, &metricHandler{
metrics: make(map[string]*logpb.LogMetric),
})
srv.Start()
return srv.Addr, nil
}
// DeleteLog deletes a log and all its log entries. The log will reappear if it
// receives new entries.
func (h *loggingHandler) DeleteLog(_ context.Context, req *logpb.DeleteLogRequest) (*emptypb.Empty, error) {
// TODO(jba): return NotFound if log isn't there?
h.mu.Lock()
defer h.mu.Unlock()
delete(h.logs, req.LogName)
return &emptypb.Empty{}, nil
}
// The only project ID that WriteLogEntries will accept.
// Important for testing Ping.
const validProjectID = "PROJECT_ID"
// WriteLogEntries writes log entries to Stackdriver Logging. All log entries in
// Stackdriver Logging are written by this method.
func (h *loggingHandler) WriteLogEntries(_ context.Context, req *logpb.WriteLogEntriesRequest) (*logpb.WriteLogEntriesResponse, error) {
if !strings.HasPrefix(req.LogName, "projects/"+validProjectID+"/") {
return nil, fmt.Errorf("bad project ID: %q", req.LogName)
}
// TODO(jba): support insertId?
h.mu.Lock()
defer h.mu.Unlock()
for _, e := range req.Entries {
// Assign timestamp if missing.
if e.Timestamp == nil {
e.Timestamp = &tspb.Timestamp{Seconds: time.Now().Unix(), Nanos: 0}
}
// Fill from common fields in request.
if e.LogName == "" {
e.LogName = req.LogName
}
if e.Resource == nil {
// TODO(jba): use a global one if nil?
e.Resource = req.Resource
}
for k, v := range req.Labels {
if _, ok := e.Labels[k]; !ok {
e.Labels[k] = v
}
}
// Store by log name.
h.logs[e.LogName] = append(h.logs[e.LogName], e)
}
return &logpb.WriteLogEntriesResponse{}, nil
}
// ListLogEntries lists log entries. Use this method to retrieve log entries
// from Stackdriver Logging.
//
// This fake implementation ignores project IDs. It does not support full filtering, only
// expressions of the form "logName = NAME".
func (h *loggingHandler) ListLogEntries(_ context.Context, req *logpb.ListLogEntriesRequest) (*logpb.ListLogEntriesResponse, error) {
h.mu.Lock()
defer h.mu.Unlock()
entries, err := h.filterEntries(req.Filter)
if err != nil {
return nil, err
}
if err = sortEntries(entries, req.OrderBy); err != nil {
return nil, err
}
from, to, nextPageToken, err := getPage(int(req.PageSize), req.PageToken, len(entries))
if err != nil {
return nil, err
}
return &logpb.ListLogEntriesResponse{
Entries: entries[from:to],
NextPageToken: nextPageToken,
}, nil
}
// getPage converts an incoming page size and token from an RPC request into
// slice bounds and the outgoing next-page token.
//
// getPage assumes that the complete, unpaginated list of items exists as a
// single slice. In addition to the page size and token, getPage needs the
// length of that slice.
//
// getPage's first two return values should be used to construct a sub-slice of
// the complete, unpaginated slice. E.g. if the complete slice is s, then
// s[from:to] is the desired page. Its third return value should be set as the
// NextPageToken field of the RPC response.
func getPage(pageSize int, pageToken string, length int) (from, to int, nextPageToken string, err error) {
from, to = 0, length
if pageToken != "" {
from, err = strconv.Atoi(pageToken)
if err != nil {
return 0, 0, "", invalidArgument("bad page token")
}
if from >= length {
return length, length, "", nil
}
}
if pageSize > 0 && from+pageSize < length {
to = from + pageSize
nextPageToken = strconv.Itoa(to)
}
return from, to, nextPageToken, nil
}
func (h *loggingHandler) filterEntries(filter string) ([]*logpb.LogEntry, error) {
logName, err := parseFilter(filter)
if err != nil {
return nil, err
}
if logName != "" {
return h.logs[logName], nil
}
var entries []*logpb.LogEntry
for _, es := range h.logs {
entries = append(entries, es...)
}
return entries, nil
}
var filterRegexp = regexp.MustCompile(`^logName\s*=\s*"?([-_/.%\w]+)"?$`)
// returns the log name, or "" for the empty filter
func parseFilter(filter string) (string, error) {
if filter == "" {
return "", nil
}
subs := filterRegexp.FindStringSubmatch(filter)
if subs == nil {
return "", invalidArgument("bad filter")
}
return subs[1], nil // cannot panic by construction of regexp
}
func sortEntries(entries []*logpb.LogEntry, orderBy string) error {
switch orderBy {
case "", "timestamp asc":
sort.Sort(byTimestamp(entries))
return nil
case "timestamp desc":
sort.Sort(sort.Reverse(byTimestamp(entries)))
return nil
default:
return invalidArgument("bad order_by")
}
}
type byTimestamp []*logpb.LogEntry
func (s byTimestamp) Len() int { return len(s) }
func (s byTimestamp) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s byTimestamp) Less(i, j int) bool {
c := compareTimestamps(s[i].Timestamp, s[j].Timestamp)
switch {
case c < 0:
return true
case c > 0:
return false
default:
return s[i].InsertId < s[j].InsertId
}
}
func compareTimestamps(ts1, ts2 *tspb.Timestamp) int64 {
if ts1.Seconds != ts2.Seconds {
return ts1.Seconds - ts2.Seconds
}
return int64(ts1.Nanos - ts2.Nanos)
}
// Lists monitored resource descriptors that are used by Stackdriver Logging.
func (h *loggingHandler) ListMonitoredResourceDescriptors(context.Context, *logpb.ListMonitoredResourceDescriptorsRequest) (*logpb.ListMonitoredResourceDescriptorsResponse, error) {
return &logpb.ListMonitoredResourceDescriptorsResponse{
ResourceDescriptors: []*mrpb.MonitoredResourceDescriptor{
{
Type: "global",
DisplayName: "Global",
Description: "... a log is not associated with any specific resource.",
Labels: []*lpb.LabelDescriptor{
{Key: "project_id", Description: "The identifier of the GCP project..."},
},
},
},
}, nil
}
// Gets a sink.
func (h *configHandler) GetSink(_ context.Context, req *logpb.GetSinkRequest) (*logpb.LogSink, error) {
h.mu.Lock()
defer h.mu.Unlock()
if s, ok := h.sinks[req.SinkName]; ok {
return s, nil
}
// TODO(jba): use error codes
return nil, fmt.Errorf("sink %q not found", req.SinkName)
}
// Creates a sink.
func (h *configHandler) CreateSink(_ context.Context, req *logpb.CreateSinkRequest) (*logpb.LogSink, error) {
h.mu.Lock()
defer h.mu.Unlock()
fullName := fmt.Sprintf("%s/sinks/%s", req.Parent, req.Sink.Name)
if _, ok := h.sinks[fullName]; ok {
return nil, fmt.Errorf("sink with name %q already exists", fullName)
}
h.sinks[fullName] = req.Sink
return req.Sink, nil
}
// Creates or updates a sink.
func (h *configHandler) UpdateSink(_ context.Context, req *logpb.UpdateSinkRequest) (*logpb.LogSink, error) {
h.mu.Lock()
defer h.mu.Unlock()
// Update of a non-existent sink will create it.
h.sinks[req.SinkName] = req.Sink
return req.Sink, nil
}
// Deletes a sink.
func (h *configHandler) DeleteSink(_ context.Context, req *logpb.DeleteSinkRequest) (*emptypb.Empty, error) {
h.mu.Lock()
defer h.mu.Unlock()
delete(h.sinks, req.SinkName)
return &emptypb.Empty{}, nil
}
// Lists sinks. This fake implementation ignores the Parent field of
// ListSinksRequest. All sinks are listed, regardless of their project.
func (h *configHandler) ListSinks(_ context.Context, req *logpb.ListSinksRequest) (*logpb.ListSinksResponse, error) {
h.mu.Lock()
var sinks []*logpb.LogSink
for _, s := range h.sinks {
sinks = append(sinks, s)
}
h.mu.Unlock() // safe because no *logpb.LogSink is ever modified
// Since map iteration varies, sort the sinks.
sort.Sort(sinksByName(sinks))
from, to, nextPageToken, err := getPage(int(req.PageSize), req.PageToken, len(sinks))
if err != nil {
return nil, err
}
return &logpb.ListSinksResponse{
Sinks: sinks[from:to],
NextPageToken: nextPageToken,
}, nil
return nil, nil
}
type sinksByName []*logpb.LogSink
func (s sinksByName) Len() int { return len(s) }
func (s sinksByName) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s sinksByName) Less(i, j int) bool { return s[i].Name < s[j].Name }
// Gets a metric.
func (h *metricHandler) GetLogMetric(_ context.Context, req *logpb.GetLogMetricRequest) (*logpb.LogMetric, error) {
h.mu.Lock()
defer h.mu.Unlock()
if s, ok := h.metrics[req.MetricName]; ok {
return s, nil
}
// TODO(jba): use error codes
return nil, fmt.Errorf("metric %q not found", req.MetricName)
}
// Creates a metric.
func (h *metricHandler) CreateLogMetric(_ context.Context, req *logpb.CreateLogMetricRequest) (*logpb.LogMetric, error) {
h.mu.Lock()
defer h.mu.Unlock()
fullName := fmt.Sprintf("%s/metrics/%s", req.Parent, req.Metric.Name)
if _, ok := h.metrics[fullName]; ok {
return nil, fmt.Errorf("metric with name %q already exists", fullName)
}
h.metrics[fullName] = req.Metric
return req.Metric, nil
}
// Creates or updates a metric.
func (h *metricHandler) UpdateLogMetric(_ context.Context, req *logpb.UpdateLogMetricRequest) (*logpb.LogMetric, error) {
h.mu.Lock()
defer h.mu.Unlock()
// Update of a non-existent metric will create it.
h.metrics[req.MetricName] = req.Metric
return req.Metric, nil
}
// Deletes a metric.
func (h *metricHandler) DeleteLogMetric(_ context.Context, req *logpb.DeleteLogMetricRequest) (*emptypb.Empty, error) {
h.mu.Lock()
defer h.mu.Unlock()
delete(h.metrics, req.MetricName)
return &emptypb.Empty{}, nil
}
// Lists metrics. This fake implementation ignores the Parent field of
// ListMetricsRequest. All metrics are listed, regardless of their project.
func (h *metricHandler) ListLogMetrics(_ context.Context, req *logpb.ListLogMetricsRequest) (*logpb.ListLogMetricsResponse, error) {
h.mu.Lock()
var metrics []*logpb.LogMetric
for _, s := range h.metrics {
metrics = append(metrics, s)
}
h.mu.Unlock() // safe because no *logpb.LogMetric is ever modified
// Since map iteration varies, sort the metrics.
sort.Sort(metricsByName(metrics))
from, to, nextPageToken, err := getPage(int(req.PageSize), req.PageToken, len(metrics))
if err != nil {
return nil, err
}
return &logpb.ListLogMetricsResponse{
Metrics: metrics[from:to],
NextPageToken: nextPageToken,
}, nil
return nil, nil
}
type metricsByName []*logpb.LogMetric
func (s metricsByName) Len() int { return len(s) }
func (s metricsByName) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s metricsByName) Less(i, j int) bool { return s[i].Name < s[j].Name }
func invalidArgument(msg string) error {
// TODO(jba): status codes
return errors.New(msg)
}