Merge lp:~corey.bryant/charm-helpers/action-managed-upgrade into lp:charm-helpers

[Corey Bryant]

[lp:~corey.bryant/charm-helpers/action-managed-upgrade]

453. By Corey Bryant on 2015-09-14

call upgrade_callback

454. By Corey Bryant on 2015-09-15

unit tests for do_action_openstack_upgrade()

455. By Corey Bryant on 2015-09-15

more unit test updates

456. By Corey Bryant on 2015-09-15

Merge charm-helpers trunk

[James Page (james-page)]

Corey

This all looks OK to me, but it currently conflicts with head of charm-helpers due to the landing of the service status work.

Please can you rebase, and then +1

review: Approve

[lp:~corey.bryant/charm-helpers/action-managed-upgrade]

457. By Corey Bryant on 2015-09-16

Drop action-managed upgrade code temporarily for merge

458. By Corey Bryant on 2015-09-16

Sync charm-helpers trunk

459. By Corey Bryant on 2015-09-16

Add action-managed upgrade code after merge

460. By Corey Bryant on 2015-09-16

Fix up test_openstack_upgrade_traceback()

=== modified file 'charmhelpers/contrib/openstack/utils.py'
--- charmhelpers/contrib/openstack/utils.py	2015-09-15 17:52:15 +0000
+++ charmhelpers/contrib/openstack/utils.py	2015-09-16 15:03:29 +0000
@@ -25,6 +25,7 @@
 import re
 
 import six
+import traceback
 import yaml
 
 from charmhelpers.contrib.network import ip
@@ -34,6 +35,8 @@
 )
 
 from charmhelpers.core.hookenv import (
+    action_fail,
+    action_set,
     config,
     log as juju_log,
     charm_dir,
@@ -921,3 +924,47 @@
     for i in incomplete_relations:
         incomplete_context_data[i] = configs.get_incomplete_context_data(required_interfaces[i])
     return incomplete_context_data
+
+
+def do_action_openstack_upgrade(package, upgrade_callback, configs):
+    """Perform action-managed OpenStack upgrade.
+
+    Upgrades packages to the configured openstack-origin version and sets
+    the corresponding action status as a result.
+
+    If the charm was installed from source we cannot upgrade it.
+    For backwards compatibility a config flag (action-managed-upgrade) must
+    be set for this code to run, otherwise a full service level upgrade will
+    fire on config-changed.
+
+    @param package: package name for determining if upgrade available
+    @param upgrade_callback: function callback to charm's upgrade function
+    @param configs: templating object derived from OSConfigRenderer class
+
+    @return: True if upgrade successful; False if upgrade failed or skipped
+    """
+    ret = False
+
+    if git_install_requested():
+        action_set({'outcome': 'installed from source, skipped upgrade.'})
+    else:
+        if openstack_upgrade_available(package):
+            if config('action-managed-upgrade'):
+                juju_log('Upgrading OpenStack release')
+
+                try:
+                    upgrade_callback(configs=configs)
+                    action_set({'outcome': 'success, upgrade completed.'})
+                    ret = True
+                except:
+                    action_set({'outcome': 'upgrade failed, see traceback.'})
+                    action_set({'traceback': traceback.format_exc()})
+                    action_fail('do_openstack_upgrade resulted in an '
+                                'unexpected error')
+            else:
+                action_set({'outcome': 'action-managed-upgrade config is '
+                                       'False, skipped upgrade.'})
+        else:
+            action_set({'outcome': 'no upgrade available.'})
+
+    return ret

=== modified file 'tests/contrib/openstack/test_openstack_utils.py'
--- tests/contrib/openstack/test_openstack_utils.py	2015-09-15 17:52:15 +0000
+++ tests/contrib/openstack/test_openstack_utils.py	2015-09-16 15:03:29 +0000
@@ -943,5 +943,125 @@
                                       "incomplete relations: message, "
                                       "identity")
 
