Merge lp:~alecu/ubuntuone-client/use-staggered-sso-ports into lp:ubuntuone-client

[Alejandro J. Cura]

Calculate the pb port number from the user id and use tcpactivation to only start one instance.

Calculate the pb port number from the user id and use tcpactivation to only start one instance.

[lp:~alecu/ubuntuone-client/use-staggered-sso-ports]

1067. By Alejandro J. Cura on 2011-07-27

merged trunk in

[Roberto Alsina (ralsina)]

+1 IRL and code review

review: Approve

[Natalia Bidart (nataliabidart)]

Text conflict in ubuntuone/platform/windows/__init__.py
1 conflicts encountered.

review: Needs Fixing

[lp:~alecu/ubuntuone-client/use-staggered-sso-ports]

1068. By Alejandro J. Cura on 2011-07-28

merged trunk in

1069. By Alejandro J. Cura on 2011-07-28

merged with trunk

1070. By Alejandro J. Cura on 2011-07-28

ugly workaround for the circular import on the windows platform modules (see LP: #817559)

[Natalia Bidart (nataliabidart)]

All good!

review: Approve

=== modified file 'bin/ubuntuone-syncdaemon'
--- bin/ubuntuone-syncdaemon	2011-07-26 02:26:33 +0000
+++ bin/ubuntuone-syncdaemon	2011-07-28 14:37:29 +0000
@@ -45,17 +45,28 @@
 
 from ubuntuone.syncdaemon.main import Main
 
-from twisted.internet import reactor
+from twisted.internet import reactor, defer
 from ubuntuone.platform.xdg_base_directory import (
     xdg_cache_home,
     xdg_data_home,
 )
 
 
+class DeathException(Exception):
+    """The process has commited seppuku."""
+
+
 def die(msg):
+    """Write the error message an die."""
     logger.root_logger.warning(msg)
     sys.stderr.write(msg + '\n')
-    sys.exit(1)
+    raise DeathException()
+
+
+def check_death(failure):
+    """Stop the reactor and exit the process."""
+    failure.trap(DeathException)
+    reactor.callWhenRunning(reactor.stop)
 
 
 def main(argv):
@@ -69,7 +80,24 @@
         configs.extend(get_config_files())
     (parser, options, argv) = config.configglue(file(configs[0]), *configs[1:],
                                args=args, usage=usage)
-
+    d = async_main(parser, options, argv)
+    d.addErrback(check_death)
+
+    if options.debug_lsprof_file:
+        try:
+            from bzrlib.lsprof import profile
+            ret, stats = profile(reactor.run)
+            stats.save(options.debug_lsprof_file)
+        except ImportError:
+            logger.root_logger.warning('bzrlib.lsprof not available')
+            reactor.run()
+    else:
+        reactor.run()
+
+
[e-mail]
+def async_main(parser, options, argv):
+    """The client entry point that can yield."""
     logger.init()
     if options.debug:
         logger.set_debug('stdout file')
@@ -92,7 +120,9 @@
         die('Files synchronization is disabled.')
 
     # check if there is another instance running
-    if is_already_running():
+    is_running = yield is_already_running()
+
+    if is_running:
         die('Another instance is running')
 
     # check if we are using xdg_data_home and it doesn't exists
@@ -173,16 +203,6 @@
             guppy.heapy.RM.on()
 
     main.start()
-    if options.debug_lsprof_file:
-        try:
-            from bzrlib.lsprof import profile
-            ret, stats = profile(reactor.run)
-            stats.save(options.debug_lsprof_file)
-        except ImportError:
-            logger.root_logger.warning('bzrlib.lsprof not available')
-            reactor.run()
-    else:
-        reactor.run()
 
 
 if __name__ == '__main__':
 
=== modified file 'tests/platform/windows/test_ipc.py'
--- tests/platform/windows/test_ipc.py	2011-07-27 20:38:16 +0000
+++ tests/platform/windows/test_ipc.py	2011-07-28 14:37:29 +0000
@@ -61,7 +61,7 @@
     SharesClient
 )
 
