Merge lp:~alecu/ubuntuone-client/make-ziggy-optional into lp:ubuntuone-client

[Alejandro J. Cura]

Zeitgeist is now not required to run syncdaemon.

Move the zeitgeist logging code into the platform/linux module.
Zeitgeist is now not required to run syncdaemon.

[lp:~alecu/ubuntuone-client/make-ziggy-optional]

778. By Alejandro J. Cura on 2010-12-15

moved and fixed a testing module that was misplaced

[Facundo Batista (facundo)]

Great, thanks!

review: Approve

[Natalia Bidart (nataliabidart)]

review: Approve

=== renamed file 'tests/syncdaemon/test_event_logging.py' => 'tests/eventlog/test_zg_listener.py'
--- tests/syncdaemon/test_event_logging.py	2010-12-13 23:40:14 +0000
+++ tests/eventlog/test_zg_listener.py	2010-12-15 21:21:19 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# tests.syncdaemon.test_event_logging - test logging ZG events
+# tests.eventlog.test_zg_listener - test logging ZG events
 #
 # Author: Alejandro J. Cura <[e-mail]>
 #
@@ -22,6 +22,7 @@
 import logging
 import os
 import shutil
+import unittest
 import uuid
 
 from twisted.internet import defer
@@ -35,7 +36,7 @@
 from ubuntuone.storageprotocol.sharersp import NotifyShareHolder
 from ubuntuone.syncdaemon.action_queue import (
         RequestQueue, Upload, MakeFile, MakeDir)
-from ubuntuone.syncdaemon.event_logging import (
+from ubuntuone.eventlog.zg_listener import (
         zglog, ZeitgeistListener, ACTOR_UBUNTUONE,
         EVENT_INTERPRETATION_U1_FOLDER_SHARED,
         EVENT_INTERPRETATION_U1_FOLDER_UNSHARED,
@@ -51,7 +52,7 @@
         STORAGE_DELETED, STORAGE_NETWORK, STORAGE_LOCAL)
 from ubuntuone.syncdaemon.sync import Sync
 from ubuntuone.syncdaemon.volume_manager import Share, Shared, UDF
-from test_action_queue import ConnectedBaseTestCase
+from tests.syncdaemon.test_action_queue import ConnectedBaseTestCase
 
 VOLUME = uuid.UUID('12345678-1234-1234-1234-123456789abc')
 
@@ -1136,3 +1137,13 @@
         self.assertTrue(public_file.origin.endswith(node_id))
         self.assertEqual(public_file.mimetype, "audio/mpeg")
         self.assertEqual(public_file.storage, STORAGE_DELETED)
+
+
+def test_suite():
+    """Collect these tests only on linux."""
+    import sys
+    if sys.platform == 'linux2':
+        tests = unittest.TestLoader().loadTestsFromName(__name__)
+    else:
+        tests = []
+    return tests

=== added file 'tests/platform/linux/test_event_logging.py'
--- tests/platform/linux/test_event_logging.py	1970-01-01 00:00:00 +0000
+++ tests/platform/linux/test_event_logging.py	2010-12-15 21:21:19 +0000
@@ -0,0 +1,38 @@
+# tests.platform.linux.test_event_logging
+#
+# Author: Alejandro J. Cura <[e-mail]>
+#
+# Copyright 2010 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/>.
+"""Test the event logging on linux."""
+
+from twisted.trial.unittest import TestCase
+
+from ubuntuone.platform.linux import event_logging
+
+
+class GetListenerTestCase(TestCase):
+    """The zg listener is created."""
+
+    def test_zeitgeist_installed_returns_listener(self):
+        """get_listener returns a listener if ZG installed."""
+        self.patch(event_logging, "is_zeitgeist_installed", lambda: True)
+        listener = event_logging.get_listener(None, None)
+        self.assertNotEqual(listener, None)
+
+    def test_zeitgeist_not_installed_returns_none(self):
+        """get_listener returns None if ZG not installed."""
+        self.patch(event_logging, "is_zeitgeist_installed", lambda: False)
+        listener = event_logging.get_listener(None, None)
+        self.assertEqual(listener, None)

=== added file 'tests/platform/windows/test_event_logging.py'
--- tests/platform/windows/test_event_logging.py	1970-01-01 00:00:00 +0000
+++ tests/platform/windows/test_event_logging.py	2010-12-15 21:21:19 +0000
@@ -0,0 +1,36 @@
+# tests.platform.windows.test_event_logging
+#
+# Author: Alejandro J. Cura <[e-mail]>
+#
+# Copyright 2010 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/>.
+"""Test the event logging on windows."""
+
+import sys
+
+from twisted.trial import unittest
+
+class GetListenerTestCase(unittest.TestCase):
+    """Listener creation tests."""
+
+    def test_never_creates_a_listener(self):
+        """The listener is never created on windows."""
+        from ubuntuone.platform.windows import event_logging
+        listener = event_logging.get_listener(None, None)
+        self.assertEqual(listener, None)
+
+def test_suite():
+    if sys.platform == 'win32':
+        return unittest.TestLoader().loadTestsFromName(__name__)
+    return unittest.TestSuite()

=== modified file 'tests/syncdaemon/test_main.py'
--- tests/syncdaemon/test_main.py	2010-12-10 19:44:18 +0000
+++ tests/syncdaemon/test_main.py	2010-12-15 21:21:19 +0000
@@ -205,3 +205,17 @@
         self.addCleanup(lambda: main.shutdown())
 
         self.assertFalse(self.connect_called)
+
+    def test_event_logger_starts_if_available(self):
+        """The event logger is started if available."""
+        self.patch(main_mod.event_logging, "get_listener", lambda *a: object())
+        main = self.build_main()
+        self.addCleanup(lambda: main.shutdown())
+        self.assertIn(main.eventlog_listener, main.event_q._listeners)
+
+    def test_event_logger_not_started_if_not_available(self):
+        """The event logger is not started if it's not available."""
+        self.patch(main_mod.event_logging, "get_listener", lambda *a: None)
+        main = self.build_main()
+        self.addCleanup(lambda: main.shutdown())
+        self.assertNotIn(main.eventlog_listener, main.event_q._listeners)

=== renamed file 'ubuntuone/syncdaemon/event_logging.py' => 'ubuntuone/eventlog/zg_listener.py'
--- ubuntuone/syncdaemon/event_logging.py	2010-12-13 06:10:47 +0000
+++ ubuntuone/eventlog/zg_listener.py	2010-12-15 21:21:19 +0000
@@ -1,4 +1,4 @@
-# ubuntuone.syncdaemon.event_logging - listen for SD events, log into ZG
+# ubuntuone.eventlog.zg_listener - listen for SD events, log into ZG
 #
 # Author: Alejandro J. Cura <[e-mail]>
 #

=== modified file 'ubuntuone/platform/linux/__init__.py'
--- ubuntuone/platform/linux/__init__.py	2010-12-10 19:44:18 +0000
+++ ubuntuone/platform/linux/__init__.py	2010-12-15 21:21:19 +0000
@@ -40,7 +40,7 @@
 )
 from ubuntuone.platform.linux.vm_helper import (create_shares_link,
     get_udf_path_name, get_udf_path, get_share_path, VMMetadataUpgraderMixIn)
