Merge lp:~facundo/magicicada-gui/simple-api into lp:magicicada-gui

[Facundo Batista]

Expose a simple API to the GUI.

These are the attributes (exposed in SyncDaemon.current_state):

  is_started
  is_connected
  is_online

And the methods:

  start
  stop
  connect
  disconnect

[Natalia Bidart (nataliabidart)]

Is there a typo here: """Tells the SyncDaemon that the user wants it to DISconnect.""" ?

When running nose, I get:

======================================================================
ERROR: Check that it polls mq until no more is needed.
----------------------------------------------------------------------
TimeoutError: <test_syncdaemon.MetaQueueChangedTests testMethod=test_mq_polling_untilfinish> (test_mq_polling_untilfinish) still running at 2.0 secs

======================================================================
ERROR: Check that it polls mq until no more is needed.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python2.6/dist-packages/twisted/internet/base.py", line 778, in runUntilCurrent
    call.func(*call.args, **call.kw)
  File "/home/nessita/projects/magicicada/review_simple-api/magicicada/tests/test_syncdaemon.py", line 365, in check
    self.assertEqual(len(calls), 3)
  File "/usr/lib/python2.6/dist-packages/twisted/trial/unittest.py", line 287, in failUnlessEqual
    % (msg, pformat(first), pformat(second)))
FailTest: not equal:
a = 2
b = 3

----------------------------------------------------------------------
Ran 70 tests in 3.033s

FAILED (errors=2)

review: Needs Fixing

[lp:~facundo/magicicada-gui/simple-api]

9. By Facundo Batista on 2010-05-18

Merged trunk in

10. By Facundo Batista on 2010-05-18

Typo, and refactored test

11. By Facundo Batista on 2010-05-18

Not beyond 80 columns!

12. By Facundo Batista on 2010-05-18

Merged trunk in

[Natalia Bidart (nataliabidart)]

Nice!

review: Approve

=== modified file 'magicicada/syncdaemon.py'
--- magicicada/syncdaemon.py	2010-05-17 16:10:28 +0000
+++ magicicada/syncdaemon.py	2010-05-18 22:03:29 +0000
@@ -29,12 +29,12 @@
 
 from magicicada.helpers import NO_OP
 
-
 # structures that hold content and queue information
 QueueData = collections.namedtuple('QueueData', 'operation path share node')
 State = collections.namedtuple('State', 'name description is_error '
                                'is_connected is_online queues connection')
 
