Merge lp:~robru/friends/testmode into lp:friends

[Robert Bruce Park]

Reintroduce --test mode, with mock dbus API and test coverage.

Bring back --test mode, this time with a full dbus API that accepts callbacks and the whole deal, acceptable for use as a mock within the libfriends testsuite.

Best part is that I included a test case that ensures the mock has the identical dbus API interface, including identical in/out signatures, as the real Dispatcher... so if in the future somebody changes our dbus API, the testsuite will politely remind them to update the mock, too.

=== modified file 'friends/main.py'
--- friends/main.py	2013-02-03 21:16:19 +0000
+++ friends/main.py	2013-02-03 21:16:19 +0000
@@ -63,6 +63,10 @@
             print(class_name)
         return
 
+    if args.test:
+        global Dispatcher
+        from friends.service.mock_service import Dispatcher
+
     # Set up the DBus main loop.
     DBusGMainLoop(set_as_default=True)
     loop = GLib.MainLoop()

=== added file 'friends/service/mock_service.py'
--- friends/service/mock_service.py	1970-01-01 00:00:00 +0000
+++ friends/service/mock_service.py	2013-02-03 21:16:19 +0000
@@ -0,0 +1,105 @@
+# friends-service -- send & receive messages from any social network
+# Copyright (C) 2012  Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""DBus service object for general dispatching of commands."""
+
+__all__ = [
+    'Dispatcher',
+    ]
+
+
+import json
+import logging
+
+import dbus
+import dbus.service
+
+from friends.service.dispatcher import DBUS_INTERFACE, STUB
+
+
+log = logging.getLogger(__name__)
+
+
+class Dispatcher(dbus.service.Object):
+    """This object mocks the official friends-service dbus API."""
+    __dbus_object_path__ = '/com/canonical/friends/Service'
+
+    def __init__(self, *ignore):
+        self.bus = dbus.SessionBus()
+        bus_name = dbus.service.BusName(DBUS_INTERFACE, bus=self.bus)
+        super().__init__(bus_name, self.__dbus_object_path__)
+
+        self._succeed = True
+
+    @dbus.service.method(DBUS_INTERFACE)
+    def Contacts(self):
+        pass
+
+    @dbus.service.method(DBUS_INTERFACE)
+    def Refresh(self):
+        pass
+
+    @dbus.service.method(DBUS_INTERFACE)
+    def ClearIndicators(self):
+        pass
+
+    @dbus.service.method(DBUS_INTERFACE,
+                         in_signature='sss',
+                         out_signature='s',
+                         async_callbacks=('success','failure'))
+    def Do(self, action, account_id='', arg='',
+           success=STUB, failure=STUB):
+        message = "Called with: action={}, account_id={}, arg={}".format(
+            action, account_id, arg)
+        success(message) if self._succeed else failure(message)
+
+    @dbus.service.method(DBUS_INTERFACE,
+                         in_signature='s',
+                         out_signature='s',
+                         async_callbacks=('success','failure'))
+    def SendMessage(self, message, success=STUB, failure=STUB):
+        message = "Called with: message={}".format(message)
+        success(message) if self._succeed else failure(message)
+
+    @dbus.service.method(DBUS_INTERFACE,
+                         in_signature='sss',
+                         out_signature='s',
+                         async_callbacks=('success','failure'))
+    def SendReply(self, account_id, message_id, msg,
+                  success=STUB, failure=STUB):
+        message = "Called with: account_id={}, message_id={}, msg={}".format(
+            account_id, message_id, msg)
+        success(message) if self._succeed else failure(message)
+
+    @dbus.service.method(DBUS_INTERFACE,
+                         in_signature='sss',
+                         out_signature='s',
+                         async_callbacks=('success','failure'))
+    def Upload(self, account_id, uri, description, success=STUB, failure=STUB):
+        message = "Called with: account_id={}, uri={}, description={}".format(
+            account_id, uri, description)
+        success(message) if self._succeed else failure(message)
+
+    @dbus.service.method(DBUS_INTERFACE, in_signature='s', out_signature='s')
+    def GetFeatures(self, protocol_name):
+        return json.dumps(protocol_name.split())
+
+    @dbus.service.method(DBUS_INTERFACE)
+    def Quit(self):
+        self._succeed = False
+
+    @dbus.service.method(DBUS_INTERFACE, in_signature='s', out_signature='s')
+    def URLShorten(self, url):
+        return str(len(url))

