/usr/share/pyshared/wokkel/test/test_subprotocols.py is in python-wokkel 0.7.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # Copyright (c) Ralph Meijer.
# See LICENSE for details.
"""
Tests for L{wokkel.subprotocols}
"""
from zope.interface.verify import verifyObject
from twisted.trial import unittest
from twisted.test import proto_helpers
from twisted.internet import defer, task
from twisted.internet.error import ConnectionDone
from twisted.python import failure
from twisted.words.xish import domish
from twisted.words.protocols.jabber import error, ijabber, xmlstream
from wokkel import generic, subprotocols
class DeprecationTest(unittest.TestCase):
"""
Deprecation test for L{wokkel.subprotocols}.
"""
def lookForDeprecationWarning(self, testmethod, attributeName, newName):
"""
Importing C{testmethod} emits a deprecation warning.
"""
warningsShown = self.flushWarnings([testmethod])
self.assertEqual(len(warningsShown), 1)
self.assertIdentical(warningsShown[0]['category'], DeprecationWarning)
self.assertEqual(
warningsShown[0]['message'],
"wokkel.subprotocols." + attributeName + " "
"was deprecated in Wokkel 0.7.0: Use " + newName + " instead.")
def test_xmppHandlerCollection(self):
"""
L{subprotocols.XMPPHandlerCollection} is deprecated.
"""
from wokkel.subprotocols import XMPPHandlerCollection
XMPPHandlerCollection
self.lookForDeprecationWarning(
self.test_xmppHandlerCollection,
"XMPPHandlerCollection",
"twisted.words.protocols.jabber.xmlstream."
"XMPPHandlerCollection")
class DummyFactory(object):
"""
Dummy XmlStream factory that only registers bootstrap observers.
"""
def __init__(self):
self.callbacks = {}
def addBootstrap(self, event, callback):
self.callbacks[event] = callback
class DummyXMPPHandler(subprotocols.XMPPHandler):
"""
Dummy XMPP subprotocol handler to count the methods are called on it.
"""
def __init__(self):
self.doneMade = 0
self.doneInitialized = 0
self.doneLost = 0
def makeConnection(self, xs):
self.connectionMade()
def connectionMade(self):
self.doneMade += 1
def connectionInitialized(self):
self.doneInitialized += 1
def connectionLost(self, reason):
self.doneLost += 1
class FailureReasonXMPPHandler(subprotocols.XMPPHandler):
"""
Dummy handler specifically for failure Reason tests.
"""
def __init__(self):
self.gotFailureReason = False
def connectionLost(self, reason):
if isinstance(reason, failure.Failure):
self.gotFailureReason = True
class IQGetStanza(generic.Stanza):
timeout = None
stanzaKind = 'iq'
stanzaType = 'get'
stanzaID = 'test'
class XMPPHandlerTest(unittest.TestCase):
"""
Tests for L{subprotocols.XMPPHandler}.
"""
def test_interface(self):
"""
L{xmlstream.XMPPHandler} implements L{ijabber.IXMPPHandler}.
"""
verifyObject(ijabber.IXMPPHandler, subprotocols.XMPPHandler())
def test_send(self):
"""
Test that data is passed on for sending by the stream manager.
"""
class DummyStreamManager(object):
def __init__(self):
self.outlist = []
def send(self, data):
self.outlist.append(data)
handler = subprotocols.XMPPHandler()
handler.parent = DummyStreamManager()
handler.send('<presence/>')
self.assertEquals(['<presence/>'], handler.parent.outlist)
def test_makeConnection(self):
"""
Test that makeConnection saves the XML stream and calls connectionMade.
"""
class TestXMPPHandler(subprotocols.XMPPHandler):
def connectionMade(self):
self.doneMade = True
handler = TestXMPPHandler()
xs = xmlstream.XmlStream(xmlstream.Authenticator())
handler.makeConnection(xs)
self.assertTrue(handler.doneMade)
self.assertIdentical(xs, handler.xmlstream)
def test_connectionLost(self):
"""
Test that connectionLost forgets the XML stream.
"""
handler = subprotocols.XMPPHandler()
xs = xmlstream.XmlStream(xmlstream.Authenticator())
handler.makeConnection(xs)
handler.connectionLost(Exception())
self.assertIdentical(None, handler.xmlstream)
def test_request(self):
"""
A request is passed up to the stream manager.
"""
class DummyStreamManager(object):
def __init__(self):
self.requests = []
def request(self, request):
self.requests.append(request)
return defer.succeed(None)
handler = subprotocols.XMPPHandler()
handler.parent = DummyStreamManager()
request = IQGetStanza()
d = handler.request(request)
self.assertEquals(1, len(handler.parent.requests))
self.assertIdentical(request, handler.parent.requests[-1])
return d
class StreamManagerTest(unittest.TestCase):
"""
Tests for L{subprotocols.StreamManager}.
"""
def setUp(self):
factory = xmlstream.XmlStreamFactory(xmlstream.Authenticator())
self.clock = task.Clock()
self.streamManager = subprotocols.StreamManager(factory, self.clock)
self.xmlstream = factory.buildProtocol(None)
self.transport = proto_helpers.StringTransport()
self.xmlstream.transport = self.transport
self.request = IQGetStanza()
def _streamStarted(self):
"""
Bring the test stream to the initialized state.
"""
self.xmlstream.connectionMade()
self.xmlstream.dataReceived(
"<stream:stream xmlns='jabber:client' "
"xmlns:stream='http://etherx.jabber.org/streams' "
"from='example.com' id='12345'>")
self.xmlstream.dispatch(self.xmlstream, "//event/stream/authd")
def test_basic(self):
"""
Test correct initialization and setup of factory observers.
"""
factory = DummyFactory()
sm = subprotocols.StreamManager(factory)
self.assertIdentical(None, sm.xmlstream)
self.assertEquals([], sm.handlers)
self.assertEquals(sm._connected,
sm.factory.callbacks['//event/stream/connected'])
self.assertEquals(sm._authd,
sm.factory.callbacks['//event/stream/authd'])
self.assertEquals(sm._disconnected,
sm.factory.callbacks['//event/stream/end'])
self.assertEquals(sm.initializationFailed,
sm.factory.callbacks['//event/xmpp/initfailed'])
def test_connected(self):
"""
Test that protocol handlers have their connectionMade method called
when the XML stream is connected.
"""
sm = self.streamManager
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
xs = xmlstream.XmlStream(xmlstream.Authenticator())
sm._connected(xs)
self.assertEquals(1, handler.doneMade)
self.assertEquals(0, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
def test_connectedLogTrafficFalse(self):
"""
Test raw data functions unset when logTraffic is set to False.
"""
sm = self.streamManager
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
xs = xmlstream.XmlStream(xmlstream.Authenticator())
sm._connected(xs)
self.assertIdentical(None, xs.rawDataInFn)
self.assertIdentical(None, xs.rawDataOutFn)
def test_connectedLogTrafficTrue(self):
"""
Test raw data functions set when logTraffic is set to True.
"""
sm = self.streamManager
sm.logTraffic = True
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
xs = xmlstream.XmlStream(xmlstream.Authenticator())
sm._connected(xs)
self.assertNotIdentical(None, xs.rawDataInFn)
self.assertNotIdentical(None, xs.rawDataOutFn)
def test_authd(self):
"""
Test that protocol handlers have their connectionInitialized method
called when the XML stream is initialized.
"""
sm = self.streamManager
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
xs = xmlstream.XmlStream(xmlstream.Authenticator())
sm._authd(xs)
self.assertEquals(0, handler.doneMade)
self.assertEquals(1, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
def test_disconnected(self):
"""
Protocol handlers have connectionLost called on stream disconnect.
"""
sm = self.streamManager
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
sm._disconnected(None)
self.assertEquals(0, handler.doneMade)
self.assertEquals(0, handler.doneInitialized)
self.assertEquals(1, handler.doneLost)
def test_disconnectedReason(self):
"""
A L{STREAM_END_EVENT} results in L{StreamManager} firing the handlers
L{connectionLost} methods, passing a L{failure.Failure} reason.
"""
sm = self.streamManager
handler = FailureReasonXMPPHandler()
handler.setHandlerParent(sm)
xmlstream.XmlStream(xmlstream.Authenticator())
sm._disconnected(failure.Failure(Exception("no reason")))
self.assertEquals(True, handler.gotFailureReason)
def test_addHandler(self):
"""
Test the addition of a protocol handler while not connected.
"""
sm = self.streamManager
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
self.assertEquals(0, handler.doneMade)
self.assertEquals(0, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
def test_addHandlerConnected(self):
"""
Adding a handler when connected doesn't call connectionInitialized.
"""
sm = self.streamManager
xs = xmlstream.XmlStream(xmlstream.Authenticator())
sm._connected(xs)
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
self.assertEquals(1, handler.doneMade)
self.assertEquals(0, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
def test_addHandlerConnectedNested(self):
"""
Adding a handler in connectionMade doesn't cause 2nd call.
"""
class NestingHandler(DummyXMPPHandler):
nestedHandler = None
def connectionMade(self):
DummyXMPPHandler.connectionMade(self)
self.nestedHandler = DummyXMPPHandler()
self.nestedHandler.setHandlerParent(self.parent)
sm = self.streamManager
xs = xmlstream.XmlStream(xmlstream.Authenticator())
handler = NestingHandler()
handler.setHandlerParent(sm)
sm._connected(xs)
self.assertEquals(1, handler.doneMade)
self.assertEquals(0, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
self.assertEquals(1, handler.nestedHandler.doneMade)
self.assertEquals(0, handler.nestedHandler.doneInitialized)
self.assertEquals(0, handler.nestedHandler.doneLost)
def test_addHandlerInitialized(self):
"""
Test the addition of a protocol handler after the stream
have been initialized.
Make sure that the handler will have the connected stream
passed via C{makeConnection} and have C{connectionInitialized}
called.
"""
sm = self.streamManager
xs = xmlstream.XmlStream(xmlstream.Authenticator())
sm._connected(xs)
sm._authd(xs)
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
self.assertEquals(1, handler.doneMade)
self.assertEquals(1, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
def test_addHandlerInitializedNested(self):
"""
Adding a handler in connectionInitialized doesn't cause 2nd call.
"""
class NestingHandler(DummyXMPPHandler):
nestedHandler = None
def connectionInitialized(self):
DummyXMPPHandler.connectionInitialized(self)
self.nestedHandler = DummyXMPPHandler()
self.nestedHandler.setHandlerParent(self.parent)
sm = self.streamManager
xs = xmlstream.XmlStream(xmlstream.Authenticator())
handler = NestingHandler()
handler.setHandlerParent(sm)
sm._connected(xs)
sm._authd(xs)
self.assertEquals(1, handler.doneMade)
self.assertEquals(1, handler.doneInitialized)
self.assertEquals(0, handler.doneLost)
self.assertEquals(1, handler.nestedHandler.doneMade)
self.assertEquals(1, handler.nestedHandler.doneInitialized)
self.assertEquals(0, handler.nestedHandler.doneLost)
def test_addHandlerConnectionLostNested(self):
"""
Adding a handler in connectionLost doesn't call connectionLost there.
"""
class NestingHandler(DummyXMPPHandler):
nestedHandler = None
def connectionLost(self, reason):
DummyXMPPHandler.connectionLost(self, reason)
self.nestedHandler = DummyXMPPHandler()
self.nestedHandler.setHandlerParent(self.parent)
sm = self.streamManager
xs = xmlstream.XmlStream(xmlstream.Authenticator())
handler = NestingHandler()
handler.setHandlerParent(sm)
sm._connected(xs)
sm._authd(xs)
sm._disconnected(xs)
self.assertEquals(1, handler.doneMade)
self.assertEquals(1, handler.doneInitialized)
self.assertEquals(1, handler.doneLost)
self.assertEquals(0, handler.nestedHandler.doneMade)
self.assertEquals(0, handler.nestedHandler.doneInitialized)
self.assertEquals(0, handler.nestedHandler.doneLost)
def test_removeHandler(self):
"""
Test removal of protocol handler.
"""
sm = self.streamManager
handler = DummyXMPPHandler()
handler.setHandlerParent(sm)
handler.disownHandlerParent(sm)
self.assertNotIn(handler, sm)
self.assertIdentical(None, handler.parent)
def test_sendInitialized(self):
"""
Test send when the stream has been initialized.
The data should be sent directly over the XML stream.
"""
factory = xmlstream.XmlStreamFactory(xmlstream.Authenticator())
sm = subprotocols.StreamManager(factory)
xs = factory.buildProtocol(None)
xs.transport = proto_helpers.StringTransport()
xs.connectionMade()
xs.dataReceived("<stream:stream xmlns='jabber:client' "
"xmlns:stream='http://etherx.jabber.org/streams' "
"from='example.com' id='12345'>")
xs.dispatch(xs, "//event/stream/authd")
sm.send("<presence/>")
self.assertEquals("<presence/>", xs.transport.value())
def test_sendNotConnected(self):
"""
Test send when there is no established XML stream.
The data should be cached until an XML stream has been established and
initialized.
"""
factory = xmlstream.XmlStreamFactory(xmlstream.Authenticator())
sm = subprotocols.StreamManager(factory)
handler = DummyXMPPHandler()
sm.addHandler(handler)
xs = factory.buildProtocol(None)
xs.transport = proto_helpers.StringTransport()
sm.send("<presence/>")
self.assertEquals("", xs.transport.value())
self.assertEquals("<presence/>", sm._packetQueue[0])
xs.connectionMade()
self.assertEquals("", xs.transport.value())
self.assertEquals("<presence/>", sm._packetQueue[0])
xs.dataReceived("<stream:stream xmlns='jabber:client' "
"xmlns:stream='http://etherx.jabber.org/streams' "
"from='example.com' id='12345'>")
xs.dispatch(xs, "//event/stream/authd")
self.assertEquals("<presence/>", xs.transport.value())
self.assertFalse(sm._packetQueue)
def test_sendNotInitialized(self):
"""
Test send when the stream is connected but not yet initialized.
The data should be cached until the XML stream has been initialized.
"""
factory = xmlstream.XmlStreamFactory(xmlstream.Authenticator())
sm = subprotocols.StreamManager(factory)
xs = factory.buildProtocol(None)
xs.transport = proto_helpers.StringTransport()
xs.connectionMade()
xs.dataReceived("<stream:stream xmlns='jabber:client' "
"xmlns:stream='http://etherx.jabber.org/streams' "
"from='example.com' id='12345'>")
sm.send("<presence/>")
self.assertEquals("", xs.transport.value())
self.assertEquals("<presence/>", sm._packetQueue[0])
def test_sendDisconnected(self):
"""
Test send after XML stream disconnection.
The data should be cached until a new XML stream has been established
and initialized.
"""
factory = xmlstream.XmlStreamFactory(xmlstream.Authenticator())
sm = subprotocols.StreamManager(factory)
handler = DummyXMPPHandler()
sm.addHandler(handler)
xs = factory.buildProtocol(None)
xs.connectionMade()
xs.transport = proto_helpers.StringTransport()
xs.connectionLost(None)
sm.send("<presence/>")
self.assertEquals("", xs.transport.value())
self.assertEquals("<presence/>", sm._packetQueue[0])
def test_requestSendInitialized(self):
"""
A request is sent out over the wire when the stream is initialized.
"""
self._streamStarted()
self.streamManager.request(self.request)
expected = u"<iq type='get' id='%s'/>" % self.request.stanzaID
self.assertEquals(expected, self.transport.value())
def test_requestSendInitializedFreshID(self):
"""
A request without an ID gets a fresh one upon send.
"""
self._streamStarted()
self.request.stanzaID = None
self.streamManager.request(self.request)
self.assertNotIdentical(None, self.request.stanzaID)
expected = u"<iq type='get' id='%s'/>" % self.request.stanzaID
self.assertEquals(expected, self.transport.value())
def test_requestSendNotConnected(self):
"""
A request is queued until a stream is initialized.
"""
handler = DummyXMPPHandler()
self.streamManager.addHandler(handler)
self.streamManager.request(self.request)
expected = u"<iq type='get' id='test'/>"
xs = self.xmlstream
self.assertEquals("", xs.transport.value())
xs.connectionMade()
self.assertEquals("", xs.transport.value())
xs.dataReceived("<stream:stream xmlns='jabber:client' "
"xmlns:stream='http://etherx.jabber.org/streams' "
"from='example.com' id='12345'>")
xs.dispatch(xs, "//event/stream/authd")
self.assertEquals(expected, xs.transport.value())
self.assertFalse(self.streamManager._packetQueue)
def test_requestResultResponse(self):
"""
A result response gets the request deferred fired with the response.
"""
def cb(result):
self.assertEquals(result['type'], 'result')
self._streamStarted()
d = self.streamManager.request(self.request)
d.addCallback(cb)
xs = self.xmlstream
xs.dataReceived("<iq type='result' id='test'/>")
return d
def test_requestErrorResponse(self):
"""
An error response gets the request deferred fired with a failure.
"""
self._streamStarted()
d = self.streamManager.request(self.request)
self.assertFailure(d, error.StanzaError)
xs = self.xmlstream
xs.dataReceived("<iq type='error' id='test'/>")
return d
def test_requestNonTrackedResponse(self):
"""
Test that untracked iq responses don't trigger any action.
Untracked means that the id of the incoming response iq is not
in the stream's C{iqDeferreds} dictionary.
"""
# Set up a fallback handler that checks the stanza's handled attribute.
# If that is set to True, the iq tracker claims to have handled the
# response.
dispatched = []
def cb(iq):
dispatched.append(iq)
self._streamStarted()
self.xmlstream.addObserver("/iq", cb, -1)
# Receive an untracked iq response
self.xmlstream.dataReceived("<iq type='result' id='other'/>")
self.assertEquals(1, len(dispatched))
self.assertFalse(getattr(dispatched[-1], 'handled', False))
def test_requestCleanup(self):
"""
Test if the deferred associated with an iq request is removed
from the list kept in the L{XmlStream} object after it has
been fired.
"""
self._streamStarted()
d = self.streamManager.request(self.request)
xs = self.xmlstream
xs.dataReceived("<iq type='result' id='test'/>")
self.assertNotIn('test', self.streamManager._iqDeferreds)
return d
def test_requestDisconnectCleanup(self):
"""
Test if deferreds for iq's that haven't yet received a response
have their errback called on stream disconnect.
"""
d = self.streamManager.request(self.request)
xs = self.xmlstream
xs.connectionLost(failure.Failure(ConnectionDone()))
self.assertFailure(d, ConnectionDone)
return d
def test_requestNoModifyingDict(self):
"""
Test to make sure the errbacks cannot cause the iteration of the
iqDeferreds to blow up in our face.
"""
def eb(failure):
d = xmlstream.IQ(self.xmlstream).send()
d.addErrback(eb)
d = self.streamManager.request(self.request)
d.addErrback(eb)
self.xmlstream.connectionLost(failure.Failure(ConnectionDone()))
return d
def test_requestTimingOut(self):
"""
Test that an iq request with a defined timeout times out.
"""
self.request.timeout = 60
d = self.streamManager.request(self.request)
self.assertFailure(d, xmlstream.TimeoutError)
self.clock.pump([1, 60])
self.assertFalse(self.clock.calls)
self.assertFalse(self.streamManager._iqDeferreds)
return d
def test_requestNotTimingOut(self):
"""
Test that an iq request with a defined timeout does not time out
when a response was received before the timeout period elapsed.
"""
self._streamStarted()
self.request.timeout = 60
d = self.streamManager.request(self.request)
self.clock.callLater(1, self.xmlstream.dataReceived,
"<iq type='result' id='test'/>")
self.clock.pump([1, 1])
self.assertFalse(self.clock.calls)
return d
def test_requestDisconnectTimeoutCancellation(self):
"""
Test if timeouts for iq's that haven't yet received a response
are cancelled on stream disconnect.
"""
self.request.timeout = 60
d = self.streamManager.request(self.request)
self.xmlstream.connectionLost(failure.Failure(ConnectionDone()))
self.assertFailure(d, ConnectionDone)
self.assertFalse(self.clock.calls)
return d
def test_requestNotIQ(self):
"""
The request stanza must be an iq.
"""
stanza = generic.Stanza()
stanza.stanzaKind = 'message'
d = self.streamManager.request(stanza)
self.assertFailure(d, ValueError)
def test_requestNotResult(self):
"""
The request stanza cannot be of type 'result'.
"""
stanza = generic.Stanza()
stanza.stanzaKind = 'iq'
stanza.stanzaType = 'result'
d = self.streamManager.request(stanza)
self.assertFailure(d, ValueError)
def test_requestNotError(self):
"""
The request stanza cannot be of type 'error'.
"""
stanza = generic.Stanza()
stanza.stanzaKind = 'iq'
stanza.stanzaType = 'error'
d = self.streamManager.request(stanza)
self.assertFailure(d, ValueError)
class DummyIQHandler(subprotocols.IQHandlerMixin):
iqHandlers = {'/iq[@type="get"]': 'onGet'}
def __init__(self):
self.output = []
self.xmlstream = xmlstream.XmlStream(xmlstream.Authenticator())
self.xmlstream.send = self.output.append
def send(self, obj):
self.xmlstream.send(obj)
class IQHandlerTest(unittest.TestCase):
def test_match(self):
"""
Test that the matching handler gets called.
"""
class Handler(DummyIQHandler):
called = False
def onGet(self, iq):
self.called = True
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
self.assertTrue(handler.called)
def test_noMatch(self):
"""
Test that the matching handler gets called.
"""
class Handler(DummyIQHandler):
called = False
def onGet(self, iq):
self.called = True
iq = domish.Element((None, 'iq'))
iq['type'] = 'set'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
self.assertFalse(handler.called)
def test_success(self):
"""
Test response when the request is handled successfully.
"""
class Handler(DummyIQHandler):
def onGet(self, iq):
return None
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('result', response['type'])
def test_successPayload(self):
"""
Test response when the request is handled successfully with payload.
"""
class Handler(DummyIQHandler):
payload = domish.Element(('testns', 'foo'))
def onGet(self, iq):
return self.payload
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('result', response['type'])
payload = response.elements().next()
self.assertEqual(handler.payload, payload)
def test_successDeferred(self):
"""
Test response when where the handler was a deferred.
"""
class Handler(DummyIQHandler):
def onGet(self, iq):
return defer.succeed(None)
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('result', response['type'])
def test_failure(self):
"""
Test response when the request is handled unsuccessfully.
"""
class Handler(DummyIQHandler):
def onGet(self, iq):
raise error.StanzaError('forbidden')
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('error', response['type'])
e = error.exceptionFromStanza(response)
self.assertEquals('forbidden', e.condition)
def test_failureUnknown(self):
"""
Test response when the request handler raises a non-stanza-error.
"""
class TestError(Exception):
pass
class Handler(DummyIQHandler):
def onGet(self, iq):
raise TestError()
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('error', response['type'])
e = error.exceptionFromStanza(response)
self.assertEquals('internal-server-error', e.condition)
self.assertEquals(1, len(self.flushLoggedErrors(TestError)))
def test_notImplemented(self):
"""
Test response when the request is recognised but not implemented.
"""
class Handler(DummyIQHandler):
def onGet(self, iq):
raise NotImplementedError()
iq = domish.Element((None, 'iq'))
iq['type'] = 'get'
iq['id'] = 'r1'
handler = Handler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('error', response['type'])
e = error.exceptionFromStanza(response)
self.assertEquals('feature-not-implemented', e.condition)
def test_noHandler(self):
"""
Test when the request is not recognised.
"""
iq = domish.Element((None, 'iq'))
iq['type'] = 'set'
iq['id'] = 'r1'
handler = DummyIQHandler()
handler.handleRequest(iq)
response = handler.output[-1]
self.assertEquals(None, response.uri)
self.assertEquals('iq', response.name)
self.assertEquals('error', response['type'])
e = error.exceptionFromStanza(response)
self.assertEquals('feature-not-implemented', e.condition)
|