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
|
import os
import sys
import unittest
from lxml import etree
from xmldiff import formatting, main, actions
from .testing import generate_filebased_cases
START = '<document xmlns:diff="http://namespaces.shoobx.com/diff"><node'
END = "</node></document>"
class PlaceholderMakerTests(unittest.TestCase):
def test_get_placeholder(self):
replacer = formatting.PlaceholderMaker()
# Get a placeholder:
ph = replacer.get_placeholder(etree.Element("tag"), formatting.T_OPEN, None)
self.assertEqual(ph, "\ue005")
# Do it again:
ph = replacer.get_placeholder(etree.Element("tag"), formatting.T_OPEN, None)
self.assertEqual(ph, "\ue005")
# Get another one
ph = replacer.get_placeholder(etree.Element("tag"), formatting.T_CLOSE, ph)
self.assertEqual(ph, "\ue006")
def test_do_element(self):
replacer = formatting.PlaceholderMaker(["p"], ["b"])
# Formatting tags get replaced, and the content remains
text = "<p>This is a tag with <b>formatted</b> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
self.assertEqual(
etree.tounicode(element),
"<p>This is a tag with \ue006formatted\ue005 text.</p>",
)
replacer.undo_element(element)
self.assertEqual(etree.tounicode(element), text)
# Non formatting tags get replaced with content
text = "<p>This is a tag with <foo>formatted</foo> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
result = etree.tounicode(element)
self.assertEqual(result, "<p>This is a tag with \ue007 text.</p>")
# Single formatting tags still get two placeholders.
text = "<p>This is a <b/> with <foo/> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
result = etree.tounicode(element)
self.assertEqual(result, "<p>This is a \ue009\ue008 with \ue00a text.</p>")
def test_do_undo_element(self):
replacer = formatting.PlaceholderMaker(["p"], ["b"])
# Formatting tags get replaced, and the content remains
text = "<p>This <is/> a <f>tag</f> with <b>formatted</b> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
self.assertEqual(
element.text, "This \ue005 a \ue006 with \ue008formatted" "\ue007 text."
)
replacer.undo_element(element)
result = etree.tounicode(element)
self.assertEqual(result, text)
def test_do_undo_element_double_format(self):
replacer = formatting.PlaceholderMaker(["p"], ["b", "u"])
# Formatting tags get replaced, and the content remains
text = "<p>This is <u>doubly <b>formatted</b></u> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
self.assertEqual(
element.text, "This is \ue006doubly \ue008formatted\ue007" "\ue005 text."
)
replacer.undo_element(element)
result = etree.tounicode(element)
self.assertEqual(result, text)
def test_rml_bug(self):
etree.register_namespace(formatting.DIFF_PREFIX, formatting.DIFF_NS)
before_diff = """<document xmlns:diff="http://namespaces.shoobx.com/diff">
<section>
<para>
<ref>4</ref>.
<u><b>At Will Employment</b></u>
.\u201cText\u201d
</para>
</section>
</document>"""
tree = etree.fromstring(before_diff)
replacer = formatting.PlaceholderMaker(
text_tags=("para",),
formatting_tags=(
"b",
"u",
"i",
),
)
replacer.do_tree(tree)
after_diff = """<document xmlns:diff="http://namespaces.shoobx.com/diff">
<section>
<para>
<insert>\ue005</insert>.
\ue007\ue009At Will Employment\ue008\ue006
.\u201c<insert>New </insert>Text\u201d
</para>
</section>
</document>"""
# The diff formatting will find some text to insert.
delete_attrib = "{%s}delete-format" % formatting.DIFF_NS
replacer.placeholder2tag["\ue006"].element.attrib[delete_attrib] = ""
replacer.placeholder2tag["\ue007"].element.attrib[delete_attrib] = ""
tree = etree.fromstring(after_diff)
replacer.undo_tree(tree)
result = etree.tounicode(tree)
expected = """<document xmlns:diff="http://namespaces.shoobx.com/diff">
<section>
<para>
<insert><ref>4</ref></insert>.
<u diff:delete-format=""><b>At Will Employment</b></u>
.\u201c<insert>New </insert>Text\u201d
</para>
</section>
</document>"""
self.assertEqual(result, expected)
def test_placeholder_overflow(self):
# PY3: This whole test is Python 2 support.
# Test what happens when we have more than 6400 placeholders,
# by patching the placeholder:
try:
orig_start = formatting.PLACEHOLDER_START
# This is the last character of the Private use area
formatting.PLACEHOLDER_START = 0xF8FF
replacer = formatting.PlaceholderMaker(["p"], ["b"])
# Formatting tags get replaced, and the content remains
text = "<p>This <is/> a <f>tag</f> with <b>some</b> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
#
self.assertEqual(
element.text, "This \uf904 a \uf905 with \uf907some" "\uf906 text."
)
try:
# If this is a wide build, also test what happens if we
# get over 8192 substitutions, and overflow the 2-byte code.
# (On narrow builds this will give an error)
formatting.PLACEHOLDER_START = 0xFFFF
replacer = formatting.PlaceholderMaker(["p"], ["b"])
# Formatting tags get replaced, and the content remains
text = "<p>This <is/> a <f>tag</f> with <b>some</b> text.</p>"
element = etree.fromstring(text)
replacer.do_element(element)
# This should raise an error on a narrow build
self.assertEqual(
element.text,
"This \U00010004 a \U00010005 with \U00010007some"
"\U00010006 text.",
)
except ValueError:
if sys.maxunicode > 0x10000:
# This is a wide build, we should NOT get an error
raise
finally:
# Set it back
formatting.PLACEHOLDER_START = orig_start
class XMLFormatTests(unittest.TestCase):
def _format_test(self, left, action, expected):
formatter = formatting.XMLFormatter(pretty_print=False)
result = formatter.format([action], etree.fromstring(left))
self.assertEqual(result, expected)
def test_incorrect_xpaths(self):
left = '<document><node a="v"/><node>Text</node></document>'
expected = START + ' diff:delete-attr="a">Text' + END
with self.assertRaises(ValueError):
action = actions.DeleteAttrib("/document/node", "a")
self._format_test(left, action, expected)
with self.assertRaises(ValueError):
action = actions.DeleteAttrib("/document/ummagumma", "a")
self._format_test(left, action, expected)
def test_del_attr(self):
left = '<document><node a="v">Text</node></document>'
action = actions.DeleteAttrib("/document/node", "a")
expected = START + ' diff:delete-attr="a">Text' + END
self._format_test(left, action, expected)
def test_del_node(self):
left = '<document><node attr="val">Text</node></document>'
action = actions.DeleteNode("/document/node")
expected = START + ' attr="val" diff:delete="">Text' + END
self._format_test(left, action, expected)
def test_del_text(self):
left = '<document><node attr="val">Text</node></document>'
action = actions.UpdateTextIn("/document/node", None)
expected = START + ' attr="val"><diff:delete>Text</diff:delete>' + END
self._format_test(left, action, expected)
def test_insert_attr(self):
left = "<document><node>We need more text</node></document>"
action = actions.InsertAttrib("/document/node", "attr", "val")
expected = START + ' attr="val" diff:add-attr="attr">' "We need more text" + END
self._format_test(left, action, expected)
def test_insert_node(self):
left = "<document></document>"
action = actions.InsertNode("/document", "node", 0)
expected = START + ' diff:insert=""/></document>'
self._format_test(left, action, expected)
def test_move_attr(self):
# The library currently only uses move attr for when attributes are
# renamed:
left = '<document><node attr="val">Text</node></document>'
action = actions.RenameAttrib("/document/node", "attr", "bottr")
expected = START + ' bottr="val" diff:rename-attr="attr:bottr"' ">Text" + END
self._format_test(left, action, expected)
def test_move_node(self):
# Move 1 down
left = '<document><node id="1" /><node id="2" /></document>'
action = actions.MoveNode("/document/node[1]", "/document", 1)
expected = (
START + ' id="1" diff:delete=""/><node id="2"/><node '
'id="1" diff:insert=""/></document>'
)
self._format_test(left, action, expected)
# Move 2 up (same result, different diff)
left = '<document><node id="1" /><node id="2" /></document>'
action = actions.MoveNode("/document/node[2]", "/document", 0)
expected = (
START + ' id="2" diff:insert=""/><node id="1"/><node '
'id="2" diff:delete=""/></document>'
)
self._format_test(left, action, expected)
def test_rename_node(self):
left = "<document><node><para>Content</para>Tail</node></document>"
action = actions.RenameNode("/document/node[1]/para[1]", "newtag")
expected = START + '><newtag diff:rename="para">Content' "</newtag>Tail" + END
self._format_test(left, action, expected)
def test_update_attr(self):
left = '<document><node attr="val"/></document>'
action = actions.UpdateAttrib("/document/node", "attr", "newval")
expected = START + ' attr="newval" diff:update-attr="attr:val"/>' "</document>"
self._format_test(left, action, expected)
def test_update_text_in(self):
left = '<document><node attr="val"/></document>'
action = actions.UpdateTextIn("/document/node", "Text")
expected = START + ' attr="val"><diff:insert>Text</diff:insert>' + END
self._format_test(left, action, expected)
left = "<document><node>This is a bit of text, right" + END
action = actions.UpdateTextIn("/document/node", "Also a bit of text, rick")
expected = (
START + "><diff:delete>This is</diff:delete><diff:insert>"
"Also</diff:insert> a bit of text, ri<diff:delete>ght"
"</diff:delete><diff:insert>ck</diff:insert>" + END
)
self._format_test(left, action, expected)
def test_update_text_after_1(self):
left = "<document><node/><node/></document>"
action = actions.UpdateTextAfter("/document/node[1]", "Text")
expected = START + "/><diff:insert>Text</diff:insert>" "<node/></document>"
self._format_test(left, action, expected)
def test_update_text_after_2(self):
left = "<document><node/>This is a bit of text, right</document>"
action = actions.UpdateTextAfter("/document/node", "Also a bit of text, rick")
expected = (
START + "/><diff:delete>This is</diff:delete>"
"<diff:insert>Also</diff:insert> a bit of text, ri<diff:delete>"
"ght</diff:delete><diff:insert>ck</diff:insert></document>"
)
self._format_test(left, action, expected)
class DiffFormatTests(unittest.TestCase):
def _format_test(self, action, expected):
formatter = formatting.DiffFormatter()
result = formatter.format([action], None)
self.assertEqual(result, expected)
def test_del_attr(self):
action = actions.DeleteAttrib("/document/node", "a")
expected = "[delete-attribute, /document/node, a]"
self._format_test(action, expected)
def test_del_node(self):
action = actions.DeleteNode("/document/node")
expected = "[delete, /document/node]"
self._format_test(action, expected)
def test_del_text(self):
action = actions.UpdateTextIn("/document/node", None)
expected = "[update-text, /document/node, null]"
self._format_test(action, expected)
def test_insert_attr(self):
action = actions.InsertAttrib("/document/node", "attr", "val")
expected = '[insert-attribute, /document/node, attr, "val"]'
self._format_test(action, expected)
def test_insert_node(self):
action = actions.InsertNode("/document", "node", 0)
expected = "[insert, /document, node, 0]"
self._format_test(action, expected)
def test_rename_attr(self):
action = actions.RenameAttrib("/document/node", "attr", "bottr")
expected = "[rename-attribute, /document/node, attr, bottr]"
self._format_test(action, expected)
def test_move_node(self):
# Move 1 down
action = actions.MoveNode("/document/node[1]", "/document", 1)
expected = "[move, /document/node[1], /document, 1]"
self._format_test(action, expected)
# Move 2 up (same result, different diff)
action = actions.MoveNode("/document/node[2]", "/document", 0)
expected = "[move, /document/node[2], /document, 0]"
self._format_test(action, expected)
def test_rename_node(self):
# Move 1 down
action = actions.RenameNode("/document/node[1]", "newtag")
expected = "[rename, /document/node[1], newtag]"
self._format_test(action, expected)
# Move 2 up (same result, different diff)
action = actions.MoveNode("/document/node[2]", "/document", 0)
expected = "[move, /document/node[2], /document, 0]"
self._format_test(action, expected)
def test_update_attr(self):
action = actions.UpdateAttrib("/document/node", "attr", "newval")
expected = '[update-attribute, /document/node, attr, "newval"]'
self._format_test(action, expected)
def test_update_text_in(self):
action = actions.UpdateTextIn("/document/node", "Text")
expected = '[update-text, /document/node, "Text"]'
self._format_test(action, expected)
action = actions.UpdateTextIn("/document/node", 'Also a bit of text, "rick"')
expected = "[update-text, /document/node, " '"Also a bit of text, \\"rick\\""]'
self._format_test(action, expected)
def test_update_text_after_1(self):
action = actions.UpdateTextAfter("/document/node[1]", "Text")
expected = '[update-text-after, /document/node[1], "Text"]'
self._format_test(action, expected)
def test_update_text_after_2(self):
action = actions.UpdateTextAfter("/document/node", "Also a bit of text, rick")
expected = "[update-text-after, /document/node, " '"Also a bit of text, rick"]'
self._format_test(action, expected)
def test_insert_comment(self):
action = actions.InsertComment("/document/node", 2, "Commentary")
expected = '[insert-comment, /document/node, 2, "Commentary"]'
self._format_test(action, expected)
class XmlDiffFormatTests(unittest.TestCase):
# RenameAttr and MoveNode requires an orig_tree, so they
# are not tested in the _format_test tests, but in the
# all_actions test, which uses test_data files.
def _format_test(self, action, expected):
formatter = formatting.XmlDiffFormatter()
result = formatter.format([action], None)
self.assertEqual(result, expected)
def test_del_attr(self):
action = actions.DeleteAttrib("/document/node", "a")
expected = "[remove, /document/node/@a]"
self._format_test(action, expected)
def test_del_node(self):
action = actions.DeleteNode("/document/node")
expected = "[remove, /document/node]"
self._format_test(action, expected)
def test_del_text(self):
action = actions.UpdateTextIn("/document/node", None)
expected = "[update, /document/node/text()[1], null]"
self._format_test(action, expected)
def test_insert_attr(self):
action = actions.InsertAttrib("/document/node", "attr", "val")
expected = "[insert, /document/node, \n<@attr>\nval\n</@attr>]"
self._format_test(action, expected)
def test_insert_node(self):
action = actions.InsertNode("/document", "node", 0)
expected = "[insert-first, /document, \n<node/>]"
self._format_test(action, expected)
def test_rename_node(self):
# Move 1 down
action = actions.RenameNode("/document/node[1]", "newtag")
expected = "[rename, /document/node[1], newtag]"
self._format_test(action, expected)
# Move 2 up (same result, different diff)
action = actions.MoveNode("/document/node[2]", "/document", 0)
expected = "[move-first, /document/node[2], /document]"
self._format_test(action, expected)
def test_update_attr(self):
action = actions.UpdateAttrib("/document/node", "attr", "newval")
expected = '[update, /document/node/@attr, "newval"]'
self._format_test(action, expected)
def test_update_text_in(self):
action = actions.UpdateTextIn("/document/node", "Text")
expected = '[update, /document/node/text()[1], "Text"]'
self._format_test(action, expected)
action = actions.UpdateTextIn("/document/node", 'Also a bit of text, "rick"')
expected = (
"[update, /document/node/text()[1], " '"Also a bit of text, \\"rick\\""]'
)
self._format_test(action, expected)
def test_update_text_after_1(self):
action = actions.UpdateTextAfter("/document/node[1]", "Text")
expected = '[update, /document/node[1]/text()[2], "Text"]'
self._format_test(action, expected)
def test_update_text_after_2(self):
action = actions.UpdateTextAfter("/document/node", "Also a bit of text, rick")
expected = "[update, /document/node/text()[2], " '"Also a bit of text, rick"]'
self._format_test(action, expected)
def test_all_actions(self):
here = os.path.split(__file__)[0]
lfile = os.path.join(here, "test_data", "all_actions.left.xml")
rfile = os.path.join(here, "test_data", "all_actions.right.xml")
formatter = formatting.XmlDiffFormatter()
result = main.diff_files(lfile, rfile, formatter=formatter)
expected = (
"[insert-namespace, space, http://namespaces.shoobx.com/outerspace]\n"
"[delete-namespace, name]\n"
"[move-after, /document/node[2], /document/tag[1]]\n"
"[insert-comment, /document[1], 0, Insert a new comment ]\n"
'[update, /document/node[1]/@name, "was updated"]\n'
"[remove, /document/node[1]/@attribute]\n"
"[insert, /document/node[1], \n"
"<@newtribute>\n"
"renamed\n"
"</@newtribute>]\n"
"[insert, /document/node[1], \n"
"<@this>\n"
"is new\n"
"</@this>]\n"
"[remove, /document/node[1]/@attr]\n"
'[update, /document/node[1]/text()[1], "\\n Modified\\n "]\n'
'[update, /document/node[1]/text()[2], "\\n '
'New tail content\\n "]\n'
"[rename, /document/node[2], nod]\n"
"[rename, /document/name:space[1], {http://namespaces.shoobx.com/outerspace}name]\n"
'[update, /document/space:name[1]/text()[2], "\\n "]\n'
"[remove, /document/tail[1]]"
)
self.assertEqual(result, expected)
class FormatterFileTests(unittest.TestCase):
formatter = None # Override this
maxDiff = None
def process(self, left, right):
return main.diff_files(left, right, formatter=self.formatter)
class XMLFormatterFileTests(FormatterFileTests):
# The XMLFormatter has no text or formatting tags, so
formatter = formatting.XMLFormatter(
pretty_print=False, normalize=formatting.WS_TEXT
)
# Also test the bits that handle text tags:
class HTMLFormatterFileTests(FormatterFileTests):
# We use a few tags for the placeholder tests.
# <br/> is intentionally left out, to test an edge case
# with empty non-formatting tags in text.
formatter = formatting.XMLFormatter(
normalize=formatting.WS_BOTH,
pretty_print=True,
text_tags=("p", "h1", "h2", "h3", "h4", "h5", "h6", "li"),
formatting_tags=(
"b",
"u",
"i",
"strike",
"em",
"super",
"sup",
"sub",
"link",
"a",
"span",
),
)
# Add tests that use no placeholder replacement (ie plain XML)
data_dir = os.path.join(os.path.dirname(__file__), "test_data")
generate_filebased_cases(data_dir, XMLFormatterFileTests)
# Add tests that use placeholder replacement (ie HTML)
data_dir = os.path.join(os.path.dirname(__file__), "test_data")
generate_filebased_cases(data_dir, HTMLFormatterFileTests, suffix="html")
|