Merge lp:~diegosarmentero/ubuntuone-client/refactor-ipc into lp:ubuntuone-client

[Diego Sarmentero]

- Refactor platform/ipc (LP: #989127).

[dobey (dobey)]

review: Approve

[Manuel de la Peña (mandel)]

Same as https://code.launchpad.net/~diegosarmentero/ubuntuone-client/refactor-notification/+merge/104164/comments/224328

review: Needs Fixing

[lp:~diegosarmentero/ubuntuone-client/refactor-ipc]

1231. By Diego Sarmentero on 2012-05-01

improve __init__ imports

[Manuel de la Peña (mandel)]

review: Approve

[lp:~diegosarmentero/ubuntuone-client/refactor-ipc]

1232. By Diego Sarmentero on 2012-05-01

improve tests imports

[Mike McCracken (mikemc)]

FYI, the last commit in this branch introduced a syntax error (see line 11 of the unified diff below) that I am fixing over in https://code.launchpad.net/~mikemc/ubuntuone-client/test-platform-init-typo-bugfix/+merge/104297

This was discussed on IRC between dobey and I but I'm noting it here for the benefit of the others.

=== modified file 'tests/platform/__init__.py'
--- tests/platform/__init__.py	2012-04-09 20:07:05 +0000
+++ tests/platform/__init__.py	2012-05-01 14:37:18 +0000
@@ -28,11 +28,10 @@
 import sys
 
 if sys.platform.startswith('linux'):
-    from tests.platform.linux import test_dbus
-    ipc_source = test_dbus
+    from tests.platform.ipc import test_linux as ipc_source
+     = test_linux
 else:
-    from tests.platform.windows import test_ipc
-    ipc_source = test_ipc
+    from tests.platform.ipc import test_windows as ipc_source
 
 IPCTestCase = ipc_source.IPCTestCase
 StatusTestCase = ipc_source.StatusTestCase

=== added directory 'tests/platform/ipc'
=== added file 'tests/platform/ipc/__init__.py'
--- tests/platform/ipc/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/platform/ipc/__init__.py	2012-05-01 14:37:18 +0000
@@ -0,0 +1,27 @@
+# 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.
+"""Platform/IPC test code."""

=== renamed file 'tests/platform/test_external_interface.py' => 'tests/platform/ipc/test_external_interface.py'
=== renamed file 'tests/platform/linux/test_dbus.py' => 'tests/platform/ipc/test_linux.py'
--- tests/platform/linux/test_dbus.py	2012-04-09 20:07:05 +0000
+++ tests/platform/ipc/test_linux.py	2012-05-01 14:37:18 +0000
@@ -40,8 +40,8 @@
     FakedService,
     FakedObject,
 )
