Changeset 169:bb939a909750

Timestamp:

Feb 25, 2012, 8:27:56 PM (10 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Message:

Let wokkel.component.Component reconnect if first attempt fails.

Author: ralphm.
Fixes #75.

Files:

• NEWS (modified) (1 diff)
• wokkel/component.py (modified) (5 diffs)
• wokkel/test/test_component.py (modified) (2 diffs)

NEWS

@@ +1 @@
+x.x.x (yyyy-mm-dd)
+==================
+
+Fixes
+-----
+
+ - wokkel.component.Component now reconnects if first attempt failed (#75).
+
+
 0.7.0 (2012-01-23)
-======================
-
-Features
---------
+==================
+
+Features
+--------
+
  - Added method wokkel.data_form.Form.typeCheck for type checking incoming Data
    Forms submissions against field definitions.

wokkel/component.py

@@ -5 +5 @@
 
 """
-XMPP External Component utilities
+XMPP External Component utilities.
 """
 
@@ -21 +21 @@
 
 class Component(StreamManager, service.Service):
+    """
+    XMPP External Component service.
+
+    This service is a XMPP stream manager that connects as an External
+    Component to an XMPP server, as described in
+    U{XEP-0114<http://xmpp.org/extensions/xep-0114.html>}.
+    """
     def __init__(self, host, port, jid, password):
         self.host = host
@@ -29 +36 @@
         StreamManager.__init__(self, factory)
 
+
     def _authd(self, xs):
+        """
+        Called when stream initialization has completed.
+
+        This replaces the C{send} method of the C{XmlStream} instance
+        that represents the current connection so that outgoing stanzas
+        always have a from attribute set to the JID of the component.
+        """
         old_send = xs.send
 
@@ -41 +56 @@
         StreamManager._authd(self, xs)
 
+
     def initializationFailed(self, reason):
         """
@@ -51 +67 @@
         reason.raiseException()
 
+
     def startService(self):
+        """
+        Start the service and connect to the server.
+        """
         service.Service.startService(self)
 
+        self._connection = self._getConnection()
+
+
+    def stopService(self):
+        """
+        Stop the service, close the connection and prevent reconnects.
+        """
+        service.Service.stopService(self)
+
         self.factory.stopTrying()
-        self._connection = self._getConnection()
-
-    def stopService(self):
-        service.Service.stopService(self)
-
         self._connection.disconnect()
 
+
     def _getConnection(self):
+        """
+        Create a connector that connects to the server.
+        """
         return reactor.connectTCP(self.host, self.port, self.factory)
 

wokkel/test/test_component.py

@@ -3 +3 @@
 
 """
-Tests for L{wokkel.component}
+Tests for L{wokkel.component}.
 """
 
 from zope.interface.verify import verifyObject
 
+from twisted.internet.base import BaseConnector
+from twisted.internet.error import ConnectionRefusedError
+from twisted.internet.task import Clock
 from twisted.python import failure
 from twisted.trial import unittest
@@ -18 +21 @@
 from wokkel import component
 from wokkel.generic import XmlPipe
+
+class FakeConnector(BaseConnector):
+    """
+    Fake connector that counts connection attempts.
+    """
+    connects = 0
+
+    def connect(self):
+        self.connects += 1
+        BaseConnector.connect(self)
+
+
+    def _makeTransport(self):
+        return None
+
+
+
+class TestableComponent(component.Component):
+    """
+    Testable component.
+
+    This component provides the created factory with a L{Clock}
+    instead of the regular reactor and uses L{FakeConnector} for testing
+    connects and reconnects.
+    """
+
+    def __init__(self, *args, **kwargs):
+        component.Component.__init__(self, *args, **kwargs)
+        self.factory.clock = Clock()
+
+
+    def _getConnection(self):
+        c = FakeConnector(self.factory, None, None)
+        c.connect()
+        return c
+
+
+
+class ComponentTest(unittest.TestCase):
+    """
+    Tests for L{component.Component}.
+    """
+    def test_startServiceReconnectAfterFailure(self):
+        """
+        When the first connection attempt fails, retry.
+        """
+        comp = TestableComponent('example.org', 5347,
+                                 'test.example.org', 'secret')
+
+        # Starting the service initiates a connection attempt.
+        comp.startService()
+        connector = comp._connection
+        self.assertEqual(1, connector.connects)
+
+        # Fail the connection.
+        connector.connectionFailed(ConnectionRefusedError())
+
+        # After a back-off delay, a new connection is attempted.
+        comp.factory.clock.advance(5)
+        self.assertEqual(2, connector.connects)
+
+
+    def test_stopServiceNoReconnect(self):
+        """
+        When the service is stopped, no reconnect is attempted.
+        """
+        comp = TestableComponent('example.org', 5347,
+                                 'test.example.org', 'secret')
+
+        # Starting the service initiates a connection attempt.
+        comp.startService()
+        connector = comp._connection
+
+        # Fail the connection.
+        connector.connectionFailed(ConnectionRefusedError())
+
+        # If the service is stopped before the back-off delay expires,
+        # no new connection is attempted.
+        comp.factory.clock.advance(1)
+        comp.stopService()
+        comp.factory.clock.advance(4)
+        self.assertEqual(1, connector.connects)
+
+
 
 class InternalComponentTest(unittest.TestCase):