Merge lp:~nataliabidart/ubuntuone-client/filter-events-for-unsubscribed-volumes into lp:ubuntuone-client

[Natalia Bidart]

Filtering SV_HASH_NEW event for un-subscribed udf's.

[Natalia Bidart (nataliabidart)]

Filtering SV_HASH_NEW event for un-subscribed udf's.

[Guillermo Gonzalez (verterok)]

Looks good.

review: Approve

[dobey (dobey)]

review: Approve

=== modified file 'tests/syncdaemon/test_action_queue.py'
--- tests/syncdaemon/test_action_queue.py	2010-01-13 20:07:41 +0000
+++ tests/syncdaemon/test_action_queue.py	2010-01-14 15:57:14 +0000
@@ -31,11 +31,11 @@
 from twisted.python.failure import DefaultException, Failure
 
 from contrib.testing.testcase import (
-    BaseTwistedTestCase,
+    BaseTwistedTestCase, FakeMain,
     MementoHandler,
 )
 
-from ubuntuone.storageprotocol import client
+from ubuntuone.storageprotocol import client, volumes
 from ubuntuone.syncdaemon.dbus_interface import DBusInterface
 from ubuntuone.syncdaemon.main import Main
 from ubuntuone.syncdaemon.action_queue import (
@@ -502,3 +502,75 @@
         events = [('AQ_DELETE_VOLUME_ERROR', (), {'volume_id': VOLUME, 'error': msg})]
         self.assertEquals(events, self.command.action_queue.event_queue.events)
         self.assertTrue(res is None)
+
+
+class FilterEventsTestCase(BaseTwistedTestCase):
+    """Tests for event filtering when a volume is not of our interest."""
+
+    def setUp(self):
+        """Init."""
+        BaseTwistedTestCase.setUp(self)
+        self.log = logging.getLogger("ubuntuone.SyncDaemon.TEST")
+        self.log.info("starting test %s.%s", self.__class__.__name__,
+                      self._testMethodName)
+        self.root_dir = self.mktemp('root_dir')
+        self.data_dir = self.mktemp('data_dir')
+        self.shares_dir = self.mktemp('shares_dir')
+        self.partials_dir = self.mktemp('partials_dir')
+        self.main = FakeMain(self.root_dir, self.shares_dir,
+                             self.data_dir, self.partials_dir)
+        self.vm = self.main.vm
+
+        self.action_queue = ActionQueue(FakedEventQueue(), self.main,
+                                        host='localhost', port=0,
+                                        dns_srv=False)
+
+    def tearDown(self):
+        """Clean up."""
+        self.action_queue = None
+
+        self.main.shutdown()
+        self.rmtree(self.root_dir)
+        self.rmtree(self.data_dir)
+        self.rmtree(self.shares_dir)
+        self.log.info("finished test %s.%s", self.__class__.__name__,
+                      self._testMethodName)
+        return BaseTwistedTestCase.tearDown(self)
+
+    def test_SV_HASH_NEW_is_pushed_for_subscrined_volume(self):
+        """SV_HASH_NEW is filtered when the volume is unsubscribed."""
+        udf_id = 'udf_id'
+        udf_volume = volumes.UDFVolume(udf_id, 'udf_node',
+                                       u'~/ñoño'.encode("utf8"))
+        self.vm.handle_SV_VOLUME_CREATED(volume=udf_volume)
+        self.vm.subscribe_udf(udf_id)
+        assert self.vm.udfs[udf_id].subscribed
+
+        kwargs = dict(share_id=udf_id, node_id=None, hash=None)
+        self.action_queue._node_state_callback(**kwargs)
+        self.assertEquals([('SV_HASH_NEW', (), kwargs)],
+                           self.action_queue.event_queue.events)
+
+    def test_SV_HASH_NEW_is_filtered_for_unsubscrined_volume(self):
+        """SV_HASH_NEW is filtered when the volume is unsubscribed."""
+        # build a VM and add it an UDF with subscribed to False
+        udf_id = 'udf_id'
+        udf_volume = volumes.UDFVolume(udf_id, 'udf_node',
+                                       u'~/ñoño'.encode("utf8"))
+        self.vm.handle_SV_VOLUME_CREATED(volume=udf_volume)
+        self.vm.unsubscribe_udf(udf_id)
+        assert not self.vm.udfs[udf_id].subscribed
+
+        self.action_queue._node_state_callback(share_id=udf_id,
+                                               node_id=None, hash=None)
+        self.assertEquals([], self.action_queue.event_queue.events)
+
+    def test_SV_HASH_NEW_doesnt_fail_for_non_udf(self):
+        """SV_HASH_NEW keeps working like before for non-udfs."""
+        other_id = 'not in udfs'
+        assert other_id not in self.vm.udfs
+
+        kwargs = dict(share_id=other_id, node_id=None, hash=None)
+        self.action_queue._node_state_callback(**kwargs)
+        self.assertEquals([('SV_HASH_NEW', (), kwargs)],
+                          self.action_queue.event_queue.events)

=== modified file 'ubuntuone/syncdaemon/action_queue.py'
--- ubuntuone/syncdaemon/action_queue.py	2010-01-13 20:07:41 +0000
+++ ubuntuone/syncdaemon/action_queue.py	2010-01-14 15:57:14 +0000
@@ -817,6 +817,9 @@
         """
         Called by the client when notified that node changed.
         """
+        volume = self.main.vm.udfs.get(share_id, None)
+        if volume is not None and not volume.subscribed:
+            return
         self.event_queue.push('SV_HASH_NEW',
                               share_id=share_id, node_id=node_id, hash=hash)