Merge lp:~ddellav/charms/trusty/glance/upgrade-action into lp:~openstack-charmers-archive/charms/trusty/glance/next

[David Della Vecchia]

This branch adds the openstack_upgrade action, action_managed_upgrade config option, and related unit_tests to the glance charm.

This action will upgrade the charm to the openstack version specified in the openstack-origin config option provided the action_managed_upgrade config option is set to a truthy value (it defaults to False to maintain backwards compatibility).

If the charm was installed from source (git_install) the upgrade action will gracefully fail.

The openstack_upgrade action utilizes the pre-existing do_openstack_upgrade function code so the unit-tests added only cover the possible action execution paths and not the full upgrade process (as that is covered elsewhere).

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #6635 glance-next for ddellav mp265592
    LINT FAIL: lint-test failed

LINT Results (max last 2 lines):
make: *** [lint] Error 1
ERROR:root:Make target returned non-zero.

Full lint test output: http://paste.ubuntu.com/11922190/
Build: http://10.245.162.77:8080/job/charm_lint_check/6635/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #6262 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/6262/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #6637 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/6637/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #6264 glance-next for ddellav mp265592
    UNIT FAIL: unit-test failed

UNIT Results (max last 2 lines):
make: *** [test] Error 1
ERROR:root:Make target returned non-zero.

Full unit test output: http://paste.ubuntu.com/11922470/
Build: http://10.245.162.77:8080/job/charm_unit_test/6264/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #6638 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/6638/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #6265 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/6265/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5265 glance-next for ddellav mp265592
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/11922596/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5265/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5267 glance-next for ddellav mp265592
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/11922845/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5267/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5268 glance-next for ddellav mp265592
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/11922911/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5268/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5269 glance-next for ddellav mp265592
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
ERROR subprocess encountered error code 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/11923590/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5269/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #6733 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/6733/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #6360 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/6360/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5275 glance-next for ddellav mp265592
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/5275/

[James Page (james-page)]

review: Needs Fixing

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #7485 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/7485/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #6942 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/6942/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5607 glance-next for ddellav mp265592
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/11998771/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5607/

[James Page (james-page)]

review: Needs Fixing

[James Page (james-page)]

I note some amulet tests failures as well - pls take a look

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #7583 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/7583/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #7023 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/7023/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5645 glance-next for ddellav mp265592
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/5645/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #7738 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/7738/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #7165 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/7165/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5677 glance-next for ddellav mp265592
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/12049127/
Build: http://10.245.162.77:8080/job/charm_amulet_test/5677/

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #7863 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/7863/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #7284 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/7284/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5700 glance-next for ddellav mp265592
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/5700/

[Corey Bryant (corey.bryant)]

Looking good DDV. I deployed your charm and successfully ran a few tests including an upgrade. I did see a formatting issue with the output of 'juju get' (see below). Also while you're in there you might want to make the invalid config message more explicit as mentioned below..

[Corey Bryant (corey.bryant)]

One more minor suggestion in the config.yaml description

[lp:~ddellav/charms/trusty/glance/upgrade-action]

136. By David Della Vecchia on 2015-08-14

Fixes formatting issue in config.yaml. Updated error message output to be more specific and helpful in action code.

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #8046 glance-next for ddellav mp265592
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/8046/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #7457 glance-next for ddellav mp265592
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/7457/

[Corey Bryant (corey.bryant)]

Looks and works good, and all of James' and my comments have been handled. I think this is ready to land. Thanks DDV!

review: Approve

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #5790 glance-next for ddellav mp265592
    AMULET OK: passed

Build: http://10.245.162.77:8080/job/charm_amulet_test/5790/

=== modified file 'actions.yaml'
--- actions.yaml	2015-03-21 01:36:16 +0000
+++ actions.yaml	2015-08-14 15:55:41 +0000
@@ -1,2 +1,4 @@
 git-reinstall:
   description: Reinstall glance from the openstack-origin-git repositories.
+openstack-upgrade:
+  description: Perform openstack upgrades. Config option action-managed-upgrade must be set to True.

