Merge lp:~barry/ubuntu-system-image/citrain-250u1 into lp:~ubuntu-managed-branches/ubuntu-system-image/system-image

[Barry Warsaw]

Fixes for LP: #1369717 and LP: #1370586

Fixes for LP: #1369717 and LP: #1370586

[lp:~barry/ubuntu-system-image/citrain-250u1]

241. By Barry Warsaw on 2014-09-29

Unrelease

=== modified file 'NEWS.rst'
--- NEWS.rst	2014-09-17 13:41:31 +0000
+++ NEWS.rst	2014-09-29 18:55:39 +0000
@@ -2,6 +2,13 @@
 NEWS for system-image updater
 =============================
 
+2.5 (2014-XX-XX)
+================
+ * Remove the previously deprecated `system-image-cli --dbus` command line
+   switch.  (LP: #1369717)
+ * Add a `target_build_number` key to the mapping returned by the
+   `.Information()` D-Bus method.  (LP: #1370586)
+
 2.4 (2014-09-16)
 ================
  * The channel.ini file can override the device name by setting

=== modified file 'PKG-INFO'
--- PKG-INFO	2014-09-17 02:59:15 +0000
+++ PKG-INFO	2014-09-29 18:55:39 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: system-image
-Version: 2.4
+Version: 2.5
 Summary: Ubuntu System Image Based Upgrades
 Home-page: UNKNOWN
 Author: Barry Warsaw

=== modified file 'dbus-manpage.rst'
--- dbus-manpage.rst	2014-07-23 22:51:19 +0000
+++ dbus-manpage.rst	2014-09-29 18:55:39 +0000
@@ -128,19 +128,28 @@
     This is a **synchronous** call which returns an extensible mapping of
     UTF-8 keys to UTF-8 values.  The following keys are currently defined:
 
-    * *current_build_number* - the current build number as an integer.
-    * *device_name* - the name of the device type.
-    * *channel_name* - the channel the device is currently on.
-    * *last_update_date* - the last time this device was updated as a
+    * *current_build_number* - The current build number as an integer.
+    * *target_build_number* - If an update is known to be available, this will
+      be the build number that an update will leave the device at.  If no
+      `CheckForUpdate()` has been previously performed, then the
+      *target_build_number* will be "-1".  If a previous check has been
+      performed, but no update is available (i.e., the device is already at
+      the latest version), then *target_build_number* will be the same as
+      *current_build_number*.
+    * *device_name* - The name of the device type.
+    * *channel_name* - The channel the device is currently on.
+    * *last_update_date* - The last time this device was updated as a
       datetime, e.g. "YYYY-MM-DDTHH:MM:SS"
-    * *version_detail* - a string containing a comma-separated list of
+    * *version_detail* - A string containing a comma-separated list of
       key-value pairs providing additional component version details,
       e.g. "ubuntu=123,mako=456,custom=789".
-    * *last_check_date* - the last time a ``CheckForUpdate()`` call was
+    * *last_check_date* - The last time a ``CheckForUpdate()`` call was
       performed.
 
     *New in system-image 2.3*
 
+    *New in system-image 2.5: target_build_number*
+
 ``FactoryReset()``
     This is a **synchronous** call which wipes the data partition and issue a
     reboot to recovery.  A ``Rebooting`` signal may be sent, depending on

=== modified file 'debian/changelog'
--- debian/changelog	2014-09-17 17:56:46 +0000
+++ debian/changelog	2014-09-29 18:55:39 +0000
@@ -1,3 +1,12 @@
+system-image (2.5-0ubuntu1) UNRELEASED; urgency=medium
+
+  * New upstream release.
+    - LP: #1369717 - Remove `system-image-cli --dbus` command line switch.
+    - LP: #1370586 - Add a `target_build_number` key to the mapping
+      returned by the `.Information()` D-Bus method.
+
+ -- Barry Warsaw <[e-mail]>  Fri, 26 Sep 2014 10:36:13 -0400
+
 system-image (2.4-0ubuntu1) utopic; urgency=medium
 
   [ Barry Warsaw ]

=== modified file 'setup.cfg'
--- setup.cfg	2014-09-17 13:41:31 +0000
+++ setup.cfg	2014-09-29 18:55:39 +0000
@@ -4,7 +4,7 @@
 logging-filter = systemimage
 
 [egg_info]
+tag_svn_revision = 0
 tag_build = 
 tag_date = 0
-tag_svn_revision = 0
 

=== modified file 'system_image.egg-info/PKG-INFO'
--- system_image.egg-info/PKG-INFO	2014-09-17 02:59:15 +0000
+++ system_image.egg-info/PKG-INFO	2014-09-29 18:55:39 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: system-image
-Version: 2.4
+Version: 2.5
 Summary: Ubuntu System Image Based Upgrades
 Home-page: UNKNOWN
 Author: Barry Warsaw

=== modified file 'system_image.egg-info/SOURCES.txt'
--- system_image.egg-info/SOURCES.txt	2014-09-17 02:59:15 +0000
+++ system_image.egg-info/SOURCES.txt	2014-09-29 18:55:39 +0000
@@ -18,7 +18,6 @@
 systemimage/__init__.py
 systemimage/api.py
 systemimage/bag.py
-systemimage/bindings.py
 systemimage/candidates.py
 systemimage/channel.py
 systemimage/config.py

=== removed file 'systemimage/bindings.py'
--- systemimage/bindings.py	2014-09-17 13:41:31 +0000
+++ systemimage/bindings.py	1970-01-01 00:00:00 +0000
@@ -1,98 +0,0 @@
-# Copyright (C) 2013-2014 Canonical Ltd.
-# Author: Barry Warsaw <[e-mail]>
-
-# 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/>.
-
-"""Helpers for when the command line script is used as a DBus client."""
-
-
-__all__ = [
-    'DBusClient',
-    'UASRecord',
-    ]
-
-
-import dbus
-import logging
-
-from collections import namedtuple
-from systemimage.reactor import Reactor
-
-log = logging.getLogger('systemimage')
-
-
-# Use a namedtuple for more convenient argument unpacking.
-UASRecord = namedtuple('UASRecord',
-    'is_available downloading available_version update_size '
-    'last_update_date error_reason')
-
-
-class DBusClient(Reactor):
-    """Python bindings to be used as a DBus client."""
-
-    def __init__(self):
-        super().__init__(dbus.SystemBus())
-        service = self._bus.get_object('com.canonical.SystemImage', '/Service')
-        self.iface = dbus.Interface(service, 'com.canonical.SystemImage')
-        self.react_to('UpdateAvailableStatus')
-        self.react_to('UpdateDownloaded')
-        self.react_to('UpdateFailed')
-        self.failed = False
-        self.is_available = False
-        self.downloaded = False
-
-    def _do_UpdateAvailableStatus(self, signal, path, *args):
-        payload = UASRecord(*args)
-        if payload.error_reason != '':              # pragma: no cover
-            # Cancel the download, set the failed flag and log the reason.
-            log.error('CheckForUpdate returned an error: {}',
-                      payload.error_reason)
-            self.failed = True
-            self.quit()
-            return
-        if not payload.is_available:
-            log.info('No update available')
-            self.quit()
-            return
-        if not payload.downloading:                 # pragma: no cover
-            # We should be in auto download mode, so why aren't we downloading
-            # the update?  Do it manually.
-            log.info('Update available, downloading manually')
-            self.iface.DownloadUpdate()
-        self.is_available = True
-
-    def _do_UpdateDownloaded(self, signal, path):
-        self.downloaded = True
-        self.quit()
-
-    def _do_UpdateFailed(self, signal, path,
-                         consecutive_failure_count, last_reason):
-        log.error('UpdateFailed: {}', last_reason)
-        self.failed = True
-        self.quit()
-
-    def check_for_update(self):
-        # Switch to auto-download mode for this run.
-        old_value = self.iface.GetSetting('auto_download')
-        self.iface.SetSetting('auto_download', '2')
-        self.schedule(self.iface.CheckForUpdate)
-        self.run()
-        self.iface.SetSetting('auto_download', old_value)
-
-    def _do_Rebooting(self, signal, path, status):
-        self.quit()
-
-    def reboot(self):
-        self.react_to('Rebooting')
-        self.schedule(self.iface.ApplyUpdate)
-        self.run()

=== modified file 'systemimage/dbus.py'
--- systemimage/dbus.py	2014-09-17 13:41:31 +0000
+++ systemimage/dbus.py	2014-09-29 18:55:39 +0000
@@ -334,14 +334,22 @@
     def Information(self):
         self._loop.keepalive()
         settings = Settings()
-        return dict(
-            current_build_number=str(config.build_number),
+        current_build_number = str(config.build_number)
+        response = dict(
+            current_build_number=current_build_number,
             device_name=config.device,
             channel_name=config.channel,
             last_update_date=last_update_date(),
             version_detail=getattr(config.service, 'version_detail', ''),
             last_check_date=settings.get('last_check_date'),
             )
+        if self._update is None:
+            response['target_build_number'] = '-1'
+        elif not self._update.is_available:
+            response['target_build_number'] = current_build_number
+        else:
+            response['target_build_number'] = str(self._update.version)
+        return response
 
     @log_and_exit
     @method('com.canonical.SystemImage', in_signature='ss')

=== modified file 'systemimage/main.py'
--- systemimage/main.py	2014-09-17 13:41:31 +0000
+++ systemimage/main.py	2014-09-29 18:55:39 +0000
@@ -25,11 +25,9 @@
 import sys
 import logging
 import argparse
-import warnings
 
 from dbus.mainloop.glib import DBusGMainLoop
 from pkg_resources import resource_string as resource_bytes
-from systemimage.bindings import DBusClient
 from systemimage.candidates import delta_filter, full_filter
 from systemimage.config import config
 from systemimage.helpers import last_update_date, makedirs, version_detail
@@ -72,9 +70,6 @@
     parser.add_argument('-d', '--device',
                         default=None, action='store',
                         help='Override the device name just this once')
-    parser.add_argument('--dbus',
-                        default=False, action='store_true',
-                        help='Run in D-Bus client mode.')
     parser.add_argument('-f', '--filter',
                         default=None, action='store',
                         help="""Filter the candidate paths to contain only
@@ -266,28 +261,6 @@
                 print('    {} (alias for: {})'.format(key, alias))
         return 0
 
-    # 2014-09-15 BAW: --dbus is deprecated (LP: #1369714) and will be removed
-    # in system-image 2.5 (LP: #1369717).
-    if args.dbus:                                   # pragma: no cover
-        print('WARNING: --dbus is deprecated and will be removed soon',
-              file=sys.stderr)
-        warnings.warn('--dbus is deprecated and will be removed soon',
-                      DeprecationWarning)
-        client = DBusClient()
-        client.check_for_update()
-        if not client.is_available:
-            log.info('No update is available')
-            return 0
-        if not client.downloaded:
-            log.info('No update was downloaded')
-            return 1
-        if client.failed:
-            log.info('Update failed')
-            return 2
-        client.reboot()
-        # We probably won't get here..
-        return 0
-
     # When verbosity is at 1, logging every progress signal from
     # ubuntu-download-manager would be way too noisy.  OTOH, not printing
     # anything leads some folks to think the process is just hung, since it

=== modified file 'systemimage/testing/dbus.py'
--- systemimage/testing/dbus.py	2014-09-17 13:41:31 +0000
+++ systemimage/testing/dbus.py	2014-09-29 18:55:39 +0000
@@ -334,6 +334,7 @@
         self._updated = '2099-08-01 04:45:45'
         self._version = 'ubuntu=123,mako=456,custom=789'
         self._checked = '2099-08-01 04:45:00'
+        self._target = 53
 
     @log_and_exit
     @method('com.canonical.SystemImage')
@@ -354,7 +355,8 @@
                     channel_name=self._channel,
                     last_update_date=self._updated,
                     version_detail=self._version,
-                    last_check_date=self._checked)
+                    last_check_date=self._checked,
+                    target_build_number=str(self._target))
 
 
 class _Crasher(Service):

=== modified file 'systemimage/testing/nose.py'
--- systemimage/testing/nose.py	2014-09-17 13:41:31 +0000
+++ systemimage/testing/nose.py	2014-09-29 18:55:39 +0000
@@ -22,7 +22,6 @@
 
 import re
 import atexit
-import logging
 
 from dbus.mainloop.glib import DBusGMainLoop
 from nose2.events import Plugin

=== modified file 'systemimage/tests/test_dbus.py'
--- systemimage/tests/test_dbus.py	2014-09-17 13:41:31 +0000
+++ systemimage/tests/test_dbus.py	2014-09-29 18:55:39 +0000
@@ -20,7 +20,6 @@
     'TestDBusCheckForUpdate',
     'TestDBusCheckForUpdateToUnwritablePartition',
     'TestDBusCheckForUpdateWithBrokenIndex',
-    'TestDBusClient',
     'TestDBusDownload',
     'TestDBusFactoryReset',
     'TestDBusGetSet',
@@ -51,11 +50,11 @@
 import unittest
 
 from contextlib import ExitStack, suppress
+from collections import namedtuple
 from datetime import datetime
 from dbus.exceptions import DBusException
 from functools import partial
 from pathlib import Path
-from systemimage.bindings import DBusClient, UASRecord
 from systemimage.config import Configuration
 from systemimage.helpers import MiB, atomic, safe_remove
 from systemimage.reactor import Reactor
@@ -66,6 +65,12 @@
 from systemimage.testing.nose import SystemImagePlugin
 
 
+# Use a namedtuple for more convenient argument unpacking.
+UASRecord = namedtuple('UASRecord',
+    'is_available downloading available_version update_size '
+    'last_update_date error_reason')
+
+
 class SignalCapturingReactor(Reactor):
     def __init__(self, *signals):
         super().__init__(dbus.SystemBus())
@@ -1097,48 +1102,6 @@
         self.assertIsNotNone(reactor.status)
 
 
-class TestDBusClient(_LiveTesting):
-    """Test the DBus client (used with --dbus)."""
-
-    def setUp(self):
-        super().setUp()
-        self._client = DBusClient()
-
-    def test_check_for_update(self):
-        # There is an update available.
-        self._client.check_for_update()
-        self.assertTrue(self._client.is_available)
-        self.assertTrue(self._client.downloaded)
-
-    def test_check_for_no_update(self):
-        # There is no update available.
-        self._touch_build(1701)
-        self._client.check_for_update()
-        self.assertFalse(self._client.is_available)
-        self.assertFalse(self._client.downloaded)
-
-    def test_update_failed(self):
-        # For some reason <wink>, the update fails.
-        #
-        # Cause the update to fail by deleting a file from the server.
-        os.remove(os.path.join(SystemImagePlugin.controller.serverdir,
-                               '4/5/6.txt.asc'))
-        self._client.check_for_update()
-        self.assertTrue(self._client.is_available)
-        self.assertFalse(self._client.downloaded)
-        self.assertTrue(self._client.failed)
-
-    def test_reboot(self):
-        # After a successful update, we can reboot.
-        self._client.check_for_update()
-        self.assertTrue(self._client.is_available)
-        self.assertTrue(self._client.downloaded)
-        self._client.reboot()
-        with open(self.reboot_log, encoding='utf-8') as fp:
-            reboot = fp.read()
-        self.assertEqual(reboot, '/sbin/reboot -f recovery')
-
-
 class TestDBusRegressions(_LiveTesting):
     """Test that various regressions have been fixed."""
 
@@ -1355,9 +1318,11 @@
                 'device_name',
                 'last_check_date',
                 'last_update_date',
+                'target_build_number',
                 'version_detail',
                 ])
         self.assertEqual(response['current_build_number'], '45')
+        self.assertEqual(response['target_build_number'], '53')
         self.assertEqual(response['device_name'], 'nexus11')
         self.assertEqual(response['channel_name'], 'daily-proposed')
         self.assertEqual(response['last_update_date'], '2099-08-01 04:45:45')
@@ -1388,6 +1353,7 @@
         self.assertEqual(response['last_update_date'], '2022-08-01 04:45:45')
         self.assertEqual(response['version_detail'], '')
         self.assertEqual(response['last_check_date'], '')
+        self.assertEqual(response['target_build_number'], '-1')
 
     def test_information_no_details(self):
         # .Information() where there is no channel.ini with version details,
@@ -1414,6 +1380,7 @@
         self.assertEqual(response['last_update_date'], '2022-08-01 04:45:45')
         self.assertEqual(response['version_detail'], '')
         self.assertEqual(response['last_check_date'], '2055-08-01 21:12:00')
+        self.assertEqual(response['target_build_number'], '1600')
 
     def test_information(self):
         # .Information() where there is a channel.ini with version details,
@@ -1453,6 +1420,31 @@
         # in a robust way.  E.g. what if we just happen to be at 12:59:59 on
         # December 31st?  Let's at least make sure it has a sane format.
         self.assertRegex(response['last_check_date'], '2055-08-01 21:12:01')
+        self.assertEqual(response['target_build_number'], '1600')
+
+    def test_information_no_update_available(self):
+        # .Information() where we know that no update is available, gives us a
+        # target build number equal to the current build number.
+        self._touch_build(1701)
+        reactor = SignalCapturingReactor('UpdateAvailableStatus')
+        reactor.run(self.iface.CheckForUpdate)
+        signal = reactor.signals[0]
+        self.assertEqual(signal.available_version, '')
+        response = self.iface.Information()
+        self.assertEqual(response['target_build_number'], '1701')
+
+    def test_information_workflow(self):
+        # At first, .Information() won't know whether there is an update
+        # available or not.  Then we check, and it tells us there is one.
+        self._touch_build(45)
+        response = self.iface.Information()
+        self.assertEqual(response['target_build_number'], '-1')
+        reactor = SignalCapturingReactor('UpdateAvailableStatus')
+        reactor.run(self.iface.CheckForUpdate)
+        signal = reactor.signals[0]
+        self.assertEqual(signal.available_version, '1600')
+        response = self.iface.Information()
+        self.assertEqual(response['target_build_number'], '1600')
 
 
 class TestLiveDBusInfoWithChannelIni(_LiveTesting):

=== modified file 'systemimage/version.txt'
--- systemimage/version.txt	2014-09-17 13:41:31 +0000
+++ systemimage/version.txt	2014-09-29 18:55:39 +0000
@@ -1,1 +1,1 @@
-2.4
+2.5