Changeset 45:125f9d902a20 for wokkel/test/test_subprotocols.py

Timestamp:

Nov 1, 2008, 7:18:50 PM (14 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@134

Message:

Bring subprotocols code in line with Twisted trunk.

File:

• wokkel/test/test_subprotocols.py (modified) (14 diffs)

wokkel/test/test_subprotocols.py

@@ -5 +5 @@
 Tests for L{wokkel.subprotocols}
 """
+
+from zope.interface.verify import verifyObject
 
 from twisted.trial import unittest
@@ -12 +14 @@
 from twisted.words.protocols.jabber import error, xmlstream
 
-from wokkel import subprotocols
+from wokkel import iwokkel, subprotocols
 
 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
@@ -28 +38 @@
         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 XMPPHandlerTest(unittest.TestCase):
+    """
+    Tests for L{subprotocols.XMPPHandler}.
+    """
+
+    def test_interface(self):
+        """
+        L{xmlstream.XMPPHandler} implements L{iwokkel.IXMPPHandler}.
+        """
+        verifyObject(iwokkel.IXMPPHandler, subprotocols.XMPPHandler())
+
 
     def test_send(self):
@@ -47 +72 @@
         Test that data is passed on for sending by the stream manager.
         """
-
         class DummyStreamManager(object):
             def __init__(self):
@@ -61 +85 @@
 
 
+    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)
+
+
+
+class XMPPHandlerCollectionTest(unittest.TestCase):
+    """
+    Tests for L{subprotocols.XMPPHandlerCollection}.
+    """
+
+    def setUp(self):
+        self.collection = subprotocols.XMPPHandlerCollection()
+
+
+    def test_interface(self):
+        """
+        L{subprotocols.StreamManager} implements L{iwokkel.IXMPPHandlerCollection}.
+        """
+        verifyObject(iwokkel.IXMPPHandlerCollection, self.collection)
+
+
+    def test_addHandler(self):
+        """
+        Test the addition of a protocol handler.
+        """
+        handler = DummyXMPPHandler()
+        handler.setHandlerParent(self.collection)
+        self.assertIn(handler, self.collection)
+        self.assertIdentical(self.collection, handler.parent)
+
+
+    def test_removeHandler(self):
+        """
+        Test removal of a protocol handler.
+        """
+        handler = DummyXMPPHandler()
+        handler.setHandlerParent(self.collection)
+        handler.disownHandlerParent(self.collection)
+        self.assertNotIn(handler, self.collection)
+        self.assertIdentical(None, handler.parent)
+
+
+
 class StreamManagerTest(unittest.TestCase):
+    """
+    Tests for L{subprotocols.StreamManager}.
+    """
 
     def setUp(self):
@@ -83 +175 @@
                           sm.factory.callbacks['//event/xmpp/initfailed'])
 
-    def test__connected(self):
+
+    def test_connected(self):
         """
         Test that protocol handlers have their connectionMade method called
@@ -97 +190 @@
         self.assertEquals(0, handler.doneLost)
 
-    def test__authd(self):
+
+    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
@@ -111 +232 @@
         self.assertEquals(0, handler.doneLost)
 
-    def test__disconnected(self):
+
+    def test_disconnected(self):
         """
         Test that protocol handlers have their connectionLost method
@@ -125 +247 @@
         self.assertEquals(1, handler.doneLost)
 
+
     def test_addHandler(self):
         """
@@ -132 +255 @@
         handler = DummyXMPPHandler()
         handler.setHandlerParent(sm)
-        self.assertIn(handler, sm)
-        self.assertIdentical(sm, handler.parent)
 
         self.assertEquals(0, handler.doneMade)
         self.assertEquals(0, handler.doneInitialized)
         self.assertEquals(0, handler.doneLost)
+
 
     def test_addHandlerInitialized(self):
@@ -188 +310 @@
         self.assertEquals("<presence/>", xs.transport.value())
 
+
     def test_sendNotConnected(self):
         """
@@ -216 +339 @@
 
         self.assertEquals("<presence/>", xs.transport.value())
-        self.failIf(sm._packetQueue)
+        self.assertFalse(sm._packetQueue)
+
 
     def test_sendNotInitialized(self):
@@ -236 +360 @@
         self.assertEquals("<presence/>", sm._packetQueue[0])
 
+
     def test_sendDisconnected(self):
         """
@@ -258 +383 @@
 
 
+
 class DummyIQHandler(subprotocols.IQHandlerMixin):
     iqHandlers = {'/iq[@type="get"]': 'onGet'}