+    @patch.object(openstack, 'action_set')
+    @patch.object(openstack, 'action_fail')
+    @patch.object(openstack, 'openstack_upgrade_available')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade(self, config, openstack_upgrade_available,
+                               action_fail, action_set):
+        def do_openstack_upgrade(configs):
+            pass
+
+        openstack_upgrade_available.return_value = True
+
+        # openstack-origin-git=None, action-managed-upgrade=True
+        config.side_effect = [None, True]
+
+        openstack.do_action_openstack_upgrade('package-xyz',
+                                              do_openstack_upgrade,
+                                              None)
+
+        self.assertTrue(openstack_upgrade_available.called)
+        msg = ('success, upgrade completed.')
+        action_set.assert_called_with({'outcome': msg})
+        self.assertFalse(action_fail.called)
+
+    @patch.object(openstack, 'action_set')
+    @patch.object(openstack, 'action_fail')
+    @patch.object(openstack, 'openstack_upgrade_available')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_git(self, config, openstack_upgrade_available,
+                                   action_fail, action_set):
+        def do_openstack_upgrade(configs):
+            pass
+
+        openstack_upgrade_available.return_value = True
+
+        # openstack-origin-git=xyz
+        config.side_effect = ['openstack-origin-git: xyz']
+
+        openstack.do_action_openstack_upgrade('package-xyz',
+                                              do_openstack_upgrade,
+                                              None)
+
+        self.assertFalse(openstack_upgrade_available.called)
+        msg = ('installed from source, skipped upgrade.')
+        action_set.assert_called_with({'outcome': msg})
+        self.assertFalse(action_fail.called)
+
+    @patch.object(openstack, 'action_set')
+    @patch.object(openstack, 'action_fail')
+    @patch.object(openstack, 'openstack_upgrade_available')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_not_avail(self, config,
+                                         openstack_upgrade_available,
+                                         action_fail, action_set):
+        def do_openstack_upgrade(configs):
+            pass
+
+        openstack_upgrade_available.return_value = False
+
+        # openstack-origin-git=None
+        config.side_effect = [None]
+
+        openstack.do_action_openstack_upgrade('package-xyz',
+                                              do_openstack_upgrade,
+                                              None)
+
+        self.assertTrue(openstack_upgrade_available.called)
+        msg = ('no upgrade available.')
+        action_set.assert_called_with({'outcome': msg})
+        self.assertFalse(action_fail.called)
+
+    @patch.object(openstack, 'action_set')
+    @patch.object(openstack, 'action_fail')
+    @patch.object(openstack, 'openstack_upgrade_available')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_config_false(self, config,
+                                            openstack_upgrade_available,
+                                            action_fail, action_set):
+        def do_openstack_upgrade(configs):
+            pass
+
+        openstack_upgrade_available.return_value = True
+
+        # openstack-origin-git=None, action-managed-upgrade=False
+        config.side_effect = [None, False]
+
+        openstack.do_action_openstack_upgrade('package-xyz',
+                                              do_openstack_upgrade,
+                                              None)
+
+        self.assertTrue(openstack_upgrade_available.called)
+        msg = ('action-managed-upgrade config is False, skipped upgrade.')
+        action_set.assert_called_with({'outcome': msg})
+        self.assertFalse(action_fail.called)
+
+    @patch.object(openstack, 'action_set')
+    @patch.object(openstack, 'action_fail')
+    @patch.object(openstack, 'openstack_upgrade_available')
+    @patch('traceback.format_exc')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_traceback(self, config, traceback,
+                                         openstack_upgrade_available,
+                                         action_fail, action_set):
+        def do_openstack_upgrade(configs):
+            oops()  # noqa
+
+        openstack_upgrade_available.return_value = True
+
+        # openstack-origin-git=None, action-managed-upgrade=False
+        config.side_effect = [None, True]
+
+        openstack.do_action_openstack_upgrade('package-xyz',
+                                              do_openstack_upgrade,
+                                              None)
+
+        self.assertTrue(openstack_upgrade_available.called)
+        msg = 'do_openstack_upgrade resulted in an unexpected error'
+        action_fail.assert_called_with(msg)
+        self.assertTrue(action_set.called)
+        self.assertTrue(traceback.called)
+
 if __name__ == '__main__':
     unittest.main()