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 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
|
import unittest
from slixmpp.test import SlixTest
from slixmpp.xmlstream.stanzabase import ElementBase, register_stanza_plugin, ET
from collections import OrderedDict
class TestElementBase(SlixTest):
def testFixNs(self):
"""Test fixing namespaces in an XPath expression."""
e = ElementBase()
ns = "http://jabber.org/protocol/disco#items"
result = e._fix_ns("{%s}foo/bar/{abc}baz/{%s}more" % (ns, ns))
expected = "/".join(["{%s}foo" % ns,
"{%s}bar" % ns,
"{abc}baz",
"{%s}more" % ns])
self.failUnless(expected == result,
"Incorrect namespace fixing result: %s" % str(result))
def testExtendedName(self):
"""Test element names of the form tag1/tag2/tag3."""
class TestStanza(ElementBase):
name = "foo/bar/baz"
namespace = "test"
stanza = TestStanza()
self.check(stanza, """
<foo xmlns="test">
<bar>
<baz />
</bar>
</foo>
""")
def testGetStanzaValues(self):
"""Test get_stanza_values using plugins and substanzas."""
class TestStanzaPlugin(ElementBase):
name = "foo2"
namespace = "foo"
interfaces = {'bar', 'baz'}
plugin_attrib = "foo2"
class TestSubStanza(ElementBase):
name = "subfoo"
namespace = "foo"
interfaces = {'bar', 'baz'}
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
register_stanza_plugin(TestStanza, TestStanzaPlugin, iterable=True)
stanza = TestStanza()
stanza['bar'] = 'a'
stanza['foo2']['baz'] = 'b'
substanza = TestSubStanza()
substanza['bar'] = 'c'
stanza.append(substanza)
values = stanza.get_stanza_values()
expected = {'lang': '',
'bar': 'a',
'baz': '',
'foo2': {'lang': '',
'bar': '',
'baz': 'b'},
'substanzas': [{'__childtag__': '{foo}foo2',
'lang': '',
'bar': '',
'baz': 'b'},
{'__childtag__': '{foo}subfoo',
'lang': '',
'bar': 'c',
'baz': ''}]}
self.failUnless(values == expected,
"Unexpected stanza values:\n%s\n%s" % (str(expected), str(values)))
def testSetStanzaValues(self):
"""Test using set_stanza_values with substanzas and plugins."""
class TestStanzaPlugin(ElementBase):
name = "pluginfoo"
namespace = "foo"
interfaces = {'bar', 'baz'}
plugin_attrib = "plugin_foo"
class TestStanzaPlugin2(ElementBase):
name = "pluginfoo2"
namespace = "foo"
interfaces = {'bar', 'baz'}
plugin_attrib = "plugin_foo2"
class TestSubStanza(ElementBase):
name = "subfoo"
namespace = "foo"
interfaces = {'bar', 'baz'}
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
register_stanza_plugin(TestStanza, TestSubStanza, iterable=True)
register_stanza_plugin(TestStanza, TestStanzaPlugin)
register_stanza_plugin(TestStanza, TestStanzaPlugin2)
stanza = TestStanza()
values = {'bar': 'a',
'baz': '',
'plugin_foo': {'bar': '',
'baz': 'b'},
'plugin_foo2': {'bar': 'd',
'baz': 'e'},
'substanzas': [{'__childtag__': '{foo}subfoo',
'bar': 'c',
'baz': ''}]}
stanza.values = values
self.check(stanza, """
<foo xmlns="foo" bar="a">
<pluginfoo baz="b" />
<pluginfoo2 bar="d" baz="e" />
<subfoo bar="c" />
</foo>
""")
def testGetItem(self):
"""Test accessing stanza interfaces."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz', 'qux'}
sub_interfaces = {'baz'}
def get_qux(self):
return 'qux'
class TestStanzaPlugin(ElementBase):
name = "foobar"
namespace = "foo"
plugin_attrib = "foobar"
interfaces = {'fizz'}
register_stanza_plugin(TestStanza, TestStanza, iterable=True)
register_stanza_plugin(TestStanza, TestStanzaPlugin)
stanza = TestStanza()
substanza = TestStanza()
stanza.append(substanza)
stanza.set_stanza_values({'bar': 'a',
'baz': 'b',
'qux': 42,
'foobar': {'fizz': 'c'}})
# Test non-plugin interfaces
expected = {'substanzas': [substanza],
'bar': 'a',
'baz': 'b',
'qux': 'qux',
'meh': ''}
for interface, value in expected.items():
result = stanza[interface]
self.failUnless(result == value,
"Incorrect stanza interface access result: %s" % result)
# Test plugin interfaces
self.failUnless(isinstance(stanza['foobar'], TestStanzaPlugin),
"Incorrect plugin object result.")
self.failUnless(stanza['foobar']['fizz'] == 'c',
"Incorrect plugin subvalue result.")
def testSetItem(self):
"""Test assigning to stanza interfaces."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz', 'qux'}
sub_interfaces = {'baz'}
def set_qux(self, value):
pass
class TestStanzaPlugin(ElementBase):
name = "foobar"
namespace = "foo"
plugin_attrib = "foobar"
interfaces = {'foobar'}
register_stanza_plugin(TestStanza, TestStanzaPlugin)
stanza = TestStanza()
stanza['bar'] = 'attribute!'
stanza['baz'] = 'element!'
stanza['qux'] = 'overridden'
stanza['foobar'] = 'plugin'
self.check(stanza, """
<foo xmlns="foo" bar="attribute!">
<baz>element!</baz>
<foobar foobar="plugin" />
</foo>
""")
def testDelItem(self):
"""Test deleting stanza interface values."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz', 'qux'}
sub_interfaces = {'bar'}
def del_qux(self):
pass
class TestStanzaPlugin(ElementBase):
name = "foobar"
namespace = "foo"
plugin_attrib = "foobar"
interfaces = {'foobar'}
register_stanza_plugin(TestStanza, TestStanzaPlugin)
stanza = TestStanza()
stanza['bar'] = 'a'
stanza['baz'] = 'b'
stanza['qux'] = 'c'
stanza['foobar']['foobar'] = 'd'
self.check(stanza, """
<foo xmlns="foo" baz="b" qux="c">
<bar>a</bar>
<foobar foobar="d" />
</foo>
""")
del stanza['bar']
del stanza['baz']
del stanza['qux']
del stanza['foobar']
self.check(stanza, """
<foo xmlns="foo" qux="c" />
""")
def testModifyingAttributes(self):
"""Test modifying top level attributes of a stanza's XML object."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
stanza = TestStanza()
self.check(stanza, """
<foo xmlns="foo" />
""")
self.failUnless(stanza._get_attr('bar') == '',
"Incorrect value returned for an unset XML attribute.")
stanza._set_attr('bar', 'a')
stanza._set_attr('baz', 'b')
self.check(stanza, """
<foo xmlns="foo" bar="a" baz="b" />
""")
self.failUnless(stanza._get_attr('bar') == 'a',
"Retrieved XML attribute value is incorrect.")
stanza._set_attr('bar', None)
stanza._del_attr('baz')
self.check(stanza, """
<foo xmlns="foo" />
""")
self.failUnless(stanza._get_attr('bar', 'c') == 'c',
"Incorrect default value returned for an unset XML attribute.")
def testGetSubText(self):
"""Test retrieving the contents of a sub element."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar'}
def set_bar(self, value):
wrapper = ET.Element("{foo}wrapper")
bar = ET.Element("{foo}bar")
bar.text = value
wrapper.append(bar)
self.xml.append(wrapper)
def get_bar(self):
return self._get_sub_text("wrapper/bar", default="not found")
stanza = TestStanza()
self.failUnless(stanza['bar'] == 'not found',
"Default _get_sub_text value incorrect.")
stanza['bar'] = 'found'
self.check(stanza, """
<foo xmlns="foo">
<wrapper>
<bar>found</bar>
</wrapper>
</foo>
""")
self.failUnless(stanza['bar'] == 'found',
"_get_sub_text value incorrect: %s." % stanza['bar'])
def testSubElement(self):
"""Test setting the contents of a sub element."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
def set_baz(self, value):
self._set_sub_text("wrapper/baz", text=value)
def get_baz(self):
return self._get_sub_text("wrapper/baz")
def set_bar(self, value):
self._set_sub_text("wrapper/bar", text=value)
def get_bar(self):
return self._get_sub_text("wrapper/bar")
stanza = TestStanza()
stanza['bar'] = 'a'
stanza['baz'] = 'b'
self.check(stanza, """
<foo xmlns="foo">
<wrapper>
<bar>a</bar>
<baz>b</baz>
</wrapper>
</foo>
""")
stanza._set_sub_text('wrapper/bar', text='', keep=True)
self.check(stanza, """
<foo xmlns="foo">
<wrapper>
<bar />
<baz>b</baz>
</wrapper>
</foo>
""", use_values=False)
stanza['bar'] = 'a'
stanza._set_sub_text('wrapper/bar', text='')
self.check(stanza, """
<foo xmlns="foo">
<wrapper>
<baz>b</baz>
</wrapper>
</foo>
""")
def testDelSub(self):
"""Test removing sub elements."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
def set_bar(self, value):
self._set_sub_text("path/to/only/bar", value)
def get_bar(self):
return self._get_sub_text("path/to/only/bar")
def del_bar(self):
self._del_sub("path/to/only/bar")
def set_baz(self, value):
self._set_sub_text("path/to/just/baz", value)
def get_baz(self):
return self._get_sub_text("path/to/just/baz")
def del_baz(self):
self._del_sub("path/to/just/baz")
stanza = TestStanza()
stanza['bar'] = 'a'
stanza['baz'] = 'b'
self.check(stanza, """
<foo xmlns="foo">
<path>
<to>
<only>
<bar>a</bar>
</only>
<just>
<baz>b</baz>
</just>
</to>
</path>
</foo>
""")
del stanza['bar']
del stanza['baz']
self.check(stanza, """
<foo xmlns="foo">
<path>
<to>
<only />
<just />
</to>
</path>
</foo>
""", use_values=False)
stanza['bar'] = 'a'
stanza['baz'] = 'b'
stanza._del_sub('path/to/only/bar', all=True)
self.check(stanza, """
<foo xmlns="foo">
<path>
<to>
<just>
<baz>b</baz>
</just>
</to>
</path>
</foo>
""")
def testMatch(self):
"""Test matching a stanza against an XPath expression."""
class TestSubStanza(ElementBase):
name = "sub"
namespace = "baz"
interfaces = {'attrib'}
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar','baz', 'qux'}
sub_interfaces = {'qux'}
def set_qux(self, value):
self._set_sub_text('qux', text=value)
def get_qux(self):
return self._get_sub_text('qux')
class TestStanzaPlugin(ElementBase):
name = "plugin"
namespace = "http://test/slash/bar"
interfaces = {'attrib'}
register_stanza_plugin(TestStanza, TestSubStanza, iterable=True)
register_stanza_plugin(TestStanza, TestStanzaPlugin)
stanza = TestStanza()
self.failUnless(stanza.match("foo"),
"Stanza did not match its own tag name.")
self.failUnless(stanza.match("{foo}foo"),
"Stanza did not match its own namespaced name.")
stanza['bar'] = 'a'
self.failUnless(stanza.match("foo@bar=a"),
"Stanza did not match its own name with attribute value check.")
stanza['baz'] = 'b'
self.failUnless(stanza.match("foo@bar=a@baz=b"),
"Stanza did not match its own name with multiple attributes.")
stanza['qux'] = 'c'
self.failUnless(stanza.match("foo/qux"),
"Stanza did not match with subelements.")
stanza['qux'] = ''
self.failUnless(stanza.match("foo/qux") == False,
"Stanza matched missing subinterface element.")
self.failUnless(stanza.match("foo/bar") == False,
"Stanza matched nonexistent element.")
stanza['plugin']['attrib'] = 'c'
self.failUnless(stanza.match("foo/plugin@attrib=c"),
"Stanza did not match with plugin and attribute.")
self.failUnless(stanza.match("foo/{http://test/slash/bar}plugin"),
"Stanza did not match with namespaced plugin.")
substanza = TestSubStanza()
substanza['attrib'] = 'd'
stanza.append(substanza)
self.failUnless(stanza.match("foo/sub@attrib=d"),
"Stanza did not match with substanzas and attribute.")
self.failUnless(stanza.match("foo/{baz}sub"),
"Stanza did not match with namespaced substanza.")
def testComparisons(self):
"""Test comparing ElementBase objects."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
stanza1 = TestStanza()
stanza1['bar'] = 'a'
self.failUnless(stanza1,
"Stanza object does not evaluate to True")
stanza2 = TestStanza()
stanza2['baz'] = 'b'
self.failUnless(stanza1 != stanza2,
"Different stanza objects incorrectly compared equal.")
stanza1['baz'] = 'b'
stanza2['bar'] = 'a'
self.failUnless(stanza1 == stanza2,
"Equal stanzas incorrectly compared inequal.")
def testKeys(self):
"""Test extracting interface names from a stanza object."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
plugin_attrib = 'qux'
register_stanza_plugin(TestStanza, TestStanza)
stanza = TestStanza()
self.failUnless(set(stanza.keys()) == {'lang', 'bar', 'baz'},
"Returned set of interface keys does not match expected.")
stanza.enable('qux')
self.failUnless(set(stanza.keys()) == {'lang', 'bar', 'baz', 'qux'},
"Incorrect set of interface and plugin keys.")
def testGet(self):
"""Test accessing stanza interfaces using get()."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
stanza = TestStanza()
stanza['bar'] = 'a'
self.failUnless(stanza.get('bar') == 'a',
"Incorrect value returned by stanza.get")
self.failUnless(stanza.get('baz', 'b') == 'b',
"Incorrect default value returned by stanza.get")
def testSubStanzas(self):
"""Test manipulating substanzas of a stanza object."""
class TestSubStanza(ElementBase):
name = "foobar"
namespace = "foo"
interfaces = {'qux'}
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
register_stanza_plugin(TestStanza, TestSubStanza, iterable=True)
stanza = TestStanza()
substanza1 = TestSubStanza()
substanza2 = TestSubStanza()
substanza1['qux'] = 'a'
substanza2['qux'] = 'b'
# Test appending substanzas
self.failUnless(len(stanza) == 0,
"Incorrect empty stanza size.")
stanza.append(substanza1)
self.check(stanza, """
<foo xmlns="foo">
<foobar qux="a" />
</foo>
""", use_values=False)
self.failUnless(len(stanza) == 1,
"Incorrect stanza size with 1 substanza.")
stanza.append(substanza2)
self.check(stanza, """
<foo xmlns="foo">
<foobar qux="a" />
<foobar qux="b" />
</foo>
""", use_values=False)
self.failUnless(len(stanza) == 2,
"Incorrect stanza size with 2 substanzas.")
# Test popping substanzas
stanza.pop(0)
self.check(stanza, """
<foo xmlns="foo">
<foobar qux="b" />
</foo>
""", use_values=False)
# Test iterating over substanzas
stanza.append(substanza1)
results = []
for substanza in stanza:
results.append(substanza['qux'])
self.failUnless(results == ['b', 'a'],
"Iteration over substanzas failed: %s." % str(results))
def testCopy(self):
"""Test copying stanza objects."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
stanza1 = TestStanza()
stanza1['bar'] = 'a'
stanza2 = stanza1.__copy__()
self.failUnless(stanza1 == stanza2,
"Copied stanzas are not equal to each other.")
stanza1['baz'] = 'b'
self.failUnless(stanza1 != stanza2,
"Divergent stanza copies incorrectly compared equal.")
def testExtension(self):
"""Testing using is_extension."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
class TestExtension(ElementBase):
name = 'extended'
namespace = 'foo'
plugin_attrib = name
interfaces = {name}
is_extension = True
def set_extended(self, value):
self.xml.text = value
def get_extended(self):
return self.xml.text
def del_extended(self):
self.parent().xml.remove(self.xml)
register_stanza_plugin(TestStanza, TestExtension)
stanza = TestStanza()
stanza['extended'] = 'testing'
self.check(stanza, """
<foo xmlns="foo">
<extended>testing</extended>
</foo>
""")
self.failUnless(stanza['extended'] == 'testing',
"Could not retrieve stanza extension value.")
del stanza['extended']
self.check(stanza, """
<foo xmlns="foo" />
""")
def testOverrides(self):
"""Test using interface overrides."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar', 'baz'}
class TestOverride(ElementBase):
name = 'overrider'
namespace = 'foo'
plugin_attrib = name
interfaces = {'bar'}
overrides = ['set_bar']
def setup(self, xml):
# Don't create XML for the plugin
self.xml = ET.Element('')
def set_bar(self, value):
if not value.startswith('override-'):
self.parent()._set_attr('bar', 'override-%s' % value)
else:
self.parent()._set_attr('bar', value)
stanza = TestStanza()
stanza['bar'] = 'foo'
self.check(stanza, """
<foo xmlns="foo" bar="foo" />
""")
register_stanza_plugin(TestStanza, TestOverride, overrides=True)
stanza = TestStanza()
stanza['bar'] = 'foo'
self.check(stanza, """
<foo xmlns="foo" bar="override-foo" />
""")
def testBoolInterfaces(self):
"""Test using boolean interfaces."""
class TestStanza(ElementBase):
name = "foo"
namespace = "foo"
interfaces = {'bar'}
bool_interfaces = interfaces
stanza = TestStanza()
self.check(stanza, """
<foo xmlns="foo" />
""")
self.assertFalse(stanza['bar'],
"Returned True for missing bool interface element.")
stanza['bar'] = True
self.check(stanza, """
<foo xmlns="foo">
<bar />
</foo>
""")
self.assertTrue(stanza['bar'],
"Returned False for present bool interface element.")
stanza['bar'] = False
self.check(stanza, """
<foo xmlns="foo" />
""")
def testGetMultiAttrib(self):
"""Test retrieving multi_attrib substanzas."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'foo'
interfaces = set()
class TestMultiStanza1(ElementBase):
name = 'bar'
namespace = 'bar'
plugin_attrib = name
plugin_multi_attrib = 'bars'
class TestMultiStanza2(ElementBase):
name = 'baz'
namespace = 'baz'
plugin_attrib = name
plugin_multi_attrib = 'bazs'
register_stanza_plugin(TestStanza, TestMultiStanza1, iterable=True)
register_stanza_plugin(TestStanza, TestMultiStanza2, iterable=True)
stanza = TestStanza()
stanza.append(TestMultiStanza1())
stanza.append(TestMultiStanza2())
stanza.append(TestMultiStanza1())
stanza.append(TestMultiStanza2())
self.check(stanza, """
<foo xmlns="foo">
<bar xmlns="bar" />
<baz xmlns="baz" />
<bar xmlns="bar" />
<baz xmlns="baz" />
</foo>
""", use_values=False)
bars = stanza['bars']
bazs = stanza['bazs']
for bar in bars:
self.check(bar, """
<bar xmlns="bar" />
""")
for baz in bazs:
self.check(baz, """
<baz xmlns="baz" />
""")
self.assertEqual(len(bars), 2,
"Wrong number of <bar /> stanzas: %s" % len(bars))
self.assertEqual(len(bazs), 2,
"Wrong number of <baz /> stanzas: %s" % len(bazs))
def testSetMultiAttrib(self):
"""Test setting multi_attrib substanzas."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'foo'
interfaces = set()
class TestMultiStanza1(ElementBase):
name = 'bar'
namespace = 'bar'
plugin_attrib = name
plugin_multi_attrib = 'bars'
class TestMultiStanza2(ElementBase):
name = 'baz'
namespace = 'baz'
plugin_attrib = name
plugin_multi_attrib = 'bazs'
register_stanza_plugin(TestStanza, TestMultiStanza1, iterable=True)
register_stanza_plugin(TestStanza, TestMultiStanza2, iterable=True)
stanza = TestStanza()
stanza['bars'] = [TestMultiStanza1(), TestMultiStanza1()]
stanza['bazs'] = [TestMultiStanza2(), TestMultiStanza2()]
self.check(stanza, """
<foo xmlns="foo">
<bar xmlns="bar" />
<bar xmlns="bar" />
<baz xmlns="baz" />
<baz xmlns="baz" />
</foo>
""", use_values=False)
self.assertEqual(len(stanza['substanzas']), 4,
"Wrong number of substanzas: %s" % len(stanza['substanzas']))
stanza['bars'] = [TestMultiStanza1()]
self.check(stanza, """
<foo xmlns="foo">
<baz xmlns="baz" />
<baz xmlns="baz" />
<bar xmlns="bar" />
</foo>
""", use_values=False)
self.assertEqual(len(stanza['substanzas']), 3,
"Wrong number of substanzas: %s" % len(stanza['substanzas']))
def testDelMultiAttrib(self):
"""Test deleting multi_attrib substanzas."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'foo'
interfaces = set()
class TestMultiStanza1(ElementBase):
name = 'bar'
namespace = 'bar'
plugin_attrib = name
plugin_multi_attrib = 'bars'
class TestMultiStanza2(ElementBase):
name = 'baz'
namespace = 'baz'
plugin_attrib = name
plugin_multi_attrib = 'bazs'
register_stanza_plugin(TestStanza, TestMultiStanza1, iterable=True)
register_stanza_plugin(TestStanza, TestMultiStanza2, iterable=True)
stanza = TestStanza()
bars = [TestMultiStanza1(), TestMultiStanza1()]
bazs = [TestMultiStanza2(), TestMultiStanza2()]
stanza['bars'] = bars
stanza['bazs'] = bazs
self.check(stanza, """
<foo xmlns="foo">
<bar xmlns="bar" />
<bar xmlns="bar" />
<baz xmlns="baz" />
<baz xmlns="baz" />
</foo>
""", use_values=False)
del stanza['bars']
self.check(stanza, """
<foo xmlns="foo">
<baz xmlns="baz" />
<baz xmlns="baz" />
</foo>
""", use_values=False)
self.assertEqual(len(stanza['substanzas']), 2,
"Wrong number of substanzas: %s" % len(stanza['substanzas']))
def testDefaultLang(self):
"""Test setting a normal subinterface when a default language is set"""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['lang'] = 'sv'
stanza['test'] = 'hej'
self.check(stanza, """
<foo xmlns="test" xml:lang="sv">
<test>hej</test>
</foo>
""")
self.assertEqual(stanza['test'], 'hej',
"Incorrect subinterface value: %s" % stanza['test'])
self.assertEqual(stanza['test|sv'], 'hej',
"Incorrect subinterface value: %s" % stanza['test|sv'])
def testSpecifyLangWithDefault(self):
"""Test specifying various languages."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['lang'] = 'sv'
stanza['test'] = 'hej'
stanza['test|en'] = 'hi'
stanza['test|es'] = 'hola'
self.check(stanza, """
<foo xmlns="test" xml:lang="sv">
<test>hej</test>
<test xml:lang="en">hi</test>
<test xml:lang="es">hola</test>
</foo>
""")
self.assertEqual(stanza['test'], 'hej',
"Incorrect subinterface value: %s" % stanza['test'])
self.assertEqual(stanza['test|sv'], 'hej',
"Incorrect subinterface value: %s" % stanza['test|sv'])
self.assertEqual(stanza['test|en'], 'hi',
"Incorrect subinterface value: %s" % stanza['test|en'])
self.assertEqual(stanza['test|es'], 'hola',
"Incorrect subinterface value: %s" % stanza['test|es'])
def testSpecifyLangWithNoDefault(self):
"""Test specifying various languages."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['test'] = 'hej'
stanza['test|en'] = 'hi'
stanza['test|es'] = 'hola'
self.check(stanza, """
<foo xmlns="test">
<test>hej</test>
<test xml:lang="en">hi</test>
<test xml:lang="es">hola</test>
</foo>
""")
self.assertEqual(stanza['test'], 'hej',
"Incorrect subinterface value: %s" % stanza['test'])
self.assertEqual(stanza['test|en'], 'hi',
"Incorrect subinterface value: %s" % stanza['test|en'])
self.assertEqual(stanza['test|es'], 'hola',
"Incorrect subinterface value: %s" % stanza['test|es'])
def testModifyLangInterfaceWithDefault(self):
"""Test resetting an interface when a default lang is used."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['lang'] = 'es'
stanza['test'] = 'hola'
stanza['test|en'] = 'hi'
self.check(stanza, """
<foo xmlns="test" xml:lang="es">
<test>hola</test>
<test xml:lang="en">hi</test>
</foo>
""")
stanza['test'] = 'adios'
stanza['test|en'] = 'bye'
self.check(stanza, """
<foo xmlns="test" xml:lang="es">
<test>adios</test>
<test xml:lang="en">bye</test>
</foo>
""")
self.assertEqual(stanza['test'], 'adios',
"Incorrect subinterface value: %s" % stanza['test'])
self.assertEqual(stanza['test|es'], 'adios',
"Incorrect subinterface value: %s" % stanza['test|es'])
self.assertEqual(stanza['test|en'], 'bye',
"Incorrect subinterface value: %s" % stanza['test|en'])
stanza['test|es'] = 'hola'
self.check(stanza, """
<foo xmlns="test" xml:lang="es">
<test>hola</test>
<test xml:lang="en">bye</test>
</foo>
""")
self.assertEqual(stanza['test'], 'hola',
"Incorrect subinterface value: %s" % stanza['test'])
self.assertEqual(stanza['test|es'], 'hola',
"Incorrect subinterface value: %s" % stanza['test|es'])
def testModifyLangInterfaceWithNoDefault(self):
"""Test resetting an interface when no default lang is used."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['test'] = 'hola'
stanza['test|en'] = 'hi'
self.check(stanza, """
<foo xmlns="test">
<test>hola</test>
<test xml:lang="en">hi</test>
</foo>
""")
stanza['test'] = 'adios'
stanza['test|en'] = 'bye'
self.check(stanza, """
<foo xmlns="test">
<test>adios</test>
<test xml:lang="en">bye</test>
</foo>
""")
self.assertEqual(stanza['test'], 'adios',
"Incorrect subinterface value: %s" % stanza['test'])
self.assertEqual(stanza['test'], 'adios',
"Incorrect subinterface value: %s" % stanza['test|es'])
self.assertEqual(stanza['test|en'], 'bye',
"Incorrect subinterface value: %s" % stanza['test|en'])
def testDelInterfacesWithDefaultLang(self):
"""Test deleting interfaces with a default lang set."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['lang'] = 'en'
stanza['test'] = 'hi'
stanza['test|no'] = 'hej'
stanza['test|fr'] = 'bonjour'
self.check(stanza, """
<foo xmlns="test" xml:lang="en">
<test>hi</test>
<test xml:lang="no">hej</test>
<test xml:lang="fr">bonjour</test>
</foo>
""")
del stanza['test']
self.check(stanza, """
<foo xmlns="test" xml:lang="en">
<test xml:lang="no">hej</test>
<test xml:lang="fr">bonjour</test>
</foo>
""")
del stanza['test|no']
self.check(stanza, """
<foo xmlns="test" xml:lang="en">
<test xml:lang="fr">bonjour</test>
</foo>
""")
def testDelInterfacesWithNoDefaultLang(self):
"""Test deleting interfaces with no default lang set."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
stanza = TestStanza()
stanza['test'] = 'hi'
stanza['test|no'] = 'hej'
stanza['test|fr'] = 'bonjour'
self.check(stanza, """
<foo xmlns="test">
<test>hi</test>
<test xml:lang="no">hej</test>
<test xml:lang="fr">bonjour</test>
</foo>
""")
del stanza['test']
self.check(stanza, """
<foo xmlns="test">
<test xml:lang="no">hej</test>
<test xml:lang="fr">bonjour</test>
</foo>
""")
del stanza['test|no']
self.check(stanza, """
<foo xmlns="test">
<test xml:lang="fr">bonjour</test>
</foo>
""")
def testStarLang(self):
"""Test using interface|*."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = {'test'}
sub_interfaces = interfaces
lang_interfaces = interfaces
data = OrderedDict()
data['en'] = 'hi'
data['fr'] = 'bonjour'
data['no'] = 'hej'
stanza = TestStanza()
stanza['test|*'] = data
self.check(stanza, """
<foo xmlns="test">
<test xml:lang="en">hi</test>
<test xml:lang="fr">bonjour</test>
<test xml:lang="no">hej</test>
</foo>
""")
data2 = stanza['test|*']
self.assertEqual(data, data2,
"Did not extract expected language data: %s" % data2)
del stanza['test|*']
self.check(stanza, """
<foo xmlns="test" />
""")
suite = unittest.TestLoader().loadTestsFromTestCase(TestElementBase)
|