Merge lp:~nataliabidart/ubuntuone-control-panel/stop-backend into lp:ubuntuone-control-panel

[Natalia Bidart]

- Stop the control panel backend once the UI is done (LP: #704434).

To test IRL, please do the following:

* killall ubuntuone-control-panel-backend

Then, run in two terminals:

nessita@dali:~/canonical/u1/cp/stop-backend$ DEBUG=True PYTHONPATH=. ./bin/ubuntuone-control-panel-backend

nessita@dali:~/canonical/u1/cp/stop-backend$ DEBUG=True PYTHONPATH=. ./bin/ubuntuone-control-panel-gtk

Then close the control panel UI. Check that there is no ubuntuone-control-panel-backend process running.

[Eric Casteleijn (thisfred)]

Code looks great, closing the panel stops the backend

review: Approve

[Roberto Alsina (ralsina)]

+1

review: Approve

=== modified file 'ubuntuone/controlpanel/backend.py'
--- ubuntuone/controlpanel/backend.py	2011-03-02 19:54:09 +0000
+++ ubuntuone/controlpanel/backend.py	2011-03-28 17:32:28 +0000
@@ -69,8 +69,9 @@
     SHARE_TYPE = u'SHARE'
     NAME_NOT_SET = u'ENAMENOTSET'
 
-    def __init__(self):
+    def __init__(self, shutdown_func=None):
         """Initialize the webclient."""
+        self.shutdown_func = shutdown_func
         self.wc = WebClient(dbus_client.get_credentials)
         self._status_changed_handler = None
         self.status_changed_handler = lambda *a: None
@@ -478,3 +479,10 @@
         """Install the extension to sync bookmarks."""
         # still pending (LP: #673673)
         returnValue(None)
+
+    @log_call(logger.info)
+    def shutdown(self):
+        """Stop this service."""
+        # do any other needed cleanup
+        if self.shutdown_func is not None:
+            self.shutdown_func()

=== modified file 'ubuntuone/controlpanel/dbus_service.py'
--- ubuntuone/controlpanel/dbus_service.py	2011-01-20 14:31:24 +0000
+++ ubuntuone/controlpanel/dbus_service.py	2011-03-28 17:32:28 +0000
@@ -538,15 +538,24 @@
     def InstallBookmarksError(self, error):
         """Problem installing the extension to sync bookmarks."""
 
+    #---
+
+    @log_call(logger.info)
+    @method(dbus_interface=DBUS_PREFERENCES_IFACE, in_signature="")
+    def shutdown(self):
+        """Shutdown this service."""
+        self.backend.shutdown()
+
 
 def init_mainloop():
     """Start the DBus mainloop."""
     DBusGMainLoop(set_as_default=True)
 
 
-def run_mainloop():
+def run_mainloop(loop=None):
     """Run the gobject main loop."""
-    loop = gobject.MainLoop()
+    if loop is None:
+        loop = gobject.MainLoop()
     loop.run()
 
 
@@ -566,10 +575,10 @@
     return dbus.service.BusName(DBUS_BUS_NAME, bus=dbus.SessionBus())
 
 
-def publish_backend(backend=None):
+def publish_backend(backend=None, shutdown_func=None):
     """Publish the backend on the DBus."""
     if backend is None:
-        backend = ControlBackend()
+        backend = ControlBackend(shutdown_func=shutdown_func)
     return ControlPanelBackend(backend=backend,
                                object_path=DBUS_PREFERENCES_PATH,
                                bus_name=get_busname())
@@ -579,7 +588,8 @@
     """Hook the DBus listeners and start the main loop."""
     init_mainloop()
     if register_service():
-        publish_backend()
-        run_mainloop()
+        loop = gobject.MainLoop()
+        publish_backend(shutdown_func=loop.quit)
+        run_mainloop(loop=loop)
     else:
         print "Control panel backend already running."

=== modified file 'ubuntuone/controlpanel/gtk/gui.py'
--- ubuntuone/controlpanel/gtk/gui.py	2011-03-25 20:48:13 +0000
+++ ubuntuone/controlpanel/gtk/gui.py	2011-03-28 17:32:28 +0000
@@ -1516,6 +1516,7 @@
         gtk.Notebook.__init__(self)
         ControlPanelMixin.__init__(self)
         gtk.link_button_set_uri_hook(uri_hook)
+        self.connect('destroy', self.shutdown)
 
         self.main_window = main_window
 
@@ -1539,6 +1540,12 @@
         logger.debug('%s: started (window size %r).',
                      self.__class__.__name__, self.get_size_request())
 
+    def shutdown(self, *args, **kwargs):
+        """Shutdown backend."""
+        logger.info('Shutding down...')
+        self.backend.shutdown(reply_handler=NO_OP,
+                              error_handler=error_handler)
+
     def on_show_overview_panel(self, widget=None):
         """Show the overview panel."""
         self.set_current_page(0)

=== modified file 'ubuntuone/controlpanel/gtk/tests/__init__.py'
--- ubuntuone/controlpanel/gtk/tests/__init__.py	2011-03-01 15:23:01 +0000
+++ ubuntuone/controlpanel/gtk/tests/__init__.py	2011-03-28 17:32:28 +0000
@@ -180,7 +180,7 @@
         'replications_info', 'change_replication_settings',  # replications
         'file_sync_status', 'enable_files', 'disable_files',  # files
         'connect_files', 'disconnect_files',
-        'restart_files', 'start_files', 'stop_files',
+        'restart_files', 'start_files', 'stop_files', 'shutdown',
     ]
 
 

