Merge lp:~alecu/ubuntuone-client/aggregator-fixes into lp:ubuntuone-client

[Alejandro J. Cura]

Add a config/dbus option to disable notification bubbles (part I)

Add a config/dbus option to disable notification bubbles (part I)

[Eric Casteleijn (thisfred)]

great!

review: Approve

[Martin Albisetti (beuno)]

review: Approve

=== modified file 'contrib/testing/testcase.py'
--- contrib/testing/testcase.py	2011-02-08 18:38:31 +0000
+++ contrib/testing/testcase.py	2011-02-15 13:50:18 +0000
@@ -170,6 +170,12 @@
     node_is_with_queued_move = cleanup = get_public_files = disconnect
 
 
+class FakeStatusListener(object):
+    """A fake StatusListener."""
+
+    show_all_notifications = True
+
+
 class FakeMain(main.Main):
     """ A fake Main class to setup the tests """
 
@@ -205,6 +211,7 @@
         self.external = FakeExternalInterface()
         self.lr = local_rescan.LocalRescan(self.vm, self.fs,
                                            self.event_q, self.action_q)
+        self.status_listener = FakeStatusListener()
 
     def _connect_aq(self, _):
         """Connect the fake action queue."""

=== modified file 'data/syncdaemon.conf'
--- data/syncdaemon.conf	2011-02-01 14:33:46 +0000
+++ data/syncdaemon.conf	2011-02-15 13:50:18 +0000
@@ -85,6 +85,13 @@
                  \A\..*\.tmp\Z
 
 
+[notifications]
+show_all_notifications.default = True
+show_all_notifications.parser = bool
+show_all_notifications.action = store_true
+show_all_notifications.help = Show all bubble notifications
+
+
 [bandwidth_throttling]
 on.default = False
 on.parser = bool

=== modified file 'tests/platform/linux/test_dbus.py'
--- tests/platform/linux/test_dbus.py	2011-02-10 11:28:49 +0000
+++ tests/platform/linux/test_dbus.py	2011-02-15 13:50:18 +0000
@@ -2570,6 +2570,61 @@
                            error_handler=self.error_handler)
         return d
 
