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

[Barry Warsaw]

LP: #1349478

2.3.2 (2014-07-31)
==================
 * When system-image-{cli,dbus} is run as non-root, use a fallback location
   for the settings.db file, if the parent directory isn't writable.
   (LP: #1349478)

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

236. By Barry Warsaw on 2014-08-01

* d/control:
  - Bump X-Python3-Version to (Python) 3.4.
  - Update run-time dependencies so that system-image-common now depends
    on python3-dbus and python3-xdg, while -dbus and -cli only need to
    depend on system-image-common.

237. By Barry Warsaw on 2014-08-01

bump version number for ppa happiness

=== modified file 'NEWS.rst'
--- NEWS.rst	2014-07-23 22:51:19 +0000
+++ NEWS.rst	2014-08-01 18:33:04 +0000
@@ -2,6 +2,12 @@
 NEWS for system-image updater
 =============================
 
+2.3.2 (2014-07-31)
+==================
+ * When system-image-{cli,dbus} is run as non-root, use a fallback location
+   for the settings.db file, if the parent directory isn't writable.
+   (LP: #1349478)
+
 2.3.1 (2014-07-23)
 ==================
  * Fix a traceback that occurs when the `systemimage.testing` subpackage isn't

=== modified file 'PKG-INFO'
--- PKG-INFO	2014-07-23 17:56:24 +0000
+++ PKG-INFO	2014-08-01 18:33:04 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: system-image
-Version: 2.3.1
+Version: 2.3.2
 Summary: Ubuntu System Image Based Upgrades
 Home-page: UNKNOWN
 Author: Barry Warsaw

=== modified file 'debian/changelog'
--- debian/changelog	2014-07-23 23:07:39 +0000
+++ debian/changelog	2014-08-01 18:33:04 +0000
@@ -1,3 +1,17 @@
+system-image (2.3.2-0ubuntu2) UNRELEASED; urgency=medium
+
+  * New upstream release.
+    - LP: #1349478 - When system-image-{cli,dbus} is run as non-root, use
+      a fallback location for the settings.db file, if the parent
+      directory isn't writable.
+  * d/control:
+    - Bump X-Python3-Version to (Python) 3.4.
+    - Update run-time dependencies so that system-image-common now depends
+      on python3-dbus and python3-xdg, while -dbus and -cli only need to
+      depend on system-image-common.
+
+ -- Barry Warsaw <[e-mail]>  Fri, 01 Aug 2014 14:32:02 -0400
+
 system-image (2.3.1-0ubuntu1) utopic; urgency=medium
 
   [ Barry Warsaw ]

=== modified file 'debian/control'
--- debian/control	2014-07-17 18:11:57 +0000
+++ debian/control	2014-08-01 18:33:04 +0000
@@ -2,7 +2,7 @@
 Maintainer: Barry Warsaw <[e-mail]>
 Homepage: https://wiki.ubuntu.com/ImageBasedUpgrades
 Section: python
-X-Python3-Version: >= 3.3
+X-Python3-Version: >= 3.4
 Priority: optional
 Build-Depends: dbus,
                dbus-x11,
@@ -36,18 +36,19 @@
 
 Package: system-image-dbus
 Architecture: all
+Depends: system-image-common (= ${binary:Version}),
+         ${misc:Depends},
+         ${python3:Depends}
+Description: Ubuntu system image updater command line client
+ This is the command line client for the Ubuntu system image updater.
+
+Package: system-image-common
+Architecture: all
 Depends: python3-dbus,
          python3-gi,
-         system-image-common (= ${binary:Version}),
-         ${misc:Depends},
-         ${python3:Depends}
-Description: Ubuntu system image updater command line client
- This is the command line client for the Ubuntu system image updater.
-
-Package: system-image-common
-Architecture: all
-Depends: python3-gnupg,
+         python3-gnupg,
          python3-pkg-resources,
+         python3-xdg,
          ubuntu-download-manager,
          ${misc:Depends},
          ${python3:Depends}

=== modified file 'setup.cfg'
--- setup.cfg	2014-07-23 22:51:19 +0000
+++ setup.cfg	2014-08-01 18:33:04 +0000
@@ -4,7 +4,7 @@
 logging-filter = systemimage
 
 [egg_info]
+tag_svn_revision = 0
 tag_date = 0
 tag_build = 
-tag_svn_revision = 0
 

=== modified file 'system_image.egg-info/PKG-INFO'
--- system_image.egg-info/PKG-INFO	2014-07-23 17:56:24 +0000
+++ system_image.egg-info/PKG-INFO	2014-08-01 18:33:04 +0000
@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: system-image
-Version: 2.3.1
+Version: 2.3.2
 Summary: Ubuntu System Image Based Upgrades
 Home-page: UNKNOWN
 Author: Barry Warsaw

=== modified file 'systemimage/settings.py'
--- systemimage/settings.py	2014-07-23 22:51:19 +0000
+++ systemimage/settings.py	2014-08-01 18:33:04 +0000
@@ -23,7 +23,9 @@
 import sqlite3
 
 from contextlib import contextmanager
+from pathlib import Path
 from systemimage.config import config
+from xdg.BaseDirectory import xdg_cache_home
 
 SCHEMA_VERSION = '1'
 AUTO_DOWNLOAD_DEFAULT = '1'
@@ -32,7 +34,16 @@
 class Settings:
     def __init__(self, use_config=None):
         self._use_config = use_config
-        # If the database file does not yet exist, create it.
+        # If the database file does not yet exist, create it.  This could fail,
+        # as LP: #1349478 describes, if the parent directory containing
+        # settings.db is not writable by the process.  In that case, fall back
+        # to a user path.
+        self._dbpath = None
+        try:
+            with self._cursor():
+                pass
+        except sqlite3.OperationalError:
+            self._check_fallback()
         with self._cursor() as c:
             c.execute('select tbl_name from sqlite_master')
             if len(c.fetchall()) == 0:
@@ -43,12 +54,24 @@
             c.execute('insert into settings values ("__version__", ?)',
                       (SCHEMA_VERSION,))
 
+    def _check_fallback(self):
+        # This is refactored into a separate method for testing purposes.
+        self._dbpath = Path(xdg_cache_home) / 'lib' / 'settings.db'
+        try:
+            self._dbpath.parent.mkdir(parents=True)
+        except FileExistsError:
+            # http://bugs.python.org/issue21539
+            pass
+        with self._cursor():
+            pass
+
     @contextmanager
     def _cursor(self):
-        dbpath = (config.system.settings_db
-                  if self._use_config is None
-                  else self._use_config.system.settings_db)
-        with sqlite3.connect(dbpath) as conn:
+        if self._dbpath is None:
+            self._dbpath = (config.system.settings_db
+                            if self._use_config is None
+                            else self._use_config.system.settings_db)
+        with sqlite3.connect(str(self._dbpath)) as conn:
             yield conn.cursor()
 
     def set(self, key, value):

=== modified file 'systemimage/tests/test_config.py'
--- systemimage/tests/test_config.py	2014-07-23 22:51:19 +0000
+++ systemimage/tests/test_config.py	2014-08-01 18:33:04 +0000
@@ -28,7 +28,7 @@
 
 from datetime import timedelta
 from pkg_resources import resource_filename
-from subprocess import check_output
+from subprocess import CalledProcessError, check_output
 from systemimage.config import Configuration
 from systemimage.device import SystemProperty
 from systemimage.reboot import Reboot
@@ -198,7 +198,10 @@
         config = Configuration()
         # Silence the log exceptions this will provoke.
         with patch('systemimage.device.logging.getLogger'):
-            self.assertEqual(config.device, '?')
+            # It's possible getprop actually does exist on the system.
+            with patch('systemimage.device.check_output',
+                       side_effect=CalledProcessError(1, 'ignore')):
+                self.assertEqual(config.device, '?')
 
     @configuration
     def test_get_channel(self, ini_file):

=== modified file 'systemimage/tests/test_settings.py'
--- systemimage/tests/test_settings.py	2014-07-23 22:51:19 +0000
+++ systemimage/tests/test_settings.py	2014-08-01 18:33:04 +0000
@@ -23,9 +23,13 @@
 import os
 import unittest
 
+from contextlib import ExitStack
+from pathlib import Path
 from systemimage.config import Configuration
+from systemimage.helpers import temporary_directory
 from systemimage.settings import Settings
-from systemimage.testing.helpers import configuration
+from systemimage.testing.helpers import chmod, configuration
+from unittest.mock import patch
 
 
 class TestSettings(unittest.TestCase):
@@ -99,3 +103,30 @@
         keyval = list(settings)
         keyval.sort()
         self.assertEqual(keyval, [('a', 'ant'), ('b', 'bee'), ('c', 'cat')])
+
+    @configuration
+    def test_settings_db_permission_denied(self, ini_file):
+        # LP: #1349478 - some tests are run as non-root, meaning they don't
+        # have write permission to /var/lib/system-image.  This is where
+        # settings.db gets created, but if the process can't create files
+        # there, we get a sqlite3 exception.
+        config = Configuration(ini_file)
+        db_file = Path(config.system.settings_db)
+        self.assertFalse(db_file.exists())
+        with ExitStack() as resources:
+            resources.enter_context(chmod(str(db_file.parent), 0o555))
+            # With no fallback, this will fail.
+            with patch('systemimage.settings.Settings._check_fallback',
+                       side_effect=RuntimeError):
+                self.assertRaises(RuntimeError, Settings)
+            # Now, set the XDG cache directory to a temporary directory, allow
+            # the fallback to work and try again.
+            tmpdir = resources.enter_context(temporary_directory())
+            resources.enter_context(
+                patch('systemimage.settings.xdg_cache_home', tmpdir))
+            settings = Settings()
+            settings.set('bar', 'baz')
+            self.assertEqual(Settings().get('bar'), 'baz')
+        # The settings.db file still doesn't exist because it got
+        # created in a different place.
+        self.assertFalse(db_file.exists())

=== modified file 'systemimage/version.txt'
--- systemimage/version.txt	2014-07-23 22:51:19 +0000
+++ systemimage/version.txt	2014-08-01 18:33:04 +0000
@@ -1,1 +1,1 @@
-2.3.1
+2.3.2