charm-heat/unit_tests/test_heat_utils.py

# Copyright 2016 Canonical Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#  http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from copy import deepcopy
from collections import OrderedDict
from unittest.mock import patch, MagicMock, call
from test_utils import CharmTestCase

from charmhelpers.core import hookenv

_conf = hookenv.config
hookenv.config = MagicMock()

import heat_utils as utils

hookenv.config = _conf

TO_PATCH = [
    'config',
    'log',
    'os_release',
    'get_os_codename_install_source',
    'configure_installation_source',
    'apt_install',
    'apt_update',
    'apt_upgrade',
    'check_call',
    'service_start',
    'service_stop',
    'token_cache_pkgs',
    'enable_memcache',
    'os'
]


# Restart map should be constructed such that API services restart
# before frontends (haproxy/apaceh) to avoid port conflicts.
RESTART_MAP = OrderedDict([
    ('/etc/heat/heat.conf', ['heat-api', 'heat-api-cfn', 'heat-engine']),
    ('/etc/heat/api-paste.ini', ['heat-api', 'heat-api-cfn']),
    ('/etc/haproxy/haproxy.cfg', ['haproxy']),
    ('/etc/heat/api_audit_map.conf', ['heat-api']),
    ('/etc/apache2/sites-available/openstack_https_frontend', ['apache2']),
    ('/etc/apache2/sites-available/openstack_https_frontend.conf',
     ['apache2']),
    ('/etc/memcached.conf', ['memcached']),
    ('/etc/apache2/ports.conf', ['apache2']),
])


class HeatUtilsTests(CharmTestCase):

    def setUp(self):
        super(HeatUtilsTests, self).setUp(utils, TO_PATCH)
        self.config.side_effect = self.test_config.get

    @patch('charmhelpers.contrib.openstack.context.SubordinateConfigContext')
    def test_determine_packages(self, subcontext):
        self.os_release.return_value = 'havana'
        pkgs = utils.determine_packages()
        ex = list(set(utils.BASE_PACKAGES + utils.BASE_SERVICES))
        self.assertEqual(ex, pkgs)

    @patch('charmhelpers.contrib.openstack.context.SubordinateConfigContext')
    def test_determine_packages_queens(self, subcontext):
        self.os_release.return_value = 'queens'
        self.token_cache_pkgs.return_value = ['python-memcache', 'memcached']
        pkgs = utils.determine_packages()
        ex = list(set(utils.BASE_PACKAGES + ['python-memcache', 'memcached'] +
                      utils.BASE_SERVICES))
        self.assertEqual(sorted(ex), sorted(pkgs))

    @patch('charmhelpers.contrib.openstack.context.SubordinateConfigContext')
    def test_determine_packages_rocky(self, subcontext):
        self.os_release.return_value = 'rocky'
        self.token_cache_pkgs.return_value = ['python-memcache', 'memcached']
        pkgs = utils.determine_packages()
        ex = list(set(
            [p for p in utils.BASE_PACKAGES if not p.startswith('python-')] +
            ['memcached'] + utils.BASE_SERVICES + utils.PY3_PACKAGES))
        self.assertEqual(sorted(ex), sorted(pkgs))

    def test_determine_purge_packages(self):
        'Ensure no packages are identified for purge prior to rocky'
        self.os_release.return_value = 'queens'
        self.assertEqual(utils.determine_purge_packages(), [])

    def test_determine_purge_packages_rocky(self):
        'Ensure python packages are identified for purge at rocky'
        self.os_release.return_value = 'rocky'
        self.assertEqual(utils.determine_purge_packages(),
                         [p for p in utils.BASE_PACKAGES
                          if p.startswith('python-')] +
                         ['python-heat', 'python-memcache'])

    def test_restart_map(self):
        # Icehouse
        self.os_release.return_value = "icehouse"
        self.enable_memcache.return_value = False
        self.os.path.exists.return_value = False
        _restart_map = deepcopy(RESTART_MAP)
        _restart_map.pop(
            "/etc/apache2/sites-available/openstack_https_frontend.conf")
        _restart_map.pop("/etc/memcached.conf")
        self.assertEqual(_restart_map, utils.restart_map())

        # Mitaka
        self.os_release.return_value = "mitaka"
        self.enable_memcache.return_value = True
        self.os.path.exists.return_value = True
        _restart_map = deepcopy(RESTART_MAP)
        _restart_map.pop(
            "/etc/apache2/sites-available/openstack_https_frontend")
        self.assertEqual(_restart_map, utils.restart_map())

    def test_openstack_upgrade(self):
        self.config.side_effect = None
        self.config.return_value = 'cloud:precise-havana'
        self.get_os_codename_install_source.return_value = 'havana'
        self.os_release.return_value = 'icehouse'
        configs = MagicMock()
        utils.do_openstack_upgrade(configs)
        self.assertTrue(self.apt_update.called)
        self.assertTrue(self.apt_upgrade.called)
        self.assertTrue(self.apt_install.called)
        configs.set_release.assert_called_with(openstack_release='havana')
        self.assertTrue(configs.write_all.called)

    def test_api_ports(self):
        cfn = utils.api_port('heat-api-cfn')
        self.assertEqual(cfn, 8000)
        cfn = utils.api_port('heat-api')
        self.assertEqual(cfn, 8004)

    def test_migrate_database(self):
        utils.migrate_database()
        self.assertTrue(self.log.called)
        self.check_call.assert_called_with(['heat-manage', 'db_sync'])
        expected = [call('heat-api'), call('heat-api-cfn'),
                    call('heat-engine'), call('apache2')]
        self.service_stop.assert_has_calls(expected, any_order=True)
        self.service_start.assert_has_calls(expected, any_order=True)