+    def test_show_all_notifications_enabled(self):
+        """Test for Config.show_all_notifications_enabled."""
+        client = self.get_client()
+        d = defer.Deferred()
+
+        def reply_handler_disabled(result):
+            """Handle the reply."""
+            self.assertTrue(result)
+            config.get_user_config().set_show_all_notifications(not result)
+            client.call_method('show_all_notifications_enabled',
+                               reply_handler=reply_handler_enabled,
+                               error_handler=self.error_handler)
+
+        def reply_handler_enabled(result):
+            """Handle the reply."""
+            self.assertFalse(result)
+            d.callback(True)
+
+        client.call_method('show_all_notifications_enabled',
+                           reply_handler=reply_handler_disabled,
+                           error_handler=self.error_handler)
+        return d
+
+    def test_enable_show_all_notifications(self):
+        """Test for Config.enable_show_all_notifications."""
+        client = self.get_client()
+        d = defer.Deferred()
+        self.main.status_listener.show_all_notifications = False
+        def reply_handler(_):
+            """Handle the reply."""
+            user_config = config.get_user_config()
+            self.assertTrue(user_config.get_show_all_notifications())
+            self.assertTrue(self.main.status_listener.show_all_notifications)
+            d.callback(True)
+        client.call_method('enable_show_all_notifications',
+                           reply_handler=reply_handler,
+                           error_handler=self.error_handler)
+        return d
+
+    def test_disable_show_all_notifications(self):
+        """Test for Config.disable_show_all_notifications."""
+        client = self.get_client()
+        d = defer.Deferred()
+        self.main.status_listener.show_all_notifications = True
+        def reply_handler(_):
+            """Handle the reply."""
+            user_config = config.get_user_config()
+            self.assertFalse(user_config.get_show_all_notifications())
+            self.assertFalse(self.main.status_listener.show_all_notifications)
+            d.callback(True)
+        client.call_method('disable_show_all_notifications',
+                           reply_handler=reply_handler,
+                           error_handler=self.error_handler)
+        return d
+
 
 class DBusOAuthTestCase(BaseTwistedTestCase):
     """Tests the interaction between dbus_interface and credentials.

=== modified file 'tests/status/test_aggregator.py'
--- tests/status/test_aggregator.py	2011-02-10 17:47:02 +0000
+++ tests/status/test_aggregator.py	2011-02-15 13:50:18 +0000
@@ -22,6 +22,7 @@
 from twisted.internet.task import Clock
 from twisted.trial.unittest import TestCase
 
+from contrib.testing.testcase import BaseTwistedTestCase
 from ubuntuone.devtools.handlers import MementoHandler
 from ubuntuone.status import aggregator
 from ubuntuone.status.notification import AbstractNotification
@@ -629,11 +630,12 @@
     upload_finished = misc_command_unqueued
 
 
-class StatusFrontendTestCase(TestCase):
+class StatusFrontendTestCase(BaseTwistedTestCase):
     """Test the status frontend."""
 
     def setUp(self):
         """Initialize this test instance."""
+        BaseTwistedTestCase.setUp(self)
         self.patch(aggregator, "StatusAggregator", FakeAggregator)
         self.patch(aggregator, "Notification", FakeNotificationSingleton())
         self.patch(aggregator, "Messaging", FakeMessaging)

=== modified file 'tests/syncdaemon/test_config.py'
--- tests/syncdaemon/test_config.py	2011-02-08 18:38:31 +0000
+++ tests/syncdaemon/test_config.py	2011-02-15 13:50:18 +0000
@@ -372,6 +372,54 @@
         conf_1 = config._Config(conf_file)
         self.assertEquals(True, conf_1.get_autoconnect())
 
+    def test_load_show_all_notifications(self):
+        """Test load/set/override of show_all_notifications config value."""
+        conf_file = os.path.join(self.test_root,
+                                 'test_show_all_notifications_config.conf')
+        # ensure that show_all_notifications is True
+        with open(conf_file, 'w') as fp:
+            fp.write('[notifications]\n')
+            fp.write('show_all_notifications = True\n')
+
+        # keep a original around
+        conf_orig = config._Config(conf_file)
+
+        # assert default is correct
+        self.assertTrue(conf_orig.get_show_all_notifications(),
+                        'show_all_notifications is True by default.')
+
+        # load the config
+        conf = config._Config(conf_file)
+        self.assertTrue(conf.get_show_all_notifications())
+
+        # change it to False
+        conf.set_show_all_notifications(False)
+        self.assertFalse(conf.get_show_all_notifications())
+
+        # save, load and check
+        conf.save()
+        conf_1 = config._Config(conf_file)
+        self.assertFalse(conf_1.get_show_all_notifications())
+        # change it to True
+        conf.set_show_all_notifications(True)
+        self.assertTrue(conf.get_show_all_notifications())
+        # save, load and check
+        conf.save()
+        conf_1 = config._Config(conf_file)
+        self.assertTrue(conf_1.get_show_all_notifications())
+
+        # load the config, check the override of the value
+        conf = config._Config(conf_file)
+        self.assertTrue(conf.get_show_all_notifications())
+        overridden_opts = [('notifications', 'show_all_notifications', False)]
+        conf.override_options(overridden_opts)
+        self.assertFalse(conf.get_show_all_notifications())
+        self.assertNotEqual(conf.get_show_all_notifications(),
+                            conf_orig.get_show_all_notifications())
+        conf.save()
+        conf_1 = config._Config(conf_file)
+        self.assertEquals(True, conf_1.get_show_all_notifications())
+
 
 class ConfigglueParsersTests(BaseTwistedTestCase):
     """Tests for our custom configglue parsers"""

=== modified file 'tests/syncdaemon/test_status_listener.py'
--- tests/syncdaemon/test_status_listener.py	2011-02-08 20:09:46 +0000
+++ tests/syncdaemon/test_status_listener.py	2011-02-15 13:50:18 +0000
@@ -20,19 +20,19 @@
 import os
 
 from twisted.internet import defer
-from twisted.trial.unittest import TestCase
 
-from contrib.testing.testcase import FakeMainTestCase
-from ubuntuone.syncdaemon import status_listener
+from contrib.testing.testcase import FakeMainTestCase, BaseTwistedTestCase
+from ubuntuone.syncdaemon import config, status_listener
 from ubuntuone.syncdaemon.volume_manager import Share, UDF
 
 
-class GetListenerTestCase(TestCase):
+class GetListenerTestCase(BaseTwistedTestCase):
     """The status listener is created."""
 
     def test_returns_listener(self):
         """get_listener returns a listener if status reporting is enabled."""
         self.patch(status_listener, "should_start_listener", lambda: True)
+        self.patch(status_listener, "StatusFrontend", FakeStatusFrontend)
         fsm = object()
         vm = object()
         listener = status_listener.get_listener(fsm, vm)
@@ -108,6 +108,32 @@
         return listen_for(self.main.event_q, *args, **kwargs)
 
 
+class StatusListenerConfigTestCase(StatusListenerTestCase):
+    """Test the config of the status listener."""
+
+    def test_show_all_notifications_calls_frontend(self):
+        """Changes in the value of notifications are sent to the frontend."""
+        self.listener.show_all_notifications = True
+        call = ("set_show_all_notifications", (True,), {})
+        self.assertIn(call, self.status_frontend.call_log)
+
+    def test_show_all_notifications_true(self):
+        """The value of show_all_notifications is set to True."""
+        user_conf = config.get_user_config()
+        user_conf.set_show_all_notifications(True)
+        listener = status_listener.StatusListener(None, None,
+                                                  self.status_frontend)
+        self.assertTrue(listener.show_all_notifications)
+
+    def test_show_all_notifications_false(self):
+        """The value of show_all_notifications is set to False."""
+        user_conf = config.get_user_config()
+        user_conf.set_show_all_notifications(False)
+        listener = status_listener.StatusListener(None, None,
+                                                  self.status_frontend)
+        self.assertFalse(listener.show_all_notifications)
+
+
 class PublicFilesStatusTestCase(StatusListenerTestCase):
     """Public files events are passed to the status object."""
 

=== modified file 'ubuntuone/platform/linux/dbus_interface.py'
--- ubuntuone/platform/linux/dbus_interface.py	2011-02-10 11:28:49 +0000
+++ ubuntuone/platform/linux/dbus_interface.py	2011-02-15 13:50:18 +0000
@@ -1445,7 +1445,7 @@
     @dbus.service.method(DBUS_IFACE_CONFIG_NAME,
                          in_signature='', out_signature='')
     def disable_udf_autosubscribe(self):
-        """Enable UDF autosubscribe."""
+        """Disable UDF autosubscribe."""
         user_config = config.get_user_config()
         user_config.set_udf_autosubscribe(False)
         user_config.save()
@@ -1459,7 +1459,7 @@
     @dbus.service.method(DBUS_IFACE_CONFIG_NAME,
                          in_signature='', out_signature='')
     def enable_share_autosubscribe(self):
-        """Enable UDF autosubscribe."""
+        """Enable share autosubscribe."""
         user_config = config.get_user_config()
         user_config.set_share_autosubscribe(True)
         user_config.save()
@@ -1467,7 +1467,7 @@
     @dbus.service.method(DBUS_IFACE_CONFIG_NAME,
                          in_signature='', out_signature='')
     def disable_share_autosubscribe(self):
-        """Enable UDF autosubscribe."""
+        """Disable share autosubscribe."""
         user_config = config.get_user_config()
         user_config.set_share_autosubscribe(False)
         user_config.save()
@@ -1502,6 +1502,31 @@
         user_config.set_autoconnect(enabled)
         user_config.save()
 
+    @dbus.service.method(DBUS_IFACE_CONFIG_NAME,
+                         in_signature='', out_signature='b')
+    def show_all_notifications_enabled(self):
+        """Return the show_all_notifications config value."""
+
+        return config.get_user_config().get_show_all_notifications()
+
+    @dbus.service.method(DBUS_IFACE_CONFIG_NAME,
+                         in_signature='', out_signature='')
+    def enable_show_all_notifications(self):
+        """Enable showing all notifications."""
+        user_config = config.get_user_config()
+        user_config.set_show_all_notifications(True)
+        user_config.save()
+        self.dbus_iface.main.status_listener.show_all_notifications = True
+
+    @dbus.service.method(DBUS_IFACE_CONFIG_NAME,
+                         in_signature='', out_signature='')
+    def disable_show_all_notifications(self):
+        """Disable showing all notifications."""
+        user_config = config.get_user_config()
+        user_config.set_show_all_notifications(False)
+        user_config.save()
+        self.dbus_iface.main.status_listener.show_all_notifications = False
+
 
 class Folders(DBusExposedObject):
     """A dbus interface to interact with User Defined Folders"""

=== modified file 'ubuntuone/status/aggregator.py'
--- ubuntuone/status/aggregator.py	2011-02-10 17:47:02 +0000
+++ ubuntuone/status/aggregator.py	2011-02-15 13:50:18 +0000
@@ -550,28 +550,6 @@
         self.progress_bar.completed()
         self.reset()
 
-    def no_callback(self, status_events):
-        """Pushed a bunch of events by the buffer."""
-
-        lines = []
-
-        if self.show_progress:
-            lines.append(self.get_progress_message())
-
-        for weight, statuses in group_statuses(status_events):
-            statuses = list(statuses)
-            count = len(statuses)
-            first_status = statuses[0]
-            if count == 1:
-                lines.append(first_status.one())
-            else:
-                lines.append(first_status.many(count))
-
-        text = "\n".join(lines)
-        self.notification.send_notification(UBUNTUONE_TITLE, text)
-        logger.debug("notification shown: %s", text)
-        self.show_progress = False
-
     def misc_command_queued(self, command):
         """A miscellaneous command was queued."""
         self.total_counter += 1
@@ -700,3 +678,6 @@
         logger.debug("server connection made")
         self.notification.send_notification(
             UBUNTUONE_TITLE, ConnectionMadeStatus().one())
+
+    def set_show_all_notifications(self, value):
+        """Set the flag to show all notifications."""

=== modified file 'ubuntuone/syncdaemon/config.py'
--- ubuntuone/syncdaemon/config.py	2011-02-07 19:19:50 +0000
+++ ubuntuone/syncdaemon/config.py	2011-02-15 13:50:18 +0000
@@ -62,6 +62,7 @@
 
 # sections
 THROTTLING = 'bandwidth_throttling'
+NOTIFICATIONS = 'notifications'
 MAIN = '__main__'
 
 # global logger
@@ -271,7 +272,7 @@
     def save(self):
         """Save the config object to disk"""
         # cleanup empty sections
-        for section in [MAIN, THROTTLING]:
+        for section in [MAIN, THROTTLING, NOTIFICATIONS]:
             if self.has_section(section) and not self.options(section):
                 self.remove_section(section)
         with open(self.config_file+'.new', 'w') as fp:
@@ -364,6 +365,15 @@
     def get_autoconnect(self):
         return self.get_parsed(MAIN, 'autoconnect')
 
+    @requires_section(NOTIFICATIONS)
+    def set_show_all_notifications(self, enabled):
+        self.set(NOTIFICATIONS, 'show_all_notifications', str(enabled))
+
+    @requires_section(NOTIFICATIONS)
+    def get_show_all_notifications(self):
+        """The value of the show_all_notifications setting."""
+        return self.get_parsed(NOTIFICATIONS, 'show_all_notifications')
+
 
 
 def configglue(fileobj, *filenames, **kwargs):

=== modified file 'ubuntuone/syncdaemon/status_listener.py'
--- ubuntuone/syncdaemon/status_listener.py	2011-02-08 20:09:46 +0000
+++ ubuntuone/syncdaemon/status_listener.py	2011-02-15 13:50:18 +0000
@@ -18,7 +18,7 @@
 """Listener for event queue that updates the UI to show syncdaemon status."""
 
 from ubuntuone.status.aggregator import StatusFrontend
-from ubuntuone.syncdaemon import action_queue
+from ubuntuone.syncdaemon import action_queue, config
 
 def should_start_listener():
     """Check if the status listener should be started."""
@@ -37,11 +37,27 @@
 class StatusListener(object):
     """SD listener for EQ events that turns them into status updates."""
 
+    _show_all_notifications = True
+
     def __init__(self, fsm, vm, status_frontend):
         """Initialize this instance with the FSM and VM."""
         self.fsm = fsm
         self.vm = vm
         self.status_frontend = status_frontend
+        user_conf = config.get_user_config()
+        self.show_all_notifications = user_conf.get_show_all_notifications()
+
+    def get_show_all_notifications(self):
+        """Get the value of show_all_notifications."""
+        return self._show_all_notifications
+
+    def set_show_all_notifications(self, value):
+        """Set the value of show_all_notifications."""
+        self._show_all_notifications = value
+        self.status_frontend.set_show_all_notifications(value)
+
+    show_all_notifications = property(get_show_all_notifications,
+                                      set_show_all_notifications)
 
     def handle_AQ_CHANGE_PUBLIC_ACCESS_OK(self, share_id, node_id, is_public,
                                                   public_url):