=== added file 'friends/tests/test_mock_dispatcher.py'
--- friends/tests/test_mock_dispatcher.py	1970-01-01 00:00:00 +0000
+++ friends/tests/test_mock_dispatcher.py	2013-02-03 21:16:19 +0000
@@ -0,0 +1,65 @@
+# friends-service -- send & receive messages from any social network
+# Copyright (C) 2012  Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Test the dispatcher directly, without dbus."""
+
+__all__ = [
+    'TestMockDispatcher',
+    ]
+
+
+import dbus.service
+import unittest
+import json
+
+from dbus.mainloop.glib import DBusGMainLoop
+
+from friends.service.mock_service import Dispatcher as MockDispatcher
+from friends.service.dispatcher import Dispatcher
+from friends.tests.mocks import LogMock, mock
+
+
+# Set up the DBus main loop.
+DBusGMainLoop(set_as_default=True)
+
+
+def get_signature(klass, signature):
+    """Extract dbus in/out signatures from a dbus class."""
+    return [
+        (m, getattr(getattr(klass, m), signature))
+        for m in dir(klass)
+        if hasattr(getattr(klass, m), signature)
+        ]
+
+
+class TestMockDispatcher(unittest.TestCase):
+    """Ensure our mock Dispatcher has the same API as the real one."""
+
+    def test_api_similarity(self):
+        real = [m for m in dir(Dispatcher)
+                if hasattr(getattr(Dispatcher, m), '_dbus_interface')]
+        mock = [m for m in dir(MockDispatcher)
+                if hasattr(getattr(MockDispatcher, m), '_dbus_interface')]
+        self.assertEqual(real, mock)
+
+    def test_in_signatures(self):
+        real = get_signature(Dispatcher, '_dbus_in_signature')
+        mock = get_signature(MockDispatcher, '_dbus_in_signature')
+        self.assertEqual(real, mock)
+
+    def test_out_signatures(self):
+        real = get_signature(Dispatcher, '_dbus_out_signature')
+        mock = get_signature(MockDispatcher, '_dbus_out_signature')
+        self.assertEqual(real, mock)

=== modified file 'friends/tests/test_model.py'
--- friends/tests/test_model.py	2012-12-17 22:42:15 +0000
+++ friends/tests/test_model.py	2013-02-03 21:16:19 +0000
@@ -26,7 +26,7 @@
 
 import unittest
 
-from friends.utils.model import Model, first_run, stale_schema
+from friends.utils.model import Model
 from friends.utils.model import prune_model, persist_model
 from friends.tests.mocks import LogMock, mock
 from gi.repository import Dee
@@ -41,22 +41,6 @@
     def tearDown(self):
         self.log_mock.stop()
 
-    def test_basic_properties(self):
-        self.assertIsInstance(Model, Dee.SequenceModel)
-        self.assertEqual(Model.get_n_columns(), 18)
-        self.assertEqual(Model.get_schema(),
-                         ['aas', 's', 's', 's', 's', 'b', 's', 's', 's', 's',
-                          'd', 'b', 's', 's', 's', 's', 's', 's'])
-        if first_run or stale_schema:
-            # Then the Model should be brand-new and empty
-            self.assertEqual(Model.get_n_rows(), 0)
-
-    @mock.patch('friends.utils.model._resource_manager')
-    def test_persistence(self, resource_manager):
-        persist_model()
-        resource_manager.store.assert_called_once_with(
-            Model, 'com.canonical.Friends.Streams')
-
     @mock.patch('friends.utils.model.Model')
     @mock.patch('friends.utils.model.persist_model')
     def test_prune_one(self, persist, model):

=== modified file 'friends/utils/options.py'
--- friends/utils/options.py	2012-11-16 18:26:56 +0000
+++ friends/utils/options.py	2013-02-03 21:16:19 +0000
@@ -32,6 +32,10 @@
             description='The Friends backend dbus service.')
 
         self.parser.add_argument(
+            '-t', '--test',
+            action='store_true', default=False,
+            help='Replace friends-service daemon with a crash test dummy.')
+        self.parser.add_argument(
             '-d', '--debug',
             action='store_true', default=False,
             help='Enable debug level log messages.')