~canonical-hw-cert/charms/xenial/snappy-device-agent/trunk

# Copyright 2014-2015 Canonical Limited.

#

# This file is part of charm-helpers.

#

# charm-helpers is free software: you can redistribute it and/or modify

# it under the terms of the GNU Lesser General Public License version 3 as

# published by the Free Software Foundation.

#

# charm-helpers is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Lesser General Public License for more details.

#

# You should have received a copy of the GNU Lesser General Public License

# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

# Common python helper functions used for OpenStack charms.

from collections import OrderedDict

from functools import wraps

import subprocess

import json

import os

import sys

import re

import itertools

import functools

import six

import tempfile

import traceback

import uuid

import yaml

from charmhelpers.contrib.network import ip

from charmhelpers.core import (

    unitdata,

)

from charmhelpers.core.hookenv import (

    action_fail,

    action_set,

    config,

    log as juju_log,

    charm_dir,

    DEBUG,

    INFO,

    related_units,

    relation_ids,

    relation_set,

    status_set,

    hook_name

)

from charmhelpers.contrib.storage.linux.lvm import (

    deactivate_lvm_volume_group,

    is_lvm_physical_volume,

    remove_lvm_physical_volume,

)

from charmhelpers.contrib.network.ip import (

    get_ipv6_addr,

    is_ipv6,

    port_has_listener,

)

from charmhelpers.contrib.python.packages import (

    pip_create_virtualenv,

    pip_install,

)

from charmhelpers.core.host import (

    lsb_release,

    mounts,

    umount,

    service_running,

    service_pause,

    service_resume,

    restart_on_change_helper,

)

from charmhelpers.fetch import apt_install, apt_cache, install_remote

from charmhelpers.contrib.storage.linux.utils import is_block_device, zap_disk

from charmhelpers.contrib.storage.linux.loopback import ensure_loopback_device

CLOUD_ARCHIVE_URL = "http://ubuntu-cloud.archive.canonical.com/ubuntu"

CLOUD_ARCHIVE_KEY_ID = '5EDB1B62EC4926EA'

DISTRO_PROPOSED = ('deb http://archive.ubuntu.com/ubuntu/ %s-proposed '

                   'restricted main multiverse universe')

UBUNTU_OPENSTACK_RELEASE = OrderedDict([

    ('oneiric', 'diablo'),

    ('precise', 'essex'),

    ('quantal', 'folsom'),

    ('raring', 'grizzly'),

    ('saucy', 'havana'),

    ('trusty', 'icehouse'),

    ('utopic', 'juno'),

    ('vivid', 'kilo'),

    ('wily', 'liberty'),

    ('xenial', 'mitaka'),

])

OPENSTACK_CODENAMES = OrderedDict([

    ('2011.2', 'diablo'),

    ('2012.1', 'essex'),

    ('2012.2', 'folsom'),

    ('2013.1', 'grizzly'),

    ('2013.2', 'havana'),

    ('2014.1', 'icehouse'),

    ('2014.2', 'juno'),

    ('2015.1', 'kilo'),

    ('2015.2', 'liberty'),

    ('2016.1', 'mitaka'),

])

# The ugly duckling - must list releases oldest to newest

SWIFT_CODENAMES = OrderedDict([

    ('diablo',

        ['1.4.3']),

    ('essex',

        ['1.4.8']),

    ('folsom',

        ['1.7.4']),

    ('grizzly',

        ['1.7.6', '1.7.7', '1.8.0']),

    ('havana',

        ['1.9.0', '1.9.1', '1.10.0']),

    ('icehouse',

        ['1.11.0', '1.12.0', '1.13.0', '1.13.1']),

    ('juno',

        ['2.0.0', '2.1.0', '2.2.0']),

    ('kilo',

        ['2.2.1', '2.2.2']),

    ('liberty',

        ['2.3.0', '2.4.0', '2.5.0']),

    ('mitaka',

        ['2.5.0', '2.6.0', '2.7.0']),

])

# >= Liberty version->codename mapping