+# regular expressions for parsing MetaQueue data
 RE_OP_LISTDIR = re.compile("(ListDir)\(share_id=(.*?), node_id=(.*?), .*")
 RE_OP_UNLINK = re.compile("(Unlink)\(share_id=(.*?), node_id=(.*?), .*")
 RE_OP_MAKEFILE = re.compile(
@@ -42,6 +42,35 @@
 RE_OP_MAKEDIR = re.compile(
                 "(MakeDir)\(share_id=(.*?), parent_id=(.*?), name=(.*?), .*")
 
+# structure that hold content and queue information
+QueueData = collections.namedtuple('QueueData', 'operation path share node')
+
+class State(object):
+    """Holds the state of SD."""
+    _attrs =  ['name', 'description', 'is_error', 'is_connected',
+               'is_online', 'queues', 'connection', 'is_started']
+
+    def __init__(self, syncdaemon):
+        self._sd = syncdaemon
+
+    def __getattribute__(self, name):
+        """Return the value if there."""
+        if name[0] == "_":
+            return object.__getattribute__(self, name)
+        else:
+            if name == 'is_started':
+                v = self._sd._get_started()
+            else:
+                v = self.__dict__.get(name)
+            return v
+
+    def _set(self, **data):
+        """Sets the attributes fromd data, if allowed."""
+        for name, value in data.iteritems():
+            if name not in self._attrs:
+                raise AttributeError("Name not in _attrs: %r" % name)
+            self.__dict__[name] = value
+
 
 class SyncDaemon(object):
     """Interface to Ubuntu One's SyncDaemon."""
@@ -51,6 +80,7 @@
         loop = DBusGMainLoop(set_as_default=True)
         self._bus = bus = dbus.SessionBus(mainloop=loop)
         self.sync_daemon_tool = tools.SyncDaemonTool(bus)
+        self.current_state = State(self)
 
         # hook up for signals and store info for the shutdown
         _signals = [
@@ -73,6 +103,11 @@
         # calls to obtain data from SDT
         self._get_content_queue = self.sync_daemon_tool.waiting_content
         self._get_meta_queue = self.sync_daemon_tool.waiting_metadata
+        self._get_started = tools.is_running
+        self._do_start = self.sync_daemon_tool.start
+        self._do_quit = self.sync_daemon_tool.quit
+        self._do_connect = self.sync_daemon_tool.connect
+        self._do_disconnect = self.sync_daemon_tool.disconnect
 
         # previous data
         self._last_CQ_data = None
@@ -102,9 +137,7 @@
         is_online = bool(state['is_online'])
         queues = state['queues']
         connection = state['connection']
-        self.current_state = State(name, description, is_error,
-                                   is_connected, is_online,
-                                   queues, connection)
+        self.current_state._set(**state)
         self.status_changed_callback(name, description, is_error,
                                      is_connected, is_online,
                                      queues, connection)
@@ -198,3 +231,18 @@
         d.addCallback(self._process_mq)
         self._mqcaller = reactor.callLater(self._mq_poll_time, self._check_mq)
 
+    def start(self):
+        """Starts the SyncDaemon."""
+        self._do_start()
+
+    def quit(self):
+        """Stops the SyncDaemon and makes it quit."""
+        self._do_quit()
+
+    def connect(self):
+        """Tells the SyncDaemon that the user wants it to connect."""
+        self._do_connect()
+
+    def disconnect(self):
+        """Tells the SyncDaemon that the user wants it to disconnect."""
+        self._do_disconnect()

=== modified file 'magicicada/tests/test_syncdaemon.py'
--- magicicada/tests/test_syncdaemon.py	2010-05-04 01:30:42 +0000
+++ magicicada/tests/test_syncdaemon.py	2010-05-18 22:03:29 +0000
@@ -18,12 +18,14 @@
 
 """Tests for the SyncDaemon communication backend."""
 
+import unittest
+
 import dbus
 from dbus.mainloop.glib import DBusGMainLoop
 
 # this should be imported *before* importing the reactor below, as needs to
 # install the glib connection first
-from magicicada.syncdaemon import SyncDaemon
+from magicicada.syncdaemon import SyncDaemon, State
 
 from dbus.lowlevel import SignalMessage
 from twisted.trial.unittest import TestCase as TwistedTestCase
@@ -340,34 +342,163 @@
 
     def test_mq_polling_untilfinish(self):
         """Check that it polls mq until no more is needed."""
-
-        # set the callback, and adjust the polling time to .2 seconds
+        # prepare different status changed signals
+        d1 = dict(name='QUEUE_MANAGER', queues='WORKING_ON_BOTH',
+                  description='description', is_error='', is_connected='True',
+                  is_online='', connection='conn')
+
+        d2 = dict(name='QUEUE_MANAGER', queues='WORKING_ON_CONTENT',
+                  description='description', is_error='', is_connected='True',
+                  is_online='', connection='conn')
+
+        # set the callback, and adjust the polling time to faster
         calls = []
         def fake_get(*a):
             calls.append(None)
+            if len(calls) < 3:
+                pass  # no changes, should keep calling
+            elif len(calls) == 3:
+                self.send_signal(DBUS_IFACE_STATUS_NAME,
+                                 'StatusChanged', 'a{ss}', d2)
+                # allow time to see if a mistaken call happens
+                reactor.callLater(.5, deferred.callback, True)
+            else:
+                deferred.errback(ValueError("Too many calls"))
             return defer.Deferred()
+
         self.sd._get_meta_queue = fake_get
-        self.sd._mq_poll_time = .4
-
-        # prepare different status changed signals
-        d1 = dict(name='QUEUE_MANAGER', queues='WORKING_ON_BOTH',
-                  description='description', is_error='', is_connected='True',
-                  is_online='', connection='conn')
-
-        d2 = dict(name='QUEUE_MANAGER', queues='WORKING_ON_CONTENT',
-                  description='description', is_error='', is_connected='True',
-                  is_online='', connection='conn')
-
-        def check():
-            """Verify the polling function was called n times."""
-            self.assertEqual(len(calls), 3)
-            deferred.callback(True)
-
-        # start with the working one, stop it .5 seconds later, and check
+        self.sd._mq_poll_time = .1
+
         self.send_signal(DBUS_IFACE_STATUS_NAME, 'StatusChanged', 'a{ss}', d1)
-        reactor.callLater(1, self.send_signal, DBUS_IFACE_STATUS_NAME,
-                              'StatusChanged', 'a{ss}', d2)
-        reactor.callLater(1.2, check)
-
         deferred = defer.Deferred()
         return deferred
+
+
+class StateTests(unittest.TestCase):
+    """Test State class."""
+
+    def test_initial(self):
+        """Initial state for vals."""
+        st = State(None)
+        self.assertEqual(st.name, None)
+
+    def test_set_one_value(self):
+        """Set one value."""
+        st = State(None)
+        st._set(name=55)
+
+        # check the one is set, the rest not
+        self.assertEqual(st.name, 55)
+        self.assertEqual(st.description, None)
+
+    def test_set_two_values(self):
+        """Set two values."""
+        st = State(None)
+        st._set(name=55, description=77)
+
+        # check those two are set, the rest not
+        self.assertEqual(st.name, 55)
+        self.assertEqual(st.description, 77)
+        self.assertEqual(st.is_error, None)
+
+    def test_bad_value(self):
+        """Set a value that should not."""
+        st = State(None)
+        self.assertRaises(AttributeError, st._set, not_really_allowed=44)
+
+
+class APITests(unittest.TestCase):
+    """Check exposed methods and attributes."""
+
+    def setUp(self):
+        """Set up the test."""
+        self.sd = SyncDaemon()
+
+        self._replaced = None
+        self.called = False
+
+    def tearDown(self):
+        """Tear down the test."""
+        if self._replaced is not None:
+            setattr(*self._replaced)
+        self.sd.shutdown()
+
+    def mpatch_called(self, obj, method_name):
+        """Monkeypatch to flag called."""
+        self._replaced = (obj, method_name, getattr(obj, method_name))
+        f = lambda *a, **k: setattr(self, 'called', True)
+        setattr(obj, method_name, f)
+
+    def test_defaults_are_callable(self):
+        """Check the attributes are callable."""
+        meths = (self.sd._get_content_queue, self.sd._get_meta_queue,
+                 self.sd._get_started, self.sd._do_start, self.sd._do_quit,
+                 self.sd._do_connect, self.sd._do_disconnect)
+        for meth in meths:
+            self.assertTrue(callable(meth), "Meth %r is not callable" % meth)
+
+    def test_is_connected_yes(self):
+        """Check is_connected, True."""
+        d = dict(name='name', description='description', is_error='',
+                 is_connected='True', is_online='', queues='queues',
+                 connection='connection')
+        self.sd._on_status_changed(d)
+        self.assertTrue(self.sd.current_state.is_connected)
+
+    def test_is_connected_no(self):
+        """Check is_connected, False."""
+        d = dict(name='name', description='description', is_error='',
+                 is_connected='', is_online='', queues='queues',
+                 connection='connection')
+        self.sd._on_status_changed(d)
+        self.assertFalse(self.sd.current_state.is_connected)
+
+    def test_is_online_yes(self):
+        """Check is_online, True."""
+        d = dict(name='name', description='description', is_error='',
+                 is_connected='True', is_online='True', queues='queues',
+                 connection='connection')
+        self.sd._on_status_changed(d)
+        self.assertTrue(self.sd.current_state.is_online)
+
+    def test_is_online_no(self):
+        """Check is_online, False."""
+        d = dict(name='name', description='description', is_error='',
+                 is_connected='True', is_online='', queues='queues',
+                 connection='connection')
+        self.sd._on_status_changed(d)
+        self.assertFalse(self.sd.current_state.is_online)
+
+    def test_is_started_yes(self):
+        """Check is_started, True."""
+        self.sd._get_started = lambda: True
+        self.assertTrue(self.sd.current_state.is_started)
+
+    def test_is_started_no(self):
+        """Check is_started, False."""
+        self.sd._get_started = lambda: False
+        self.assertFalse(self.sd.current_state.is_started)
+
+    def test_start(self):
+        """Test start calls SD."""
+        self.mpatch_called(self.sd, '_do_start')
+        self.sd.start()
+        self.assertTrue(self.called)
+
+    def test_quit(self):
+        """Test quit calls SD."""
+        self.mpatch_called(self.sd, '_do_quit')
+        self.sd.quit()
+        self.assertTrue(self.called)
+
+    def test_connect(self):
+        """Test connect calls SD."""
+        self.mpatch_called(self.sd, '_do_connect')
+        self.sd.connect()
+        self.assertTrue(self.called)
+
+    def test_disconnect(self):
+        """Test disconnect calls SD."""
+        self.mpatch_called(self.sd, '_do_disconnect')
+        self.sd.disconnect()
+        self.assertTrue(self.called)