Merge lp:~barry/ubuntu-system-image/citrain301 into lp:~ubuntu-managed-branches/ubuntu-system-image/system-image

[Barry Warsaw]

system-image 3.0.1

  * New upstream release.
    - LP: #1463061 - When `--progress=json` is used, print an error record
      to stdout if the state machine fails.
  * d/control: XS-Testsuite -> Testsuite
  * d/tests
    - control: Re-enable smoketests.
    - 00_default.ini.in: Fix path to archive-master keyring.

[lp:~barry/ubuntu-system-image/citrain301]

245. By Barry Warsaw on 2015-06-17

No change version bump for PPA wackiness

246. By Barry Warsaw on 2015-06-17

It wasn't a version problem

247. By Barry Warsaw on 2015-06-18

* d/control:
  - XS-Testsuite -> Testsuite
  - Bump debhelper to version 9.
  - wrap-and-sort -a -t
* d/compat: Bump to version 9.
* .bzr-builddeb/default.conf: Split packaging.

248. By Barry Warsaw on 2015-06-18

No split packaging

=== modified file 'NEWS.rst'
--- NEWS.rst	2015-05-08 21:41:15 +0000
+++ NEWS.rst	2015-06-18 14:03:53 +0000
@@ -2,6 +2,11 @@
 NEWS for system-image updater
 =============================
 