PACKAGE_CODENAMES = {

    'nova-common': OrderedDict([

        ('12.0', 'liberty'),

        ('13.0', 'mitaka'),

    ]),

    'neutron-common': OrderedDict([

        ('7.0', 'liberty'),

        ('8.0', 'mitaka'),

        ('8.1', 'mitaka'),

    ]),

    'cinder-common': OrderedDict([

        ('7.0', 'liberty'),

        ('8.0', 'mitaka'),

    ]),

    'keystone': OrderedDict([

        ('8.0', 'liberty'),

        ('8.1', 'liberty'),

        ('9.0', 'mitaka'),

    ]),

    'horizon-common': OrderedDict([

        ('8.0', 'liberty'),

        ('9.0', 'mitaka'),

    ]),

    'ceilometer-common': OrderedDict([

        ('5.0', 'liberty'),

        ('6.0', 'mitaka'),

    ]),

    'heat-common': OrderedDict([

        ('5.0', 'liberty'),

        ('6.0', 'mitaka'),

    ]),

    'glance-common': OrderedDict([

        ('11.0', 'liberty'),

        ('12.0', 'mitaka'),

    ]),

    'openstack-dashboard': OrderedDict([

        ('8.0', 'liberty'),

        ('9.0', 'mitaka'),

    ]),

}

DEFAULT_LOOPBACK_SIZE = '5G'

def error_out(msg):

    juju_log("FATAL ERROR: %s" % msg, level='ERROR')

    sys.exit(1)

def get_os_codename_install_source(src):

    '''Derive OpenStack release codename from a given installation source.'''

    ubuntu_rel = lsb_release()['DISTRIB_CODENAME']

    rel = ''

    if src is None:

        return rel

    if src in ['distro', 'distro-proposed']:

        try:

            rel = UBUNTU_OPENSTACK_RELEASE[ubuntu_rel]

        except KeyError:

            e = 'Could not derive openstack release for '\

                'this Ubuntu release: %s' % ubuntu_rel

            error_out(e)

        return rel

    if src.startswith('cloud:'):

        ca_rel = src.split(':')[1]

        ca_rel = ca_rel.split('%s-' % ubuntu_rel)[1].split('/')[0]

        return ca_rel

    # Best guess match based on deb string provided

    if src.startswith('deb') or src.startswith('ppa'):

        for k, v in six.iteritems(OPENSTACK_CODENAMES):

            if v in src:

                return v

def get_os_version_install_source(src):

    codename = get_os_codename_install_source(src)

    return get_os_version_codename(codename)

def get_os_codename_version(vers):

    '''Determine OpenStack codename from version number.'''

    try:

        return OPENSTACK_CODENAMES[vers]

    except KeyError:

        e = 'Could not determine OpenStack codename for version %s' % vers

        error_out(e)

def get_os_version_codename(codename, version_map=OPENSTACK_CODENAMES):

    '''Determine OpenStack version number from codename.'''

    for k, v in six.iteritems(version_map):

        if v == codename:

            return k

    e = 'Could not derive OpenStack version for '\

        'codename: %s' % codename

    error_out(e)

def get_os_version_codename_swift(codename):

    '''Determine OpenStack version number of swift from codename.'''

    for k, v in six.iteritems(SWIFT_CODENAMES):

        if k == codename:

            return v[-1]

    e = 'Could not derive swift version for '\

        'codename: %s' % codename

    error_out(e)

def get_swift_codename(version):

    '''Determine OpenStack codename that corresponds to swift version.'''

    codenames = [k for k, v in six.iteritems(SWIFT_CODENAMES) if version in v]

    if len(codenames) > 1:

        # If more than one release codename contains this version we determine

        # the actual codename based on the highest available install source.

        for codename in reversed(codenames):

            releases = UBUNTU_OPENSTACK_RELEASE

            release = [k for k, v in six.iteritems(releases) if codename in v]

            ret = subprocess.check_output(['apt-cache', 'policy', 'swift'])

            if codename in ret or release[0] in ret:

                return codename

    elif len(codenames) == 1:

        return codenames[0]

    return None

