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
|
# Copyright 2020 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import os
from parameterized import parameterized
import sys
import unittest
sys.path.append(os.path.join(os.path.dirname(__file__), '..', 'common'))
import etree_util
import histogram_configuration_model
PRETTY_XML_RIGHT_ENUM_ORDER = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
<enum name="Enum2">
<summary>Summary text</summary>
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
<enum name="Enum3">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
PRETTY_XML = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_ATTRIBUTE_ORDER = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int label="Label1" value="0" >Int text</int>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_INDENT = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_SINGLELINE = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<obsolete>Obsolete text</obsolete>
<summary>
Summary text
</summary>
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_LINEBREAK = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_ENUM_ORDER = """
<histogram-configuration>
<enums>
<enum name="Enum2">
<summary>Summary text</summary>
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
<enum name="Enum3">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
</enum>
<enum name="Enum1">
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_INT_ORDER = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<obsolete>
Obsolete text
</obsolete>
<summary>Summary text</summary>
<int value="1" label="Label2"/>
<int value="0" label="Label1">Int text</int>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WRONG_CHILDREN_ORDER = """
<histogram-configuration>
<enums>
<enum name="Enum1">
<int value="0" label="Label1">Int text</int>
<int value="1" label="Label2"/>
<summary>Summary text</summary>
<obsolete>
Obsolete text
</obsolete>
</enum>
</enums>
</histogram-configuration>
""".strip()
PRETTY_XML_WITH_COMMENTS = """
<histogram-configuration>
<enums>
<!-- Comment1 -->
<enum name="Enum1">
<!-- Comment2 -->
<summary>Summary text</summary>
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
<enum name="Enum2">
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
XML_WITH_COMMENTS_WRONG_INDENT_LINEBREAK = """
<histogram-configuration>
<enums>
<!-- Comment1 -->
<enum name="Enum1">
<!-- Comment2 -->
<summary>Summary text</summary>
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
<enum name="Enum2">
<int value="0" label="Label1"/>
<int value="1" label="Label2"/>
</enum>
</enums>
</histogram-configuration>
""".strip()
class EnumXmlTest(unittest.TestCase):
@parameterized.expand([
# Test prettify already pretty XML to verify the pretty-printed version
# is the same.
('AlreadyPrettyXml', PRETTY_XML, PRETTY_XML),
('AttributeOrder', XML_WRONG_ATTRIBUTE_ORDER, PRETTY_XML),
('Indent', XML_WRONG_INDENT, PRETTY_XML),
('SingleLine', XML_WRONG_SINGLELINE, PRETTY_XML),
('LineBreak', XML_WRONG_LINEBREAK, PRETTY_XML),
# <int> tags of enums should be sorted by the integer value
('IntOrder', XML_WRONG_INT_ORDER, PRETTY_XML),
# The children of enums should be sorted in the order of <obsolete>,
# <summary> and <int>
('ChildrenOrder', XML_WRONG_CHILDREN_ORDER, PRETTY_XML),
# Test prettify already pretty XML with right enum order to verify the
# pretty-printed version is the same.
('AlreadyRightOrder', PRETTY_XML_RIGHT_ENUM_ORDER,
PRETTY_XML_RIGHT_ENUM_ORDER),
# Enums should be sorted in the order of their name attribute
('EnumOrder', XML_WRONG_ENUM_ORDER, PRETTY_XML_RIGHT_ENUM_ORDER),
# Test prettify already pretty XML with comments to verify the
# pretty-printed version is the same.
('AlreadyPrettyWithComments', PRETTY_XML_WITH_COMMENTS,
PRETTY_XML_WITH_COMMENTS),
('CommentsIndentsLineBreak', XML_WITH_COMMENTS_WRONG_INDENT_LINEBREAK,
PRETTY_XML_WITH_COMMENTS),
])
def testPrettify(self, _, input_xml, expected_xml):
result = histogram_configuration_model.PrettifyTree(
etree_util.ParseXMLString(input_xml))
self.assertMultiLineEqual(result.strip(), expected_xml)
@parameterized.expand([
# The "name" attribute of <enum> only allows alphanumeric characters
# and punctuations "." and "_". It does not allow space.
('BadEnumNameIllegalPunctuation', PRETTY_XML, 'Enum1', 'Enum:1'),
('BadEnumNameWithSpace', PRETTY_XML, 'Enum1', 'Enum 1'),
('BadIntValueNegative', PRETTY_XML, '1', '-5'),
('BadIntValueNonNumeric', PRETTY_XML, '1', 'hello')
])
def testRegex(self, _, pretty_input_xml, original_string, bad_string):
BAD_XML = pretty_input_xml.replace(original_string, bad_string)
with self.assertRaises(ValueError) as context:
histogram_configuration_model.PrettifyTree(
etree_util.ParseXMLString(BAD_XML))
self.assertIn(bad_string, str(context.exception))
self.assertIn('does not match regex', str(context.exception))
if __name__ == '__main__':
unittest.main()
|