forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_query.py
More file actions
576 lines (464 loc) · 21.2 KB
/
test_query.py
File metadata and controls
576 lines (464 loc) · 21.2 KB
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
# Copyright 2016 Google LLC
#
# 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.
from __future__ import absolute_import
import datetime
import unittest
import mock
PROJECT = "my-project"
METRIC_TYPE = "compute.googleapis.com/instance/uptime"
METRIC_LABELS = {"instance_name": "instance-1"}
METRIC_LABELS2 = {"instance_name": "instance-2"}
RESOURCE_TYPE = "gce_instance"
RESOURCE_LABELS = {
"project_id": "my-project",
"zone": "us-east1-a",
"instance_id": "1234567890123456789",
}
RESOURCE_LABELS2 = {
"project_id": "my-project",
"zone": "us-east1-b",
"instance_id": "9876543210987654321",
}
METRIC_KIND = "DELTA"
VALUE_TYPE = "DOUBLE"
TS0 = datetime.datetime(2016, 4, 6, 22, 5, 0, 42)
TS1 = datetime.datetime(2016, 4, 6, 22, 5, 1, 42)
TS2 = datetime.datetime(2016, 4, 6, 22, 5, 2, 42)
class MultiCallableStub(object):
"""Stub for the grpc.UnaryUnaryMultiCallable interface."""
def __init__(self, method, channel_stub):
self.method = method
self.channel_stub = channel_stub
def __call__(self, request, timeout=None, metadata=None, credentials=None):
self.channel_stub.requests.append((self.method, request))
response = None
if self.channel_stub.responses:
response = self.channel_stub.responses.pop()
if isinstance(response, Exception):
raise response
if response:
return response
class ChannelStub(object):
"""Stub for the grpc.Channel interface."""
def __init__(self, responses=[]):
from google.cloud.monitoring_v3.proto import metric_service_pb2
self.responses = responses
self.responses = [
metric_service_pb2.ListTimeSeriesResponse(**response)
for response in responses
]
self.requests = []
def unary_unary(self, method, request_serializer=None, response_deserializer=None):
return MultiCallableStub(method, self)
class TestQuery(unittest.TestCase):
@staticmethod
def _get_target_class():
from google.cloud.monitoring_v3.query import Query
return Query
def _make_one(self, *args, **kwargs):
return self._get_target_class()(*args, **kwargs)
@staticmethod
def _make_interval(end_time, start_time=None):
from google.cloud.monitoring_v3 import types
interval = types.TimeInterval()
interval.end_time.FromDatetime(end_time)
if start_time is not None:
interval.start_time.FromDatetime(start_time)
return interval
def test_constructor_minimal(self):
from google.cloud.monitoring_v3 import MetricServiceClient
# Mock the API response
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT)
self.assertEqual(query._client, client)
self.assertEqual(
query._filter.metric_type, self._get_target_class().DEFAULT_METRIC_TYPE
)
self.assertIsNone(query._start_time)
self.assertIsNone(query._end_time)
self.assertEqual(query._per_series_aligner, 0)
self.assertEqual(query._alignment_period_seconds, 0)
self.assertEqual(query._cross_series_reducer, 0)
self.assertEqual(query._group_by_fields, ())
def test_constructor_maximal(self):
from google.cloud.monitoring_v3 import MetricServiceClient
T1 = datetime.datetime(2016, 4, 7, 2, 30, 30)
DAYS, HOURS, MINUTES = 1, 2, 3
T0 = T1 - datetime.timedelta(days=DAYS, hours=HOURS, minutes=MINUTES)
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(
client,
PROJECT,
METRIC_TYPE,
end_time=T1,
days=DAYS,
hours=HOURS,
minutes=MINUTES,
)
self.assertEqual(query._client, client)
self.assertEqual(query._filter.metric_type, METRIC_TYPE)
self.assertEqual(query._start_time, T0)
self.assertEqual(query._end_time, T1)
self.assertEqual(query._per_series_aligner, 0)
self.assertEqual(query._alignment_period_seconds, 0)
self.assertEqual(query._cross_series_reducer, 0)
self.assertEqual(query._group_by_fields, ())
def test_constructor_default_end_time(self):
from google.cloud.monitoring_v3 import MetricServiceClient
MINUTES = 5
NOW = datetime.datetime(2016, 4, 7, 2, 30, 30)
T0 = datetime.datetime(2016, 4, 7, 2, 25, 0)
T1 = datetime.datetime(2016, 4, 7, 2, 30, 0)
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
with mock.patch("google.cloud.monitoring_v3.query._UTCNOW", new=lambda: NOW):
query = self._make_one(client, PROJECT, METRIC_TYPE, minutes=MINUTES)
self.assertEqual(query._start_time, T0)
self.assertEqual(query._end_time, T1)
def test_constructor_nonzero_duration_illegal(self):
from google.cloud.monitoring_v3 import MetricServiceClient
T1 = datetime.datetime(2016, 4, 7, 2, 30, 30)
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
with self.assertRaises(ValueError):
self._make_one(client, PROJECT, METRIC_TYPE, end_time=T1)
def test_execution_without_interval_illegal(self):
from google.cloud.monitoring_v3 import MetricServiceClient
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
with self.assertRaises(ValueError):
list(query)
def test_metric_type(self):
from google.cloud.monitoring_v3 import MetricServiceClient
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
self.assertEqual(query.metric_type, METRIC_TYPE)
def test_filter(self):
from google.cloud.monitoring_v3 import MetricServiceClient
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
expected = 'metric.type = "{type}"'.format(type=METRIC_TYPE)
self.assertEqual(query.filter, expected)
def test_filter_by_group(self):
from google.cloud.monitoring_v3 import MetricServiceClient
GROUP = "1234567"
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_group(GROUP)
expected = ('metric.type = "{type}"' ' AND group.id = "{group}"').format(
type=METRIC_TYPE, group=GROUP
)
self.assertEqual(query.filter, expected)
def test_filter_by_projects(self):
from google.cloud.monitoring_v3 import MetricServiceClient
PROJECT1, PROJECT2 = "project-1", "project-2"
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_projects(PROJECT1, PROJECT2)
expected = (
'metric.type = "{type}"'
' AND project = "{project1}" OR project = "{project2}"'
).format(type=METRIC_TYPE, project1=PROJECT1, project2=PROJECT2)
self.assertEqual(query.filter, expected)
def test_filter_by_resources(self):
from google.cloud.monitoring_v3 import MetricServiceClient
ZONE_PREFIX = "europe-"
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_resources(zone_prefix=ZONE_PREFIX)
expected = (
'metric.type = "{type}"'
' AND resource.label.zone = starts_with("{prefix}")'
).format(type=METRIC_TYPE, prefix=ZONE_PREFIX)
self.assertEqual(query.filter, expected)
def test_filter_by_metrics(self):
from google.cloud.monitoring_v3 import MetricServiceClient
INSTANCE = "my-instance"
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_metrics(instance_name=INSTANCE)
expected = (
'metric.type = "{type}"' ' AND metric.label.instance_name = "{instance}"'
).format(type=METRIC_TYPE, instance=INSTANCE)
self.assertEqual(query.filter, expected)
def test_request_parameters_minimal(self):
from google.cloud.monitoring_v3 import MetricServiceClient
from google.cloud.monitoring_v3.gapic import enums
T1 = datetime.datetime(2016, 4, 7, 2, 30, 0)
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_interval(end_time=T1)
actual = query._build_query_params()
expected = {
"name": u"projects/{}".format(PROJECT),
"filter_": 'metric.type = "{type}"'.format(type=METRIC_TYPE),
"interval": self._make_interval(T1),
"view": enums.ListTimeSeriesRequest.TimeSeriesView.FULL,
}
self.assertEqual(actual, expected)
def test_request_parameters_maximal(self):
from google.cloud.monitoring_v3 import MetricServiceClient
from google.cloud.monitoring_v3 import types
from google.cloud.monitoring_v3.gapic import enums
T0 = datetime.datetime(2016, 4, 7, 2, 0, 0)
T1 = datetime.datetime(2016, 4, 7, 2, 30, 0)
ALIGNER = "ALIGN_DELTA"
MINUTES, SECONDS, PERIOD_IN_SECONDS = 1, 30, 90
REDUCER = "REDUCE_MEAN"
FIELD1, FIELD2 = "resource.zone", "metric.instance_name"
PAGE_SIZE = 100
channel = ChannelStub()
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_interval(start_time=T0, end_time=T1)
query = query.align(ALIGNER, minutes=MINUTES, seconds=SECONDS)
query = query.reduce(REDUCER, FIELD1, FIELD2)
actual = query._build_query_params(headers_only=True, page_size=PAGE_SIZE)
expected = {
"name": "projects/%s" % PROJECT,
"filter_": 'metric.type = "{type}"'.format(type=METRIC_TYPE),
"interval": self._make_interval(T1, T0),
"aggregation": types.Aggregation(
per_series_aligner=ALIGNER,
alignment_period={"seconds": PERIOD_IN_SECONDS},
cross_series_reducer=REDUCER,
group_by_fields=[FIELD1, FIELD2],
),
"view": enums.ListTimeSeriesRequest.TimeSeriesView.HEADERS,
"page_size": PAGE_SIZE,
}
self.assertEqual(actual, expected)
def test_iteration(self):
from google.cloud.monitoring_v3 import MetricServiceClient
from google.cloud.monitoring_v3.gapic import enums
from google.cloud.monitoring_v3.proto import metric_service_pb2
T0 = datetime.datetime(2016, 4, 6, 22, 5, 0)
T1 = datetime.datetime(2016, 4, 6, 22, 10, 0)
INTERVAL1 = self._make_interval(TS1, TS0)
INTERVAL2 = self._make_interval(TS2, TS1)
VALUE1 = 60 # seconds
VALUE2 = 60.001 # seconds
SERIES1 = {
"metric": {"type": METRIC_TYPE, "labels": METRIC_LABELS},
"resource": {"type": RESOURCE_TYPE, "labels": RESOURCE_LABELS},
"metric_kind": METRIC_KIND,
"value_type": VALUE_TYPE,
"points": [
{"interval": INTERVAL2, "value": {"double_value": VALUE1}},
{"interval": INTERVAL1, "value": {"double_value": VALUE1}},
],
}
SERIES2 = {
"metric": {"type": METRIC_TYPE, "labels": METRIC_LABELS2},
"resource": {"type": RESOURCE_TYPE, "labels": RESOURCE_LABELS2},
"metric_kind": METRIC_KIND,
"value_type": VALUE_TYPE,
"points": [
{"interval": INTERVAL2, "value": {"double_value": VALUE2}},
{"interval": INTERVAL1, "value": {"double_value": VALUE2}},
],
}
RESPONSE = {"time_series": [SERIES1, SERIES2], "next_page_token": ""}
channel = ChannelStub(responses=[RESPONSE])
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_interval(start_time=T0, end_time=T1)
response = list(query)
self.assertEqual(len(response), 2)
series1, series2 = response
self.assertEqual(series1.metric.labels, METRIC_LABELS)
self.assertEqual(series2.metric.labels, METRIC_LABELS2)
self.assertEqual(series1.resource.labels, RESOURCE_LABELS)
self.assertEqual(series2.resource.labels, RESOURCE_LABELS2)
self.assertEqual(
[p.value.double_value for p in series1.points], [VALUE1, VALUE1]
)
self.assertEqual(
[p.value.double_value for p in series2.points], [VALUE2, VALUE2]
)
self.assertEqual([p.interval for p in series1.points], [INTERVAL2, INTERVAL1])
self.assertEqual([p.interval for p in series2.points], [INTERVAL2, INTERVAL1])
expected_request = metric_service_pb2.ListTimeSeriesRequest(
name="projects/" + PROJECT,
filter='metric.type = "{type}"'.format(type=METRIC_TYPE),
interval=self._make_interval(T1, T0),
view=enums.ListTimeSeriesRequest.TimeSeriesView.FULL,
)
request = channel.requests[0][1]
self.assertEqual(request, expected_request)
def test_iteration_empty(self):
from google.cloud.monitoring_v3 import MetricServiceClient
from google.cloud.monitoring_v3.gapic import enums
from google.cloud.monitoring_v3.proto import metric_service_pb2
T0 = datetime.datetime(2016, 4, 6, 22, 5, 0)
T1 = datetime.datetime(2016, 4, 6, 22, 10, 0)
channel = ChannelStub(responses=[{"next_page_token": ""}])
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_interval(start_time=T0, end_time=T1)
response = list(query)
self.assertEqual(len(response), 0)
expected_request = metric_service_pb2.ListTimeSeriesRequest(
name="projects/" + PROJECT,
filter='metric.type = "{type}"'.format(type=METRIC_TYPE),
interval=self._make_interval(T1, T0),
view=enums.ListTimeSeriesRequest.TimeSeriesView.FULL,
)
request = channel.requests[0][1]
self.assertEqual(request, expected_request)
def test_iteration_headers_only(self):
from google.cloud.monitoring_v3 import MetricServiceClient
from google.cloud.monitoring_v3.gapic import enums
from google.cloud.monitoring_v3.proto import metric_service_pb2
T0 = datetime.datetime(2016, 4, 6, 22, 5, 0)
T1 = datetime.datetime(2016, 4, 6, 22, 10, 0)
SERIES1 = {
"metric": {"type": METRIC_TYPE, "labels": METRIC_LABELS},
"resource": {"type": RESOURCE_TYPE, "labels": RESOURCE_LABELS},
"metric_kind": METRIC_KIND,
"value_type": VALUE_TYPE,
}
SERIES2 = {
"metric": {"type": METRIC_TYPE, "labels": METRIC_LABELS2},
"resource": {"type": RESOURCE_TYPE, "labels": RESOURCE_LABELS2},
"metric_kind": METRIC_KIND,
"value_type": VALUE_TYPE,
}
RESPONSE = {"time_series": [SERIES1, SERIES2], "next_page_token": ""}
channel = ChannelStub(responses=[RESPONSE])
client = MetricServiceClient(channel=channel)
query = self._make_one(client, PROJECT, METRIC_TYPE)
query = query.select_interval(start_time=T0, end_time=T1)
response = list(query.iter(headers_only=True))
self.assertEqual(len(response), 2)
series1, series2 = response
self.assertEqual(series1.metric.labels, METRIC_LABELS)
self.assertEqual(series2.metric.labels, METRIC_LABELS2)
self.assertEqual(series1.resource.labels, RESOURCE_LABELS)
self.assertEqual(series2.resource.labels, RESOURCE_LABELS2)
self.assertFalse(len(series1.points))
self.assertFalse(len(series2.points))
expected_request = metric_service_pb2.ListTimeSeriesRequest(
name="projects/" + PROJECT,
filter='metric.type = "{type}"'.format(type=METRIC_TYPE),
interval=self._make_interval(T1, T0),
view=enums.ListTimeSeriesRequest.TimeSeriesView.HEADERS,
)
request = channel.requests[0][1]
self.assertEqual(request, expected_request)
class Test_Filter(unittest.TestCase):
@staticmethod
def _get_target_class():
from google.cloud.monitoring_v3.query import _Filter
return _Filter
def _make_one(self, metric_type):
return self._get_target_class()(metric_type)
def test_minimal(self):
obj = self._make_one(METRIC_TYPE)
expected = 'metric.type = "{type}"'.format(type=METRIC_TYPE)
self.assertEqual(str(obj), expected)
def test_maximal(self):
obj = self._make_one(METRIC_TYPE)
obj.group_id = "1234567"
obj.projects = "project-1", "project-2"
obj.select_resources(resource_type="some-resource", resource_label="foo")
obj.select_metrics(metric_label_prefix="bar-")
expected = (
'metric.type = "{type}"'
' AND group.id = "1234567"'
' AND project = "project-1" OR project = "project-2"'
' AND resource.label.resource_label = "foo"'
' AND resource.type = "some-resource"'
' AND metric.label.metric_label = starts_with("bar-")'
).format(type=METRIC_TYPE)
self.assertEqual(str(obj), expected)
class Test__build_label_filter(unittest.TestCase):
def _call_fut(self, *args, **kwargs):
from google.cloud.monitoring_v3.query import _build_label_filter
return _build_label_filter(*args, **kwargs)
def test_no_labels(self):
self.assertEqual(self._call_fut("resource"), "")
def test_label_is_none(self):
self.assertEqual(self._call_fut("resource", foo=None), "")
def test_metric_labels(self):
actual = self._call_fut(
"metric", alpha_prefix="a-", beta_gamma_suffix="-b", delta_epsilon="xyz"
)
expected = (
'metric.label.alpha = starts_with("a-")'
' AND metric.label.beta_gamma = ends_with("-b")'
' AND metric.label.delta_epsilon = "xyz"'
)
self.assertEqual(actual, expected)
def test_metric_label_response_code_greater_less(self):
actual = self._call_fut(
"metric", response_code_greater=500, response_code_less=600
)
expected = (
"metric.label.response_code < 600" " AND metric.label.response_code > 500"
)
self.assertEqual(actual, expected)
def test_metric_label_response_code_greater_less_equal(self):
actual = self._call_fut(
"metric", response_code_greaterequal=500, response_code_lessequal=600
)
expected = (
"metric.label.response_code <= 600" " AND metric.label.response_code >= 500"
)
self.assertEqual(actual, expected)
def test_resource_labels(self):
actual = self._call_fut(
"resource", alpha_prefix="a-", beta_gamma_suffix="-b", delta_epsilon="xyz"
)
expected = (
'resource.label.alpha = starts_with("a-")'
' AND resource.label.beta_gamma = ends_with("-b")'
' AND resource.label.delta_epsilon = "xyz"'
)
self.assertEqual(actual, expected)
def test_raw_label_filters(self):
actual = self._call_fut(
"resource",
'resource.label.alpha = starts_with("a-")',
'resource.label.beta_gamma = ends_with("-b")',
'resource.label.delta_epsilon = "xyz"',
)
expected = (
'resource.label.alpha = starts_with("a-")'
' AND resource.label.beta_gamma = ends_with("-b")'
' AND resource.label.delta_epsilon = "xyz"'
)
self.assertEqual(actual, expected)
def test_resource_type(self):
actual = self._call_fut("resource", resource_type="foo")
expected = 'resource.type = "foo"'
self.assertEqual(actual, expected)
def test_resource_type_prefix(self):
actual = self._call_fut("resource", resource_type_prefix="foo-")
expected = 'resource.type = starts_with("foo-")'
self.assertEqual(actual, expected)
def test_resource_type_suffix(self):
actual = self._call_fut("resource", resource_type_suffix="-foo")
expected = 'resource.type = ends_with("-foo")'
self.assertEqual(actual, expected)