Merge lp:~mikemc/ubuntuone-client/refactor-platform-event-logging into lp:ubuntuone-client

[Mike McCracken]

- Refactor ubuntuone platform/event_logging into submodule ( LP: 989120 )

- Refactor ubuntuone platform/event_logging into submodule ( LP: 989120 )

* creates event_logging package in platform/

- Note: it's small to be a package, but this avoids importing 'is_zeitgeist_installed' on win/darwin

* moves platform/event_logging.py to be the __init__ of that package
* moves code in platform/linux/event_logging to new package

* removes platform/windows/event_logging, replaced with one line in new package __init__

Tested on linux.

[lp:~mikemc/ubuntuone-client/refactor-platform-event-logging]

1236. By Mike McCracken on 2012-05-02

merge with trunk

1237. By Mike McCracken on 2012-05-02

refactor the test suite into event_logging/test_<theplatform>.py

[dobey (dobey)]

review: Approve

[Brian Curtin (brian.curtin)]

Tests aren't passing on Windows:

Traceback (most recent call last):
  File "C:\u1\bin\python-script.py", line 62, in <module>
    execfile(__file__)
  File "C:\u1\bin\u1trial", line 331, in <module>
    main()
  File "C:\u1\bin\u1trial", line 311, in main
    suite = trial_runner.get_suite(config)
  File "C:\u1\bin\u1trial", line 184, in get_suite
    config['ignore-paths']))
  File "C:\u1\bin\u1trial", line 168, in _collect_tests
    module_suite = self._load_unittest(filepath)
  File "C:\u1\bin\u1trial", line 108, in _load_unittest
    module = __import__(modpath, None, None, [""])
  File "C:\u1\working\mmcc\tests\platform\__init__.py", line 34, in <module>
    from tests.platform.ipc import test_windows
  File "C:\u1\working\mmcc\tests\platform\ipc\test_windows.py", line 44, in <module>
    from contrib.testing.testcase import (
  File "C:\u1\working\mmcc\contrib\testing\testcase.py", line 49, in <module>
    from ubuntuone.syncdaemon import (
  File "C:\u1\working\mmcc\ubuntuone\syncdaemon\config.py", line 47, in <module>
    from ubuntuone.platform import expand_user
  File "C:\u1\working\mmcc\ubuntuone\platform\__init__.py", line 40, in <module>
    from ubuntuone.platform import windows
  File "C:\u1\working\mmcc\ubuntuone\platform\windows\__init__.py", line 74, in <m
odule>
    from ubuntuone.platform.windows import event_logging
ImportError: cannot import name event_logging

[Brian Curtin (brian.curtin)]

review: Needs Fixing

[lp:~mikemc/ubuntuone-client/refactor-platform-event-logging]

1238. By Mike McCracken on 2012-05-03

remove obsolete import in platform/windows/__init__.py

[Mike McCracken (mikemc)]

The last push fixes the error and passes the tests on linux and windows

review: Needs Resubmitting

[Brian Curtin (brian.curtin)]

Looks good and works on Windows.

review: Approve

[Mike McCracken (mikemc)]

review: Abstain

[Manuel de la Peña (mandel)]

There seems to be conflicts with trunk.

review: Needs Fixing

[lp:~mikemc/ubuntuone-client/refactor-platform-event-logging]

1239. By Mike McCracken on 2012-05-04

merge with trunk

[Mike McCracken (mikemc)]

After latest merge fixed conflicts, tests pass in Linux and Windows

[Manuel de la Peña (mandel)]

Looks good.

review: Approve

=== added directory 'tests/platform/event_logging'
=== added file 'tests/platform/event_logging/__init__.py'
--- tests/platform/event_logging/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/platform/event_logging/__init__.py	2012-05-04 16:22: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/event_logging test code."""

=== renamed file 'tests/platform/linux/test_event_logging.py' => 'tests/platform/event_logging/test_linux.py'
--- tests/platform/linux/test_event_logging.py	2012-04-09 20:07:05 +0000
+++ tests/platform/event_logging/test_linux.py	2012-05-04 16:22:18 +0000
@@ -1,4 +1,4 @@
-# tests.platform.linux.test_event_logging
+# tests.platform.event_logging.test_linux
 #
 # Author: Alejandro J. Cura <[e-mail]>
 #
@@ -34,7 +34,7 @@
 
 from twisted.trial.unittest import TestCase
 
-from ubuntuone.platform.linux import event_logging
+import ubuntuone.platform.event_logging.linux as event_logging
 
 
 class ZeitgeistDetectionTestCase(TestCase):

=== renamed file 'tests/platform/windows/test_event_logging.py' => 'tests/platform/event_logging/test_windows.py'
--- tests/platform/windows/test_event_logging.py	2012-04-09 20:07:05 +0000
+++ tests/platform/event_logging/test_windows.py	2012-05-04 16:22:18 +0000
@@ -37,7 +37,7 @@
 
     def test_never_creates_a_listener(self):
         """The listener is never created on windows."""
-        from ubuntuone.platform.windows import event_logging
+        from ubuntuone.platform import event_logging
         listener = event_logging.get_listener(None, None)
         self.assertEqual(listener, None)
 

=== added directory 'ubuntuone/platform/event_logging'
=== renamed file 'ubuntuone/platform/event_logging.py' => 'ubuntuone/platform/event_logging/__init__.py'
--- ubuntuone/platform/event_logging.py	2012-04-09 20:07:05 +0000
+++ ubuntuone/platform/event_logging/__init__.py	2012-05-04 16:22:18 +0000
@@ -30,13 +30,10 @@
 
 import sys
 
-
-if sys.platform == "win32":
-    from ubuntuone.platform.windows import event_logging
-    source = event_logging
+if sys.platform in ["win32", "darwin"]:
+    # Zeitgeist is not installed on these platforms
+    get_listener = lambda x, y: None
 else:
-    from ubuntuone.platform.linux import event_logging
-    source = event_logging
-    is_zeitgeist_installed = source.is_zeitgeist_installed
+    from ubuntuone.platform.event_logging import linux as source
+    get_listener = source.get_listener
 
-get_listener = source.get_listener

=== renamed file 'ubuntuone/platform/linux/event_logging.py' => 'ubuntuone/platform/event_logging/linux.py'
--- ubuntuone/platform/linux/event_logging.py	2012-04-09 20:07:05 +0000
+++ ubuntuone/platform/event_logging/linux.py	2012-05-04 16:22:18 +0000
@@ -1,4 +1,3 @@
-# ubuntuone.platform.linux.event_logging
 #
 # Author: Alejandro J. Cura <[e-mail]>
 #

=== modified file 'ubuntuone/platform/windows/__init__.py'
--- ubuntuone/platform/windows/__init__.py	2012-05-03 20:14:42 +0000
+++ ubuntuone/platform/windows/__init__.py	2012-05-04 16:22:18 +0000
@@ -36,7 +36,6 @@
 platform = "win32"
 
 
-import event_logging
 import logger
 
 from ubuntuone.platform.os_helper import (
@@ -70,7 +69,7 @@
     stat_path,
     walk,
 )
-from ubuntuone.platform.windows import event_logging
+
 from ubuntuone.platform.windows.logger import (
     setup_filesystem_logging,
     get_filesystem_logger,

=== removed file 'ubuntuone/platform/windows/event_logging.py'
--- ubuntuone/platform/windows/event_logging.py	2012-04-09 20:07:05 +0000
+++ ubuntuone/platform/windows/event_logging.py	1970-01-01 00:00:00 +0000
@@ -1,36 +0,0 @@
-# ubuntuone.platform.windows.event_logging
-#
-# Author: Alejandro J. Cura <[e-mail]>
-#
-# Copyright 2010-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.
-"""Event logging module for windows, that does nothing."""
-
-
-def get_listener(fsm, vm):
-    """Zeitgeist is not available on windows yet."""
-    return None