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
|
# -*- coding: utf-8 -*-
# Copyright 2021 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Model of a structured metrics description xml file.
This marshals an XML string into a Model, and validates that the XML is
semantically correct. The model can also be used to create a canonically
formatted version XML.
"""
import xml.etree.ElementTree as ET
import textwrap as tw
import model_util as util
# Default key rotation period if not explicitly specified in the XML.
DEFAULT_KEY_ROTATION_PERIOD = 90
def wrap(text, indent):
wrapper = tw.TextWrapper(width=80,
initial_indent=indent,
subsequent_indent=indent)
return wrapper.fill(tw.dedent(text))
# TODO(crbug.com/1148168): This can be removed and replaced with textwrap.indent
# once this is run under python3.
def indent(text, prefix):
return '\n'.join(prefix + line if line else '' for line in text.split('\n'))
class Model:
"""Represents all projects in the structured.xml file.
A Model is initialized with an XML string representing the top-level of
the structured.xml file. This file is built from three building blocks:
metrics, events, and projects. These have the following attributes.
METRIC
- summary
- data type
EVENT
- summary
- one or more metrics
PROJECT
- summary
- id specifier
- one or more owners
- one or more events
The following is an example input XML.
<structured-metrics>
<project name="MyProject">
<owner>owner@chromium.org</owner>
<id>none</id>
<scope>profile</scope>
<summary> My project. </summary>
<event name="MyEvent">
<summary> My event. </summary>
<metric name="MyMetric" type="int">
<summary> My metric. </summary>
</metric>
</event>
</project>
</structured-metrics>
Calling str(model) will return a canonically formatted XML string.
"""
OWNER_REGEX = r'^.+@(chromium\.org|google\.com)$'
NAME_REGEX = r'^[A-Za-z0-9_.]+$'
TYPE_REGEX = r'^(hmac-string|raw-string|int)$'
ID_REGEX = r'^(none|per-project|uma)$'
SCOPE_REGEX = r'^(profile|device)$'
KEY_REGEX = r'^[0-9]+$'
def __init__(self, xml_string):
elem = ET.fromstring(xml_string)
util.check_attributes(elem, set())
util.check_children(elem, {'project'})
util.check_child_names_unique(elem, 'project')
projects = util.get_compound_children(elem, 'project')
self.projects = [Project(p) for p in projects]
def __repr__(self):
projects = '\n\n'.join(str(p) for p in self.projects)
result = tw.dedent("""\
<structured-metrics>
{projects}
</structured-metrics>""")
return result.format(projects=projects)
class Project:
"""Represents a single structured metrics project.
A Project is initialized with an XML node representing one project, eg:
<project name="MyProject">
<owner>owner@chromium.org</owner>
<id>none</id>
<scope>project</scope>
<key-rotation>60</key-rotation>
<summary> My project. </summary>
<event name="MyEvent">
<summary> My event. </summary>
<metric name="MyMetric" type="int">
<summary> My metric. </summary>
</metric>
</event>
</project>
Calling str(project) will return a canonically formatted XML string.
"""
def __init__(self, elem):
util.check_attributes(elem, {'name'})
util.check_children(elem, {'id', 'scope', 'summary', 'owner', 'event'})
util.check_child_names_unique(elem, 'event')
self.name = util.get_attr(elem, 'name', Model.NAME_REGEX)
self.id = util.get_text_child(elem, 'id', Model.ID_REGEX)
self.scope = util.get_text_child(elem, 'scope', Model.SCOPE_REGEX)
self.summary = util.get_text_child(elem, 'summary')
self.owners = util.get_text_children(elem, 'owner', Model.OWNER_REGEX)
self.key_rotation_period = DEFAULT_KEY_ROTATION_PERIOD
# Check if key-rotation is specified. If so, then change the
# key_rotation_period.
if elem.find('key-rotation') is not None:
self.key_rotation_period = util.get_text_child(elem, 'key-rotation',
Model.KEY_REGEX)
self.events = [
Event(e, self) for e in util.get_compound_children(elem, 'event')
]
def __repr__(self):
events = '\n\n'.join(str(e) for e in self.events)
events = indent(events, ' ')
summary = wrap(self.summary, indent=' ')
owners = '\n'.join(' <owner>{}</owner>'.format(o) for o in self.owners)
result = tw.dedent("""\
<project name="{name}">
{owners}
<id>{id}</id>
<scope>{scope}</scope>
<key-rotation>{key_rotation}</key-rotation>
<summary>
{summary}
</summary>
{events}
</project>""")
return result.format(name=self.name,
owners=owners,
id=self.id,
scope=self.scope,
summary=summary,
key_rotation=self.key_rotation_period,
events=events)
class Event:
"""Represents a single structured metrics event.
An Event is initialized with an XML node representing one event, eg:
<event name="MyEvent">
<summary> My event. </summary>
<metric name="MyMetric" type="int">
<summary> My metric. </summary>
</metric>
</event>
Calling str(event) will return a canonically formatted XML string.
"""
def __init__(self, elem, project):
util.check_attributes(elem, {'name'})
util.check_children(elem, {'summary', 'metric'})
util.check_child_names_unique(elem, 'metric')
self.name = util.get_attr(elem, 'name', Model.NAME_REGEX)
self.summary = util.get_text_child(elem, 'summary')
self.metrics = [
Metric(m, project) for m in util.get_compound_children(elem, 'metric')
]
def __repr__(self):
metrics = '\n'.join(str(m) for m in self.metrics)
metrics = indent(metrics, ' ')
summary = wrap(self.summary, indent=' ')
result = tw.dedent("""\
<event name="{name}">
<summary>
{summary}
</summary>
{metrics}
</event>""")
return result.format(name=self.name, summary=summary, metrics=metrics)
class Metric:
"""Represents a single metric.
A Metric is initialized with an XML node representing one metric, eg:
<metric name="MyMetric" type="int">
<summary> My metric. </summary>
</metric>
Calling str(metric) will return a canonically formatted XML string.
"""
def __init__(self, elem, project):
util.check_attributes(elem, {'name', 'type'})
util.check_children(elem, {'summary'})
self.name = util.get_attr(elem, 'name', Model.NAME_REGEX)
self.type = util.get_attr(elem, 'type', Model.TYPE_REGEX)
self.summary = util.get_text_child(elem, 'summary')
if self.type == 'raw-string' and project.id != 'none':
util.error(
elem, "raw-string metrics must be in a project with id type "
"'none', but {} has id type '{}'".format(project.name, project.id))
def __repr__(self):
summary = wrap(self.summary, indent=' ')
result = tw.dedent("""\
<metric name="{name}" type="{type}">
<summary>
{summary}
</summary>
</metric>""")
return result.format(name=self.name, type=self.type, summary=summary)
|