=== added symlink 'actions/openstack-upgrade'
=== target is u'openstack_upgrade.py'
=== added file 'actions/openstack_upgrade.py'
--- actions/openstack_upgrade.py	1970-01-01 00:00:00 +0000
+++ actions/openstack_upgrade.py	2015-08-14 15:55:41 +0000
@@ -0,0 +1,62 @@
+#!/usr/bin/python
+import sys
+import traceback
+
+sys.path.append('hooks/')
+
+from charmhelpers.core.hookenv import (
+    action_set,
+    action_fail,
+    config
+)
+
+from glance_relations import config_changed
+
+from charmhelpers.contrib.openstack.utils import (
+    juju_log,
+    git_install_requested,
+    openstack_upgrade_available
+)
+
+from glance_utils import (
+    do_openstack_upgrade,
+    register_configs
+)
+
+
+CONFIGS = register_configs()
+
+
+def openstack_upgrade():
+    """Upgrade packages to config-set Openstack version.
+
+    If the charm was installed from source we cannot upgrade it.
+    For backwards compatibility a config flag must be set for this
+    code to run, otherwise a full service level upgrade will fire
+    on config-changed."""
+
+    if git_install_requested():
+        action_set({'outcome': 'installed from source, skipped upgrade.'})
+    else:
+        if openstack_upgrade_available('glance-common'):
+            if config('action-managed-upgrade'):
+                juju_log('Upgrading OpenStack release')
+
+                try:
+                    do_openstack_upgrade(CONFIGS)
+                    action_set({'outcome': 'success, upgrade completed.'})
+                except:
+                    action_set({'outcome': 'upgrade failed, see traceback.'})
+                    action_set({'traceback': traceback.format_exc()})
+                    action_fail('do_openstack_upgrade resulted in an '
+                                'unexpected error')
+
+                config_changed()
+            else:
+                action_set({'outcome': 'action-managed-upgrade config is '
+                                       'False, skipped upgrade.'})
+        else:
+            action_set({'outcome': 'no upgrade available.'})
+
+if __name__ == '__main__':
+    openstack_upgrade()

=== modified file 'config.yaml'
--- config.yaml	2015-07-10 14:14:20 +0000
+++ config.yaml	2015-08-14 15:55:41 +0000
@@ -233,3 +233,13 @@
     description: |
         A comma-separated list of nagios servicegroups.
         If left empty, the nagios_context will be used as the servicegroup
+  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 the config variable for the openstack version
+      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.

=== modified file 'hooks/glance_relations.py'
--- hooks/glance_relations.py	2015-05-11 07:28:22 +0000
+++ hooks/glance_relations.py	2015-08-14 15:55:41 +0000
@@ -333,7 +333,7 @@
     if git_install_requested():
         if config_value_changed('openstack-origin-git'):
             git_install(config('openstack-origin-git'))
-    else:
+    elif not config('action-managed-upgrade'):
         if openstack_upgrade_available('glance-common'):
             juju_log('Upgrading OpenStack release')
             do_openstack_upgrade(CONFIGS)

