Action-managed openstack upgrade support

actions.yaml

@@ -0,0 +1,4 @@
+openstack-upgrade:
+  description:
+    Perform openstack upgrades. Config option action-managed-upgrade must be
+    set to True.

actions/openstack-upgrade

@@ -0,0 +1 @@
+openstack_upgrade.py

actions/openstack_upgrade.py

@@ -0,0 +1,38 @@
+#!/usr/bin/python
+import sys
+
+sys.path.append('hooks/')
+
+from charmhelpers.contrib.openstack.utils import (
+    do_action_openstack_upgrade,
+)
+
+from heat_relations import config_changed
+
+from heat_utils import (
+    do_openstack_upgrade,
+    register_configs
+)
+
+
+CONFIGS = register_configs()
+
+
+def openstack_upgrade():
+    """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."""
+
+    if (do_action_openstack_upgrade('heat-common',
+                                    do_openstack_upgrade,
+                                    CONFIGS)):
+        config_changed()
+
+if __name__ == '__main__':
+    openstack_upgrade()

config.yaml

@@ -85,3 +85,13 @@ options:
       create the following public endpoints for ceilometer:
       .
       https://ceilometer.example.com:8777/
+  action-managed-upgrade:
+    type: boolean
+    default: False
+    description: |
+      If True enables openstack upgrades for this charm via juju actions.
+      You will still need to set openstack-origin to the new repository but
+      instead of an upgrade running automatically across all units, it will
+      wait for you to execute the openstack-upgrade action for this charm on
+      each unit. If False it will revert to existing behavior of upgrading
+      all units on config change.

hooks/heat_relations.py

@@ -87,8 +87,9 @@ def install():
 @hooks.hook('config-changed')
 @restart_on_change(restart_map())
 def config_changed():
-    if openstack_upgrade_available('heat-common'):
-        do_openstack_upgrade(CONFIGS)
+    if not config('action-managed-upgrade'):
+        if openstack_upgrade_available('heat-common'):
+            do_openstack_upgrade(CONFIGS)
     CONFIGS.write_all()
     configure_https()
 

unit_tests/__init__.py

@@ -1,2 +1,3 @@
 import sys
+sys.path.append('actions/')
 sys.path.append('hooks/')

unit_tests/test_actions_openstack_upgrade.py

@@ -0,0 +1,54 @@
+from mock import patch
+import os
+
+os.environ['JUJU_UNIT_NAME'] = 'heat'
+
+with patch('heat_utils.register_configs') as register_configs:
+    import openstack_upgrade
+
+from test_utils import (
+    CharmTestCase
+)
+
+TO_PATCH = [
+    'config_changed',
+    'do_openstack_upgrade',
+    'register_configs',
+]
+
+
+class TestHeatUpgradeActions(CharmTestCase):
+
+    def setUp(self):
+        super(TestHeatUpgradeActions, self).setUp(openstack_upgrade,
+                                                    TO_PATCH)
+
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    @patch('charmhelpers.contrib.openstack.utils.action_set')
+    @patch('charmhelpers.contrib.openstack.utils.git_install_requested')
+    @patch('charmhelpers.contrib.openstack.utils.openstack_upgrade_available')
+    def test_openstack_upgrade_true(self, upgrade_avail, git_requested,
+                                    action_set, config):
+        git_requested.return_value = False
+        upgrade_avail.return_value = True
+        config.return_value = True
+
+        openstack_upgrade.openstack_upgrade()
+
+        self.assertTrue(self.do_openstack_upgrade.called)
+        self.assertTrue(self.config_changed.called)
+
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    @patch('charmhelpers.contrib.openstack.utils.action_set')
+    @patch('charmhelpers.contrib.openstack.utils.git_install_requested')
+    @patch('charmhelpers.contrib.openstack.utils.openstack_upgrade_available')
+    def test_openstack_upgrade_false(self, upgrade_avail, git_requested,
+                                     action_set, config):
+        git_requested.return_value = False
+        upgrade_avail.return_value = True
+        config.return_value = False
+
+        openstack_upgrade.openstack_upgrade()
+
+        self.assertFalse(self.do_openstack_upgrade.called)
+        self.assertFalse(self.config_changed.called)

unit_tests/test_heat_relations.py

@@ -76,6 +76,16 @@ class HeatRelationTests(CharmTestCase):
         relations.config_changed()
         self.assertTrue(self.do_openstack_upgrade.called)
 
+    @patch.object(relations, 'configure_https')
+    def test_config_changed_with_openstack_upgrade_action(self,
+                                                          mock_configure_https):
+        self.openstack_upgrade_available.return_value = True
+        self.test_config.set('action-managed-upgrade', True)
+
+        relations.config_changed()
+
+        self.assertFalse(self.do_openstack_upgrade.called)
+
     def test_db_joined(self):
         self.unit_get.return_value = 'heat.foohost.com'
         relations.db_joined()