Merge lp:~facundo/ubuntuone-client/unsubscribe-during-lr into lp:ubuntuone-client

[Facundo Batista]

Support unsubscribing the volume (or removing it) while LocalRescan'ing (LP: #820353).

Support unsubscribing the volume (or removing it) while LocalRescan'ing.

Also renamed the 'ro_share' to 'rw_share', because it's actually a writable one.

Tests included.

Unmerged revisions

1111. By Facundo Batista on 2011-08-24

Support unsubscribing the volume (or removing it) while LocalRescan'ing

=== modified file 'contrib/testing/testcase.py'
--- contrib/testing/testcase.py	2011-08-15 22:05:02 +0000
+++ contrib/testing/testcase.py	2011-08-24 21:06:23 +0000
@@ -439,6 +439,12 @@
         udf.subscribed = False
         self.udfs[udf_id] = udf
 
+    def unsubscribe_share(self, share_id):
+        """Mark the Share as unsubscribed."""
+        share = self.shares[share_id]
+        share.subscribed = False
+        self.shares[share_id] = share
+
     def delete_volume(self, volume_id):
         """Request the deletion of a volume."""
 

=== modified file 'tests/syncdaemon/test_localrescan.py'
--- tests/syncdaemon/test_localrescan.py	2011-08-12 15:26:13 +0000
+++ tests/syncdaemon/test_localrescan.py	2011-08-24 21:06:23 +0000
@@ -62,18 +62,27 @@
     """Fake EQ"""
     def __init__(self):
         self.pushed = []
+        self.watching = set()
 
     def push(self, event, **kwargs):
         """Store stuff as pushed."""
         self.pushed.append((event, kwargs))
 
     def _fake(self, *a, **k):
-        """fake"""
-    add_watch = freeze_rollback = is_frozen = _fake
-    rm_watch = freeze_begin = add_to_mute_filter = _fake
+        """Fake."""
+    freeze_rollback = is_frozen = _fake
+    freeze_begin = add_to_mute_filter = _fake
+
+    def add_watch(self, path):
+        """Fake add watch."""
+        self.watching.add(path)
+
+    def rm_watch(self, path):
+        """Fake rm watch."""
+        self.watching.discard(path)
 
     def freeze_commit(self, events):
-        """just store events"""
+        """Just store events."""
         self.pushed.extend(events)
 
 
@@ -506,7 +515,7 @@
         self.lr = local_rescan.LocalRescan(self.vm, self.fsm, self.eq, self.aq)
 
         # create a share
-        self.share = yield self.create_share('share_id', u'ro_share',
+        self.share = yield self.create_share('share_id', u'rw_share',
                                              access_level='Modify')
         self.fsm.create(self.share.path, "share_id", is_dir=True)
         self.fsm.set_node_id(self.share.path, "uuidshare")
@@ -905,9 +914,9 @@
     def test_one_dir_ro_share(self):
         """The dir is in a share that's RO, no error but no action."""
         # create the share
-        share = yield self.create_share('share_id', u'ro_share2',
+        share = yield self.create_share('new_share_id', u'ro_share2',
                                         access_level='View')
-        self.fsm.create(share.path, "share_id", is_dir=True)
+        self.fsm.create(share.path, "new_share_id", is_dir=True)
         self.fsm.set_node_id(share.path, "uuidshare")
 
         lr = local_rescan.LocalRescan(self.vm, self.fsm, self.eq, self.aq)
@@ -1005,6 +1014,70 @@
         yield self.lr.start()
         self.assertEqual(self.eq.pushed, [])
 
+    @defer.inlineCallbacks
+    def test_middle_unsubscribe(self):
+        """Unsubscribe while the LR."""
+        # make a file, and a dir with a file in it
+        sh1 = os.path.join(self.share.path, "file")
+        open_file(sh1, 'w').close()
+
+        # create a node that is already there (normally LR would put a
+        # watch on it), and put a file in it
+        sh2 = self.create_node("old_dir", is_dir=True)
+        sh3 = os.path.join(sh2, "inside")
+        open_file(sh3, 'w').close()
+
+        # do some magic to unsubscribe in the middle of the LR
+        original_compare = self.lr._compare
+
+        def middle(dirpath, dnames, fnames, share):
+            """Unsubscribe, and call the original."""
+            if share == self.share:
+                self.vm.unsubscribe_share(share.id)
+                self.lr._compare = original_compare
+            return original_compare(dirpath, dnames, fnames, share)
+
+        self.lr._compare = middle
+
+        # make LR spin and check
+        yield self.lr.start()
+        self.assertEqual(self.eq.pushed, [])
+        self.assertNotIn(sh2, self.eq.watching)
+        self.assertTrue(self.handler.check_debug(
+                        "Discarded scan", "volume unsubscribed or removed"))
+
+    @defer.inlineCallbacks
+    def test_middle_remove(self):
+        """Remove the share while the LR."""
+        # make a file, and a dir with a file in it
+        sh1 = os.path.join(self.share.path, "file")
+        open_file(sh1, 'w').close()
+
+        # create a node that is already there (normally LR would put a
+        # watch on it), and put a file in it
+        sh2 = self.create_node("old_dir", is_dir=True)
+        sh3 = os.path.join(sh2, "inside")
+        open_file(sh3, 'w').close()
+
+        # do some magic to unsubscribe in the middle of the LR
+        original_compare = self.lr._compare
+
+        def middle(dirpath, dnames, fnames, share):
+            """Unsubscribe, and call the original."""
+            if share == self.share:
+                del self.vm.shares[share.id]
+                self.lr._compare = original_compare
+            return original_compare(dirpath, dnames, fnames, share)
+
+        self.lr._compare = middle
+
+        # make LR spin and check
+        yield self.lr.start()
+        self.assertEqual(self.eq.pushed, [])
+        self.assertNotIn(sh2, self.eq.watching)
+        self.assertTrue(self.handler.check_debug(
+                        "Discarded scan", "volume unsubscribed or removed"))
+
 
 class InotifyTests(TwistedBase):
     """Test LocalRescan pushing events to the EventQueue."""
@@ -2015,7 +2088,7 @@
     def test_SERVER_share(self):
         """We were downloading the share root dir but it was interrupted."""
         # create a share
-        share = yield self.create_share('share_id_1', u'rw_share',
+        share = yield self.create_share('share_id_1', u'new_share',
                                         access_level='Modify')
         self.fsm.create(share.path, "share_id_1", is_dir=True)
         self.fsm.set_node_id(share.path, "uuid_share_1")

=== modified file 'ubuntuone/syncdaemon/local_rescan.py'
--- ubuntuone/syncdaemon/local_rescan.py	2011-08-10 15:03:17 +0000
+++ ubuntuone/syncdaemon/local_rescan.py	2011-08-24 21:06:23 +0000
@@ -660,7 +660,23 @@
 
             events, to_scan_later = self._compare(dirpath, dnames, fnames,
                                                   share)
-            to_later.extend(to_scan_later)
+
+            # if the volume is no longer suscribed or was remvoed, discard
+            # these events, remove the just added watch and avoid going deeper
+            # FIXME: soportar que no este
+            try:
+                still_useful = self.vm.get_volume(share.id).subscribed
+            except volume_manager.VolumeDoesNotExist:
+                still_useful = False
+
+            if still_useful:
+                to_later.extend(to_scan_later)
+            else:
+                m = "Discarded scan, volume unsubscribed or removed; id: %s"
+                log_debug(m, share.id)
+                events = []
+                self.eq.rm_watch(dirpath)
+
             return events
 
         delete_events = []