+3.0.1 (2015-06-16)
+==================
+ * When `--progress=json` is used, print an error record to stdout if the
+   state machine fails.  (LP: #1463061)
+
 3.0 (2015-05-08)
 ================
  * Support a built-in PyCURL-based downloader in addition to the traditional

=== modified file 'PKG-INFO'
--- PKG-INFO	2015-05-08 21:41:15 +0000
+++ PKG-INFO	2015-06-18 14:03:53 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: system-image
-Version: 3.0
+Version: 3.0.1
 Summary: Ubuntu System Image Based Upgrades
 Home-page: UNKNOWN
 Author: Barry Warsaw

=== modified file 'debian/changelog'
--- debian/changelog	2015-05-20 15:04:21 +0000
+++ debian/changelog	2015-06-18 14:03:53 +0000
@@ -1,3 +1,19 @@
+system-image (3.0.1-0ubuntu1) wily; urgency=medium
+
+  * New upstream release.
+    - LP: #1463061 - When `--progress=json` is used, print an error record
+      to stdout if the state machine fails.
+  * d/control:
+    - XS-Testsuite -> Testsuite
+    - Bump debhelper to version 9.
+    - wrap-and-sort -a -t
+  * d/compat: Bump to version 9.
+  * d/tests
+    - control: Re-enable smoketests.
+    - 00_default.ini.in: Fix path to archive-master keyring.
+
+ -- Barry Warsaw <[e-mail]>  Wed, 17 Jun 2015 11:16:10 -0400
+
 system-image (3.0-0ubuntu2) wily; urgency=medium
 
   [ Barry Warsaw ]

=== modified file 'debian/compat'
--- debian/compat	2013-12-13 13:55:51 +0000
+++ debian/compat	2015-06-18 14:03:53 +0000
@@ -1,1 +1,1 @@
-8
+9

=== modified file 'debian/control'
--- debian/control	2015-05-09 16:57:53 +0000
+++ debian/control	2015-06-18 14:03:53 +0000
@@ -6,7 +6,7 @@
 Priority: optional
 Build-Depends: dbus,
                dbus-x11,
-               debhelper (>= 8),
+               debhelper (>= 9),
                dh-python,
                python-docutils,
                python3-all (>= 3.3),
@@ -19,9 +19,9 @@
                python3-pycurl,
                python3-setuptools,
                python3-xdg,
-               ubuntu-download-manager
+               ubuntu-download-manager,
 Standards-Version: 3.9.6
-XS-Testsuite: autopkgtest
+Testsuite: autopkgtest
 Vcs-Bzr: https://code.launchpad.net/~ubuntu-managed-branches/ubuntu-system-image/system-image
 Vcs-Browser: http://bazaar.launchpad.net/~ubuntu-managed-branches/ubuntu-system-image/system-image/files
 X-Auto-Uploader: no-rewrite-version
@@ -30,7 +30,7 @@
 Architecture: all
 Depends: system-image-common (= ${binary:Version}),
          ${misc:Depends},
-         ${python3:Depends}
+         ${python3:Depends},
 Description: Ubuntu system image updater command line client
  This is the command line client for the Ubuntu system image updater.
 
@@ -38,7 +38,7 @@
 Architecture: all
 Depends: system-image-common (= ${binary:Version}),
          ${misc:Depends},
-         ${python3:Depends}
+         ${python3:Depends},
 Description: Ubuntu system image updater command line client
  This is the command line client for the Ubuntu system image updater.
 
@@ -51,13 +51,16 @@
          python3-xdg,
          ubuntu-download-manager | python3-pycurl,
          ${misc:Depends},
-         ${python3:Depends}
+         ${python3:Depends},
 Description: Ubuntu system image updater
  This is the common bits for the Ubuntu system image updater.
 
 Package: system-image-dev
 Architecture: all
-Depends: python3-gnupg, python3-psutil, ${misc:Depends}, ${python3:Depends}
+Depends: python3-gnupg,
+         python3-psutil,
+         ${misc:Depends},
+         ${python3:Depends},
 Description: Ubuntu system image updater development
  This is the development bits for the Ubuntu system image updater.
  Install this package if you want to run the tests.

=== modified file 'debian/tests/00_default.ini.in'
--- debian/tests/00_default.ini.in	2015-05-19 20:27:26 +0000
+++ debian/tests/00_default.ini.in	2015-06-18 14:03:53 +0000
@@ -16,7 +16,7 @@
 settings_db: {TMPDIR}/settings.db
 
 [gpg]
-archive_master: /etc/system-image/archive-master.tar.xz
+archive_master: /usr/share/system-image/archive-master.tar.xz
 image_master: {TMPDIR}/image-master.tar.xz
 image_signing: {TMPDIR}/image-signing.tar.xz
 device_signing: {TMPDIR}/device-signing.tar.xz

=== modified file 'debian/tests/control'
--- debian/tests/control	2015-05-20 14:46:42 +0000
+++ debian/tests/control	2015-06-18 14:03:53 +0000
@@ -1,10 +1,10 @@
-#Tests: smoketest
-#Restrictions: isolation-container
-#Depends: system-image-common, system-image-cli, system-image-dbus, ubuntu-download-manager, dbus, dbus-x11, python3-psutil, python3-xdg, python3-pycurl
+Tests: smoketest
+Restrictions: isolation-container
+Depends: system-image-common, system-image-cli, system-image-dbus, ubuntu-download-manager, dbus, dbus-x11, python3-psutil, python3-xdg, python3-pycurl
 
-#Tests: smoketest-noreboot
-#Restrictions: isolation-container allow-stderr
-#Depends: system-image-common, system-image-cli, system-image-dbus, ubuntu-download-manager, dbus, dbus-x11, python3-psutil, python3-xdg, python3-pycurl
+Tests: smoketest-noreboot
+Restrictions: isolation-container allow-stderr
+Depends: system-image-common, system-image-cli, system-image-dbus, ubuntu-download-manager, dbus, dbus-x11, python3-psutil, python3-xdg, python3-pycurl
 
 Tests: dryrun
 Restrictions: allow-stderr

=== modified file 'setup.cfg'
--- setup.cfg	2015-05-08 21:41:15 +0000
+++ setup.cfg	2015-06-18 14:03:53 +0000
@@ -4,7 +4,7 @@
 logging-filter = systemimage
 
 [egg_info]
-tag_build = 
 tag_date = 0
 tag_svn_revision = 0
+tag_build = 
 

=== modified file 'system_image.egg-info/PKG-INFO'
--- system_image.egg-info/PKG-INFO	2015-05-08 21:41:15 +0000
+++ system_image.egg-info/PKG-INFO	2015-06-18 14:03:53 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: system-image
-Version: 3.0
+Version: 3.0.1
 Summary: Ubuntu System Image Based Upgrades
 Home-page: UNKNOWN
 Author: Barry Warsaw

=== modified file 'systemimage/main.py'
--- systemimage/main.py	2015-05-08 21:41:15 +0000
+++ systemimage/main.py	2015-06-18 14:03:53 +0000
@@ -92,7 +92,7 @@
     parser.add_argument('-C', '--config',
                         default=DEFAULT_CONFIG_D, action='store',
                         metavar='DIRECTORY',
-                        help="""Use the given configuration directory instead 
+                        help="""Use the given configuration directory instead
                                 of the default""")
     parser.add_argument('-b', '--build',
                         default=None, action='store',
@@ -387,10 +387,17 @@
                 list(state)
         except KeyboardInterrupt:                   # pragma: no cover
             return 0
-        except Exception:
+        except Exception as error:
             print('Exception occurred during update; see log file for details',
                   file=sys.stderr)
             log.exception('system-image-cli exception')
+            # This is a little bit of a hack because it's not generalized to
+            # all values of --progress.  But OTOH, we always want to log the
+            # error, so --progress=logfile is redundant, and --progress=dots
+            # doesn't make much sense either.  Just just include some JSON
+            # output if --progress=json was specified.
+            if 'json' in args.progress:
+                print(json.dumps(dict(type='error', msg=str(error))))
             return 1
         else:
             return 0

=== modified file 'systemimage/testing/helpers.py'
--- systemimage/testing/helpers.py	2015-05-08 21:41:15 +0000
+++ systemimage/testing/helpers.py	2015-06-18 14:03:53 +0000
@@ -587,9 +587,7 @@
         except:
             self._resources.close()
             raise
-
-    def tearDown(self):
-        self._resources.close()
+        self.addCleanup(self._resources.close)
 
     def _setup_server_keyrings(self, *, device_signing=True):
         # Only the archive-master key is pre-loaded.  All the other keys

=== modified file 'systemimage/tests/test_main.py'
--- systemimage/tests/test_main.py	2015-05-08 21:41:15 +0000
+++ systemimage/tests/test_main.py	2015-06-18 14:03:53 +0000
@@ -122,10 +122,7 @@
         except:
             self._resources.close()
             raise
-
-    def tearDown(self):
-        self._resources.close()
-        super().tearDown()
+        self.addCleanup(self._resources.close)
 
     def test_config_directory_good_path(self):
         # The default configuration directory exists.
@@ -1062,10 +1059,7 @@
         except:
             self._resources.close()
             raise
-
-    def tearDown(self):
-        self._resources.close()
-        super().tearDown()
+        self.addCleanup(self._resources.close)
 
     @configuration
     def test_show_settings(self, config_d):
@@ -1218,12 +1212,12 @@
 class TestDBusMain(unittest.TestCase):
     def setUp(self):
         super().setUp()
-        self._stack = ExitStack()
+        self._resources = ExitStack()
         try:
             SystemImagePlugin.controller.set_mode()
             config_d = SystemImagePlugin.controller.ini_path
             override = os.path.join(config_d, '06_override.ini')
-            self._stack.callback(safe_remove, override)
+            self._resources.callback(safe_remove, override)
             with open(override, 'w', encoding='utf-8') as fp:
                 print('[dbus]\nlifetime: 3s\n', file=fp)
             # The testing framework will have caused system-image-dbus to be
@@ -1231,14 +1225,10 @@
             # let's be sure to stop it.
             terminate_service()
         except:
-            self._stack.close()
+            self._resources.close()
             raise
-
-    def tearDown(self):
-        try:
-            terminate_service()
-        finally:
-            self._stack.close()
+        self.addCleanup(terminate_service)
+        self.addCleanup(self._resources.close)
 
     def _activate(self):
         # Re-start and reload the D-Bus service.
@@ -1485,39 +1475,50 @@
     CHANNEL = 'stable'
     DEVICE = 'nexus7'
 
+    def setUp(self):
+        super().setUp()
+        # Use a private name to avoid conflicts with the superclass attribute.
+        self.__resources = ExitStack()
+        try:
+            self._stdout = StringIO()
+            self._stderr = StringIO()
+            # Some output uses print() and others use sys.stdout.write().  Be
+            # sure to capture them both to the same object.
+            self.__resources.enter_context(capture_print(self._stdout))
+            self.__resources.enter_context(
+                patch('systemimage.main.sys.stdout', self._stdout))
+            self.__resources.enter_context(
+                patch('systemimage.main.sys.stderr', self._stderr))
+        except:
+            self.__resources.close()
+            raise
+        self.addCleanup(self.__resources.close)
+
     @configuration
     def test_dots_progress(self, config_d):
         # --progress=dots prints a bunch of dots to stderr.
         self._setup_server_keyrings()
-        stderr = StringIO()
         with ExitStack() as resources:
             resources.enter_context(
                 patch('systemimage.main.LINE_LENGTH', 10))
             resources.enter_context(
-                patch('systemimage.main.sys.stderr', stderr))
-            resources.enter_context(
                 argv('-C', config_d, '-b', '0', '--no-reboot',
                      '--progress', 'dots'))
             cli_main()
         # There should be some dots in the stderr.
-        self.assertGreater(stderr.getvalue().count('.'), 2)
+        self.assertGreater(self._stderr.getvalue().count('.'), 2)
 
     @configuration
     def test_json_progress(self, config_d):
         # --progress=json prints some JSON to stdout.
         self._setup_server_keyrings()
-        stdout = StringIO()
-        with ExitStack() as resources:
-            resources.enter_context(
-                patch('systemimage.main.sys.stdout', stdout))
-            resources.enter_context(
-                argv('-C', config_d, '-b', '0', '--no-reboot',
-                     '--progress', 'json'))
+        with argv('-C', config_d, '-b', '0', '--no-reboot',
+                  '--progress', 'json'):
             cli_main()
         # stdout is now filled with JSON goodness.  We can't assert too much
         # about the contents though.
         line_count = 0
-        for line in stdout.getvalue().splitlines():
+        for line in self._stdout.getvalue().splitlines():
             line_count += 1
             record = json.loads(line)
             self.assertEqual(record['type'], 'progress')
@@ -1550,8 +1551,6 @@
     def test_all_progress(self, config_d):
         # We can have more than one --progress flag.
         self._setup_server_keyrings()
-        stdout = StringIO()
-        stderr = StringIO()
         log_mock = MagicMock()
         from systemimage.main import _LogfileProgress
         class Testable(_LogfileProgress):
@@ -1562,10 +1561,6 @@
             resources.enter_context(
                 patch('systemimage.main.LINE_LENGTH', 10))
             resources.enter_context(
-                patch('systemimage.main.sys.stderr', stderr))
-            resources.enter_context(
-                patch('systemimage.main.sys.stdout', stdout))
-            resources.enter_context(
                 patch('systemimage.main._LogfileProgress', Testable))
             resources.enter_context(
                 argv('-C', config_d, '-b', '0', '--no-reboot',
@@ -1573,9 +1568,9 @@
                      '--progress', 'json',
                      '--progress', 'logfile'))
             cli_main()
-        self.assertGreater(stderr.getvalue().count('.'), 2)
+        self.assertGreater(self._stderr.getvalue().count('.'), 2)
         line_count = 0
-        for line in stdout.getvalue().splitlines():
+        for line in self._stdout.getvalue().splitlines():
             line_count += 1
             record = json.loads(line)
             self.assertEqual(record['type'], 'progress')
@@ -1589,17 +1584,57 @@
     @configuration
     def test_bad_progress(self, config_d):
         # An unknown progress type results in an error.
-        stderr = StringIO()
         with ExitStack() as resources:
             resources.enter_context(
-                patch('systemimage.main.sys.stderr', stderr))
-            resources.enter_context(
                 argv('-C', config_d, '-b', '0', '--no-reboot',
                      '--progress', 'not-a-meter'))
-            with self.assertRaises(SystemExit) as cm:
-                cli_main()
-            exit_code = cm.exception.code
-        self.assertEqual(exit_code, 2)
+            cm = resources.enter_context(self.assertRaises(SystemExit))
+            cli_main()
+        self.assertEqual(cm.exception.code, 2)
         self.assertEqual(
-            stderr.getvalue().splitlines()[-1],
+            self._stderr.getvalue().splitlines()[-1],
             'system-image-cli: error: Unknown progress meter: not-a-meter')
+
+    @configuration
+    def test_json_progress_errors(self, config):
+        # When an error occurs in the state machine, --progress=json should
+        # produce some client-consumable output.  LP: #1463061
+        self._setup_server_keyrings()
+        with ExitStack() as resources:
+            resources.enter_context(
+                argv('-C', config.config_d, '-b', '0', '--no-reboot',
+                     '--progress', 'json'))
+            # It's maybe not the best thing to hook into a private
+            # implementation function in order to cause the state machine to
+            # fail, but it's expedient and works with both downloaders.
+            resources.enter_context(
+                patch('systemimage.state._copy_if_missing',
+                      side_effect=RuntimeError('Bad things!')))
+            exit_code = cli_main()
+        self.assertEqual(exit_code, 1)
+        # stdout is now filled with JSON progress.  The last line should be
+        # the error record.
+        lines = self._stdout.getvalue().splitlines()
+        record = json.loads(lines[-1])
+        self.assertEqual(record['type'], 'error', lines)
+        self.assertEqual(record['msg'], 'Bad things!')
+
+    @configuration
+    def test_no_json_progress_errors(self, config):
+        # Like above, but without --progress=json.
+        self._setup_server_keyrings()
+        with ExitStack() as resources:
+            resources.enter_context(
+                argv('-C', config.config_d, '-b', '0', '--no-reboot'))
+            # It's maybe not the best thing to hook into a private
+            # implementation function in order to cause the state machine to
+            # fail, but it's expedient and works with both downloaders.
+            resources.enter_context(
+                patch('systemimage.state._copy_if_missing',
+                      side_effect=RuntimeError))
+            exit_code = cli_main()
+        self.assertEqual(exit_code, 1)
+        # stdout is now filled with JSON progress.  The last line should be
+        # the error record.
+        lines = self._stdout.getvalue().splitlines()
+        self.assertEqual(len(lines), 0)

=== modified file 'systemimage/version.txt'
--- systemimage/version.txt	2015-05-08 21:41:15 +0000
+++ systemimage/version.txt	2015-06-18 14:03:53 +0000
@@ -1,1 +1,1 @@
-3.0
+3.0.1