-TEST_HOST_PORT = "127.0.0.1", 40404
+TEST_PORT = 40404
 
 
 class FakeActivationClient(object):
@@ -95,7 +95,7 @@
 
     def setUp(self):
         """Initialize this test instance."""
-        self.patch(ipc, "HOST_PORT", TEST_HOST_PORT)
+        self.patch(ipc, "get_sd_pb_port", lambda: TEST_PORT)
         self.patch(ipc, "ActivationClient", FakeActivationClient)
 
 
@@ -756,7 +756,7 @@
         yield ipc_client_connect(fake_factory)
         self.assertEqual(len(fake_reactor.connections), 1)
         c = fake_reactor.connections[0]
-        self.assertEqual(c.port, TEST_HOST_PORT[1])
+        self.assertEqual(c.port, TEST_PORT)
         self.assertEqual(c.factory, fake_factory)
 
 
@@ -3377,3 +3377,31 @@
         """Test the connect method when autoconnecting fails."""
         d = self.ipc.connect(autoconnecting=True)
         yield self.assertFailure(d, ipc.NoAccessToken)
+
+
+class IPCPortTestCase(TestCase):
+    """Tests for the ipc port setup."""
+
+    def test_get_sd_pb_port(self):
+        """A test for the get_sd_pb_port function."""
+        sso_port = 50001
+        self.patch(ipc, "get_sso_pb_port", lambda: sso_port)
+        result = ipc.get_sd_pb_port()
+        expected = sso_port + ipc.SD_SSO_PORT_OFFSET
+        self.assertEqual(result, expected)
+
+    @defer.inlineCallbacks
+    def test_is_already_running_no(self):
+        """Test the is_already_running function."""
+        self.patch(ipc.ActivationInstance, "get_port",
+                   lambda _: defer.succeed(TEST_PORT))
+        is_running = yield ipc.is_already_running()
+        self.assertFalse(is_running, "Should not be running.")
+
+    @defer.inlineCallbacks
+    def test_is_already_running_yes(self):
+        """Test the is_already_running function."""
+        self.patch(ipc.ActivationInstance, "get_port",
+               lambda _: defer.fail(ipc.AlreadyStartedError()))
+        is_running = yield ipc.is_already_running()
+        self.assertTrue(is_running, "Should be running by now.")
 
=== modified file 'tests/platform/windows/test_tools.py'
--- tests/platform/windows/test_tools.py	2011-07-27 20:38:16 +0000
+++ tests/platform/windows/test_tools.py	2011-07-28 14:37:29 +0000
@@ -43,7 +43,7 @@
     SyncDaemonTool,
 )
 
-TEST_TOOLS_HOST_PORT = "127.0.0.1", 40405
+TEST_TOOLS_PORT = 40405
 
 
 class SaveProtocolServerFactory(PBServerFactory):
@@ -136,9 +136,9 @@
                                         self.folders, self.files)
         self.server_factory = SaveProtocolServerFactory(self.syncdaemon_root)
         # pylint: disable=E1101
-        self.patch(ipc, "HOST_PORT", TEST_TOOLS_HOST_PORT)
+        self.patch(ipc, "get_sd_pb_port", lambda: TEST_TOOLS_PORT)
         self.patch(ipc.ActivationClient, "get_active_port",
-                             lambda _: defer.succeed(TEST_TOOLS_HOST_PORT[1]))
+                             lambda _: defer.succeed(TEST_TOOLS_PORT))
         self.listener = ipc_server_listen(self.server_factory)
         self.sdtool = SyncDaemonTool()
 
 
=== modified file 'ubuntuone/platform/linux/__init__.py'
--- ubuntuone/platform/linux/__init__.py	2011-07-27 20:38:16 +0000
+++ ubuntuone/platform/linux/__init__.py	2011-07-28 14:37:29 +0000
@@ -24,6 +24,7 @@
 
 import dbus
 from dbus.mainloop.glib import DBusGMainLoop
