Merge lp:~barry/ubuntu-system-image/reload-configuration into lp:~snappy-dev/ubuntu-system-image/ppa-upload

[Barry Warsaw]

Adds a new D-Bus method called ReloadConfiguration() which takes a single argument, the path to the new client.ini file. Reloads the D-Bus service's configuration from the new path. A channel.ini file may live next to the client.ini file. The empty string is returned on success, otherwise an error string is returned.

You should be able to use this to load the configuration from the B partition.

[Barry Warsaw (barry)]

I should mention that while I think this will do what you want in the immediate case, we'll have to work out something different for si 3.0, which will have the config.d/ directory support (soon to land in trunk). So consider this expedient rather than permanent.

Oh, and I fixed the test suite so now you can run `tox` again. :)

[lp:~barry/ubuntu-system-image/reload-configuration]

305. By Barry Warsaw on 2015-01-14

Remove some comments.

[Steve Langasek (vorlon)]

This looks good to me. Merging and uploading.

review: Approve

[Michael Vogt (mvo)]

Thanks a lot Barry!

=== modified file 'debian/changelog'
--- debian/changelog	2014-12-17 07:20:40 +0000
+++ debian/changelog	2015-01-14 21:47:42 +0000
@@ -1,3 +1,11 @@
+system-image (2.5-0ubuntu1+ppa15) UNRELEASED; urgency=medium
+
+  * Added D-Bus API ReloadConfiguration() which takes a path to the new
+    client.ini file.  A channel.ini file can live next to that.  Using
+    this method will reload the configuration, e.g. to the B partition.
+
+ -- Barry Warsaw <[e-mail]>  Wed, 14 Jan 2015 16:37:12 -0500
+
 system-image (2.5-0ubuntu1+ppa14) vivid; urgency=medium
 
   * From userdata to writable

=== modified file 'systemimage/dbus.py'
--- systemimage/dbus.py	2014-09-25 20:13:57 +0000
+++ systemimage/dbus.py	2015-01-14 21:47:42 +0000
@@ -403,6 +403,30 @@
         self._loop.quit()
 
     @log_and_exit
+    @method('com.canonical.SystemImage',
+            in_signature='s', out_signature='s')
+    def ReloadConfiguration(self, path):
+        """Reload the process's configuration from the given path.
+
+        `path` must point to the client.ini file to load.  If a channel.ini
+        file lives next to the client.ini file, it will also be loaded in
+        'override' mode.
+        """
+        try:
+            config.load(path)
+        except OSError as error:
+            return str(error)
+        try:
+            # This can legitimately fail if there's no channel.ini file.
+            channel_ini = os.path.join(
+                os.path.dirname(path),
+                'channel.ini')
+            config.load(channel_ini, override=True)
+        except FileNotFoundError:
+            pass
+        return ''
+
+    @log_and_exit
     @signal('com.canonical.SystemImage', signature='bbsiss')
     def UpdateAvailableStatus(self,
                               is_available, downloading,

=== modified file 'systemimage/tests/test_config.py'
--- systemimage/tests/test_config.py	2014-10-10 11:15:04 +0000
+++ systemimage/tests/test_config.py	2015-01-14 21:47:42 +0000
@@ -77,7 +77,11 @@
         # [hooks]
         self.assertEqual(config.hooks.device, SystemProperty)
         self.assertEqual(config.hooks.scorer, WeightedScorer)
-        self.assertEqual(config.hooks.reboot, Reboot)
+        # There's no ubuntucoreupgrader module in the current package, so mock
+        # that out.
+        rebooter = object()
+        with patch.dict(config.hooks.__dict__, {'reboot': rebooter}):
+            self.assertEqual(config.hooks.reboot, rebooter)
         # [gpg]
         self.assertEqual(config.gpg.archive_master,
                          '/etc/system-image/archive-master.tar.xz')
@@ -92,7 +96,7 @@
             '/var/lib/system-image/keyrings/device-signing.tar.xz')
         # [updater]
         self.assertEqual(config.updater.cache_partition,
-                         '/userdata/cache/')
+                         '/writable/cache/')
         self.assertEqual(config.updater.data_partition,
                          '/var/lib/system-image')
         # [dbus]