def get_os_codename_package(package, fatal=True):

    '''Derive OpenStack release codename from an installed package.'''

    import apt_pkg as apt

    cache = apt_cache()

    try:

        pkg = cache[package]

    except:

        if not fatal:

            return None

        # the package is unknown to the current apt cache.

        e = 'Could not determine version of package with no installation '\

            'candidate: %s' % package

        error_out(e)

    if not pkg.current_ver:

        if not fatal:

            return None

        # package is known, but no version is currently installed.

        e = 'Could not determine version of uninstalled package: %s' % package

        error_out(e)

    vers = apt.upstream_version(pkg.current_ver.ver_str)

    if 'swift' in pkg.name:

        # Fully x.y.z match for swift versions

        match = re.match('^(\d+)\.(\d+)\.(\d+)', vers)

    else:

        # x.y match only for 20XX.X

        # and ignore patch level for other packages

        match = re.match('^(\d+)\.(\d+)', vers)

    if match:

        vers = match.group(0)

    # >= Liberty independent project versions

    if (package in PACKAGE_CODENAMES and

            vers in PACKAGE_CODENAMES[package]):

        return PACKAGE_CODENAMES[package][vers]

    else:

        # < Liberty co-ordinated project versions

        try:

            if 'swift' in pkg.name:

                return get_swift_codename(vers)

            else:

                return OPENSTACK_CODENAMES[vers]

        except KeyError:

            if not fatal:

                return None

            e = 'Could not determine OpenStack codename for version %s' % vers

            error_out(e)

def get_os_version_package(pkg, fatal=True):

    '''Derive OpenStack version number from an installed package.'''

    codename = get_os_codename_package(pkg, fatal=fatal)

    if not codename:

        return None

    if 'swift' in pkg:

        vers_map = SWIFT_CODENAMES

        for cname, version in six.iteritems(vers_map):

            if cname == codename:

                return version[-1]

    else:

        vers_map = OPENSTACK_CODENAMES

        for version, cname in six.iteritems(vers_map):

            if cname == codename:

                return version

    # e = "Could not determine OpenStack version for package: %s" % pkg

    # error_out(e)

os_rel = None

def os_release(package, base='essex'):

    '''

    Returns OpenStack release codename from a cached global.

    If the codename can not be determined from either an installed package or

    the installation source, the earliest release supported by the charm should

    be returned.

    '''

    global os_rel

    if os_rel:

        return os_rel

    os_rel = (get_os_codename_package(package, fatal=False) or

              get_os_codename_install_source(config('openstack-origin')) or

              base)

    return os_rel

def import_key(keyid):

    key = keyid.strip()

    if (key.startswith('-----BEGIN PGP PUBLIC KEY BLOCK-----') and

            key.endswith('-----END PGP PUBLIC KEY BLOCK-----')):

        juju_log("PGP key found (looks like ASCII Armor format)", level=DEBUG)

        juju_log("Importing ASCII Armor PGP key", level=DEBUG)

        with tempfile.NamedTemporaryFile() as keyfile:

            with open(keyfile.name, 'w') as fd:

                fd.write(key)

                fd.write("\n")

            cmd = ['apt-key', 'add', keyfile.name]

            try:

                subprocess.check_call(cmd)

            except subprocess.CalledProcessError:

                error_out("Error importing PGP key '%s'" % key)

    else:

        juju_log("PGP key found (looks like Radix64 format)", level=DEBUG)

        juju_log("Importing PGP key from keyserver", level=DEBUG)

        cmd = ['apt-key', 'adv', '--keyserver',

               'hkp://keyserver.ubuntu.com:80', '--recv-keys', key]

        try:

            subprocess.check_call(cmd)

        except subprocess.CalledProcessError:

            error_out("Error importing PGP key '%s'" % key)

def get_source_and_pgp_key(input):

    """Look for a pgp key ID or ascii-armor key in the given input."""

    index = input.strip()

    index = input.rfind('|')

    if index < 0:

        return input, None

    key = input[index + 1:].strip('|')

    source = input[:index]

    return source, key

