Merge lp:~nataliabidart/ubuntuone-client/does-not-exist-to-u1fsfsm into lp:ubuntuone-client

[Natalia Bidart]

Added a new event AQ_DOWNLOAD_DOES_NOT_EXIST and handlers for it on u1fsfsm.ods.

[Natalia Bidart (nataliabidart)]

Added a new event AQ_DOWNLOAD_DOES_NOT_EXIST so responses from the server with the error DOES_NOT_EXIST is correctly handled on the client.

Also binded proper handlers on u1fsfsm.ods spreadsheet.

[Rick McBride (rmcbride)]

Nice!

review: Approve

[lp:~nataliabidart/ubuntuone-client/does-not-exist-to-u1fsfsm]

367. By Natalia Bidart on 2010-02-11

Removing server hash from AQ_DOWNLOAD_DOES_NOT_EXIST parameters.

368. By Natalia Bidart on 2010-02-11

Removing server_hash from event definition.

[Facundo Batista (facundo)]

Like it!

review: Approve

=== modified file 'contrib/testing/testcase.py'
--- contrib/testing/testcase.py	2010-01-28 21:24:26 +0000
+++ contrib/testing/testcase.py	2010-02-11 13:18:15 +0000
@@ -602,3 +602,16 @@
     def handle_default(self, event_name, *args, **kwargs):
         """Keep record of every event."""
         self.events.append((event_name, args, kwargs))
+
+
+def noop(*args, **kwargs):
+    """No op."""
+
+
+class DummyClass(object):
+    """Dummy class, does nothing."""
+
+    def __getattribute__(self, name):
+        """Any attribute is a no-op."""
+        return noop
+

=== modified file 'tests/syncdaemon/test_action_queue.py'
--- tests/syncdaemon/test_action_queue.py	2010-01-29 18:09:48 +0000
+++ tests/syncdaemon/test_action_queue.py	2010-02-11 13:18:15 +0000
@@ -32,7 +32,7 @@
 
 from contrib.testing.testcase import (
     BaseTwistedTestCase, FakeMain,
-    MementoHandler,
+    MementoHandler, DummyClass
 )
 
 from ubuntuone.storageprotocol import client, volumes
@@ -40,7 +40,7 @@
 from ubuntuone.syncdaemon.main import Main
 from ubuntuone.syncdaemon.action_queue import (
     ActionQueue, ActionQueueCommand, CreateUDF, DeleteVolume, ListVolumes,
-    NoisyRequestQueue, RequestQueue
+    NoisyRequestQueue, RequestQueue, ListDir
 )
 from ubuntuone.syncdaemon.event_queue import EventQueue, EVENTS
 from ubuntuone.syncdaemon.volume_manager import UDF
@@ -187,18 +187,6 @@
                                 ])
 
 
-def noop(*args, **kwargs):
-    """No op."""
-
-
-class DummyClass(object):
-    """Dummy class, does nothing."""
-
-    def __getattribute__(self, name):
-        """Any attribute is a no-op."""
-        return noop
-
-
 class FakedTwistedTestCase(unittest.TestCase):
     """Helper for by-pass Twisted."""
 
@@ -581,3 +569,66 @@
         self.action_queue._node_state_callback(**kwargs)
         self.assertEquals([('SV_HASH_NEW', (), kwargs)],
                           self.action_queue.event_queue.events)