-from ubuntuone.platform.linux import dbus_interface
-from ubuntuone.platform.linux.dbus_interface import (
+from ubuntuone.platform.ipc import linux as dbus_interface
+from ubuntuone.platform.ipc.linux import (
     DBusExposedObject,
     DBUS_IFACE_STATUS_NAME,
     DBUS_IFACE_EVENTS_NAME,
@@ -307,6 +307,7 @@
     def test_restart(self):
         """Start things up, then fire a restart, check it tries to restart."""
         d = defer.Deferred()
+
         def _handler(*a):
             """Async helper."""
             d.callback(True)

=== renamed file 'tests/platform/windows/test_ipc.py' => 'tests/platform/ipc/test_windows.py'
--- tests/platform/windows/test_ipc.py	2012-04-09 20:07:05 +0000
+++ tests/platform/ipc/test_windows.py	2012-05-01 14:37:18 +0000
@@ -45,8 +45,8 @@
     FakedService,
     FakeMainTestCase,
 )
-from ubuntuone.platform.windows import ipc
-from ubuntuone.platform.windows.ipc import (
+from ubuntuone.platform.ipc import windows as ipc
+from ubuntuone.platform.ipc.windows import (
     Config,
     Events,
     Folders,
@@ -59,7 +59,7 @@
     SyncDaemon,
     ipc_client_connect,
 )
-from ubuntuone.platform.windows.ipc_client import (
+from ubuntuone.platform.ipc.ipc_client import (
     signal,
     ConfigClient,
     EventsClient,

=== modified file 'tests/platform/linux/eventlog/test_zglog.py'
--- tests/platform/linux/eventlog/test_zglog.py	2012-04-09 20:07:05 +0000
+++ tests/platform/linux/eventlog/test_zglog.py	2012-05-01 14:37:18 +0000
@@ -42,7 +42,7 @@
 from zeitgeist.client import ZeitgeistClient
 from zeitgeist.datamodel import Event, Subject, Interpretation, Manifestation
 
-from tests.platform.linux.test_dbus import DBusTwistedTestCase
+from tests.platform.ipc.test_linux import DBusTwistedTestCase
 from ubuntuone.eventlog.zglog import ZeitgeistLogger
 
 SRCDIR = os.environ.get('SRCDIR', os.getcwd())
@@ -97,7 +97,7 @@
             client = ZeitgeistClient()
             break
         except RuntimeError:
-            if count > seconds*10:
+            if count > seconds * 10:
                 raise
             time.sleep(0.1)
 
@@ -118,6 +118,7 @@
         os.environ["ZEITGEIST_DATA_PATH"] = tempfolder
         p = subprocess.Popen([zgdaemon], bufsize=4096, stdout=tempstdout,
                              stderr=tempstderr)
+
         def cleanup():
             """Wait for the process to finish."""
             p.terminate()

=== modified file 'tests/platform/linux/test_credentials.py'
--- tests/platform/linux/test_credentials.py	2012-04-09 20:07:05 +0000
+++ tests/platform/linux/test_credentials.py	2012-05-01 14:37:18 +0000
@@ -796,6 +796,7 @@
         d = Deferred()
 
         self.ref_count = 0
+
         def parallel_counter(*args):
             """Make the check."""
             self.ref_count += 1

=== modified file 'ubuntuone/platform/__init__.py'
--- ubuntuone/platform/__init__.py	2012-04-27 20:38:13 +0000
+++ ubuntuone/platform/__init__.py	2012-05-01 14:37:18 +0000
@@ -43,6 +43,8 @@
     from ubuntuone.platform import linux
     source = linux
 
+from ubuntuone.platform import ipc
+
 # This imports needs to be here in order to be included in this namespace
 from ubuntuone.platform import credentials
 from ubuntuone.platform import tools
@@ -109,5 +111,5 @@
 _GeneralINotifyProcessor = source._GeneralINotifyProcessor
 
 # IPC
-ExternalInterface = source.ExternalInterface
-is_already_running = source.is_already_running
+ExternalInterface = ipc.ExternalInterface
+is_already_running = ipc.is_already_running

=== added directory 'ubuntuone/platform/ipc'
=== added file 'ubuntuone/platform/ipc/__init__.py'
--- ubuntuone/platform/ipc/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/ipc/__init__.py	2012-05-01 14:37:18 +0000
@@ -0,0 +1,42 @@
+# -*- 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.
+"""IPC module."""
+
+import sys
+
+
+if sys.platform == "win32":
+    from ubuntuone.platform.ipc import windows as source
+    ExternalInterface = source.IPCInterface
+else:
+    from ubuntuone.platform.ipc import linux as source
+    ExternalInterface = source.DBusInterface
+
+
+is_already_running = source.is_already_running

=== renamed file 'ubuntuone/platform/windows/ipc_client.py' => 'ubuntuone/platform/ipc/ipc_client.py'
--- ubuntuone/platform/windows/ipc_client.py	2012-04-10 18:11:54 +0000
+++ ubuntuone/platform/ipc/ipc_client.py	2012-05-01 14:37:18 +0000
@@ -34,7 +34,7 @@
 from twisted.internet import defer
 from twisted.spread.pb import Referenceable, PBClientFactory
 
-from ubuntuone.platform.windows.ipc import RemoteMeta, ipc_client_connect
+from ubuntuone.platform.ipc.windows import RemoteMeta, ipc_client_connect
 
 logger = logging.getLogger("ubuntuone.SyncDaemon.Client")
 

=== renamed file 'ubuntuone/platform/linux/dbus_interface.py' => 'ubuntuone/platform/ipc/linux.py'
=== renamed file 'ubuntuone/platform/windows/ipc.py' => 'ubuntuone/platform/ipc/windows.py'
=== modified file 'ubuntuone/platform/linux/__init__.py'
--- ubuntuone/platform/linux/__init__.py	2012-04-27 20:38:13 +0000
+++ ubuntuone/platform/linux/__init__.py	2012-05-01 14:37:18 +0000
@@ -75,7 +75,3 @@
     _GeneralINotifyProcessor,
 )
 from ubuntuone.platform.linux import notification
-from ubuntuone.platform.linux.dbus_interface import (
-    DBusInterface as ExternalInterface,
-    is_already_running,
-)

=== modified file 'ubuntuone/platform/tools/linux.py'
--- ubuntuone/platform/tools/linux.py	2012-04-09 20:07:05 +0000
+++ ubuntuone/platform/tools/linux.py	2012-05-01 14:37:18 +0000
@@ -34,7 +34,7 @@
 from dbus.exceptions import DBusException
 from twisted.internet import defer
 
-from ubuntuone.platform.linux.dbus_interface import (
+from ubuntuone.platform.ipc.linux import (
     is_already_running,
     DBUS_IFACE_NAME,
     DBUS_IFACE_STATUS_NAME,

=== modified file 'ubuntuone/platform/tools/windows.py'
--- ubuntuone/platform/tools/windows.py	2012-04-11 13:12:26 +0000
+++ ubuntuone/platform/tools/windows.py	2012-05-01 14:37:18 +0000
@@ -36,8 +36,8 @@
 from twisted.internet import defer
 from _winreg import OpenKey, HKEY_LOCAL_MACHINE, QueryValueEx
 
-from ubuntuone.platform.windows.ipc import is_already_running
-from ubuntuone.platform.windows.ipc_client import UbuntuOneClient
+from ubuntuone.platform.ipc.windows import is_already_running
+from ubuntuone.platform.ipc.ipc_client import UbuntuOneClient
 
 
 # make pyflakes happy since we can't disable the warning

=== modified file 'ubuntuone/platform/windows/__init__.py'
--- ubuntuone/platform/windows/__init__.py	2012-04-27 20:39:54 +0000
+++ ubuntuone/platform/windows/__init__.py	2012-05-01 14:37:18 +0000
@@ -85,7 +85,3 @@
     NotifyProcessor as _GeneralINotifyProcessor,
 )
 from ubuntuone.platform.windows import notification
-from ubuntuone.platform.windows.ipc import (
-    IPCInterface as ExternalInterface,
-    is_already_running,
-)