def configure_installation_source(rel):

    '''Configure apt installation source.'''

    if rel == 'distro':

        return

    elif rel == 'distro-proposed':

        ubuntu_rel = lsb_release()['DISTRIB_CODENAME']

        with open('/etc/apt/sources.list.d/juju_deb.list', 'w') as f:

            f.write(DISTRO_PROPOSED % ubuntu_rel)

    elif rel[:4] == "ppa:":

        src, key = get_source_and_pgp_key(rel)

        if key:

            import_key(key)

        subprocess.check_call(["add-apt-repository", "-y", src])

    elif rel[:3] == "deb":

        src, key = get_source_and_pgp_key(rel)

        if key:

            import_key(key)

        with open('/etc/apt/sources.list.d/juju_deb.list', 'w') as f:

            f.write(src)

    elif rel[:6] == 'cloud:':

        ubuntu_rel = lsb_release()['DISTRIB_CODENAME']

        rel = rel.split(':')[1]

        u_rel = rel.split('-')[0]

        ca_rel = rel.split('-')[1]

        if u_rel != ubuntu_rel:

            e = 'Cannot install from Cloud Archive pocket %s on this Ubuntu '\

                'version (%s)' % (ca_rel, ubuntu_rel)

            error_out(e)

        if 'staging' in ca_rel:

            # staging is just a regular PPA.

            os_rel = ca_rel.split('/')[0]

            ppa = 'ppa:ubuntu-cloud-archive/%s-staging' % os_rel

            cmd = 'add-apt-repository -y %s' % ppa

            subprocess.check_call(cmd.split(' '))

            return

        # map charm config options to actual archive pockets.

        pockets = {

            'folsom': 'precise-updates/folsom',

            'folsom/updates': 'precise-updates/folsom',

            'folsom/proposed': 'precise-proposed/folsom',

            'grizzly': 'precise-updates/grizzly',

            'grizzly/updates': 'precise-updates/grizzly',

            'grizzly/proposed': 'precise-proposed/grizzly',

            'havana': 'precise-updates/havana',

            'havana/updates': 'precise-updates/havana',

            'havana/proposed': 'precise-proposed/havana',

            'icehouse': 'precise-updates/icehouse',

            'icehouse/updates': 'precise-updates/icehouse',

            'icehouse/proposed': 'precise-proposed/icehouse',

            'juno': 'trusty-updates/juno',

            'juno/updates': 'trusty-updates/juno',

            'juno/proposed': 'trusty-proposed/juno',

            'kilo': 'trusty-updates/kilo',

            'kilo/updates': 'trusty-updates/kilo',

            'kilo/proposed': 'trusty-proposed/kilo',

            'liberty': 'trusty-updates/liberty',

            'liberty/updates': 'trusty-updates/liberty',

            'liberty/proposed': 'trusty-proposed/liberty',

            'mitaka': 'trusty-updates/mitaka',

            'mitaka/updates': 'trusty-updates/mitaka',

            'mitaka/proposed': 'trusty-proposed/mitaka',

        }

        try:

            pocket = pockets[ca_rel]

        except KeyError:

            e = 'Invalid Cloud Archive release specified: %s' % rel

            error_out(e)

        src = "deb %s %s main" % (CLOUD_ARCHIVE_URL, pocket)

        apt_install('ubuntu-cloud-keyring', fatal=True)

        with open('/etc/apt/sources.list.d/cloud-archive.list', 'w') as f:

            f.write(src)

    else:

        error_out("Invalid openstack-release specified: %s" % rel)

def config_value_changed(option):

    """

    Determine if config value changed since last call to this function.

    """

    hook_data = unitdata.HookData()

    with hook_data():

        db = unitdata.kv()

        current = config(option)

        saved = db.get(option)

        db.set(option, current)

        if saved is None:

            return False

        return current != saved