+
+
+class ListDirTestCase(FakedTwistedTestCase):
+    """Test for ListDir ActionQueueCommand."""
+
+    def setUp(self):
+        """Init."""
+        super(ListDirTestCase, self).setUp()
+
+        request_queue = RequestQueue(name='FOO', action_queue=self.factory)
+        self.command = ListDir(request_queue, share_id='a_share_id',
+                               node_id='a_node_id', server_hash='a_server_hash',
+                               fileobj_factory=lambda: None)
+        self.command.start_unqueued()
+
+    def test_failure_with_CANCELLED(self):
+        """AQ_DOWNLOAD_CANCELLED is pushed."""
+        msg = 'CANCELLED'
+        failure = Failure(DefaultException(msg))
+        res = self.command.handle_failure(failure=failure)
+        kwargs = dict(share_id='a_share_id', node_id='a_node_id',
+                      server_hash='a_server_hash')
+        events = [('AQ_DOWNLOAD_CANCELLED', (), kwargs)]
+        self.assertEquals(events, self.command.action_queue.event_queue.events)
+        self.assertTrue(res is None)
+
+    def test_failure_without_CANCELLED(self):
+        """AQ_DOWNLOAD_ERROR with proper error is pushed."""
+        msg = 'NOT_CANCELLED'
+        failure = Failure(DefaultException(msg))
+        res = self.command.handle_failure(failure=failure)
+        kwargs = dict(share_id='a_share_id', node_id='a_node_id',
+                      server_hash='a_server_hash', error=msg)
+        events = [('AQ_DOWNLOAD_ERROR', (), kwargs)]
+        self.assertEquals(events, self.command.action_queue.event_queue.events)
+        self.assertTrue(res is None)
+
+    def test_failure_with_DOES_NOT_EXIST(self):
+        """AQ_DOWNLOAD_DOES_NOT_EXIST is pushed."""
+        msg = 'DOES_NOT_EXIST'
+        failure = Failure(DefaultException(msg))
+        res = self.command.handle_failure(failure=failure)
+        kwargs = dict(share_id='a_share_id', node_id='a_node_id')
+        events = [('AQ_DOWNLOAD_DOES_NOT_EXIST', (), kwargs)]
+        self.assertEquals(events, self.command.action_queue.event_queue.events)
+        self.assertTrue(res is None)
+
+    def test_failure_without_DOES_NOT_EXIST(self):
+        """AQ_DOWNLOAD_ERROR with proper error is pushed."""
+        msg = 'DOES_EXIST'
+        failure = Failure(DefaultException(msg))
+        res = self.command.handle_failure(failure=failure)
+        kwargs = dict(share_id='a_share_id', node_id='a_node_id',
+                      server_hash='a_server_hash', error=msg)
+        events = [('AQ_DOWNLOAD_ERROR', (), kwargs)]
+        self.assertEquals(events, self.command.action_queue.event_queue.events)
+        self.assertTrue(res is None)
+
+    def test_AQ_DOWNLOAD_DOES_NOT_EXIST_is_valid_event(self):
+        """AQ_DOWNLOAD_DOES_NOT_EXIST is a valdi event."""
+        event = 'AQ_DOWNLOAD_DOES_NOT_EXIST'
+        self.assertTrue(event in EVENTS)
+        self.assertEquals(('share_id', 'node_id'), EVENTS[event])

=== modified file 'tests/syncdaemon/test_sync.py'
--- tests/syncdaemon/test_sync.py	2010-01-22 20:31:51 +0000
+++ tests/syncdaemon/test_sync.py	2010-02-11 13:18:15 +0000
@@ -30,13 +30,13 @@
 from contrib.testing.testcase import (
     FakeVolumeManager,
     BaseTwistedTestCase,
-    MementoHandler,
+    MementoHandler, DummyClass
 )
 
 from ubuntuone.syncdaemon.dbus_interface import DBusInterface
 from ubuntuone.syncdaemon.filesystem_manager import FileSystemManager
 from ubuntuone.syncdaemon.main import Main
-from ubuntuone.syncdaemon.sync import FSKey
+from ubuntuone.syncdaemon.sync import FSKey, Sync, SyncStateMachineRunner
 from ubuntuone.syncdaemon.volume_manager import Share
 from ubuntuone.syncdaemon.event_queue import EventQueue
 
@@ -181,7 +181,10 @@
 
 
 class TestSync(BaseTwistedTestCase):
+    """Test for Sync."""
+
     def setUp(self):
+        """Init."""
         BaseTwistedTestCase.setUp(self)
         self.root = self.mktemp('root')
         self.shares = self.mktemp('shares')
@@ -204,6 +207,7 @@
         dbus.service.BusName.__del__ = lambda _: None
 
     def tearDown(self):
+        """Clean up."""
         self.main.shutdown()
         shutil.rmtree(self.root)
         shutil.rmtree(self.shares)
@@ -215,6 +219,7 @@
         BaseTwistedTestCase.tearDown(self)
 
     def test_deleting_open_files_is_no_cause_for_despair(self):
+        """test_deleting_open_files_is_no_cause_for_despair."""
         def cb(_):
             d0 = self.main.wait_for('HQ_HASH_NEW')
             f = file(self.root + '/a_file', 'w')
@@ -229,6 +234,7 @@
         return d
 
     def test_stomp_deleted_file_is_no_cause_for_despair_either(self):
+        """test_stomp_deleted_file_is_no_cause_for_despair_either."""
         def cb(_):
             d0 = self.main.wait_for('HQ_HASH_NEW')
             f = file(self.root + '/a_file', 'w')
@@ -241,3 +247,39 @@
         self.main.start()
         d.addCallback(cb)
         return d