+from twisted.internet import defer
 
 from ubuntuone.platform.linux.os_helper import (
     access,
@@ -101,4 +102,7 @@
     bus = dbus.SessionBus()
     request = bus.request_name(dbus_interface.DBUS_IFACE_NAME,
                                dbus.bus.NAME_FLAG_DO_NOT_QUEUE)
-    return request == dbus.bus.REQUEST_NAME_REPLY_EXISTS
+    if request == dbus.bus.REQUEST_NAME_REPLY_EXISTS:
+        return defer.succeed(True)
+    else:
+        return defer.succeed(False)
 
=== modified file 'ubuntuone/platform/windows/__init__.py'
--- ubuntuone/platform/windows/__init__.py	2011-07-27 20:38:16 +0000
+++ ubuntuone/platform/windows/__init__.py	2011-07-28 14:37:29 +0000
@@ -63,6 +63,12 @@
 from ubuntuone.platform.windows.notification import Notification
 
 
+def is_already_running():
+    """An ugly workaround for circular imports, see bug #817559."""
+    from ubuntuone.platform.windows.ipc import is_already_running
+    return is_already_running()
+
+
 class ExternalInterface(object):
     """An ExternalInterface implemented with a IPC interface."""
 
@@ -92,10 +98,3 @@
 
     def connect(self, *args, **kwargs):
         self.dbus_iface.connect(*args, **kwargs)
-
-
-def is_already_running():
-    """Return if the sd is running by asking the named pipe."""
-    #TODO: Do not start two instances of this process
-    #      https://launchpad.net/bugs/803672
-    return False
 
=== modified file 'ubuntuone/platform/windows/ipc.py'
--- ubuntuone/platform/windows/ipc.py	2011-07-21 14:54:14 +0000
+++ ubuntuone/platform/windows/ipc.py	2011-07-28 14:37:29 +0000
@@ -29,8 +29,13 @@
     Referenceable,
     Root,
 )
-from ubuntu_sso.main.windows import get_activation_cmdline
-from ubuntu_sso.utils.tcpactivation import ActivationClient, ActivationConfig
+from ubuntu_sso.main.windows import get_activation_cmdline, get_sso_pb_port
+from ubuntu_sso.utils.tcpactivation import (
+    ActivationClient,
+    ActivationConfig,
+    ActivationInstance,
+    AlreadyStartedError,
+)
 from ubuntuone.syncdaemon.interfaces import IMarker
 from ubuntuone.platform.windows import CredentialsManagementTool
 from ubuntuone.platform.windows.network_manager import NetworkManager
@@ -51,19 +56,19 @@
 
 logger = logging.getLogger("ubuntuone.SyncDaemon.Pb")
 LOCALHOST = "127.0.0.1"
-HOST_PORT = LOCALHOST, 50002
+SD_SSO_PORT_OFFSET = 1
 SD_SERVICE_NAME = "ubuntuone-syncdaemon"
 CLIENT_NOT_PROCESSED = -1
 
 
-def get_sd_pb_hostport():
+def get_sd_pb_port():
     """Returns the host and port for this user."""
-    return HOST_PORT
+    return get_sso_pb_port() + SD_SSO_PORT_OFFSET
 
 
 def get_activation_config():
     """Get the configuration to activate the sso service."""
-    _, port = get_sd_pb_hostport()
+    port = get_sd_pb_port()
     service_name = SD_SERVICE_NAME
     cmdline = get_activation_cmdline(service_name)
     return ActivationConfig(service_name, cmdline, port)
@@ -71,9 +76,20 @@
 
 def ipc_server_listen(server_factory):
     """Connect the IPC server factory."""
-    host, port = get_sd_pb_hostport()
+    port = get_sd_pb_port()
     # pylint: disable=E1101
-    return reactor.listenTCP(port, server_factory, interface=host)
+    return reactor.listenTCP(port, server_factory, interface=LOCALHOST)
+
+
[e-mail]
+def is_already_running():
+    """Return if the sd is running by trying to get the port."""
+    ai = ActivationInstance(get_activation_config())
+    try:
+        yield ai.get_port()
+        defer.returnValue(False)
+    except AlreadyStartedError:
+        defer.returnValue(True)
 
 
 @defer.inlineCallbacks