=== added file 'unit_tests/test_actions_openstack_upgrade.py'
--- unit_tests/test_actions_openstack_upgrade.py	1970-01-01 00:00:00 +0000
+++ unit_tests/test_actions_openstack_upgrade.py	2015-08-14 15:55:41 +0000
@@ -0,0 +1,117 @@
+from mock import patch
+import os
+
+os.environ['JUJU_UNIT_NAME'] = 'glance'
+
+with patch('glance_utils.register_configs') as register_configs:
+    import openstack_upgrade
+
+from test_utils import (
+    CharmTestCase
+)
+
+TO_PATCH = [
+    'config'
+]
+
+
+class TestGlanceUpgradeActions(CharmTestCase):
+
+    def setUp(self):
+        super(TestGlanceUpgradeActions, self).setUp(openstack_upgrade,
+                                                    TO_PATCH)
+        self.config.side_effect = self.test_config.get
+
+    @patch.object(openstack_upgrade, 'action_set')
+    @patch.object(openstack_upgrade, 'action_fail')
+    @patch.object(openstack_upgrade, 'do_openstack_upgrade')
+    @patch.object(openstack_upgrade, 'openstack_upgrade_available')
+    @patch.object(openstack_upgrade, 'config_changed')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade(self, _config, config_changed,
+                               openstack_upgrade_available,
+                               do_openstack_upgrade, action_fail,
+                               action_set):
+        _config.return_value = None
+        openstack_upgrade_available.return_value = True
+
+        self.test_config.set('action-managed-upgrade', True)
+
+        openstack_upgrade.openstack_upgrade()
+
+        self.assertTrue(do_openstack_upgrade.called)
+        self.assertTrue(config_changed.called)
+        self.assertFalse(action_fail.called)
+
+    @patch.object(openstack_upgrade, 'action_set')
+    @patch.object(openstack_upgrade, 'do_openstack_upgrade')
+    @patch.object(openstack_upgrade, 'openstack_upgrade_available')
+    @patch.object(openstack_upgrade, 'config_changed')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_not_configured(self, _config, config_changed,
+                                              openstack_upgrade_available,
+                                              do_openstack_upgrade,
+                                              action_set):
+        _config.return_value = None
+        openstack_upgrade_available.return_value = True
+
+        openstack_upgrade.openstack_upgrade()
+
+        msg = ('action-managed-upgrade config is False, skipped upgrade.')
+
+        action_set.assert_called_with({'outcome': msg})
+        self.assertFalse(do_openstack_upgrade.called)
+
+    @patch.object(openstack_upgrade, 'action_set')
+    @patch.object(openstack_upgrade, 'do_openstack_upgrade')
+    @patch.object(openstack_upgrade, 'openstack_upgrade_available')
+    @patch.object(openstack_upgrade, 'config_changed')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_git_install(self, _config, config_changed,
+                                           openstack_upgrade_available,
+                                           do_openstack_upgrade,
+                                           action_set):
+
+        self.test_config.set('action-managed-upgrade', True)
+        self.test_config.set('openstack-origin-git', True)
+
+        openstack_upgrade.openstack_upgrade()
+
+        msg = ('installed from source, skipped upgrade.')
+        action_set.assert_called_with({'outcome': msg})
+        self.assertFalse(do_openstack_upgrade.called)
+
+    @patch.object(openstack_upgrade, 'action_set')
+    @patch.object(openstack_upgrade, 'action_fail')
+    @patch.object(openstack_upgrade, 'do_openstack_upgrade')
+    @patch.object(openstack_upgrade, 'openstack_upgrade_available')
+    @patch.object(openstack_upgrade, 'config_changed')
+    @patch('traceback.format_exc')
+    @patch('charmhelpers.contrib.openstack.utils.config')
+    def test_openstack_upgrade_exception(self, _config, format_exc,
+                                         config_changed,
+                                         openstack_upgrade_available,
+                                         do_openstack_upgrade,
+                                         action_fail, action_set):
+        _config.return_value = None
+        self.test_config.set('action-managed-upgrade', True)
+        openstack_upgrade_available.return_value = True
+
+        e = OSError('something bad happened')
+        do_openstack_upgrade.side_effect = e
+        traceback = (
+            "Traceback (most recent call last):\n"
+            "  File \"actions/openstack_upgrade.py\", line 37, in openstack_upgrade\n"  # noqa
+            "    openstack_upgrade(config(\'openstack-origin-git\'))\n"
+            "  File \"/usr/lib/python2.7/dist-packages/mock.py\", line 964, in __call__\n"  # noqa
+            "    return _mock_self._mock_call(*args, **kwargs)\n"
+            "  File \"/usr/lib/python2.7/dist-packages/mock.py\", line 1019, in _mock_call\n"  # noqa
+            "    raise effect\n"
+            "OSError: something bad happened\n")
+        format_exc.return_value = traceback
+
+        openstack_upgrade.openstack_upgrade()
+
+        msg = 'do_openstack_upgrade resulted in an unexpected error'
+        action_fail.assert_called_with(msg)
+        action_set.assert_called_with({'traceback': traceback})

=== modified file 'unit_tests/test_glance_relations.py'
--- unit_tests/test_glance_relations.py	2015-06-10 20:31:46 +0000
+++ unit_tests/test_glance_relations.py	2015-08-14 15:55:41 +0000
@@ -560,6 +560,15 @@
         self.assertTrue(self.do_openstack_upgrade.called)
         self.assertTrue(configure_https.called)
 
+    @patch.object(relations, 'git_install_requested')
+    def test_config_changed_with_openstack_upgrade_action(self, git_requested):
+        git_requested.return_value = False
+        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)
+
     @patch.object(relations, 'configure_https')
     @patch.object(relations, 'git_install_requested')
     @patch.object(relations, 'config_value_changed')