def save_script_rc(script_path="scripts/scriptrc", **env_vars):

    """

    Write an rc file in the charm-delivered directory containing

    exported environment variables provided by env_vars. Any charm scripts run

    outside the juju hook environment can source this scriptrc to obtain

    updated config information necessary to perform health checks or

    service changes.

    """

    juju_rc_path = "%s/%s" % (charm_dir(), script_path)

    if not os.path.exists(os.path.dirname(juju_rc_path)):

        os.mkdir(os.path.dirname(juju_rc_path))

    with open(juju_rc_path, 'wb') as rc_script:

        rc_script.write(

            "#!/bin/bash\n")

        [rc_script.write('export %s=%s\n' % (u, p))

         for u, p in six.iteritems(env_vars) if u != "script_path"]

def openstack_upgrade_available(package):

    """

    Determines if an OpenStack upgrade is available from installation

    source, based on version of installed package.

    :param package: str: Name of installed package.

    :returns: bool:    : Returns True if configured installation source offers

                         a newer version of package.

    """

    import apt_pkg as apt

    src = config('openstack-origin')

    cur_vers = get_os_version_package(package)

    if "swift" in package:

        codename = get_os_codename_install_source(src)

        avail_vers = get_os_version_codename_swift(codename)

    else:

        avail_vers = get_os_version_install_source(src)

    apt.init()

    if "swift" in package:

        major_cur_vers = cur_vers.split('.', 1)[0]

        major_avail_vers = avail_vers.split('.', 1)[0]

        major_diff = apt.version_compare(major_avail_vers, major_cur_vers)

        return avail_vers > cur_vers and (major_diff == 1 or major_diff == 0)

    return apt.version_compare(avail_vers, cur_vers) == 1

def ensure_block_device(block_device):

    '''

    Confirm block_device, create as loopback if necessary.

    :param block_device: str: Full path of block device to ensure.

    :returns: str: Full path of ensured block device.

    '''

    _none = ['None', 'none', None]

    if (block_device in _none):

        error_out('prepare_storage(): Missing required input: block_device=%s.'

                  % block_device)

    if block_device.startswith('/dev/'):

        bdev = block_device

    elif block_device.startswith('/'):

        _bd = block_device.split('|')

        if len(_bd) == 2:

            bdev, size = _bd

        else:

            bdev = block_device

            size = DEFAULT_LOOPBACK_SIZE

        bdev = ensure_loopback_device(bdev, size)

    else:

        bdev = '/dev/%s' % block_device

    if not is_block_device(bdev):

        error_out('Failed to locate valid block device at %s' % bdev)

    return bdev

def clean_storage(block_device):

    '''

    Ensures a block device is clean.  That is:

        - unmounted

        - any lvm volume groups are deactivated

        - any lvm physical device signatures removed

        - partition table wiped

    :param block_device: str: Full path to block device to clean.

    '''

    for mp, d in mounts():

        if d == block_device:

            juju_log('clean_storage(): %s is mounted @ %s, unmounting.' %

                     (d, mp), level=INFO)

            umount(mp, persist=True)

    if is_lvm_physical_volume(block_device):

        deactivate_lvm_volume_group(block_device)

        remove_lvm_physical_volume(block_device)

    else:

        zap_disk(block_device)

is_ip = ip.is_ip

ns_query = ip.ns_query

get_host_ip = ip.get_host_ip

get_hostname = ip.get_hostname

def get_matchmaker_map(mm_file='/etc/oslo/matchmaker_ring.json'):

    mm_map = {}

    if os.path.isfile(mm_file):

        with open(mm_file, 'r') as f:

            mm_map = json.load(f)

    return mm_map

def sync_db_with_multi_ipv6_addresses(database, database_user,

                                      relation_prefix=None):

    hosts = get_ipv6_addr(dynamic_only=False)

    if config('vip'):

        vips = config('vip').split()

        for vip in vips:

            if vip and is_ipv6(vip):

                hosts.append(vip)

    kwargs = {'database': database,

              'username': database_user,

              'hostname': json.dumps(hosts)}

    if relation_prefix:

        for key in list(kwargs.keys()):

            kwargs["%s_%s" % (relation_prefix, key)] = kwargs[key]

            del kwargs[key]

    for rid in relation_ids('shared-db'):

        relation_set(relation_id=rid, **kwargs)