=== modified file 'ubuntuone/controlpanel/gtk/tests/test_gui_basic.py'
--- ubuntuone/controlpanel/gtk/tests/test_gui_basic.py	2011-03-25 20:48:13 +0000
+++ ubuntuone/controlpanel/gtk/tests/test_gui_basic.py	2011-03-28 17:32:28 +0000
@@ -219,6 +219,11 @@
 
         self.assert_current_tab_correct(self.ui.overview)
 
+    def test_backend_is_shutdown_on_close(self):
+        """When the control panel is closed, the backend is shutdown."""
+        self.ui.emit('destroy')
+        self.assert_backend_called('shutdown', ())
+
 
 class UbuntuOneBinTestCase(BaseTestCase):
     """The test suite for a Ubuntu One panel."""

=== modified file 'ubuntuone/controlpanel/integrationtests/test_dbus_service.py'
--- ubuntuone/controlpanel/integrationtests/test_dbus_service.py	2011-02-16 18:44:08 +0000
+++ ubuntuone/controlpanel/integrationtests/test_dbus_service.py	2011-03-28 17:32:28 +0000
@@ -84,12 +84,23 @@
         rs = self.mocker.replace(rs_name)
         rs()
         self.mocker.result(True)
+
+        mainloop = "ubuntuone.controlpanel.dbus_service.gobject.MainLoop"
+        mainloop = self.mocker.replace(mainloop)
+        mainloop()
+        loop = self.mocker.mock()
+        self.mocker.result(loop)
+
+        shutdown_func = self.mocker.mock()
+        loop.quit  # pylint: disable=W0104
+        self.mocker.result(shutdown_func)
+
         rml_name = "ubuntuone.controlpanel.dbus_service.run_mainloop"
         rml = self.mocker.replace(rml_name)
-        rml()
+        rml(loop=loop)
         pb_name = "ubuntuone.controlpanel.dbus_service.publish_backend"
         pb = self.mocker.replace(pb_name)
-        pb()
+        pb(shutdown_func=shutdown_func)
         self.mocker.replay()
         dbus_service.main()
 
@@ -112,6 +123,10 @@
         dbus_service.STATUS_KEY: dbus_service.FILE_SYNC_IDLE,
     }
     status_changed_handler = None
+    shutdown_func = None
+
+    def __init__(self, shutdown_func=None):
+        MockBackend.shutdown_func = shutdown_func
 
     def _process(self, result):
         """Process the request with the given result."""
@@ -197,6 +212,10 @@
         """Install the extension to sync bookmarks."""
         return self._process(None)
 
+    def shutdown(self):
+        """Stop this service."""
+        self.shutdown_func()
+
 
 class DBusServiceTestCase(TestCase):
     """Test for the DBus service."""
@@ -289,7 +308,8 @@
     def setUp(self):
         super(BaseTestCase, self).setUp()
         dbus_service.init_mainloop()
-        be = dbus_service.publish_backend(MockBackend())
+        self.patch(dbus_service, 'ControlBackend', MockBackend)
+        be = dbus_service.publish_backend()
         self.addCleanup(be.remove_from_connection)
         bus = dbus.SessionBus()
         obj = bus.get_object(bus_name=DBUS_BUS_NAME,
@@ -691,3 +711,18 @@
         cpbe = dbus_service.ControlPanelBackend(backend=be)
 
         self.assertEqual(be.status_changed_handler, cpbe.process_status)
+
+
+class ShutdownTestCase(BaseTestCase):
+    """Test for the DBus service shurdown."""
+
+    @defer.inlineCallbacks
+    def test_shutdown(self):
+        """The service can be shutdown."""
+        called = []
+        MockBackend.shutdown_func = lambda *a: called.append('shutdown')
+        self.backend.shutdown(reply_handler=lambda: self.deferred.callback(1),
+                              error_handler=self.got_error)
+        yield self.deferred
+
+        self.assertEqual(called, ['shutdown'])

=== modified file 'ubuntuone/controlpanel/tests/test_backend.py'
--- ubuntuone/controlpanel/tests/test_backend.py	2011-03-02 19:54:09 +0000
+++ ubuntuone/controlpanel/tests/test_backend.py	2011-03-28 17:32:28 +0000
@@ -278,6 +278,24 @@
         result = yield self.be.device_is_local(did)
         self.assertFalse(result)
 
+    def test_shutdown_func(self):
+        """A shutdown_func can be passed as creation parameter."""
+        f = lambda: None
+        be = backend.ControlBackend(shutdown_func=f)
+        self.assertEqual(be.shutdown_func, f)
+
+    def test_shutdown_func_is_called_on_shutdown(self):
+        """The shutdown_func is called on shutdown."""
+        self.be.shutdown_func = self._set_called
+        self.be.shutdown()
+        self.assertEqual(self._called, ((), {}))
+
+    def test_shutdown_func_when_none(self):
+        """The shutdown_func can be None."""
+        self.be.shutdown_func = None
+        self.be.shutdown()
+        # nothing explodes
+
 
 class BackendAccountTestCase(BackendBasicTestCase):
     """Account tests for the backend."""