Merge lp:~mandel/ubuntuone-client/unify-tools into lp:ubuntuone-client

[Manuel de la Peña]

- Refactored the tools code so that it is shared between windows and darwin (LP: #1002994).

- Refactored the tools code so that it is shared between windows and darwin (LP: #1002994).

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Roberto Alsina (ralsina)]

review: Approve

=== added directory 'tests/platform/tools'
=== added file 'tests/platform/tools/__init__.py'
--- tests/platform/tools/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/platform/tools/__init__.py	2012-05-24 15:14:18 +0000
@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Tests for the tools code."""

=== added file 'tests/platform/tools/test_darwin.py'
--- tests/platform/tools/test_darwin.py	1970-01-01 00:00:00 +0000
+++ tests/platform/tools/test_darwin.py	2012-05-24 15:14:18 +0000
@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Tests for the tools windows code."""
+
+from twisted.internet import defer
+from twisted.trial.unittest import TestCase
+
+from ubuntuone.platform.tools import perspective_broker, darwin
+
+
+class TestStartSyncdaemon(TestCase):
+    """Test the process of launching sd."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        yield super(TestStartSyncdaemon, self).setUp()
+        self.patch(perspective_broker.UbuntuOneClient, "connect",
+                lambda _: defer.Deferred())
+        self.sdtool = perspective_broker.SyncDaemonToolProxy()
+        self.calls = {}
+
+    def test_start_missing_exe(self):
+       """Test starting the service when the exe is missing."""
+       # file is missing
+       self.patch(darwin.os.path, 'exists', lambda f: False)
+       self.assertFailure(self.sdtool.start(), Exception)

=== renamed file 'tests/platform/windows/test_tools.py' => 'tests/platform/tools/test_tools.py'
--- tests/platform/windows/test_tools.py	2012-04-16 12:21:35 +0000
+++ tests/platform/tools/test_tools.py	2012-05-24 15:14:18 +0000
@@ -34,7 +34,7 @@
 from twisted.internet import defer
 from twisted.trial.unittest import TestCase
 
-from ubuntuone.platform.tools import windows
+from ubuntuone.platform.tools import perspective_broker
 
 
 # ugly trick to stop pylint for complaining about
@@ -49,8 +49,9 @@
     @defer.inlineCallbacks
     def setUp(self):
         yield super(TestSyncDaemonTool, self).setUp()
-        self.patch(windows.UbuntuOneClient, "connect", lambda _: defer.Deferred())
-        self.sdtool = windows.SyncDaemonToolProxy()
+        self.patch(perspective_broker.UbuntuOneClient, "connect",
+                lambda _: defer.Deferred())
+        self.sdtool = perspective_broker.SyncDaemonToolProxy()
         self.calls = {}
 
     def test_call_after_connection(self):
@@ -124,14 +125,3 @@
                 attr = getattr(self.sdtool, attr_name)
                 func_name = getattr(attr, "__name__", None)
                 self.assertNotEqual(func_name, "call_after_connection_inner")
-
-    def test_start_missing_exe(self):
-        """Test starting the service when the exe is missing."""
-        # file is missing
-        self.patch(windows.os.path, 'exists', lambda f: False)
-        key = 'key'
-        path = 'path/to/exe'
-        self.patch(windows, 'OpenKey', lambda k,p: key)
-        self.patch(windows, 'QueryValueEx', lambda k,p: path)
-
-        self.assertFailure(self.sdtool.start(), WindowsError)

=== added file 'tests/platform/tools/test_windows.py'
--- tests/platform/tools/test_windows.py	1970-01-01 00:00:00 +0000
+++ tests/platform/tools/test_windows.py	2012-05-24 15:14:18 +0000
@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Tests for the tools windows code."""
+
+import sys
+
+from twisted.internet import defer
+from twisted.trial.unittest import TestCase
+
+from ubuntuone.platform.tools import perspective_broker, windows
+
+# ugly trick to stop pylint for complaining about
+# WindowsError on Linux
+if sys.platform != 'win32':
+    WindowsError = None
+
+
+class TestStartSyncdaemon(TestCase):
+    """Test the process of launching sd."""
+
+    @defer.inlineCallbacks
+    def setUp(self):
+        yield super(TestStartSyncdaemon, self).setUp()
+        self.patch(perspective_broker.UbuntuOneClient, "connect",
+                lambda _: defer.Deferred())
+        self.sdtool = perspective_broker.SyncDaemonToolProxy()
+        self.calls = {}
+
+    def test_start_missing_exe(self):
+       """Test starting the service when the exe is missing."""
+       # file is missing
+       self.patch(windows.os.path, 'exists', lambda f: False)
+       key = 'key'
+       path = 'path/to/exe'
+       self.patch(windows, 'OpenKey', lambda k,p: key)
+       self.patch(windows, 'QueryValueEx', lambda k,p: path)
+
+       self.assertFailure(self.sdtool.start(), WindowsError)

=== modified file 'ubuntuone/platform/tools/__init__.py'
--- ubuntuone/platform/tools/__init__.py	2012-05-16 16:24:23 +0000
+++ ubuntuone/platform/tools/__init__.py	2012-05-24 15:14:18 +0000
@@ -36,12 +36,9 @@
 from twisted.internet import defer
 from ubuntuone.logger import log_call
 
-if sys.platform == 'win32':
-    from ubuntuone.platform.tools import windows
-    source = windows
-elif sys.platform == 'darwin':
-    from ubuntuone.platform.tools import darwin
-    source = darwin
+if sys.platform in ('win32', 'darwin'):
+    from ubuntuone.platform.tools import perspective_broker
+    source = perspective_broker
 else:
     from ubuntuone.platform.tools import linux
     source = linux

=== added file 'ubuntuone/platform/tools/darwin.py'
--- ubuntuone/platform/tools/darwin.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/tools/darwin.py	2012-05-24 15:14:18 +0000
@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""SyncDaemon Tools darwin implementation."""
+
+import errno
+import os
+
+import ubuntuone
+
+
+def get_sd_install_path():
+    """Return the path where the sd script was installed."""
+    # TODO: We need to find a nicer way to find paths on darwin when since this
+    # method will probably not work once the application has been packaged.
+    ubuntuone_pkg_dir = os.path.dirname(os.path.dirname(ubuntuone.__file__))
+    ubuntuone_bin_dir = os.path.join(ubuntuone_pkg_dir, 'bin')
+    ubuntuone_bin = os.path.join(ubuntuone_bin_dir,
+                    'ubuntuone-syncdaemon')
+    if not os.path.exists(ubuntuone_bin):
+        raise Exception(errno.ENOENT,
+            'Could not start syncdaemon: File not found %s' % ubuntuone_bin)
+    return ubuntuone_bin
+

=== removed file 'ubuntuone/platform/tools/darwin.py'
--- ubuntuone/platform/tools/darwin.py	2012-05-17 11:59:26 +0000
+++ ubuntuone/platform/tools/darwin.py	1970-01-01 00:00:00 +0000
@@ -1,47 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright 2012 Canonical Ltd.
-#
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU General Public License version 3, as published
-# by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranties of
-# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
-# PURPOSE.  See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-# In addition, as a special exception, the copyright holders give
-# permission to link the code of portions of this program with the
-# OpenSSL library under certain conditions as described in each
-# individual source file, and distribute linked combinations
-# including the two.
-# You must obey the GNU General Public License in all respects
-# for all of the code used other than OpenSSL.  If you modify
-# file(s) with this exception, you may extend this exception to your
-# version of the file(s), but you are not obligated to do so.  If you
-# do not wish to do so, delete this exception statement from your
-# version.  If you delete this exception statement from all source
-# files in the program, then also delete it here.
-"""SyncDaemon Tools."""
-
-
-def is_already_running(*arg):
-    """Empty implementation for MAC OS"""
-
-
-class IPCError(object):
-    """Empty implementation for MAC OS"""
-
-    def __init__(self, *args):
-        """Empty implementation for MAC OS"""
-
-
-class SyncDaemonToolProxy(object):
-    """Empty implementation for MAC OS"""
-
-    def __init__(self, *args):
-        """Empty implementation for MAC OS"""

=== renamed file 'ubuntuone/platform/tools/windows.py' => 'ubuntuone/platform/tools/perspective_broker.py'
--- ubuntuone/platform/tools/windows.py	2012-05-22 14:13:48 +0000
+++ ubuntuone/platform/tools/perspective_broker.py	2012-05-24 15:14:18 +0000
@@ -28,13 +28,10 @@
 # files in the program, then also delete it here.
 """SyncDaemon Tools."""
 
-import errno
 import subprocess
 import sys
-import os
 
 from twisted.internet import defer
-from _winreg import OpenKey, HKEY_LOCAL_MACHINE, QueryValueEx
 
 from ubuntuone.platform.ipc.perspective_broker import is_already_running
 from ubuntuone.platform.ipc.ipc_client import UbuntuOneClient
@@ -42,13 +39,17 @@
 
 # make pyflakes happy since we can't disable the warning
 is_already_running = is_already_running
-U1_REG_PATH = r'Software\\Ubuntu One'
-SD_INSTALL_PATH = 'SyncDaemonInstallPath'
 
-# ugly trick to stop pylint for complaining about
-# WindowsError on Linux
-if sys.platform != 'win32':
-    WindowsError = None
+if sys.platform == 'win32':
+    from ubuntuone.platform.tools import windows
+    get_sd_install_path = windows.get_sd_install_path
+elif sys.platform == 'darwin':
+    from ubuntuone.platform.tools import darwin
+    get_sd_install_path = darwin.get_sd_install_path
+else:
+    # add an implementation that will result in os.path.exists always to be
+    # false
+    get_sd_install_path = lambda: None
 
 
 class IPCError(Exception):
@@ -173,13 +174,9 @@
 
     def start(self):
         """Start syncdaemon, should *not* be running."""
-        # look in the reg to find the path of the .exe to be executed
-        # to launch the sd on windows
-        key = OpenKey(HKEY_LOCAL_MACHINE, U1_REG_PATH)
-        path = QueryValueEx(key, SD_INSTALL_PATH)[0]
-        if not os.path.exists(path):
-            # either the .exe was moved of the value is wrong
-            return defer.fail(WindowsError(errno.ENOENT,
-                'Could not start syncdaemon: File not found %s' % path))
+        try:
+            path = get_sd_install_path()
+        except Exception, e:
+            defer.fail(e)
         p = subprocess.Popen([path])
         return defer.succeed(p)

=== added file 'ubuntuone/platform/tools/windows.py'
--- ubuntuone/platform/tools/windows.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/tools/windows.py	2012-05-24 15:14:18 +0000
@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""SyncDaemon Tools windows implementation."""
+
+import errno
+import os
+import sys
+
+from _winreg import OpenKey, HKEY_LOCAL_MACHINE, QueryValueEx
+
+
+U1_REG_PATH = r'Software\\Ubuntu One'
+SD_INSTALL_PATH = 'SyncDaemonInstallPath'
+
+# ugly trick to stop pylint for complaining about
+# WindowsError on Linux
+if sys.platform != 'win32':
+    WindowsError = None
+
+
+def get_sd_install_path():
+    """Return the path where the sd script was installed."""
+    # look in the reg to find the path of the .exe to be executed
+    # to launch the sd on windows
+    key = OpenKey(HKEY_LOCAL_MACHINE, U1_REG_PATH)
+    path = QueryValueEx(key, SD_INSTALL_PATH)[0]
+    if not os.path.exists(path):
+        raise WindowsError(errno.ENOENT,
+            'Could not start syncdaemon: File not found %s' % path)
+    return path