def os_requires_version(ostack_release, pkg):

    """

    Decorator for hook to specify minimum supported release

    """

    def wrap(f):

        @wraps(f)

        def wrapped_f(*args):

            if os_release(pkg) < ostack_release:

                raise Exception("This hook is not supported on releases"

                                " before %s" % ostack_release)

            f(*args)

        return wrapped_f

    return wrap

def git_install_requested():

    """

    Returns true if openstack-origin-git is specified.

    """

    return config('openstack-origin-git') is not None

requirements_dir = None

def _git_yaml_load(projects_yaml):

    """

    Load the specified yaml into a dictionary.

    """

    if not projects_yaml:

        return None

    return yaml.load(projects_yaml)

def git_clone_and_install(projects_yaml, core_project):

    """

    Clone/install all specified OpenStack repositories.

    The expected format of projects_yaml is:

        repositories:

          - {name: keystone,

             repository: 'git://git.openstack.org/openstack/keystone.git',

             branch: 'stable/icehouse'}

          - {name: requirements,

             repository: 'git://git.openstack.org/openstack/requirements.git',

             branch: 'stable/icehouse'}

        directory: /mnt/openstack-git

        http_proxy: squid-proxy-url

        https_proxy: squid-proxy-url

    The directory, http_proxy, and https_proxy keys are optional.

    """

    global requirements_dir

    parent_dir = '/mnt/openstack-git'

    http_proxy = None

    projects = _git_yaml_load(projects_yaml)

    _git_validate_projects_yaml(projects, core_project)

    old_environ = dict(os.environ)

    if 'http_proxy' in projects.keys():

        http_proxy = projects['http_proxy']

        os.environ['http_proxy'] = projects['http_proxy']

    if 'https_proxy' in projects.keys():

        os.environ['https_proxy'] = projects['https_proxy']

    if 'directory' in projects.keys():

        parent_dir = projects['directory']

    pip_create_virtualenv(os.path.join(parent_dir, 'venv'))

    # Upgrade setuptools and pip from default virtualenv versions. The default

    # versions in trusty break master OpenStack branch deployments.

    for p in ['pip', 'setuptools']:

        pip_install(p, upgrade=True, proxy=http_proxy,

                    venv=os.path.join(parent_dir, 'venv'))

    for p in projects['repositories']:

        repo = p['repository']

        branch = p['branch']

        depth = '1'

        if 'depth' in p.keys():

            depth = p['depth']

        if p['name'] == 'requirements':

            repo_dir = _git_clone_and_install_single(repo, branch, depth,

                                                     parent_dir, http_proxy,

                                                     update_requirements=False)

            requirements_dir = repo_dir

        else:

            repo_dir = _git_clone_and_install_single(repo, branch, depth,

                                                     parent_dir, http_proxy,

                                                     update_requirements=True)

    os.environ = old_environ

def _git_validate_projects_yaml(projects, core_project):

    """

    Validate the projects yaml.

    """

    _git_ensure_key_exists('repositories', projects)

    for project in projects['repositories']:

        _git_ensure_key_exists('name', project.keys())

        _git_ensure_key_exists('repository', project.keys())

        _git_ensure_key_exists('branch', project.keys())

    if projects['repositories'][0]['name'] != 'requirements':

        error_out('{} git repo must be specified first'.format('requirements'))

    if projects['repositories'][-1]['name'] != core_project:

        error_out('{} git repo must be specified last'.format(core_project))

def _git_ensure_key_exists(key, keys):

    """

    Ensure that key exists in keys.

    """

    if key not in keys:

        error_out('openstack-origin-git key \'{}\' is missing'.format(key))

def _git_clone_and_install_single(repo, branch, depth, parent_dir, http_proxy,

                                  update_requirements):

    """

    Clone and install a single git repository.

    """

    if not os.path.exists(parent_dir):

        juju_log('Directory already exists at {}. '

                 'No need to create directory.'.format(parent_dir))

        os.mkdir(parent_dir)

    juju_log('Cloning git repo: {}, branch: {}'.format(repo, branch))

    repo_dir = install_remote(