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
|
#!/usr/bin/env python3
# Copyright 2022 The Pigweed Authors
#
# 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
#
# https://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.
"""Tests for retreiving and parsing metrics."""
from unittest import TestCase, mock, main
from pw_metric.metric_parser import parse_metrics
from pw_metric_proto import metric_service_pb2
from pw_status import Status
from pw_tokenizer import detokenize, tokens
DATABASE = tokens.Database(
[
tokens.TokenizedStringEntry(0x01148A48, "total_dropped"),
tokens.TokenizedStringEntry(0x03796798, "min_queue_remaining"),
tokens.TokenizedStringEntry(0x22198280, "total_created"),
tokens.TokenizedStringEntry(0x534A42F4, "max_queue_used"),
tokens.TokenizedStringEntry(0x5D087463, "pw::work_queue::WorkQueue"),
tokens.TokenizedStringEntry(0xA7C43965, "log"),
]
)
class TestParseMetrics(TestCase):
"""Test parsing metrics received from RPCs"""
def setUp(self) -> None:
"""Creating detokenizer and mocking RPC."""
self.detokenize = detokenize.Detokenizer(DATABASE)
self.rpc_timeout_s = 1
self.rpcs = mock.Mock()
self.rpcs.pw = mock.Mock()
self.rpcs.pw.metric = mock.Mock()
self.rpcs.pw.metric.proto = mock.Mock()
self.rpcs.pw.metric.proto.MetricService = mock.Mock()
self.rpcs.pw.metric.proto.MetricService.Get = mock.Mock()
self.rpcs.pw.metric.proto.MetricService.Get.return_value = mock.Mock()
self.rpcs.pw.metric.proto.MetricService.Get.return_value.status = (
Status.OK
)
# Creating a group and metric name for better identification.
self.log = 0xA7C43965
self.total_created = 0x22198280
self.total_dropped = 0x01148A48
self.min_queue_remaining = 0x03796798
self.metric = [
metric_service_pb2.Metric(
token_path=[self.log, self.total_created],
string_path='N/A',
as_float=3.0,
),
metric_service_pb2.Metric(
token_path=[self.log, self.total_dropped],
string_path='N/A',
as_float=4.0,
),
]
def test_invalid_detokenizer(self) -> None:
"""Test invalid detokenizer was supplied."""
self.assertEqual(
{},
parse_metrics(self.rpcs, None, self.rpc_timeout_s),
msg='Valid detokenizer.',
)
def test_bad_stream_status(self) -> None:
"""Test stream response has a status other than OK."""
self.rpcs.pw.metric.proto.MetricService.Get.return_value.status = (
Status.ABORTED
)
self.assertEqual(
{},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Stream response was not aborted.',
)
def test_parse_metrics(self) -> None:
"""Test metrics being parsed and recorded."""
# Loading metric into RPC.
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=self.metric)
]
self.assertEqual(
{
'log': {
'total_created': 3.0,
'total_dropped': 4.0,
}
},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Metrics are not equal.',
)
def test_three_metric_names(self) -> None:
"""Test creating a dictionary with three paths."""
# Creating another leaf.
self.metric.append(
metric_service_pb2.Metric(
token_path=[self.log, self.min_queue_remaining],
string_path='N/A',
as_float=1.0,
)
)
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=self.metric)
]
self.assertEqual(
{
'log': {
'total_created': 3.0,
'total_dropped': 4.0,
'min_queue_remaining': 1.0,
},
},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Metrics are not equal.',
)
def test_inserting_unknown_token(self) -> None:
# Inserting an unknown token as a group name.
self.metric.append(
metric_service_pb2.Metric(
token_path=[0x007, self.total_dropped],
string_path='N/A',
as_float=1.0,
)
)
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=self.metric)
]
self.assertEqual(
{
'log': {
'total_created': 3.0,
'total_dropped': 4.0,
},
'$': {'total_dropped': 1.0},
},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Metrics are not equal.',
)
def test_multiple_metric_response(self) -> None:
"""Tests multiple metric responses being handled."""
# Adding more than one MetricResponses.
metric = [
metric_service_pb2.Metric(
token_path=[0x007, self.total_dropped],
string_path='N/A',
as_float=1.0,
)
]
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=self.metric),
metric_service_pb2.MetricResponse(metrics=metric),
]
self.assertEqual(
{
'log': {
'total_created': 3.0,
'total_dropped': 4.0,
},
'$': {
'total_dropped': 1.0,
},
},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Metrics are not equal.',
)
def test_paths_longer_than_two(self) -> None:
"""Tests metric paths longer than two."""
# Path longer than two.
longest_metric = [
metric_service_pb2.Metric(
token_path=[
self.log,
self.total_created,
self.min_queue_remaining,
],
string_path='N/A',
as_float=1.0,
),
]
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=longest_metric),
]
self.assertEqual(
{
'log': {
'total_created': {'min_queue_remaining': 1.0},
}
},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Metrics are not equal.',
)
# Create a new leaf in log.
longest_metric.append(
metric_service_pb2.Metric(
token_path=[self.log, self.total_dropped],
string_path='N/A',
as_float=3.0,
)
)
metric = [
metric_service_pb2.Metric(
token_path=[0x007, self.total_dropped],
string_path='N/A',
as_float=1.0,
),
metric_service_pb2.Metric(
token_path=[0x007, self.total_created],
string_path='N/A',
as_float=2.0,
),
]
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=longest_metric),
metric_service_pb2.MetricResponse(metrics=metric),
]
self.assertEqual(
{
'log': {
'total_created': {
'min_queue_remaining': 1.0,
},
'total_dropped': 3.0,
},
'$': {
'total_dropped': 1.0,
'total_created': 2.0,
},
},
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s),
msg='Metrics are not equal.',
)
def test_conflicting_keys(self) -> None:
"""Tests conflicting key and value assignment."""
longest_metric = [
metric_service_pb2.Metric(
token_path=[
self.log,
self.total_created,
self.min_queue_remaining,
],
string_path='N/A',
as_float=1.0,
),
]
# Creates a conflict at log/total_created, should throw an error.
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=longest_metric),
metric_service_pb2.MetricResponse(metrics=self.metric),
]
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s)
self.assertRaises(ValueError, msg='Expected Value Error.')
def test_conflicting_logs(self) -> None:
"""Tests conflicting loga being streamed."""
longest_metric = [
metric_service_pb2.Metric(
token_path=[self.log, self.total_created],
string_path='N/A',
as_float=1.0,
),
]
# Creates a duplicate metric for log/total_created.
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=longest_metric),
metric_service_pb2.MetricResponse(metrics=self.metric),
]
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s)
self.assertRaises(ValueError, msg='Expected Value Error.')
# Duplicate metrics being loaded.
self.rpcs.pw.metric.proto.MetricService.Get.return_value.responses = [
metric_service_pb2.MetricResponse(metrics=self.metric),
metric_service_pb2.MetricResponse(metrics=self.metric),
]
parse_metrics(self.rpcs, self.detokenize, self.rpc_timeout_s)
self.assertRaises(ValueError, msg='Expected Value Error.')
if __name__ == '__main__':
main()
|