+
+    def test_handle_AQ_DOWNLOAD_DOES_NOT_EXIST(self):
+        """handle_AQ_DOWNLOAD_DOES_NOT_EXIST."""
+        sync = Sync(main=self.main)
+        self.called = False
+
+        def faked_nothing(ssmr, event, params, *args):
+            """Wrap SSMR.nothing to test."""
+            self.called = True
+
+        SyncStateMachineRunner.nothing = faked_nothing
+        kwargs = dict(share_id='share_id', node_id='node_id')
+        sync.handle_AQ_DOWNLOAD_DOES_NOT_EXIST(**kwargs)
+        self.assertTrue(self.called, 'nothing was called')
+
+
+class SyncStateMachineRunnerTestCase(BaseTwistedTestCase):
+    """Tests for the SyncStateMachineRunner."""
+
+    def setUp(self):
+        """Init."""
+        BaseTwistedTestCase.setUp(self)
+        self.ssmr = SyncStateMachineRunner(fsm=None, main=None,
+                                           key=DummyClass(), logger=None)
+
+    def tearDown(self):
+        """Clean up."""
+        self.ssmr = None
+        BaseTwistedTestCase.tearDown(self)
+
+    def test_delete_file(self):
+        """delete_file can be called with or without the server hash."""
+        self.ssmr.delete_file(event='AQ_DOWNLOAD_ERROR', params=None)
+
+        self.ssmr.delete_file(event='AQ_DOWNLOAD_ERROR', params=None,
+                              server_hash='')

=== modified file 'ubuntuone/syncdaemon/action_queue.py'
--- ubuntuone/syncdaemon/action_queue.py	2010-02-10 19:10:37 +0000
+++ ubuntuone/syncdaemon/action_queue.py	2010-02-11 13:18:15 +0000
@@ -2168,14 +2168,19 @@
             downloading[self.share_id, self.node_id]['command'] is self:
             del downloading[self.share_id, self.node_id]
         self.reset_fileobj()
-        if failure.getErrorMessage() == 'CANCELLED':
+        error_msg = failure.getErrorMessage()
+        if error_msg == 'CANCELLED':
             self.action_queue.event_queue.push('AQ_DOWNLOAD_CANCELLED',
                                                share_id=self.share_id,
                                                node_id=self.node_id,
                                                server_hash=self.server_hash)
+        elif error_msg == 'DOES_NOT_EXIST':
+            self.action_queue.event_queue.push('AQ_DOWNLOAD_DOES_NOT_EXIST',
+                                               share_id=self.share_id,
+                                               node_id=self.node_id)
         else:
             self.action_queue.event_queue.push('AQ_DOWNLOAD_ERROR',
-                                               error=failure.getErrorMessage(),
+                                               error=error_msg,
                                                share_id=self.share_id,
                                                node_id=self.node_id,
                                                server_hash=self.server_hash)

=== modified file 'ubuntuone/syncdaemon/event_queue.py'
--- ubuntuone/syncdaemon/event_queue.py	2010-02-09 14:06:50 +0000
+++ ubuntuone/syncdaemon/event_queue.py	2010-02-11 13:18:15 +0000
@@ -56,6 +56,7 @@
     'AQ_DOWNLOAD_FINISHED': ('share_id', 'node_id', 'server_hash'),
     'AQ_DOWNLOAD_ERROR': ('share_id', 'node_id', 'server_hash', 'error'),
     'AQ_DOWNLOAD_CANCELLED': ('share_id', 'node_id', 'server_hash'),
+    'AQ_DOWNLOAD_DOES_NOT_EXIST': ('share_id', 'node_id'),
     'AQ_UPLOAD_STARTED' : ('share_id', 'node_id', 'hash'),
     'AQ_UPLOAD_FINISHED': ('share_id', 'node_id', 'hash'),
     'AQ_UPLOAD_ERROR': ('share_id', 'node_id', 'error', 'hash'),

=== modified file 'ubuntuone/syncdaemon/sync.py'
--- ubuntuone/syncdaemon/sync.py	2010-02-10 19:10:37 +0000
+++ ubuntuone/syncdaemon/sync.py	2010-02-11 13:18:15 +0000
@@ -737,8 +737,7 @@
         self.key.remove_partial()
         self.key.upload_finished(hash)
 
-
-    def delete_file(self, event, params):
+    def delete_file(self, event, params, *args, **kwargs):
         """server file was deleted."""
         try:
             self.key.delete_file()
@@ -945,6 +944,13 @@
         ssmr = SyncStateMachineRunner(self.fsm, self.m, key, log)
         ssmr.signal_event_with_hash("AQ_DOWNLOAD_CANCELLED", server_hash)
 