-from ubuntuone.platform.linux import tools
+from ubuntuone.platform.linux import tools, event_logging
 from filesystem_notifications import FilesystemMonitor
 
 

=== added file 'ubuntuone/platform/linux/event_logging.py'
--- ubuntuone/platform/linux/event_logging.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/linux/event_logging.py	2010-12-15 21:21:19 +0000
@@ -0,0 +1,36 @@
+# ubuntuone.platform.linux.event_logging
+#
+# Author: Alejandro J. Cura <[e-mail]>
+#
+# Copyright 2010 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/>.
+"""Builds a syncdaemon listener that logs events if ZG is installed."""
+
+def is_zeitgeist_installed():
+    """Return true if zeitgeist is installed."""
+    try:
+        import zeitgeist
+        # use the above module in some way so pylint does not complain
+        assert(zeitgeist is not None)
+        return True
+    except ImportError:
+        return False
+
+def get_listener(fsm, vm):
+    """Build a listener if zg is installed."""
+    if is_zeitgeist_installed():
+        from ubuntuone.eventlog import zg_listener
+        return zg_listener.ZeitgeistListener(fsm, vm)
+    else:
+        return None

=== modified file 'ubuntuone/platform/windows/__init__.py'
--- ubuntuone/platform/windows/__init__.py	2010-12-03 19:56:31 +0000
+++ ubuntuone/platform/windows/__init__.py	2010-12-15 21:21:19 +0000
@@ -17,8 +17,9 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Windows import for ubuntuone-client
 
-This module has to have all windows specific modules and provide the api required
-to support the windows platform."""
+This module has to have all windows specific modules and provide the api
+required to support the windows platform.
+"""
 
 platform = "win32"
 
@@ -28,3 +29,5 @@
     get_share_path,
     VMMetadataUpgraderMixIn,
 )
+from ubuntuone.platform.windows import event_logging
+

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

=== modified file 'ubuntuone/syncdaemon/main.py'
--- ubuntuone/syncdaemon/main.py	2010-12-10 19:44:18 +0000
+++ ubuntuone/syncdaemon/main.py	2010-12-15 21:21:19 +0000
@@ -30,7 +30,6 @@
     event_queue,
     filesystem_manager,
     hash_queue,
-    event_logging,
     events_nanny,
     local_rescan,
     sync,
@@ -39,6 +38,7 @@
 from ubuntuone import syncdaemon
 import ubuntuone.platform
 
+from ubuntuone.platform import event_logging
 from ubuntuone.syncdaemon.states import StateManager, QueueManager
 
 
@@ -128,14 +128,21 @@
 
         self.action_q.content_queue.set_change_notification_cb(
             self.external.change_notification)
-        self.zg_listener = event_logging.ZeitgeistListener(self.fs, self.vm)
-        self.event_q.subscribe(self.zg_listener)
+
+        self.eventlog_listener = None
+        self.start_event_logger()
         self.logger.info("Using %r as root dir", self.root_dir)
         self.logger.info("Using %r as data dir", self.data_dir)
         self.logger.info("Using %r as shares root dir", self.shares_dir)
         self.mark = task.LoopingCall(self.log_mark)
         self.mark.start(mark_interval)
 
+    def start_event_logger(self):
+        """Start the event logger if it's available for this platform."""
+        self.eventlog_listener = event_logging.get_listener(self.fs, self.vm)
+        if self.eventlog_listener:
+            self.event_q.subscribe(self.eventlog_listener)
+
     def log_mark(self):
         """Log a "mark" that includes the current AQ state and queue size."""
         self.logger.note("---- MARK (state: %s; queues: metadata: %d; content:"