Changeset 44:2c222a21d538 for wokkel

Timestamp:

Nov 1, 2008, 11:37:16 AM (14 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

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

Message:

Bring compat in line with Twisted trunk regarding XmlStreamServerFactory?.

Location:

wokkel

Files:

• compat.py (modified) (3 diffs)
• test/test_compat.py (modified) (5 diffs)

wokkel/compat.py

@@ -56 +56 @@
     C{observerfn} arguments to L{utility.EventDispatcher.addObserver}.
 
+    @since: 8.2.
     @ivar bootstraps: The list of registered bootstrap event observers.
     @type bootstrap: C{list}
@@ -78 +79 @@
         """
         Add a bootstrap event handler.
+
+        @param event: The event to register an observer for.
+        @type event: C{str} or L{xpath.XPathQuery}
+        @param fn: The observer callable to be registered.
         """
         self.bootstraps.append((event, fn))
@@ -85 +90 @@
         """
         Remove a bootstrap event handler.
+
+        @param event: The event the observer is registered for.
+        @type event: C{str} or L{xpath.XPathQuery}
+        @param fn: The registered observer callable.
         """
         self.bootstraps.remove((event, fn))

wokkel/test/test_compat.py

@@ -47 +47 @@
         Dispatching an event should fire registered bootstrap observers.
         """
-        d = defer.Deferred()
+        called = []
+
+        def cb(data):
+            called.append(data)
+
         dispatcher = DummyProtocol()
-        self.factory.addBootstrap('//event/myevent', d.callback)
+        self.factory.addBootstrap('//event/myevent', cb)
         self.factory.installBootstraps(dispatcher)
+
         dispatcher.dispatch(None, '//event/myevent')
-        return d
+        self.assertEquals(1, len(called))
 
 
@@ -59 +64 @@
         Test addition and removal of a bootstrap event handler.
         """
-        def cb(self):
-            pass
+
+        called = []
+
+        def cb(data):
+            called.append(data)
 
         self.factory.addBootstrap('//event/myevent', cb)
-        self.assertIn(('//event/myevent', cb), self.factory.bootstraps)
-
         self.factory.removeBootstrap('//event/myevent', cb)
-        self.assertNotIn(('//event/myevent', cb), self.factory.bootstraps)
+
+        dispatcher = DummyProtocol()
+        self.factory.installBootstraps(dispatcher)
+
+        dispatcher.dispatch(None, '//event/myevent')
+        self.assertFalse(called)
 
 
@@ -148 +159 @@
         Set up a server factory with a authenticator factory function.
         """
+        class TestAuthenticator(object):
+            def __init__(self):
+                self.xmlstreams = []
+
+            def associateWithStream(self, xs):
+                self.xmlstreams.append(xs)
+
         def authenticatorFactory():
-            return xmlstream.Authenticator()
+            return TestAuthenticator()
 
         self.factory = XmlStreamServerFactory(authenticatorFactory)
@@ -161 +179 @@
 
 
-    def test_buildProtocol(self):
-        """
-        The authenticator factory should be passed to its protocol and it
-        should instantiate the authenticator and save it.
-        L{xmlstream.XmlStream}s do that, but we also want to ensure it really
-        is one.
-        """
-        xs = self.factory.buildProtocol(None)
-        self.assertIdentical(self.factory, xs.factory)
+    def test_buildProtocolAuthenticatorInstantiation(self):
+        """
+        The authenticator factory should be used to instantiate the
+        authenticator and pass it to the protocol.
+
+        The default protocol, L{XmlStream} stores the authenticator it is
+        passed, and calls its C{associateWithStream} method. so we use that to
+        check whether our authenticator factory is used and the protocol
+        instance gets an authenticator.
+        """
+        xs = self.factory.buildProtocol(None)
+        self.assertEquals([xs], xs.authenticator.xmlstreams)
+
+
+    def test_buildProtocolXmlStream(self):
+        """
+        The protocol factory creates Jabber XML Stream protocols by default.
+        """
+        xs = self.factory.buildProtocol(None)
         self.assertIsInstance(xs, xmlstream.XmlStream)
-        self.assertIsInstance(xs.authenticator, xmlstream.Authenticator)
 
 
@@ -183 +210 @@
         self.assertNotIdentical(xs1, xs2)
         self.assertNotIdentical(xs1.authenticator, xs2.authenticator)
+
+
+    def test_buildProtocolInstallsBootstraps(self):
+        """
+        The protocol factory installs bootstrap event handlers on the protocol.
+        """
+        called = []
+
+        def cb(data):
+            called.append(data)
+
+        self.factory.addBootstrap('//event/myevent', cb)
+
+        xs = self.factory.buildProtocol(None)
+        xs.dispatch(None, '//event/myevent')
+
+        self.assertEquals(1, len(called))
+
+
+    def test_buildProtocolStoresFactory(self):
+        """
+        The protocol factory is saved in the protocol.
+        """
+        xs = self.factory.buildProtocol(None)
+        self.assertIdentical(self.factory, xs.factory)