=== modified file 'systemimage/tests/test_dbus.py'
--- systemimage/tests/test_dbus.py	2014-09-25 20:13:57 +0000
+++ systemimage/tests/test_dbus.py	2015-01-14 21:47:42 +0000
@@ -36,6 +36,7 @@
     'TestDBusPauseResume',
     'TestDBusProgress',
     'TestDBusRegressions',
+    'TestDBusReloadConfiguration',
     'TestDBusUseCache',
     'TestLiveDBusInfo',
     'TestLiveDBusInfoWithChannelIni',
@@ -56,12 +57,12 @@
 from functools import partial
 from pathlib import Path
 from systemimage.config import Configuration
-from systemimage.helpers import MiB, atomic, safe_remove
+from systemimage.helpers import MiB, atomic, safe_remove, temporary_directory
 from systemimage.reactor import Reactor
 from systemimage.settings import Settings
 from systemimage.testing.helpers import (
-    copy, find_dbus_process, make_http_server, setup_index, setup_keyring_txz,
-    setup_keyrings, sign, write_bytes)
+    copy, data_path, find_dbus_process, make_http_server, setup_index,
+    setup_keyring_txz, setup_keyrings, sign, write_bytes)
 from systemimage.testing.nose import SystemImagePlugin
 
 
@@ -1909,3 +1910,55 @@
         # Failure count.
         self.assertEqual(failure[0], 1)
         self.assertEqual(failure[1], 'Canceled')
+
+
+class TestDBusReloadConfiguration(_LiveTesting):
+    """Test reload of the configuration files."""
+
+    def test_reload(self):
+        # Create a second configuration directory with a different
+        # build_number so that we can test that the reload actually worked.
+        with temporary_directory() as tmpdir:
+            with ExitStack() as files:
+                infp = files.enter_context(
+                    open(SystemImagePlugin.controller.ini_path, 'r',
+                         encoding='utf-8'))
+                client_ini = os.path.join(tmpdir, 'client.ini')
+                outfp = files.enter_context(
+                    open(client_ini, 'w', encoding='utf-8'))
+                ubuntu_build = os.path.join(tmpdir, 'ubuntu-build')
+                with open(ubuntu_build, 'w', encoding='utf-8') as fp:
+                    print(801, file=fp)
+                for line in infp:
+                    if line.startswith('build_file:'):
+                        print('build_file: {}'.format(ubuntu_build),
+                              file=outfp)
+                    else:
+                        outfp.write(line)
+            # Start by asking the D-Bus process what the current build number
+            # is with the old configuraiton.
+            response = self.iface.Information()
+            self.assertEqual(response['current_build_number'], '0')
+            # Now reload the new configuration and recheck the build number.
+            status = self.iface.ReloadConfiguration(client_ini)
+            self.assertEqual(status, '')
+            response = self.iface.Information()
+            self.assertEqual(response['current_build_number'], '801')
+
+    def test_reload_with_channel_ini(self):
+        # Create a second configuration directory with a different
+        # build_number so that we can test that the reload actually worked.
+        with temporary_directory() as tmpdir:
+            client_ini = os.path.join(tmpdir, 'client.ini')
+            shutil.copy(SystemImagePlugin.controller.ini_path, client_ini)
+            shutil.copy(data_path('channel_01.ini'),
+                        os.path.join(tmpdir, 'channel.ini'))
+            # Start by asking the D-Bus process what the current build number
+            # is with the old configuraiton.
+            response = self.iface.Information()
+            self.assertEqual(response['current_build_number'], '0')
+            # Now reload the new configuration and recheck the build number.
+            status = self.iface.ReloadConfiguration(client_ini)
+            self.assertEqual(status, '')
+            response = self.iface.Information()
+            self.assertEqual(response['current_build_number'], '1833')