+    def handle_AQ_DOWNLOAD_DOES_NOT_EXIST(self, share_id, node_id):
+        """on AQ_DOWNLOAD_DOES_NOT_EXIST."""
+        key = FSKey(self.m.fs, share_id=share_id, node_id=node_id)
+        log = FileLogger(self.logger, key)
+        ssmr = SyncStateMachineRunner(self.fsm, self.m, key, log)
+        ssmr.on_event("AQ_DOWNLOAD_DOES_NOT_EXIST", {}, share_id, node_id)
+
     def handle_FS_FILE_CREATE(self, path):
         """on FS_FILE_CREATE"""
         key = FSKey(self.m.fs, path=path)

=== modified file 'ubuntuone/syncdaemon/u1fsfsm.ods'
Binary files ubuntuone/syncdaemon/u1fsfsm.ods	2010-01-22 17:25:09 +0000 and ubuntuone/syncdaemon/u1fsfsm.ods	2010-02-11 13:18:15 +0000 differ
=== modified file 'ubuntuone/syncdaemon/u1fsfsm.py'
--- ubuntuone/syncdaemon/u1fsfsm.py	2010-01-22 17:25:09 +0000
+++ ubuntuone/syncdaemon/u1fsfsm.py	2010-02-11 13:18:15 +0000
@@ -365,6 +365,58 @@
                                         'STATE_OUT': {u'changed': u'=',
                                                       u'has_metadata': u'=',
                                                       u'is_directory': u'='}}],
+            u'AQ_DOWNLOAD_DOES_NOT_EXIST': [{'ACTION': u'',
+                                             'ACTION_FUNC': u'delete_file',
+                                             'COMMENTS': u"Directory doesn't exist anymore, remove it",
+                                             'PARAMETERS': {u'hash_eq_local_hash': u'NA',
+                                                            u'hash_eq_server_hash': u'NA',
+                                                            u'not_authorized': u'NA',
+                                                            u'not_available': u'NA'},
+                                             'STATE': {u'changed': u'*',
+                                                       u'has_metadata': u'T',
+                                                       u'is_directory': u'T'},
+                                             'STATE_OUT': {u'changed': u'NA',
+                                                           u'has_metadata': u'F',
+                                                           u'is_directory': u'NA'}},
+                                            {'ACTION': u'',
+                                             'ACTION_FUNC': u'delete_file',
+                                             'COMMENTS': u"File doesn't exist anymore, remove it",
+                                             'PARAMETERS': {u'hash_eq_local_hash': u'NA',
+                                                            u'hash_eq_server_hash': u'NA',
+                                                            u'not_authorized': u'NA',
+                                                            u'not_available': u'NA'},
+                                             'STATE': {u'changed': u'!LOCAL',
+                                                       u'has_metadata': u'T',
+                                                       u'is_directory': u'F'},
+                                             'STATE_OUT': {u'changed': u'NA',
+                                                           u'has_metadata': u'F',
+                                                           u'is_directory': u'NA'}},
+                                            {'ACTION': u'',
+                                             'ACTION_FUNC': u'conflict_and_delete',
+                                             'COMMENTS': u"File doesn't exist on server, but has local changes",
+                                             'PARAMETERS': {u'hash_eq_local_hash': u'NA',
+                                                            u'hash_eq_server_hash': u'NA',
+                                                            u'not_authorized': u'NA',
+                                                            u'not_available': u'NA'},
+                                             'STATE': {u'changed': u'LOCAL',
+                                                       u'has_metadata': u'T',
+                                                       u'is_directory': u'F'},
+                                             'STATE_OUT': {u'changed': u'NA',
+                                                           u'has_metadata': u'F',
+                                                           u'is_directory': u'NA'}},
+                                            {'ACTION': u'pass',
+                                             'ACTION_FUNC': u'nothing',
+                                             'COMMENTS': u'',
+                                             'PARAMETERS': {u'hash_eq_local_hash': u'NA',
+                                                            u'hash_eq_server_hash': u'NA',
+                                                            u'not_authorized': u'NA',
+                                                            u'not_available': u'NA'},
+                                             'STATE': {u'changed': u'*',
+                                                       u'has_metadata': u'F',
+                                                       u'is_directory': u'*'},
+                                             'STATE_OUT': {u'changed': u'=',
+                                                           u'has_metadata': u'=',
+                                                           u'is_directory': u'='}}],
             u'AQ_DOWNLOAD_ERROR': [{'ACTION': u'md.remove_partial(uuid);',
                                     'ACTION_FUNC': u'remove_partial',
                                     'COMMENTS': u'error while downloading, remove the partial file',