Changeset 98:c3b20ad2bb70 for wokkel

Timestamp:

Mar 7, 2011, 7:40:16 PM (11 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Track change in Twisted Words, to pass a reason Failure with STREAM_END_EVENT.

Location:

wokkel

Files:

• subprotocols.py (modified) (3 diffs)
• test/test_subprotocols.py (modified) (3 diffs)

wokkel/subprotocols.py

@@ -11 +11 @@
 
 from twisted.internet import defer
-from twisted.python import log
+from twisted.internet.error import ConnectionDone
+from twisted.python import failure, log
 from twisted.words.protocols.jabber import error, xmlstream
 from twisted.words.protocols.jabber.xmlstream import toResponse
@@ -247 +248 @@
 
 
-    def _disconnected(self, _):
+    def _disconnected(self, reason):
         """
         Called when the stream has been closed.
@@ -258 +259 @@
         self._initialized = False
 
+        # Twisted versions before 11.0 passed an XmlStream here.
+        if not hasattr(reason, 'trap'):
+            reason = failure.Failure(ConnectionDone())
+
         # Notify all child services which implement
         # the IService interface
         for e in self:
-            e.connectionLost(None)
+            e.connectionLost(reason)
 
 

wokkel/test/test_subprotocols.py

@@ -11 +11 @@
 from twisted.test import proto_helpers
 from twisted.internet import defer
+from twisted.python import failure
 from twisted.words.xish import domish
 from twisted.words.protocols.jabber import error, xmlstream
@@ -53 +54 @@
     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
 
 
@@ -235 +250 @@
     def test_disconnected(self):
         """
-        Test that protocol handlers have their connectionLost method
-        called when the XML stream is disconnected.
-        """
-        sm = self.streamManager
-        handler = DummyXMPPHandler()
-        handler.setHandlerParent(sm)
-        xs = xmlstream.XmlStream(xmlstream.Authenticator())
-        sm._disconnected(xs)
+        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)
+        xs = xmlstream.XmlStream(xmlstream.Authenticator())
+        sm._disconnected(failure.Failure(Exception("no reason")))
+        self.assertEquals(True, handler.gotFailureReason)