Merge lp:~james-page/charm-helpers/vpp-rebase into lp:~gnuoy/charm-helpers/cisco-vpp

[James Page]

[Liam Young (gnuoy)]

lgtm

review: Approve

=== modified file 'VERSION'
--- VERSION	2015-05-20 14:31:33 +0000
+++ VERSION	2015-08-13 08:33:21 +0000
@@ -1,1 +1,1 @@
-0.3.2
+0.5.0
 
=== modified file 'charmhelpers/cli/__init__.py'
--- charmhelpers/cli/__init__.py	2015-01-22 06:06:03 +0000
+++ charmhelpers/cli/__init__.py	2015-08-13 08:33:21 +0000
@@ -20,6 +20,8 @@
 
 from six.moves import zip
 
+from charmhelpers.core import unitdata
+
 
 class OutputFormatter(object):
     def __init__(self, outfile=sys.stdout):
@@ -53,6 +55,8 @@
 
     def raw(self, output):
         """Output data as raw string (default)"""
+        if isinstance(output, (list, tuple)):
+            output = '\n'.join(map(str, output))
         self.outfile.write(str(output))
 
     def py(self, output):
@@ -91,6 +95,7 @@
     argument_parser = None
     subparsers = None
     formatter = None
+    exit_code = 0
 
     def __init__(self):
         if not self.argument_parser:
@@ -115,6 +120,21 @@
             return decorated
         return wrapper
 
+    def test_command(self, decorated):
+        """
+        Subcommand is a boolean test function, so bool return values should be
+        converted to a 0/1 exit code.
+        """
+        decorated._cli_test_command = True
+        return decorated
+
+    def no_output(self, decorated):
+        """
+        Subcommand is not expected to return a value, so don't print a spurious None.
+        """
+        decorated._cli_no_output = True
+        return decorated
+
     def subcommand_builder(self, command_name, description=None):
         """
         Decorate a function that builds a subcommand. Builders should accept a
@@ -132,12 +152,19 @@
         arguments = self.argument_parser.parse_args()
         argspec = inspect.getargspec(arguments.func)
         vargs = []
-        kwargs = {}
+        for arg in argspec.args:
+            vargs.append(getattr(arguments, arg))
         if argspec.varargs:
-            vargs = getattr(arguments, argspec.varargs)
-        for arg in argspec.args:
-            kwargs[arg] = getattr(arguments, arg)
-        self.formatter.format_output(arguments.func(*vargs, **kwargs), arguments.format)
+            vargs.extend(getattr(arguments, argspec.varargs))
+        output = arguments.func(*vargs)
+        if getattr(arguments.func, '_cli_test_command', False):
+            self.exit_code = 0 if output else 1
+            output = ''
+        if getattr(arguments.func, '_cli_no_output', False):
+            output = ''
+        self.formatter.format_output(output, arguments.format)
+        if unitdata._KV:
+            unitdata._KV.flush()
 
 
 cmdline = CommandLine()
 
=== modified file 'charmhelpers/cli/commands.py'
--- charmhelpers/cli/commands.py	2015-05-13 20:44:19 +0000
+++ charmhelpers/cli/commands.py	2015-08-13 08:33:21 +0000
@@ -24,8 +24,9 @@
 from . import CommandLine  # noqa
 
 """
-Import the sub-modules to be included by chlp.
+Import the sub-modules which have decorated subcommands to register with chlp.
 """
-import host  # noqa
-import benchmark  # noqa
-import unitdata  # noqa
+from . import host  # noqa
+from . import benchmark  # noqa
+from . import unitdata  # noqa
+from . import hookenv  # noqa
 
=== added file 'charmhelpers/cli/hookenv.py'
--- charmhelpers/cli/hookenv.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/cli/hookenv.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,23 @@
+# 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/>.
+
+from . import cmdline
+from charmhelpers.core import hookenv
+
+
+cmdline.subcommand('relation-id')(hookenv.relation_id._wrapped)
+cmdline.subcommand('service-name')(hookenv.service_name)
+cmdline.subcommand('remote-service-name')(hookenv.remote_service_name._wrapped)
 
=== modified file 'charmhelpers/contrib/amulet/utils.py'
--- charmhelpers/contrib/amulet/utils.py	2015-04-21 15:40:51 +0000
+++ charmhelpers/contrib/amulet/utils.py	2015-08-13 08:33:21 +0000
@@ -14,14 +14,21 @@
 # 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/>.
 
-import ConfigParser
 import io
 import logging
+import os
 import re
 import sys
 import time
 
+import amulet
+import distro_info
 import six
+from six.moves import configparser
+if six.PY3:
+    from urllib import parse as urlparse
+else:
+    import urlparse
 
 
 class AmuletUtils(object):
@@ -33,6 +40,7 @@
 
     def __init__(self, log_level=logging.ERROR):
         self.log = self.get_logger(level=log_level)
+        self.ubuntu_releases = self.get_ubuntu_releases()
 
     def get_logger(self, name="amulet-logger", level=logging.DEBUG):
         """Get a logger object that will log to stdout."""
@@ -70,12 +78,44 @@
         else:
             return False
 
+    def get_ubuntu_release_from_sentry(self, sentry_unit):
+        """Get Ubuntu release codename from sentry unit.
+
+        :param sentry_unit: amulet sentry/service unit pointer
+        :returns: list of strings - release codename, failure message
+        """
+        msg = None
+        cmd = 'lsb_release -cs'
+        release, code = sentry_unit.run(cmd)
+        if code == 0:
+            self.log.debug('{} lsb_release: {}'.format(
+                sentry_unit.info['unit_name'], release))
+        else:
+            msg = ('{} `{}` returned {} '
+                   '{}'.format(sentry_unit.info['unit_name'],
+                               cmd, release, code))
+        if release not in self.ubuntu_releases:
+            msg = ("Release ({}) not found in Ubuntu releases "
+                   "({})".format(release, self.ubuntu_releases))
+        return release, msg
+
     def validate_services(self, commands):
-        """Validate services.
-
-           Verify the specified services are running on the corresponding
+        """Validate that lists of commands succeed on service units.  Can be
+           used to verify system services are running on the corresponding
            service units.
-           """
+
+        :param commands: dict with sentry keys and arbitrary command list vals
+        :returns: None if successful, Failure string message otherwise
+        """
+        self.log.debug('Checking status of system services...')
+
+        # /!\ DEPRECATION WARNING (beisner):
+        # New and existing tests should be rewritten to use
+        # validate_services_by_name() as it is aware of init systems.
+        self.log.warn('/!\\ DEPRECATION WARNING:  use '
+                      'validate_services_by_name instead of validate_services '
+                      'due to init system differences.')
+
         for k, v in six.iteritems(commands):
             for cmd in v:
                 output, code = k.run(cmd)
@@ -86,6 +126,45 @@
                     return "command `{}` returned {}".format(cmd, str(code))
         return None
 
+    def validate_services_by_name(self, sentry_services):
+        """Validate system service status by service name, automatically
+           detecting init system based on Ubuntu release codename.
+
+        :param sentry_services: dict with sentry keys and svc list values
+        :returns: None if successful, Failure string message otherwise
+        """
+        self.log.debug('Checking status of system services...')
+
+        # Point at which systemd became a thing
+        systemd_switch = self.ubuntu_releases.index('vivid')
+
+        for sentry_unit, services_list in six.iteritems(sentry_services):
+            # Get lsb_release codename from unit
+            release, ret = self.get_ubuntu_release_from_sentry(sentry_unit)
+            if ret:
+                return ret
+
+            for service_name in services_list:
+                if (self.ubuntu_releases.index(release) >= systemd_switch or
+                        service_name in ['rabbitmq-server', 'apache2']):
+                    # init is systemd (or regular sysv)
+                    cmd = 'sudo service {} status'.format(service_name)
+                    output, code = sentry_unit.run(cmd)
+                    service_running = code == 0
+                elif self.ubuntu_releases.index(release) < systemd_switch:
+                    # init is upstart
+                    cmd = 'sudo status {}'.format(service_name)
+                    output, code = sentry_unit.run(cmd)
+                    service_running = code == 0 and "start/running" in output
+
+                self.log.debug('{} `{}` returned '
+                               '{}'.format(sentry_unit.info['unit_name'],
+                                           cmd, code))
+                if not service_running:
+                    return u"command `{}` returned {} {}".format(
+                        cmd, output, str(code))
+        return None
+
     def _get_config(self, unit, filename):
         """Get a ConfigParser object for parsing a unit's config file."""
         file_contents = unit.file_contents(filename)
@@ -93,7 +172,7 @@
         # NOTE(beisner):  by default, ConfigParser does not handle options
         # with no value, such as the flags used in the mysql my.cnf file.
         # https://bugs.python.org/issue7005
-        config = ConfigParser.ConfigParser(allow_no_value=True)
+        config = configparser.ConfigParser(allow_no_value=True)
         config.readfp(io.StringIO(file_contents))
         return config
 
@@ -103,7 +182,15 @@
 
            Verify that the specified section of the config file contains
            the expected option key:value pairs.
+
+           Compare expected dictionary data vs actual dictionary data.
+           The values in the 'expected' dictionary can be strings, bools, ints,
+           longs, or can be a function that evaluates a variable and returns a
+           bool.
            """
+        self.log.debug('Validating config file data ({} in {} on {})'
+                       '...'.format(section, config_file,
+                                    sentry_unit.info['unit_name']))
         config = self._get_config(sentry_unit, config_file)
 
         if section != 'DEFAULT' and not config.has_section(section):
@@ -112,9 +199,20 @@
         for k in expected.keys():
             if not config.has_option(section, k):
                 return "section [{}] is missing option {}".format(section, k)
-            if config.get(section, k) != expected[k]:
+
+            actual = config.get(section, k)
+            v = expected[k]
+            if (isinstance(v, six.string_types) or
+                    isinstance(v, bool) or
+                    isinstance(v, six.integer_types)):
+                # handle explicit values
+                if actual != v:
+                    return "section [{}] {}:{} != expected {}:{}".format(
+                           section, k, actual, k, expected[k])
+            # handle function pointers, such as not_null or valid_ip
+            elif not v(actual):
                 return "section [{}] {}:{} != expected {}:{}".format(
-                       section, k, config.get(section, k), k, expected[k])
+                       section, k, actual, k, expected[k])
         return None
 
     def _validate_dict_data(self, expected, actual):
@@ -122,7 +220,7 @@
 
            Compare expected dictionary data vs actual dictionary data.
            The values in the 'expected' dictionary can be strings, bools, ints,
-           longs, or can be a function that evaluate a variable and returns a
+           longs, or can be a function that evaluates a variable and returns a
            bool.
            """
         self.log.debug('actual: {}'.format(repr(actual)))
@@ -133,8 +231,10 @@
                 if (isinstance(v, six.string_types) or
                         isinstance(v, bool) or
                         isinstance(v, six.integer_types)):
+                    # handle explicit values
                     if v != actual[k]:
                         return "{}:{}".format(k, actual[k])
+                # handle function pointers, such as not_null or valid_ip
                 elif not v(actual[k]):
                     return "{}:{}".format(k, actual[k])
             else:
@@ -321,3 +421,133 @@
 
     def endpoint_error(self, name, data):
         return 'unexpected endpoint data in {} - {}'.format(name, data)
+
+    def get_ubuntu_releases(self):
+        """Return a list of all Ubuntu releases in order of release."""
+        _d = distro_info.UbuntuDistroInfo()
+        _release_list = _d.all
+        self.log.debug('Ubuntu release list: {}'.format(_release_list))
+        return _release_list
+
+    def file_to_url(self, file_rel_path):
+        """Convert a relative file path to a file URL."""
+        _abs_path = os.path.abspath(file_rel_path)
+        return urlparse.urlparse(_abs_path, scheme='file').geturl()
+
+    def check_commands_on_units(self, commands, sentry_units):
+        """Check that all commands in a list exit zero on all
+        sentry units in a list.
+
+        :param commands:  list of bash commands
+        :param sentry_units:  list of sentry unit pointers
+        :returns: None if successful; Failure message otherwise
+        """
+        self.log.debug('Checking exit codes for {} commands on {} '
+                       'sentry units...'.format(len(commands),
+                                                len(sentry_units)))
+        for sentry_unit in sentry_units:
+            for cmd in commands:
+                output, code = sentry_unit.run(cmd)
+                if code == 0:
+                    self.log.debug('{} `{}` returned {} '
+                                   '(OK)'.format(sentry_unit.info['unit_name'],
+                                                 cmd, code))
+                else:
+                    return ('{} `{}` returned {} '
+                            '{}'.format(sentry_unit.info['unit_name'],
+                                        cmd, code, output))
+        return None
+
+    def get_process_id_list(self, sentry_unit, process_name):
+        """Get a list of process ID(s) from a single sentry juju unit
+        for a single process name.
+
+        :param sentry_unit: Pointer to amulet sentry instance (juju unit)
+        :param process_name: Process name
+        :returns: List of process IDs
+        """
+        cmd = 'pidof {}'.format(process_name)
+        output, code = sentry_unit.run(cmd)
+        if code != 0:
+            msg = ('{} `{}` returned {} '
+                   '{}'.format(sentry_unit.info['unit_name'],
+                               cmd, code, output))
+            amulet.raise_status(amulet.FAIL, msg=msg)
+        return str(output).split()
+
+    def get_unit_process_ids(self, unit_processes):
+        """Construct a dict containing unit sentries, process names, and
+        process IDs."""
+        pid_dict = {}
+        for sentry_unit, process_list in unit_processes.iteritems():
+            pid_dict[sentry_unit] = {}
+            for process in process_list:
+                pids = self.get_process_id_list(sentry_unit, process)
+                pid_dict[sentry_unit].update({process: pids})
+        return pid_dict
+
+    def validate_unit_process_ids(self, expected, actual):
+        """Validate process id quantities for services on units."""
+        self.log.debug('Checking units for running processes...')
+        self.log.debug('Expected PIDs: {}'.format(expected))
+        self.log.debug('Actual PIDs: {}'.format(actual))
+
+        if len(actual) != len(expected):
+            return ('Unit count mismatch.  expected, actual: {}, '
+                    '{} '.format(len(expected), len(actual)))
+
+        for (e_sentry, e_proc_names) in expected.iteritems():
+            e_sentry_name = e_sentry.info['unit_name']
+            if e_sentry in actual.keys():
+                a_proc_names = actual[e_sentry]
+            else:
+                return ('Expected sentry ({}) not found in actual dict data.'
+                        '{}'.format(e_sentry_name, e_sentry))
+
+            if len(e_proc_names.keys()) != len(a_proc_names.keys()):
+                return ('Process name count mismatch.  expected, actual: {}, '
+                        '{}'.format(len(expected), len(actual)))
+
+            for (e_proc_name, e_pids_length), (a_proc_name, a_pids) in \
+                    zip(e_proc_names.items(), a_proc_names.items()):
+                if e_proc_name != a_proc_name:
+                    return ('Process name mismatch.  expected, actual: {}, '
+                            '{}'.format(e_proc_name, a_proc_name))
+
+                a_pids_length = len(a_pids)
+                fail_msg = ('PID count mismatch. {} ({}) expected, actual: '
+                            '{}, {} ({})'.format(e_sentry_name, e_proc_name,
+                                                 e_pids_length, a_pids_length,
+                                                 a_pids))
+
+                # If expected is not bool, ensure PID quantities match
+                if not isinstance(e_pids_length, bool) and \
+                        a_pids_length != e_pids_length:
+                    return fail_msg
+                # If expected is bool True, ensure 1 or more PIDs exist
+                elif isinstance(e_pids_length, bool) and \
+                        e_pids_length is True and a_pids_length < 1:
+                    return fail_msg
+                # If expected is bool False, ensure 0 PIDs exist
+                elif isinstance(e_pids_length, bool) and \
+                        e_pids_length is False and a_pids_length != 0:
+                    return fail_msg
+                else:
+                    self.log.debug('PID check OK: {} {} {}: '
+                                   '{}'.format(e_sentry_name, e_proc_name,
+                                               e_pids_length, a_pids))
+        return None
+
+    def validate_list_of_identical_dicts(self, list_of_dicts):
+        """Check that all dicts within a list are identical."""
+        hashes = []
+        for _dict in list_of_dicts:
+            hashes.append(hash(frozenset(_dict.items())))
+
+        self.log.debug('Hashes: {}'.format(hashes))
+        if len(set(hashes)) == 1:
+            self.log.debug('Dicts within list are identical')
+        else:
+            return 'Dicts within list are not identical'
+
+        return None
 
=== modified file 'charmhelpers/contrib/benchmark/__init__.py'
--- charmhelpers/contrib/benchmark/__init__.py	2015-04-24 16:18:42 +0000
+++ charmhelpers/contrib/benchmark/__init__.py	2015-08-13 08:33:21 +0000
@@ -63,6 +63,8 @@
 
     """
 
+    BENCHMARK_CONF = '/etc/benchmark.conf'  # Replaced in testing
+
     required_keys = [
         'hostname',
         'port',
@@ -91,7 +93,7 @@
                     break
 
             if len(config):
-                with open('/etc/benchmark.conf', 'w') as f:
+                with open(self.BENCHMARK_CONF, 'w') as f:
                     for key, val in iter(config.items()):
                         f.write("%s=%s\n" % (key, val))
 
 
=== modified file 'charmhelpers/contrib/database/mysql.py'
--- charmhelpers/contrib/database/mysql.py	2015-06-03 20:31:29 +0000
+++ charmhelpers/contrib/database/mysql.py	2015-08-13 08:33:21 +0000
@@ -381,6 +381,9 @@
         if 'wait-timeout' in config:
             mysql_config['wait_timeout'] = config['wait-timeout']
 
+        if 'innodb-flush-log-at-trx-commit' in config:
+            mysql_config['innodb_flush_log_at_trx_commit'] = config['innodb-flush-log-at-trx-commit']
+
         # Set a sane default key_buffer size
         mysql_config['key_buffer'] = self.human_to_bytes('32M')
         total_memory = self.human_to_bytes(self.get_mem_total())
 
=== modified file 'charmhelpers/contrib/network/ufw.py'
--- charmhelpers/contrib/network/ufw.py	2015-02-12 20:08:28 +0000
+++ charmhelpers/contrib/network/ufw.py	2015-08-13 08:33:21 +0000
@@ -180,7 +180,43 @@
         return True
 
 
-def modify_access(src, dst='any', port=None, proto=None, action='allow'):
+def default_policy(policy='deny', direction='incoming'):
+    """
+    Changes the default policy for traffic `direction`
+
+    :param policy: allow, deny or reject
+    :param direction: traffic direction, possible values: incoming, outgoing,
+                      routed
+    """
+    if policy not in ['allow', 'deny', 'reject']:
+        raise UFWError(('Unknown policy %s, valid values: '
+                        'allow, deny, reject') % policy)
+
+    if direction not in ['incoming', 'outgoing', 'routed']:
+        raise UFWError(('Unknown direction %s, valid values: '
+                        'incoming, outgoing, routed') % direction)
+
+    output = subprocess.check_output(['ufw', 'default', policy, direction],
+                                     universal_newlines=True,
+                                     env={'LANG': 'en_US',
+                                          'PATH': os.environ['PATH']})
+    hookenv.log(output, level='DEBUG')
+
+    m = re.findall("^Default %s policy changed to '%s'\n" % (direction,
+                                                             policy),
+                   output, re.M)
+    if len(m) == 0:
+        hookenv.log("ufw couldn't change the default policy to %s for %s"
+                    % (policy, direction), level='WARN')
+        return False
+    else:
+        hookenv.log("ufw default policy for %s changed to %s"
+                    % (direction, policy), level='INFO')
+        return True
+
+
+def modify_access(src, dst='any', port=None, proto=None, action='allow',
+                  index=None):
     """
     Grant access to an address or subnet
 
@@ -192,6 +228,8 @@
     :param port: destiny port
     :param proto: protocol (tcp or udp)
     :param action: `allow` or `delete`
+    :param index: if different from None the rule is inserted at the given
+                  `index`.
     """
     if not is_enabled():
         hookenv.log('ufw is disabled, skipping modify_access()', level='WARN')
@@ -199,6 +237,8 @@
 
     if action == 'delete':
         cmd = ['ufw', 'delete', 'allow']
+    elif index is not None:
+        cmd = ['ufw', 'insert', str(index), action]
     else:
         cmd = ['ufw', action]
 
@@ -227,7 +267,7 @@
                     level='ERROR')
 
 
-def grant_access(src, dst='any', port=None, proto=None):
+def grant_access(src, dst='any', port=None, proto=None, index=None):
     """
     Grant access to an address or subnet
 
@@ -238,8 +278,11 @@
                 field has to be set.
     :param port: destiny port
     :param proto: protocol (tcp or udp)
+    :param index: if different from None the rule is inserted at the given
+                  `index`.
     """
-    return modify_access(src, dst=dst, port=port, proto=proto, action='allow')
+    return modify_access(src, dst=dst, port=port, proto=proto, action='allow',
+                         index=index)
 
 
 def revoke_access(src, dst='any', port=None, proto=None):
 
=== modified file 'charmhelpers/contrib/openstack/amulet/deployment.py'
--- charmhelpers/contrib/openstack/amulet/deployment.py	2015-08-12 07:50:34 +0000
+++ charmhelpers/contrib/openstack/amulet/deployment.py	2015-08-13 08:33:21 +0000
@@ -44,7 +44,7 @@
            Determine if the local branch being tested is derived from its
            stable or next (dev) branch, and based on this, use the corresonding
            stable or next branches for the other_services."""
-        base_charms = ['mysql', 'mongodb']
+        base_charms = ['mysql', 'mongodb', 'nrpe']
 
         if self.series in ['precise', 'trusty']:
             base_series = self.series
@@ -83,9 +83,10 @@
         services.append(this_service)
         use_source = ['mysql', 'mongodb', 'rabbitmq-server', 'ceph',
                       'ceph-osd', 'ceph-radosgw']
-        # Openstack subordinate charms do not expose an origin option as that
-        # is controlled by the principle
-        ignore = ['neutron-openvswitch', 'cisco-vpp', 'odl-controller']
+        # Most OpenStack subordinate charms do not expose an origin option
+        # as that is controlled by the principle.
+        ignore = ['cinder-ceph', 'hacluster', 'neutron-openvswitch', 'nrpe',
+                  'cisco-vpp', 'odl-controller']
 
         if self.openstack:
             for svc in services:
@@ -152,3 +153,36 @@
             return os_origin.split('%s-' % self.series)[1].split('/')[0]
         else:
             return releases[self.series]
+
+    def get_ceph_expected_pools(self, radosgw=False):
+        """Return a list of expected ceph pools in a ceph + cinder + glance
+        test scenario, based on OpenStack release and whether ceph radosgw
+        is flagged as present or not."""
+
+        if self._get_openstack_release() >= self.trusty_kilo:
+            # Kilo or later
+            pools = [
+                'rbd',
+                'cinder',
+                'glance'
+            ]
+        else:
+            # Juno or earlier
+            pools = [
+                'data',
+                'metadata',
+                'rbd',
+                'cinder',
+                'glance'
+            ]
+
+        if radosgw:
+            pools.extend([
+                '.rgw.root',
+                '.rgw.control',
+                '.rgw',
+                '.rgw.gc',
+                '.users.uid'
+            ])
+
+        return pools
 
=== modified file 'charmhelpers/contrib/openstack/amulet/utils.py'
--- charmhelpers/contrib/openstack/amulet/utils.py	2015-01-22 06:06:03 +0000
+++ charmhelpers/contrib/openstack/amulet/utils.py	2015-08-13 08:33:21 +0000
@@ -14,16 +14,20 @@
 # 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/>.
 
+import amulet
+import json
 import logging
 import os
+import six
 import time
 import urllib
 
+import cinderclient.v1.client as cinder_client
 import glanceclient.v1.client as glance_client
+import heatclient.v1.client as heat_client
 import keystoneclient.v2_0 as keystone_client
 import novaclient.v1_1.client as nova_client
-
-import six
+import swiftclient
 
 from charmhelpers.contrib.amulet.utils import (
     AmuletUtils
@@ -37,7 +41,7 @@
     """OpenStack amulet utilities.
 
        This class inherits from AmuletUtils and has additional support
-       that is specifically for use by OpenStack charms.
+       that is specifically for use by OpenStack charm tests.
        """
 
     def __init__(self, log_level=ERROR):
@@ -51,6 +55,8 @@
            Validate actual endpoint data vs expected endpoint data. The ports
            are used to find the matching endpoint.
            """
+        self.log.debug('Validating endpoint data...')
+        self.log.debug('actual: {}'.format(repr(endpoints)))
         found = False
         for ep in endpoints:
             self.log.debug('endpoint: {}'.format(repr(ep)))
@@ -77,6 +83,7 @@
            Validate a list of actual service catalog endpoints vs a list of
            expected service catalog endpoints.
            """
+        self.log.debug('Validating service catalog endpoint data...')
         self.log.debug('actual: {}'.format(repr(actual)))
         for k, v in six.iteritems(expected):
             if k in actual:
@@ -93,6 +100,7 @@
            Validate a list of actual tenant data vs list of expected tenant
            data.
            """
+        self.log.debug('Validating tenant data...')
         self.log.debug('actual: {}'.format(repr(actual)))
         for e in expected:
             found = False
@@ -114,6 +122,7 @@
            Validate a list of actual role data vs a list of expected role
            data.
            """
+        self.log.debug('Validating role data...')
         self.log.debug('actual: {}'.format(repr(actual)))
         for e in expected:
             found = False
@@ -134,6 +143,7 @@
            Validate a list of actual user data vs a list of expected user
            data.
            """
+        self.log.debug('Validating user data...')
         self.log.debug('actual: {}'.format(repr(actual)))
         for e in expected:
             found = False
@@ -155,17 +165,30 @@
 
            Validate a list of actual flavors vs a list of expected flavors.
            """
+        self.log.debug('Validating flavor data...')
         self.log.debug('actual: {}'.format(repr(actual)))
         act = [a.name for a in actual]
         return self._validate_list_data(expected, act)
 
     def tenant_exists(self, keystone, tenant):
         """Return True if tenant exists."""
+        self.log.debug('Checking if tenant exists ({})...'.format(tenant))
         return tenant in [t.name for t in keystone.tenants.list()]
 
+    def authenticate_cinder_admin(self, keystone_sentry, username,
+                                  password, tenant):
+        """Authenticates admin user with cinder."""
+        # NOTE(beisner): cinder python client doesn't accept tokens.
+        service_ip = \
+            keystone_sentry.relation('shared-db',
+                                     'mysql:shared-db')['private-address']
+        ept = "http://{}:5000/v2.0".format(service_ip.strip().decode('utf-8'))
+        return cinder_client.Client(username, password, tenant, ept)
+
     def authenticate_keystone_admin(self, keystone_sentry, user, password,
                                     tenant):
         """Authenticates admin user with the keystone admin endpoint."""
+        self.log.debug('Authenticating keystone admin...')
         unit = keystone_sentry
         service_ip = unit.relation('shared-db',
                                    'mysql:shared-db')['private-address']
@@ -175,6 +198,7 @@
 
     def authenticate_keystone_user(self, keystone, user, password, tenant):
         """Authenticates a regular user with the keystone public endpoint."""
+        self.log.debug('Authenticating keystone user ({})...'.format(user))
         ep = keystone.service_catalog.url_for(service_type='identity',
                                               endpoint_type='publicURL')
         return keystone_client.Client(username=user, password=password,
@@ -182,19 +206,49 @@
 
     def authenticate_glance_admin(self, keystone):
         """Authenticates admin user with glance."""
+        self.log.debug('Authenticating glance admin...')
         ep = keystone.service_catalog.url_for(service_type='image',
                                               endpoint_type='adminURL')
         return glance_client.Client(ep, token=keystone.auth_token)
 
+    def authenticate_heat_admin(self, keystone):
+        """Authenticates the admin user with heat."""
+        self.log.debug('Authenticating heat admin...')
+        ep = keystone.service_catalog.url_for(service_type='orchestration',
+                                              endpoint_type='publicURL')
+        return heat_client.Client(endpoint=ep, token=keystone.auth_token)
+
     def authenticate_nova_user(self, keystone, user, password, tenant):
         """Authenticates a regular user with nova-api."""
+        self.log.debug('Authenticating nova user ({})...'.format(user))
         ep = keystone.service_catalog.url_for(service_type='identity',
                                               endpoint_type='publicURL')
         return nova_client.Client(username=user, api_key=password,
                                   project_id=tenant, auth_url=ep)
 
+    def authenticate_swift_user(self, keystone, user, password, tenant):
+        """Authenticates a regular user with swift api."""
+        self.log.debug('Authenticating swift user ({})...'.format(user))
+        ep = keystone.service_catalog.url_for(service_type='identity',
+                                              endpoint_type='publicURL')
+        return swiftclient.Connection(authurl=ep,
+                                      user=user,
+                                      key=password,
+                                      tenant_name=tenant,
+                                      auth_version='2.0')
+
     def create_cirros_image(self, glance, image_name):
-        """Download the latest cirros image and upload it to glance."""
+        """Download the latest cirros image and upload it to glance,
+        validate and return a resource pointer.
+
+        :param glance: pointer to authenticated glance connection
+        :param image_name: display name for new image
+        :returns: glance image pointer
+        """
+        self.log.debug('Creating glance cirros image '
+                       '({})...'.format(image_name))
+
+        # Download cirros image
         http_proxy = os.getenv('AMULET_HTTP_PROXY')
         self.log.debug('AMULET_HTTP_PROXY: {}'.format(http_proxy))
         if http_proxy:
@@ -203,57 +257,67 @@
         else:
             opener = urllib.FancyURLopener()
 
-        f = opener.open("http://download.cirros-cloud.net/version/released")
+        f = opener.open('http://download.cirros-cloud.net/version/released')
         version = f.read().strip()
-        cirros_img = "cirros-{}-x86_64-disk.img".format(version)
+        cirros_img = 'cirros-{}-x86_64-disk.img'.format(version)
         local_path = os.path.join('tests', cirros_img)
 
         if not os.path.exists(local_path):
-            cirros_url = "http://{}/{}/{}".format("download.cirros-cloud.net",
+            cirros_url = 'http://{}/{}/{}'.format('download.cirros-cloud.net',
                                                   version, cirros_img)
             opener.retrieve(cirros_url, local_path)
         f.close()
 
+        # Create glance image
         with open(local_path) as f:
             image = glance.images.create(name=image_name, is_public=True,
                                          disk_format='qcow2',
                                          container_format='bare', data=f)
-        count = 1
-        status = image.status
-        while status != 'active' and count < 10:
-            time.sleep(3)
-            image = glance.images.get(image.id)
-            status = image.status
-            self.log.debug('image status: {}'.format(status))
-            count += 1
-
-        if status != 'active':
-            self.log.error('image creation timed out')
-            return None
+
+        # Wait for image to reach active status
+        img_id = image.id
+        ret = self.resource_reaches_status(glance.images, img_id,
+                                           expected_stat='active',
+                                           msg='Image status wait')
+        if not ret:
+            msg = 'Glance image failed to reach expected state.'
+            amulet.raise_status(amulet.FAIL, msg=msg)
+
+        # Re-validate new image
+        self.log.debug('Validating image attributes...')
+        val_img_name = glance.images.get(img_id).name
+        val_img_stat = glance.images.get(img_id).status
+        val_img_pub = glance.images.get(img_id).is_public
+        val_img_cfmt = glance.images.get(img_id).container_format
+        val_img_dfmt = glance.images.get(img_id).disk_format
+        msg_attr = ('Image attributes - name:{} public:{} id:{} stat:{} '
+                    'container fmt:{} disk fmt:{}'.format(
+                        val_img_name, val_img_pub, img_id,
+                        val_img_stat, val_img_cfmt, val_img_dfmt))
+
+        if val_img_name == image_name and val_img_stat == 'active' \
+                and val_img_pub is True and val_img_cfmt == 'bare' \
+                and val_img_dfmt == 'qcow2':
+            self.log.debug(msg_attr)
+        else:
+            msg = ('Volume validation failed, {}'.format(msg_attr))
+            amulet.raise_status(amulet.FAIL, msg=msg)
 
         return image
 
     def delete_image(self, glance, image):
         """Delete the specified image."""
-        num_before = len(list(glance.images.list()))
-        glance.images.delete(image)
-
-        count = 1
-        num_after = len(list(glance.images.list()))
-        while num_after != (num_before - 1) and count < 10:
-            time.sleep(3)
-            num_after = len(list(glance.images.list()))
-            self.log.debug('number of images: {}'.format(num_after))
-            count += 1
-
-        if num_after != (num_before - 1):
-            self.log.error('image deletion timed out')
-            return False
-
-        return True
+
+        # /!\ DEPRECATION WARNING
+        self.log.warn('/!\\ DEPRECATION WARNING:  use '
+                      'delete_resource instead of delete_image.')
+        self.log.debug('Deleting glance image ({})...'.format(image))
+        return self.delete_resource(glance.images, image, msg='glance image')
 
     def create_instance(self, nova, image_name, instance_name, flavor):
         """Create the specified instance."""
+        self.log.debug('Creating instance '
+                       '({}|{}|{})'.format(instance_name, image_name, flavor))
         image = nova.images.find(name=image_name)
         flavor = nova.flavors.find(name=flavor)
         instance = nova.servers.create(name=instance_name, image=image,
@@ -276,19 +340,265 @@
 
     def delete_instance(self, nova, instance):
         """Delete the specified instance."""
-        num_before = len(list(nova.servers.list()))
-        nova.servers.delete(instance)
-
-        count = 1
-        num_after = len(list(nova.servers.list()))
-        while num_after != (num_before - 1) and count < 10:
-            time.sleep(3)
-            num_after = len(list(nova.servers.list()))
-            self.log.debug('number of instances: {}'.format(num_after))
-            count += 1
-
-        if num_after != (num_before - 1):
-            self.log.error('instance deletion timed out')
-            return False
-
-        return True
+
+        # /!\ DEPRECATION WARNING
+        self.log.warn('/!\\ DEPRECATION WARNING:  use '
+                      'delete_resource instead of delete_instance.')
+        self.log.debug('Deleting instance ({})...'.format(instance))
+        return self.delete_resource(nova.servers, instance,
+                                    msg='nova instance')
+
+    def create_or_get_keypair(self, nova, keypair_name="testkey"):
+        """Create a new keypair, or return pointer if it already exists."""
+        try:
+            _keypair = nova.keypairs.get(keypair_name)
+            self.log.debug('Keypair ({}) already exists, '
+                           'using it.'.format(keypair_name))
+            return _keypair
+        except:
+            self.log.debug('Keypair ({}) does not exist, '
+                           'creating it.'.format(keypair_name))
+
+        _keypair = nova.keypairs.create(name=keypair_name)
+        return _keypair
+
+    def create_cinder_volume(self, cinder, vol_name="demo-vol", vol_size=1,
+                             img_id=None, src_vol_id=None, snap_id=None):
+        """Create cinder volume, optionally from a glance image, OR
+        optionally as a clone of an existing volume, OR optionally
+        from a snapshot.  Wait for the new volume status to reach
+        the expected status, validate and return a resource pointer.
+
+        :param vol_name: cinder volume display name
+        :param vol_size: size in gigabytes
+        :param img_id: optional glance image id
+        :param src_vol_id: optional source volume id to clone
+        :param snap_id: optional snapshot id to use
+        :returns: cinder volume pointer
+        """
+        # Handle parameter input and avoid impossible combinations
+        if img_id and not src_vol_id and not snap_id:
+            # Create volume from image
+            self.log.debug('Creating cinder volume from glance image...')
+            bootable = 'true'
+        elif src_vol_id and not img_id and not snap_id:
+            # Clone an existing volume
+            self.log.debug('Cloning cinder volume...')
+            bootable = cinder.volumes.get(src_vol_id).bootable
+        elif snap_id and not src_vol_id and not img_id:
+            # Create volume from snapshot
+            self.log.debug('Creating cinder volume from snapshot...')
+            snap = cinder.volume_snapshots.find(id=snap_id)
+            vol_size = snap.size
+            snap_vol_id = cinder.volume_snapshots.get(snap_id).volume_id
+            bootable = cinder.volumes.get(snap_vol_id).bootable
+        elif not img_id and not src_vol_id and not snap_id:
+            # Create volume
+            self.log.debug('Creating cinder volume...')
+            bootable = 'false'
+        else:
+            # Impossible combination of parameters
+            msg = ('Invalid method use - name:{} size:{} img_id:{} '
+                   'src_vol_id:{} snap_id:{}'.format(vol_name, vol_size,
+                                                     img_id, src_vol_id,
+                                                     snap_id))
+            amulet.raise_status(amulet.FAIL, msg=msg)
+
+        # Create new volume
+        try:
+            vol_new = cinder.volumes.create(display_name=vol_name,
+                                            imageRef=img_id,
+                                            size=vol_size,
+                                            source_volid=src_vol_id,
+                                            snapshot_id=snap_id)
+            vol_id = vol_new.id
+        except Exception as e:
+            msg = 'Failed to create volume: {}'.format(e)
+            amulet.raise_status(amulet.FAIL, msg=msg)
+
+        # Wait for volume to reach available status
+        ret = self.resource_reaches_status(cinder.volumes, vol_id,
+                                           expected_stat="available",
+                                           msg="Volume status wait")
+        if not ret:
+            msg = 'Cinder volume failed to reach expected state.'
+            amulet.raise_status(amulet.FAIL, msg=msg)
+
+        # Re-validate new volume
+        self.log.debug('Validating volume attributes...')
+        val_vol_name = cinder.volumes.get(vol_id).display_name
+        val_vol_boot = cinder.volumes.get(vol_id).bootable
+        val_vol_stat = cinder.volumes.get(vol_id).status
+        val_vol_size = cinder.volumes.get(vol_id).size
+        msg_attr = ('Volume attributes - name:{} id:{} stat:{} boot:'
+                    '{} size:{}'.format(val_vol_name, vol_id,
+                                        val_vol_stat, val_vol_boot,
+                                        val_vol_size))
+
+        if val_vol_boot == bootable and val_vol_stat == 'available' \
+                and val_vol_name == vol_name and val_vol_size == vol_size:
+            self.log.debug(msg_attr)
+        else:
+            msg = ('Volume validation failed, {}'.format(msg_attr))
+            amulet.raise_status(amulet.FAIL, msg=msg)
+
+        return vol_new
+
+    def delete_resource(self, resource, resource_id,
+                        msg="resource", max_wait=120):
+        """Delete one openstack resource, such as one instance, keypair,
+        image, volume, stack, etc., and confirm deletion within max wait time.
+
+        :param resource: pointer to os resource type, ex:glance_client.images
+        :param resource_id: unique name or id for the openstack resource
+        :param msg: text to identify purpose in logging
+        :param max_wait: maximum wait time in seconds
+        :returns: True if successful, otherwise False
+        """
+        self.log.debug('Deleting OpenStack resource '
+                       '{} ({})'.format(resource_id, msg))
+        num_before = len(list(resource.list()))
+        resource.delete(resource_id)
+
+        tries = 0
+        num_after = len(list(resource.list()))
+        while num_after != (num_before - 1) and tries < (max_wait / 4):
+            self.log.debug('{} delete check: '
+                           '{} [{}:{}] {}'.format(msg, tries,
+                                                  num_before,
+                                                  num_after,
+                                                  resource_id))
+            time.sleep(4)
+            num_after = len(list(resource.list()))
+            tries += 1
+
+        self.log.debug('{}:  expected, actual count = {}, '
+                       '{}'.format(msg, num_before - 1, num_after))
+
+        if num_after == (num_before - 1):
+            return True
+        else:
+            self.log.error('{} delete timed out'.format(msg))
+            return False
+
+    def resource_reaches_status(self, resource, resource_id,
+                                expected_stat='available',
+                                msg='resource', max_wait=120):
+        """Wait for an openstack resources status to reach an
+           expected status within a specified time.  Useful to confirm that
+           nova instances, cinder vols, snapshots, glance images, heat stacks
+           and other resources eventually reach the expected status.
+
+        :param resource: pointer to os resource type, ex: heat_client.stacks
+        :param resource_id: unique id for the openstack resource
+        :param expected_stat: status to expect resource to reach
+        :param msg: text to identify purpose in logging
+        :param max_wait: maximum wait time in seconds
+        :returns: True if successful, False if status is not reached
+        """
+
+        tries = 0
+        resource_stat = resource.get(resource_id).status
+        while resource_stat != expected_stat and tries < (max_wait / 4):
+            self.log.debug('{} status check: '
+                           '{} [{}:{}] {}'.format(msg, tries,
+                                                  resource_stat,
+                                                  expected_stat,
+                                                  resource_id))
+            time.sleep(4)
+            resource_stat = resource.get(resource_id).status
+            tries += 1
+
+        self.log.debug('{}:  expected, actual status = {}, '
+                       '{}'.format(msg, resource_stat, expected_stat))
+
+        if resource_stat == expected_stat:
+            return True
+        else:
+            self.log.debug('{} never reached expected status: '
+                           '{}'.format(resource_id, expected_stat))
+            return False
+
+    def get_ceph_osd_id_cmd(self, index):
+        """Produce a shell command that will return a ceph-osd id."""
+        return ("`initctl list | grep 'ceph-osd ' | "
+                "awk 'NR=={} {{ print $2 }}' | "
+                "grep -o '[0-9]*'`".format(index + 1))
+
+    def get_ceph_pools(self, sentry_unit):
+        """Return a dict of ceph pools from a single ceph unit, with
+        pool name as keys, pool id as vals."""
+        pools = {}
+        cmd = 'sudo ceph osd lspools'
+        output, code = sentry_unit.run(cmd)
+        if code != 0:
+            msg = ('{} `{}` returned {} '
+                   '{}'.format(sentry_unit.info['unit_name'],
+                               cmd, code, output))
+            amulet.raise_status(amulet.FAIL, msg=msg)
+
+        # Example output: 0 data,1 metadata,2 rbd,3 cinder,4 glance,
+        for pool in str(output).split(','):
+            pool_id_name = pool.split(' ')
+            if len(pool_id_name) == 2:
+                pool_id = pool_id_name[0]
+                pool_name = pool_id_name[1]
+                pools[pool_name] = int(pool_id)
+
+        self.log.debug('Pools on {}: {}'.format(sentry_unit.info['unit_name'],
+                                                pools))
+        return pools
+
+    def get_ceph_df(self, sentry_unit):
+        """Return dict of ceph df json output, including ceph pool state.
+
+        :param sentry_unit: Pointer to amulet sentry instance (juju unit)
+        :returns: Dict of ceph df output
+        """
+        cmd = 'sudo ceph df --format=json'
+        output, code = sentry_unit.run(cmd)
+        if code != 0:
+            msg = ('{} `{}` returned {} '
+                   '{}'.format(sentry_unit.info['unit_name'],
+                               cmd, code, output))
+            amulet.raise_status(amulet.FAIL, msg=msg)
+        return json.loads(output)
+
+    def get_ceph_pool_sample(self, sentry_unit, pool_id=0):
+        """Take a sample of attributes of a ceph pool, returning ceph
+        pool name, object count and disk space used for the specified
+        pool ID number.
+
+        :param sentry_unit: Pointer to amulet sentry instance (juju unit)
+        :param pool_id: Ceph pool ID
+        :returns: List of pool name, object count, kb disk space used
+        """
+        df = self.get_ceph_df(sentry_unit)
+        pool_name = df['pools'][pool_id]['name']
+        obj_count = df['pools'][pool_id]['stats']['objects']
+        kb_used = df['pools'][pool_id]['stats']['kb_used']
+        self.log.debug('Ceph {} pool (ID {}): {} objects, '
+                       '{} kb used'.format(pool_name, pool_id,
+                                           obj_count, kb_used))
+        return pool_name, obj_count, kb_used
+
+    def validate_ceph_pool_samples(self, samples, sample_type="resource pool"):
+        """Validate ceph pool samples taken over time, such as pool
+        object counts or pool kb used, before adding, after adding, and
+        after deleting items which affect those pool attributes.  The
+        2nd element is expected to be greater than the 1st; 3rd is expected
+        to be less than the 2nd.
+
+        :param samples: List containing 3 data samples
+        :param sample_type: String for logging and usage context
+        :returns: None if successful, Failure message otherwise
+        """
+        original, created, deleted = range(3)
+        if samples[created] <= samples[original] or \
+                samples[deleted] >= samples[created]:
+            return ('Ceph {} samples ({}) '
+                    'unexpected.'.format(sample_type, samples))
+        else:
+            self.log.debug('Ceph {} samples (OK): '
+                           '{}'.format(sample_type, samples))
+            return None
 
=== modified file 'charmhelpers/contrib/openstack/context.py'
--- charmhelpers/contrib/openstack/context.py	2015-04-16 19:19:18 +0000
+++ charmhelpers/contrib/openstack/context.py	2015-08-13 08:33:21 +0000
@@ -122,21 +122,24 @@
          of specifying multiple key value pairs within the same string. For
          example, a string in the format of 'key1=value1, key2=value2' will
          return a dict of:
-         {'key1': 'value1',
-          'key2': 'value2'}.
+
+             {'key1': 'value1',
+              'key2': 'value2'}.
 
       2. A string in the above format, but supporting a comma-delimited list
          of values for the same key. For example, a string in the format of
          'key1=value1, key2=value3,value4,value5' will return a dict of:
-         {'key1', 'value1',
-          'key2', 'value2,value3,value4'}
+
+             {'key1', 'value1',
+              'key2', 'value2,value3,value4'}
 
       3. A string containing a colon character (:) prior to an equal
          character (=) will be treated as yaml and parsed as such. This can be
          used to specify more complex key value pairs. For example,
          a string in the format of 'key1: subkey1=value1, subkey2=value2' will
          return a dict of:
-         {'key1', 'subkey1=value1, subkey2=value2'}
+
+             {'key1', 'subkey1=value1, subkey2=value2'}
 
     The provided config_flags string may be a list of comma-separated values
     which themselves may be comma-separated list of values.
@@ -240,7 +243,7 @@
         if self.relation_prefix:
             password_setting = self.relation_prefix + '_password'
 
-        for rid in relation_ids('shared-db'):
+        for rid in relation_ids(self.interfaces[0]):
             for unit in related_units(rid):
                 rdata = relation_get(rid=rid, unit=unit)
                 host = rdata.get('db_host')
@@ -891,8 +894,6 @@
         return ctxt
 
     def __call__(self):
-        self._ensure_packages()
-
         if self.network_manager not in ['quantum', 'neutron']:
             return {}
 
@@ -1050,13 +1051,22 @@
         :param config_file : Service's config file to query sections
         :param interface   : Subordinate interface to inspect
         """
-        self.service = service
         self.config_file = config_file
-        self.interface = interface
+        if isinstance(service, list):
+            self.services = service
+        else:
+            self.services = [service]
+        if isinstance(interface, list):
+            self.interfaces = interface
+        else:
+            self.interfaces = [interface]
 
     def __call__(self):
         ctxt = {'sections': {}}
-        for rid in relation_ids(self.interface):
+        rids = []
+        for interface in self.interfaces:
+            rids.extend(relation_ids(interface))
+        for rid in rids:
             for unit in related_units(rid):
                 sub_config = relation_get('subordinate_configuration',
                                           rid=rid, unit=unit)
@@ -1068,29 +1078,32 @@
                             'setting from %s' % rid, level=ERROR)
                         continue
 
-                    if self.service not in sub_config:
-                        log('Found subordinate_config on %s but it contained'
-                            'nothing for %s service' % (rid, self.service),
-                            level=INFO)
-                        continue
-
-                    sub_config = sub_config[self.service]
-                    if self.config_file not in sub_config:
-                        log('Found subordinate_config on %s but it contained'
-                            'nothing for %s' % (rid, self.config_file),
-                            level=INFO)
-                        continue
-
-                    sub_config = sub_config[self.config_file]
-                    for k, v in six.iteritems(sub_config):
-                        if k == 'sections':
-                            for section, config_dict in six.iteritems(v):
-                                log("adding section '%s'" % (section),
-                                    level=DEBUG)
-                                ctxt[k][section] = config_dict
-                        else:
-                            ctxt[k] = v
-
+                    for service in self.services:
+                        if service not in sub_config:
+                            log('Found subordinate_config on %s but it contained'
+                                'nothing for %s service' % (rid, service),
+                                level=INFO)
+                            continue
+
+                        sub_config = sub_config[service]
+                        if self.config_file not in sub_config:
+                            log('Found subordinate_config on %s but it contained'
+                                'nothing for %s' % (rid, self.config_file),
+                                level=INFO)
+                            continue
+
+                        sub_config = sub_config[self.config_file]
+                        for k, v in six.iteritems(sub_config):
+                            if k == 'sections':
+                                for section, config_list in six.iteritems(v):
+                                    log("adding section '%s'" % (section),
+                                        level=DEBUG)
+                                    if ctxt[k].get(section):
+                                        ctxt[k][section].extend(config_list)
+                                    else:
+                                        ctxt[k][section] = config_list
+                            else:
+                                ctxt[k] = v
         log("%d section(s) found" % (len(ctxt['sections'])), level=DEBUG)
         return ctxt
 
 
=== modified file 'charmhelpers/contrib/openstack/templates/ceph.conf'
--- charmhelpers/contrib/openstack/templates/ceph.conf	2014-03-26 10:26:36 +0000
+++ charmhelpers/contrib/openstack/templates/ceph.conf	2015-08-13 08:33:21 +0000
@@ -5,11 +5,11 @@
 ###############################################################################
 [global]
 {% if auth -%}
- auth_supported = {{ auth }}
- keyring = /etc/ceph/$cluster.$name.keyring
- mon host = {{ mon_hosts }}
+auth_supported = {{ auth }}
+keyring = /etc/ceph/$cluster.$name.keyring
+mon host = {{ mon_hosts }}
 {% endif -%}
- log to syslog = {{ use_syslog }}
- err to syslog = {{ use_syslog }}
- clog to syslog = {{ use_syslog }}
+log to syslog = {{ use_syslog }}
+err to syslog = {{ use_syslog }}
+clog to syslog = {{ use_syslog }}
 
 
=== modified file 'charmhelpers/contrib/openstack/templating.py'
--- charmhelpers/contrib/openstack/templating.py	2015-06-11 09:00:37 +0000
+++ charmhelpers/contrib/openstack/templating.py	2015-08-13 08:33:21 +0000
@@ -29,8 +29,8 @@
 try:
     from jinja2 import FileSystemLoader, ChoiceLoader, Environment, exceptions
 except ImportError:
-    # python-jinja2 may not be installed yet, or we're running unittests.
-    FileSystemLoader = ChoiceLoader = Environment = exceptions = None
+    apt_install('python-jinja2', fatal=True)
+    from jinja2 import FileSystemLoader, ChoiceLoader, Environment, exceptions
 
 
 class OSConfigException(Exception):
 
=== modified file 'charmhelpers/contrib/openstack/utils.py'
--- charmhelpers/contrib/openstack/utils.py	2015-06-17 12:22:29 +0000
+++ charmhelpers/contrib/openstack/utils.py	2015-08-13 08:33:21 +0000
@@ -25,6 +25,7 @@
 import os
 import sys
 import uuid
+import re
 
 import six
 import yaml
@@ -71,7 +72,6 @@
 DISTRO_PROPOSED = ('deb http://archive.ubuntu.com/ubuntu/ %s-proposed '
                    'restricted main multiverse universe')
 
-
 UBUNTU_OPENSTACK_RELEASE = OrderedDict([
     ('oneiric', 'diablo'),
     ('precise', 'essex'),
@@ -81,6 +81,7 @@
     ('trusty', 'icehouse'),
     ('utopic', 'juno'),
     ('vivid', 'kilo'),
+    ('wily', 'liberty'),
 ])
 
 
@@ -93,6 +94,7 @@
     ('2014.1', 'icehouse'),
     ('2014.2', 'juno'),
     ('2015.1', 'kilo'),
+    ('2015.2', 'liberty'),
 ])
 
 # The ugly duckling
@@ -115,8 +117,37 @@
     ('2.2.0', 'juno'),
     ('2.2.1', 'kilo'),
     ('2.2.2', 'kilo'),
+    ('2.3.0', 'liberty'),
 ])
 
+# >= Liberty version->codename mapping
+PACKAGE_CODENAMES = {
+    'nova-common': OrderedDict([
+        ('12.0.0', 'liberty'),
+    ]),
+    'neutron-common': OrderedDict([
+        ('7.0.0', 'liberty'),
+    ]),
+    'cinder-common': OrderedDict([
+        ('7.0.0', 'liberty'),
+    ]),
+    'keystone': OrderedDict([
+        ('8.0.0', 'liberty'),
+    ]),
+    'horizon-common': OrderedDict([
+        ('8.0.0', 'liberty'),
+    ]),
+    'ceilometer-common': OrderedDict([
+        ('5.0.0', 'liberty'),
+    ]),
+    'heat-common': OrderedDict([
+        ('5.0.0', 'liberty'),
+    ]),
+    'glance-common': OrderedDict([
+        ('11.0.0', 'liberty'),
+    ]),
+}
+
 DEFAULT_LOOPBACK_SIZE = '5G'
 
 
@@ -200,20 +231,29 @@
         error_out(e)
 
     vers = apt.upstream_version(pkg.current_ver.ver_str)
+    match = re.match('^(\d)\.(\d)\.(\d)', vers)
+    if match:
+        vers = match.group(0)
 
-    try:
-        if 'swift' in pkg.name:
-            swift_vers = vers[:5]
-            if swift_vers not in SWIFT_CODENAMES:
-                # Deal with 1.10.0 upward
-                swift_vers = vers[:6]
-            return SWIFT_CODENAMES[swift_vers]
-        else:
-            vers = vers[:6]
-            return OPENSTACK_CODENAMES[vers]
-    except KeyError:
-        e = 'Could not determine OpenStack codename for version %s' % vers
-        error_out(e)
+    # >= 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:
+                swift_vers = vers[:5]
+                if swift_vers not in SWIFT_CODENAMES:
+                    # Deal with 1.10.0 upward
+                    swift_vers = vers[:6]
+                return SWIFT_CODENAMES[swift_vers]
+            else:
+                vers = vers[:6]
+                return OPENSTACK_CODENAMES[vers]
+        except KeyError:
+            e = 'Could not determine OpenStack codename for version %s' % vers
+            error_out(e)
 
 
 def get_os_version_package(pkg, fatal=True):
@@ -323,6 +363,9 @@
             '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',
         }
 
         try:
@@ -518,6 +561,7 @@
     Clone/install all specified OpenStack repositories.
 
     The expected format of projects_yaml is:
+
         repositories:
           - {name: keystone,
              repository: 'git://git.openstack.org/openstack/keystone.git',
@@ -525,11 +569,13 @@
           - {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.
+    The directory, http_proxy, and https_proxy keys are optional.
+
     """
     global requirements_dir
     parent_dir = '/mnt/openstack-git'
@@ -551,6 +597,12 @@
 
     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']
@@ -612,24 +664,24 @@
     else:
         repo_dir = dest_dir
 
+    venv = os.path.join(parent_dir, 'venv')
+
     if update_requirements:
         if not requirements_dir:
             error_out('requirements repo must be cloned before '
                       'updating from global requirements.')
-        _git_update_requirements(repo_dir, requirements_dir)
+        _git_update_requirements(venv, repo_dir, requirements_dir)
 
     juju_log('Installing git repo from dir: {}'.format(repo_dir))
     if http_proxy:
-        pip_install(repo_dir, proxy=http_proxy,
-                    venv=os.path.join(parent_dir, 'venv'))
+        pip_install(repo_dir, proxy=http_proxy, venv=venv)
     else:
-        pip_install(repo_dir,
-                    venv=os.path.join(parent_dir, 'venv'))
+        pip_install(repo_dir, venv=venv)
 
     return repo_dir
 
 
-def _git_update_requirements(package_dir, reqs_dir):
+def _git_update_requirements(venv, package_dir, reqs_dir):
     """
     Update from global requirements.
 
@@ -638,12 +690,14 @@
     """
     orig_dir = os.getcwd()
     os.chdir(reqs_dir)
-    cmd = ['python', 'update.py', package_dir]
+    python = os.path.join(venv, 'bin/python')
+    cmd = [python, 'update.py', package_dir]
     try:
         subprocess.check_call(cmd)
     except subprocess.CalledProcessError:
         package = os.path.basename(package_dir)
-        error_out("Error updating {} from global-requirements.txt".format(package))
+        error_out("Error updating {} from "
+                  "global-requirements.txt".format(package))
     os.chdir(orig_dir)
 
 
 
=== modified file 'charmhelpers/contrib/peerstorage/__init__.py'
--- charmhelpers/contrib/peerstorage/__init__.py	2015-06-03 13:09:25 +0000
+++ charmhelpers/contrib/peerstorage/__init__.py	2015-08-13 08:33:21 +0000
@@ -59,7 +59,7 @@
 """
 
 
-def leader_get(attribute=None):
+def leader_get(attribute=None, rid=None):
     """Wrapper to ensure that settings are migrated from the peer relation.
 
     This is to support upgrading an environment that does not support
@@ -94,7 +94,8 @@
         # If attribute not present in leader db, check if this unit has set
         # the attribute in the peer relation
         if not leader_settings:
-            peer_setting = relation_get(attribute=attribute, unit=local_unit())
+            peer_setting = _relation_get(attribute=attribute, unit=local_unit(),
+                                         rid=rid)
             if peer_setting:
                 leader_set(settings={attribute: peer_setting})
                 leader_settings = peer_setting
@@ -103,7 +104,7 @@
             settings_migrated = True
             migrated.add(attribute)
     else:
-        r_settings = relation_get(unit=local_unit())
+        r_settings = _relation_get(unit=local_unit(), rid=rid)
         if r_settings:
             for key in set(r_settings.keys()).difference(migrated):
                 # Leader setting wins
@@ -151,7 +152,7 @@
     """
     try:
         if rid in relation_ids('cluster'):
-            return leader_get(attribute)
+            return leader_get(attribute, rid)
         else:
             raise NotImplementedError
     except NotImplementedError:
 
=== modified file 'charmhelpers/contrib/python/packages.py'
--- charmhelpers/contrib/python/packages.py	2015-05-07 18:12:54 +0000
+++ charmhelpers/contrib/python/packages.py	2015-08-13 08:33:21 +0000
@@ -36,6 +36,8 @@
 def parse_options(given, available):
     """Given a set of options, check if available"""
     for key, value in sorted(given.items()):
+        if not value:
+            continue
         if key in available:
             yield "--{0}={1}".format(key, value)
 
 
=== modified file 'charmhelpers/contrib/storage/linux/ceph.py'
--- charmhelpers/contrib/storage/linux/ceph.py	2015-01-22 06:11:15 +0000
+++ charmhelpers/contrib/storage/linux/ceph.py	2015-08-13 08:33:21 +0000
@@ -60,12 +60,12 @@
 KEYFILE = '/etc/ceph/ceph.client.{}.key'
 
 CEPH_CONF = """[global]
- auth supported = {auth}
- keyring = {keyring}
- mon host = {mon_hosts}
- log to syslog = {use_syslog}
- err to syslog = {use_syslog}
- clog to syslog = {use_syslog}
+auth supported = {auth}
+keyring = {keyring}
+mon host = {mon_hosts}
+log to syslog = {use_syslog}
+err to syslog = {use_syslog}
+clog to syslog = {use_syslog}
 """
 
 
 
=== modified file 'charmhelpers/contrib/storage/linux/utils.py'
--- charmhelpers/contrib/storage/linux/utils.py	2015-01-22 06:06:03 +0000
+++ charmhelpers/contrib/storage/linux/utils.py	2015-08-13 08:33:21 +0000
@@ -43,9 +43,10 @@
 
     :param block_device: str: Full path of block device to clean.
     '''
+    # https://github.com/ceph/ceph/commit/fdd7f8d83afa25c4e09aaedd90ab93f3b64a677b
     # sometimes sgdisk exits non-zero; this is OK, dd will clean up
-    call(['sgdisk', '--zap-all', '--mbrtogpt',
-          '--clear', block_device])
+    call(['sgdisk', '--zap-all', '--', block_device])
+    call(['sgdisk', '--clear', '--mbrtogpt', '--', block_device])
     dev_end = check_output(['blockdev', '--getsz',
                             block_device]).decode('UTF-8')
     gpt_end = int(dev_end.split()[0]) - 100
@@ -67,4 +68,4 @@
     out = check_output(['mount']).decode('UTF-8')
     if is_partition:
         return bool(re.search(device + r"\b", out))
-    return bool(re.search(device + r"[0-9]+\b", out))
+    return bool(re.search(device + r"[0-9]*\b", out))
 
=== modified file 'charmhelpers/contrib/unison/__init__.py'
--- charmhelpers/contrib/unison/__init__.py	2015-04-03 15:23:46 +0000
+++ charmhelpers/contrib/unison/__init__.py	2015-08-13 08:33:21 +0000
@@ -16,7 +16,7 @@
 
 # Easy file synchronization among peer units using ssh + unison.
 #
-# From *both* peer relation -joined and -changed, add a call to
+# For the -joined, -changed, and -departed peer relations, add a call to
 # ssh_authorized_peers() describing the peer relation and the desired
 # user + group.  After all peer relations have settled, all hosts should
 # be able to connect to on another via key auth'd ssh as the specified user.
@@ -30,14 +30,21 @@
 # ...
 # ssh_authorized_peers(peer_interface='cluster',
 #                      user='juju_ssh', group='juju_ssh',
-#                      ensure_user=True)
+#                      ensure_local_user=True)
 # ...
 #
 # cluster-relation-changed:
 # ...
 # ssh_authorized_peers(peer_interface='cluster',
 #                      user='juju_ssh', group='juju_ssh',
-#                      ensure_user=True)
+#                      ensure_local_user=True)
+# ...
+#
+# cluster-relation-departed:
+# ...
+# ssh_authorized_peers(peer_interface='cluster',
+#                      user='juju_ssh', group='juju_ssh',
+#                      ensure_local_user=True)
 # ...
 #
 # Hooks are now free to sync files as easily as:
@@ -92,11 +99,18 @@
         raise Exception
 
 
-def create_private_key(user, priv_key_path):
+def create_private_key(user, priv_key_path, key_type='rsa'):
+    types_bits = {
+        'rsa': '2048',
+        'ecdsa': '521',
+    }
+    if key_type not in types_bits:
+        log('Unknown ssh key type {}, using rsa'.format(key_type), ERROR)
+        key_type = 'rsa'
     if not os.path.isfile(priv_key_path):
         log('Generating new SSH key for user %s.' % user)
-        cmd = ['ssh-keygen', '-q', '-N', '', '-t', 'rsa', '-b', '2048',
-               '-f', priv_key_path]
+        cmd = ['ssh-keygen', '-q', '-N', '', '-t', key_type,
+               '-b', types_bits[key_type], '-f', priv_key_path]
         check_call(cmd)
     else:
         log('SSH key already exists at %s.' % priv_key_path)
@@ -152,7 +166,7 @@
     known_hosts = os.path.join(ssh_dir, 'known_hosts')
     khosts = []
     for host in hosts:
-        cmd = ['ssh-keyscan', '-H', '-t', 'rsa', host]
+        cmd = ['ssh-keyscan', host]
         remote_key = check_output(cmd, universal_newlines=True).strip()
         khosts.append(remote_key)
     log('Syncing known_hosts @ %s.' % known_hosts)
@@ -179,7 +193,8 @@
     hook = hook_name()
     if hook == '%s-relation-joined' % peer_interface:
         relation_set(ssh_pub_key=pub_key)
-    elif hook == '%s-relation-changed' % peer_interface:
+    elif hook == '%s-relation-changed' % peer_interface or \
+            hook == '%s-relation-departed' % peer_interface:
         hosts = []
         keys = []
 
 
=== added file 'charmhelpers/coordinator.py'
--- charmhelpers/coordinator.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/coordinator.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,607 @@
+# 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/>.
+'''
+The coordinator module allows you to use Juju's leadership feature to
+coordinate operations between units of a service.
+
+Behavior is defined in subclasses of coordinator.BaseCoordinator.
+One implementation is provided (coordinator.Serial), which allows an
+operation to be run on a single unit at a time, on a first come, first
+served basis. You can trivially define more complex behavior by
+subclassing BaseCoordinator or Serial.
+
+:author: Stuart Bishop <[e-mail]>
+
+
+Services Framework Usage
+========================
+
+Ensure a peer relation is defined in metadata.yaml. Instantiate a
+BaseCoordinator subclass before invoking ServiceManager.manage().
+Ensure that ServiceManager.manage() is wired up to the leader-elected,
+leader-settings-changed, peer relation-changed and peer
+relation-departed hooks in addition to any other hooks you need, or your
+service will deadlock.
+
+Ensure calls to acquire() are guarded, so that locks are only requested
+when they are really needed (and thus hooks only triggered when necessary).
+Failing to do this and calling acquire() unconditionally will put your unit
+into a hook loop. Calls to granted() do not need to be guarded.
+
+For example::
+
+    from charmhelpers.core import hookenv, services
+    from charmhelpers import coordinator
+
+    def maybe_restart(servicename):
+        serial = coordinator.Serial()
+        if needs_restart():
+            serial.acquire('restart')
+        if serial.granted('restart'):
+            hookenv.service_restart(servicename)
+
+    services = [dict(service='servicename',
+                     data_ready=[maybe_restart])]
+
+    if __name__ == '__main__':
+        _ = coordinator.Serial()  # Must instantiate before manager.manage()
+        manager = services.ServiceManager(services)
+        manager.manage()
+
+
+You can implement a similar pattern using a decorator. If the lock has
+not been granted, an attempt to acquire() it will be made if the guard
+function returns True. If the lock has been granted, the decorated function
+is run as normal::
+
+    from charmhelpers.core import hookenv, services
+    from charmhelpers import coordinator
+
+    serial = coordinator.Serial()  # Global, instatiated on module import.
+
+    def needs_restart():
+        [ ... Introspect state. Return True if restart is needed ... ]
+
+    @serial.require('restart', needs_restart)
+    def maybe_restart(servicename):
+        hookenv.service_restart(servicename)
+
+    services = [dict(service='servicename',
+                     data_ready=[maybe_restart])]
+
+    if __name__ == '__main__':
+        manager = services.ServiceManager(services)
+        manager.manage()
+
+
+Traditional Usage
+=================
+
+Ensure a peer relationis defined in metadata.yaml.
+
+If you are using charmhelpers.core.hookenv.Hooks, ensure that a
+BaseCoordinator subclass is instantiated before calling Hooks.execute.
+
+If you are not using charmhelpers.core.hookenv.Hooks, ensure
+that a BaseCoordinator subclass is instantiated and its handle()
+method called at the start of all your hooks.
+
+For example::
+
+    import sys
+    from charmhelpers.core import hookenv
+    from charmhelpers import coordinator
+
+    hooks = hookenv.Hooks()
+
+    def maybe_restart():
+        serial = coordinator.Serial()
+        if serial.granted('restart'):
+            hookenv.service_restart('myservice')
+
+    @hooks.hook
+    def config_changed():
+        update_config()
+        serial = coordinator.Serial()
+        if needs_restart():
+            serial.acquire('restart'):
+            maybe_restart()
+
+    # Cluster hooks must be wired up.
+    @hooks.hook('cluster-relation-changed', 'cluster-relation-departed')
+    def cluster_relation_changed():
+        maybe_restart()
+
+    # Leader hooks must be wired up.
+    @hooks.hook('leader-elected', 'leader-settings-changed')
+    def leader_settings_changed():
+        maybe_restart()
+
+    [ ... repeat for *all* other hooks you are using ... ]
+
+    if __name__ == '__main__':
+        _ = coordinator.Serial()  # Must instantiate before execute()
+        hooks.execute(sys.argv)
+
+
+You can also use the require decorator. If the lock has not been granted,
+an attempt to acquire() it will be made if the guard function returns True.
+If the lock has been granted, the decorated function is run as normal::
+
+    from charmhelpers.core import hookenv
+
+    hooks = hookenv.Hooks()
+    serial = coordinator.Serial()  # Must instantiate before execute()
+
+    @require('restart', needs_restart)
+    def maybe_restart():
+        hookenv.service_restart('myservice')
+
+    @hooks.hook('install', 'config-changed', 'upgrade-charm',
+                # Peer and leader hooks must be wired up.
+                'cluster-relation-changed', 'cluster-relation-departed',
+                'leader-elected', 'leader-settings-changed')
+    def default_hook():
+        [...]
+        maybe_restart()
+
+    if __name__ == '__main__':
+        hooks.execute()
+
+
+Details
+=======
+
+A simple API is provided similar to traditional locking APIs. A lock
+may be requested using the acquire() method, and the granted() method
+may be used do to check if a lock previously requested by acquire() has
+been granted. It doesn't matter how many times acquire() is called in a
+hook.
+
+Locks are released at the end of the hook they are acquired in. This may
+be the current hook if the unit is leader and the lock is free. It is
+more likely a future hook (probably leader-settings-changed, possibly
+the peer relation-changed or departed hook, potentially any hook).
+
+Whenever a charm needs to perform a coordinated action it will acquire()
+the lock and perform the action immediately if acquisition is
+successful. It will also need to perform the same action in every other
+hook if the lock has been granted.
+
+
+Grubby Details
+--------------
+
+Why do you need to be able to perform the same action in every hook?
+If the unit is the leader, then it may be able to grant its own lock
+and perform the action immediately in the source hook. If the unit is
+the leader and cannot immediately grant the lock, then its only
+guaranteed chance of acquiring the lock is in the peer relation-joined,
+relation-changed or peer relation-departed hooks when another unit has
+released it (the only channel to communicate to the leader is the peer
+relation). If the unit is not the leader, then it is unlikely the lock
+is granted in the source hook (a previous hook must have also made the
+request for this to happen). A non-leader is notified about the lock via
+leader settings. These changes may be visible in any hook, even before
+the leader-settings-changed hook has been invoked. Or the requesting
+unit may be promoted to leader after making a request, in which case the
+lock may be granted in leader-elected or in a future peer
+relation-changed or relation-departed hook.
+
+This could be simpler if leader-settings-changed was invoked on the
+leader. We could then never grant locks except in
+leader-settings-changed hooks giving one place for the operation to be
+performed. Unfortunately this is not the case with Juju 1.23 leadership.
+
+But of course, this doesn't really matter to most people as most people
+seem to prefer the Services Framework or similar reset-the-world
+approaches, rather than the twisty maze of attempting to deduce what
+should be done based on what hook happens to be running (which always
+seems to evolve into reset-the-world anyway when the charm grows beyond
+the trivial).
+
+I chose not to implement a callback model, where a callback was passed
+to acquire to be executed when the lock is granted, because the callback
+may become invalid between making the request and the lock being granted
+due to an upgrade-charm being run in the interim. And it would create
+restrictions, such no lambdas, callback defined at the top level of a
+module, etc. Still, we could implement it on top of what is here, eg.
+by adding a defer decorator that stores a pickle of itself to disk and
+have BaseCoordinator unpickle and execute them when the locks are granted.
+'''
+from datetime import datetime
+from functools import wraps
+import json
+import os.path
+
+from six import with_metaclass
+
+from charmhelpers.core import hookenv
+
+
+# We make BaseCoordinator and subclasses singletons, so that if we
+# need to spill to local storage then only a single instance does so,
+# rather than having multiple instances stomp over each other.
+class Singleton(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(Singleton, cls).__call__(*args,
+                                                                 **kwargs)
+        return cls._instances[cls]
+
+
+class BaseCoordinator(with_metaclass(Singleton, object)):
+    relid = None  # Peer relation-id, set by __init__
+    relname = None
+
+    grants = None  # self.grants[unit][lock] == timestamp
+    requests = None  # self.requests[unit][lock] == timestamp
+
+    def __init__(self, relation_key='coordinator', peer_relation_name=None):
+        '''Instatiate a Coordinator.
+
+        Data is stored on the peer relation and in leadership storage
+        under the provided relation_key.
+
+        The peer relation is identified by peer_relation_name, and defaults
+        to the first one found in metadata.yaml.
+        '''
+        # Most initialization is deferred, since invoking hook tools from
+        # the constructor makes testing hard.
+        self.key = relation_key
+        self.relname = peer_relation_name
+        hookenv.atstart(self.initialize)
+
+        # Ensure that handle() is called, without placing that burden on
+        # the charm author. They still need to do this manually if they
+        # are not using a hook framework.
+        hookenv.atstart(self.handle)
+
+    def initialize(self):
+        if self.requests is not None:
+            return  # Already initialized.
+
+        assert hookenv.has_juju_version('1.23'), 'Needs Juju 1.23+'
+
+        if self.relname is None:
+            self.relname = _implicit_peer_relation_name()
+
+        relids = hookenv.relation_ids(self.relname)
+        if relids:
+            self.relid = sorted(relids)[0]
+
+        # Load our state, from leadership, the peer relationship, and maybe
+        # local state as a fallback. Populates self.requests and self.grants.
+        self._load_state()
+        self._emit_state()
+
+        # Save our state if the hook completes successfully.
+        hookenv.atexit(self._save_state)
+
+        # Schedule release of granted locks for the end of the hook.
+        # This needs to be the last of our atexit callbacks to ensure
+        # it will be run first when the hook is complete, because there
+        # is no point mutating our state after it has been saved.
+        hookenv.atexit(self._release_granted)
+
+    def acquire(self, lock):
+        '''Acquire the named lock, non-blocking.
+
+        The lock may be granted immediately, or in a future hook.
+
+        Returns True if the lock has been granted. The lock will be
+        automatically released at the end of the hook in which it is
+        granted.
+
+        Do not mindlessly call this method, as it triggers a cascade of
+        hooks. For example, if you call acquire() every time in your
+        peer relation-changed hook you will end up with an infinite loop
+        of hooks. It should almost always be guarded by some condition.
+        '''
+        unit = hookenv.local_unit()
+        ts = self.requests[unit].get(lock)
+        if not ts:
+            # If there is no outstanding request on the peer relation,
+            # create one.
+            self.requests.setdefault(lock, {})
+            self.requests[unit][lock] = _timestamp()
+            self.msg('Requested {}'.format(lock))
+
+        # If the leader has granted the lock, yay.
+        if self.granted(lock):
+            self.msg('Acquired {}'.format(lock))
+            return True
+
+        # If the unit making the request also happens to be the
+        # leader, it must handle the request now. Even though the
+        # request has been stored on the peer relation, the peer
+        # relation-changed hook will not be triggered.
+        if hookenv.is_leader():
+            return self.grant(lock, unit)
+
+        return False  # Can't acquire lock, yet. Maybe next hook.
+
+    def granted(self, lock):
+        '''Return True if a previously requested lock has been granted'''
+        unit = hookenv.local_unit()
+        ts = self.requests[unit].get(lock)
+        if ts and self.grants.get(unit, {}).get(lock) == ts:
+            return True
+        return False
+
+    def requested(self, lock):
+        '''Return True if we are in the queue for the lock'''
+        return lock in self.requests[hookenv.local_unit()]
+
+    def request_timestamp(self, lock):
+        '''Return the timestamp of our outstanding request for lock, or None.
+
+        Returns a datetime.datetime() UTC timestamp, with no tzinfo attribute.
+        '''
+        ts = self.requests[hookenv.local_unit()].get(lock, None)
+        if ts is not None:
+            return datetime.strptime(ts, _timestamp_format)
+
+    def handle(self):
+        if not hookenv.is_leader():
+            return  # Only the leader can grant requests.
+
+        self.msg('Leader handling coordinator requests')
+
+        # Clear our grants that have been released.
+        for unit in self.grants.keys():
+            for lock, grant_ts in list(self.grants[unit].items()):
+                req_ts = self.requests.get(unit, {}).get(lock)
+                if req_ts != grant_ts:
+                    # The request timestamp does not match the granted
+                    # timestamp. Several hooks on 'unit' may have run
+                    # before the leader got a chance to make a decision,
+                    # and 'unit' may have released its lock and attempted
+                    # to reacquire it. This will change the timestamp,
+                    # and we correctly revoke the old grant putting it
+                    # to the end of the queue.
+                    ts = datetime.strptime(self.grants[unit][lock],
+                                           _timestamp_format)
+                    del self.grants[unit][lock]
+                    self.released(unit, lock, ts)
+
+        # Grant locks
+        for unit in self.requests.keys():
+            for lock in self.requests[unit]:
+                self.grant(lock, unit)
+
+    def grant(self, lock, unit):
+        '''Maybe grant the lock to a unit.
+
+        The decision to grant the lock or not is made for $lock
+        by a corresponding method grant_$lock, which you may define
+        in a subclass. If no such method is defined, the default_grant
+        method is used. See Serial.default_grant() for details.
+        '''
+        if not hookenv.is_leader():
+            return False  # Not the leader, so we cannot grant.
+
+        # Set of units already granted the lock.
+        granted = set()
+        for u in self.grants:
+            if lock in self.grants[u]:
+                granted.add(u)
+        if unit in granted:
+            return True  # Already granted.
+
+        # Ordered list of units waiting for the lock.
+        reqs = set()
+        for u in self.requests:
+            if u in granted:
+                continue  # In the granted set. Not wanted in the req list.
+            for l, ts in self.requests[u].items():
+                if l == lock:
+                    reqs.add((ts, u))
+        queue = [t[1] for t in sorted(reqs)]
+        if unit not in queue:
+            return False  # Unit has not requested the lock.
+
+        # Locate custom logic, or fallback to the default.
+        grant_func = getattr(self, 'grant_{}'.format(lock), self.default_grant)
+
+        if grant_func(lock, unit, granted, queue):
+            # Grant the lock.
+            self.msg('Leader grants {} to {}'.format(lock, unit))
+            self.grants.setdefault(unit, {})[lock] = self.requests[unit][lock]
+            return True
+
+        return False
+
+    def released(self, unit, lock, timestamp):
+        '''Called on the leader when it has released a lock.
+
+        By default, does nothing but log messages. Override if you
+        need to perform additional housekeeping when a lock is released,
+        for example recording timestamps.
+        '''
+        interval = _utcnow() - timestamp
+        self.msg('Leader released {} from {}, held {}'.format(lock, unit,
+                                                              interval))
+
+    def require(self, lock, guard_func, *guard_args, **guard_kw):
+        """Decorate a function to be run only when a lock is acquired.
+
+        The lock is requested if the guard function returns True.
+
+        The decorated function is called if the lock has been granted.
+        """
+        def decorator(f):
+            @wraps(f)
+            def wrapper(*args, **kw):
+                if self.granted(lock):
+                    self.msg('Granted {}'.format(lock))
+                    return f(*args, **kw)
+                if guard_func(*guard_args, **guard_kw) and self.acquire(lock):
+                    return f(*args, **kw)
+                return None
+            return wrapper
+        return decorator
+
+    def msg(self, msg):
+        '''Emit a message. Override to customize log spam.'''
+        hookenv.log('coordinator.{} {}'.format(self._name(), msg),
+                    level=hookenv.INFO)
+
+    def _name(self):
+        return self.__class__.__name__
+
+    def _load_state(self):
+        self.msg('Loading state'.format(self._name()))
+
+        # All responses must be stored in the leadership settings.
+        # The leader cannot use local state, as a different unit may
+        # be leader next time. Which is fine, as the leadership
+        # settings are always available.
+        self.grants = json.loads(hookenv.leader_get(self.key) or '{}')
+
+        local_unit = hookenv.local_unit()
+
+        # All requests must be stored on the peer relation. This is
+        # the only channel units have to communicate with the leader.
+        # Even the leader needs to store its requests here, as a
+        # different unit may be leader by the time the request can be
+        # granted.
+        if self.relid is None:
+            # The peer relation is not available. Maybe we are early in
+            # the units's lifecycle. Maybe this unit is standalone.
+            # Fallback to using local state.
+            self.msg('No peer relation. Loading local state')
+            self.requests = {local_unit: self._load_local_state()}
+        else:
+            self.requests = self._load_peer_state()
+            if local_unit not in self.requests:
+                # The peer relation has just been joined. Update any state
+                # loaded from our peers with our local state.
+                self.msg('New peer relation. Merging local state')
+                self.requests[local_unit] = self._load_local_state()
+
+    def _emit_state(self):
+        # Emit this units lock status.
+        for lock in sorted(self.requests[hookenv.local_unit()].keys()):
+            if self.granted(lock):
+                self.msg('Granted {}'.format(lock))
+            else:
+                self.msg('Waiting on {}'.format(lock))
+
+    def _save_state(self):
+        self.msg('Publishing state'.format(self._name()))
+        if hookenv.is_leader():
+            # sort_keys to ensure stability.
+            raw = json.dumps(self.grants, sort_keys=True)
+            hookenv.leader_set({self.key: raw})
+
+        local_unit = hookenv.local_unit()
+
+        if self.relid is None:
+            # No peer relation yet. Fallback to local state.
+            self.msg('No peer relation. Saving local state')
+            self._save_local_state(self.requests[local_unit])
+        else:
+            # sort_keys to ensure stability.
+            raw = json.dumps(self.requests[local_unit], sort_keys=True)
+            hookenv.relation_set(self.relid, relation_settings={self.key: raw})
+
+    def _load_peer_state(self):
+        requests = {}
+        units = set(hookenv.related_units(self.relid))
+        units.add(hookenv.local_unit())
+        for unit in units:
+            raw = hookenv.relation_get(self.key, unit, self.relid)
+            if raw:
+                requests[unit] = json.loads(raw)
+        return requests
+
+    def _local_state_filename(self):
+        # Include the class name. We allow multiple BaseCoordinator
+        # subclasses to be instantiated, and they are singletons, so
+        # this avoids conflicts (unless someone creates and uses two
+        # BaseCoordinator subclasses with the same class name, so don't
+        # do that).
+        return '.charmhelpers.coordinator.{}'.format(self._name())
+
+    def _load_local_state(self):
+        fn = self._local_state_filename()
+        if os.path.exists(fn):
+            with open(fn, 'r') as f:
+                return json.load(f)
+        return {}
+
+    def _save_local_state(self, state):
+        fn = self._local_state_filename()
+        with open(fn, 'w') as f:
+            json.dump(state, f)
+
+    def _release_granted(self):
+        # At the end of every hook, release all locks granted to
+        # this unit. If a hook neglects to make use of what it
+        # requested, it will just have to make the request again.
+        # Implicit release is the only way this will work, as
+        # if the unit is standalone there may be no future triggers
+        # called to do a manual release.
+        unit = hookenv.local_unit()
+        for lock in list(self.requests[unit].keys()):
+            if self.granted(lock):
+                self.msg('Released local {} lock'.format(lock))
+                del self.requests[unit][lock]
+
+
+class Serial(BaseCoordinator):
+    def default_grant(self, lock, unit, granted, queue):
+        '''Default logic to grant a lock to a unit. Unless overridden,
+        only one unit may hold the lock and it will be granted to the
+        earliest queued request.
+
+        To define custom logic for $lock, create a subclass and
+        define a grant_$lock method.
+
+        `unit` is the unit name making the request.
+
+        `granted` is the set of units already granted the lock. It will
+        never include `unit`. It may be empty.
+
+        `queue` is the list of units waiting for the lock, ordered by time
+        of request. It will always include `unit`, but `unit` is not
+        necessarily first.
+
+        Returns True if the lock should be granted to `unit`.
+        '''
+        return unit == queue[0] and not granted
+
+
+def _implicit_peer_relation_name():
+    md = hookenv.metadata()
+    assert 'peers' in md, 'No peer relations in metadata.yaml'
+    return sorted(md['peers'].keys())[0]
+
+
+# A human readable, sortable UTC timestamp format.
+_timestamp_format = '%Y-%m-%d %H:%M:%S.%fZ'
+
+
+def _utcnow():  # pragma: no cover
+    # This wrapper exists as mocking datetime methods is problematic.
+    return datetime.utcnow()
+
+
+def _timestamp():
+    return _utcnow().strftime(_timestamp_format)
 
=== added file 'charmhelpers/core/files.py'
--- charmhelpers/core/files.py	1970-01-01 00:00:00 +0000
+++ charmhelpers/core/files.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# 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/>.
+
+__author__ = 'Jorge Niedbalski <[e-mail]>'
+
+import os
+import subprocess
+
+
+def sed(filename, before, after, flags='g'):
+    """
+    Search and replaces the given pattern on filename.
+
+    :param filename: relative or absolute file path.
+    :param before: expression to be replaced (see 'man sed')
+    :param after: expression to replace with (see 'man sed')
+    :param flags: sed-compatible regex flags in example, to make
+    the  search and replace case insensitive, specify ``flags="i"``.
+    The ``g`` flag is always specified regardless, so you do not
+    need to remember to include it when overriding this parameter.
+    :returns: If the sed command exit code was zero then return,
+    otherwise raise CalledProcessError.
+    """
+    expression = r's/{0}/{1}/{2}'.format(before,
+                                         after, flags)
+
+    return subprocess.check_call(["sed", "-i", "-r", "-e",
+                                  expression,
+                                  os.path.expanduser(filename)])
 
=== modified file 'charmhelpers/core/hookenv.py'
--- charmhelpers/core/hookenv.py	2015-06-02 13:46:29 +0000
+++ charmhelpers/core/hookenv.py	2015-08-13 08:33:21 +0000
@@ -21,7 +21,10 @@
 #  Charm Helpers Developers <[e-mail]>
 
 from __future__ import print_function
+import copy
+from distutils.version import LooseVersion
 from functools import wraps
+import glob
 import os
 import json
 import yaml
@@ -71,6 +74,7 @@
         res = func(*args, **kwargs)
         cache[key] = res
         return res
+    wrapper._wrapped = func
     return wrapper
 
 
@@ -170,9 +174,19 @@
     return os.environ.get('JUJU_RELATION', None)
 
 
-def relation_id():
-    """The relation ID for the current relation hook"""
-    return os.environ.get('JUJU_RELATION_ID', None)
+@cached
+def relation_id(relation_name=None, service_or_unit=None):
+    """The relation ID for the current or a specified relation"""
+    if not relation_name and not service_or_unit:
+        return os.environ.get('JUJU_RELATION_ID', None)
+    elif relation_name and service_or_unit:
+        service_name = service_or_unit.split('/')[0]
+        for relid in relation_ids(relation_name):
+            remote_service = remote_service_name(relid)
+            if remote_service == service_name:
+                return relid
+    else:
+        raise ValueError('Must specify neither or both of relation_name and service_or_unit')
 
 
 def local_unit():
@@ -190,9 +204,20 @@
     return local_unit().split('/')[0]
 
 
+@cached
+def remote_service_name(relid=None):
+    """The remote service name for a given relation-id (or the current relation)"""
+    if relid is None:
+        unit = remote_unit()
+    else:
+        units = related_units(relid)
+        unit = units[0] if units else None
+    return unit.split('/')[0] if unit else None
+
+
 def hook_name():
     """The name of the currently executing hook"""
-    return os.path.basename(sys.argv[0])
+    return os.environ.get('JUJU_HOOK_NAME', os.path.basename(sys.argv[0]))
 
 
 class Config(dict):
@@ -242,29 +267,7 @@
         self.path = os.path.join(charm_dir(), Config.CONFIG_FILE_NAME)
         if os.path.exists(self.path):
             self.load_previous()
-
-    def __getitem__(self, key):
-        """For regular dict lookups, check the current juju config first,
-        then the previous (saved) copy. This ensures that user-saved values
-        will be returned by a dict lookup.
-
-        """
-        try:
-            return dict.__getitem__(self, key)
-        except KeyError:
-            return (self._prev_dict or {})[key]
-
-    def get(self, key, default=None):
-        try:
-            return self[key]
-        except KeyError:
-            return default
-
-    def keys(self):
-        prev_keys = []
-        if self._prev_dict is not None:
-            prev_keys = self._prev_dict.keys()
-        return list(set(prev_keys + list(dict.keys(self))))
+        atexit(self._implicit_save)
 
     def load_previous(self, path=None):
         """Load previous copy of config from disk.
@@ -283,6 +286,9 @@
         self.path = path or self.path
         with open(self.path) as f:
             self._prev_dict = json.load(f)
+        for k, v in copy.deepcopy(self._prev_dict).items():
+            if k not in self:
+                self[k] = v
 
     def changed(self, key):
         """Return True if the current value for this key is different from
@@ -314,13 +320,13 @@
         instance.
 
         """
-        if self._prev_dict:
-            for k, v in six.iteritems(self._prev_dict):
-                if k not in self:
-                    self[k] = v
         with open(self.path, 'w') as f:
             json.dump(self, f)
 
+    def _implicit_save(self):
+        if self.implicit_save:
+            self.save()
+
 
 @cached
 def config(scope=None):
@@ -485,6 +491,63 @@
 
 
 @cached
+def relation_to_interface(relation_name):
+    """
+    Given the name of a relation, return the interface that relation uses.
+
+    :returns: The interface name, or ``None``.
+    """
+    return relation_to_role_and_interface(relation_name)[1]
+
+
+@cached
+def relation_to_role_and_interface(relation_name):
+    """
+    Given the name of a relation, return the role and the name of the interface
+    that relation uses (where role is one of ``provides``, ``requires``, or ``peer``).
+
+    :returns: A tuple containing ``(role, interface)``, or ``(None, None)``.
+    """
+    _metadata = metadata()
+    for role in ('provides', 'requires', 'peer'):
+        interface = _metadata.get(role, {}).get(relation_name, {}).get('interface')
+        if interface:
+            return role, interface
+    return None, None
+
+
+@cached
+def role_and_interface_to_relations(role, interface_name):
+    """
+    Given a role and interface name, return a list of relation names for the
+    current charm that use that interface under that role (where role is one
+    of ``provides``, ``requires``, or ``peer``).
+
+    :returns: A list of relation names.
+    """
+    _metadata = metadata()
+    results = []
+    for relation_name, relation in _metadata.get(role, {}).items():
+        if relation['interface'] == interface_name:
+            results.append(relation_name)
+    return results
+
+
+@cached
+def interface_to_relations(interface_name):
+    """
+    Given an interface, return a list of relation names for the current
+    charm that use that interface.
+
+    :returns: A list of relation names.
+    """
+    results = []
+    for role in ('provides', 'requires', 'peer'):
+        results.extend(role_and_interface_to_relations(role, interface_name))
+    return results
+
+
+@cached
 def charm_name():
     """Get the name of the current charm as is specified on metadata.yaml"""
     return metadata().get('name')
@@ -587,10 +650,14 @@
             hooks.execute(sys.argv)
     """
 
-    def __init__(self, config_save=True):
+    def __init__(self, config_save=None):
         super(Hooks, self).__init__()
         self._hooks = {}
-        self._config_save = config_save
+
+        # For unknown reasons, we allow the Hooks constructor to override
+        # config().implicit_save.
+        if config_save is not None:
+            config().implicit_save = config_save
 
     def register(self, name, function):
         """Register a hook"""
@@ -598,13 +665,16 @@
 
     def execute(self, args):
         """Execute a registered hook based on args[0]"""
+        _run_atstart()
         hook_name = os.path.basename(args[0])
         if hook_name in self._hooks:
-            self._hooks[hook_name]()
-            if self._config_save:
-                cfg = config()
-                if cfg.implicit_save:
-                    cfg.save()
+            try:
+                self._hooks[hook_name]()
+            except SystemExit as x:
+                if x.code is None or x.code == 0:
+                    _run_atexit()
+                raise
+            _run_atexit()
         else:
             raise UnregisteredHookError(hook_name)
 
@@ -653,6 +723,21 @@
     subprocess.check_call(['action-fail', message])
 
 
+def action_name():
+    """Get the name of the currently executing action."""
+    return os.environ.get('JUJU_ACTION_NAME')
+
+
+def action_uuid():
+    """Get the UUID of the currently executing action."""
+    return os.environ.get('JUJU_ACTION_UUID')
+
+
+def action_tag():
+    """Get the tag for the currently executing action."""
+    return os.environ.get('JUJU_ACTION_TAG')
+
+
 def status_set(workload_state, message):
     """Set the workload state with a message
 
@@ -732,13 +817,80 @@
 @translate_exc(from_exc=OSError, to_exc=NotImplementedError)
 def leader_set(settings=None, **kwargs):
     """Juju leader set value(s)"""
-    log("Juju leader-set '%s'" % (settings), level=DEBUG)
+    # Don't log secrets.
+    # log("Juju leader-set '%s'" % (settings), level=DEBUG)
     cmd = ['leader-set']
     settings = settings or {}
     settings.update(kwargs)
-    for k, v in settings.iteritems():
+    for k, v in settings.items():
         if v is None:
             cmd.append('{}='.format(k))
         else:
             cmd.append('{}={}'.format(k, v))
     subprocess.check_call(cmd)
+
+
+@cached
+def juju_version():
+    """Full version string (eg. '1.23.3.1-trusty-amd64')"""
+    # Per https://bugs.launchpad.net/juju-core/+bug/1455368/comments/1
+    jujud = glob.glob('/var/lib/juju/tools/machine-*/jujud')[0]
+    return subprocess.check_output([jujud, 'version'],
+                                   universal_newlines=True).strip()
+
+
+@cached
+def has_juju_version(minimum_version):
+    """Return True if the Juju version is at least the provided version"""
+    return LooseVersion(juju_version()) >= LooseVersion(minimum_version)
+
+
+_atexit = []
+_atstart = []
+
+
+def atstart(callback, *args, **kwargs):
+    '''Schedule a callback to run before the main hook.
+
+    Callbacks are run in the order they were added.
+
+    This is useful for modules and classes to perform initialization
+    and inject behavior. In particular:
+
+        - Run common code before all of your hooks, such as logging
+          the hook name or interesting relation data.
+        - Defer object or module initialization that requires a hook
+          context until we know there actually is a hook context,
+          making testing easier.
+        - Rather than requiring charm authors to include boilerplate to
+          invoke your helper's behavior, have it run automatically if
+          your object is instantiated or module imported.
+
+    This is not at all useful after your hook framework as been launched.
+    '''
+    global _atstart
+    _atstart.append((callback, args, kwargs))
+
+
+def atexit(callback, *args, **kwargs):
+    '''Schedule a callback to run on successful hook completion.
+
+    Callbacks are run in the reverse order that they were added.'''
+    _atexit.append((callback, args, kwargs))
+
+
+def _run_atstart():
+    '''Hook frameworks must invoke this before running the main hook body.'''
+    global _atstart
+    for callback, args, kwargs in _atstart:
+        callback(*args, **kwargs)
+    del _atstart[:]
+
+
+def _run_atexit():
+    '''Hook frameworks must invoke this after the main hook body has
+    successfully completed. Do not invoke it if the hook fails.'''
+    global _atexit
+    for callback, args, kwargs in reversed(_atexit):
+        callback(*args, **kwargs)
+    del _atexit[:]
 
=== modified file 'charmhelpers/core/host.py'
--- charmhelpers/core/host.py	2015-06-11 09:03:58 +0000
+++ charmhelpers/core/host.py	2015-08-13 08:33:21 +0000
@@ -63,6 +63,36 @@
     return service_result
 
 
+def service_pause(service_name, init_dir=None):
+    """Pause a system service.
+
+    Stop it, and prevent it from starting again at boot."""
+    if init_dir is None:
+        init_dir = "/etc/init"
+    stopped = service_stop(service_name)
+    # XXX: Support systemd too
+    override_path = os.path.join(
+        init_dir, '{}.override'.format(service_name))
+    with open(override_path, 'w') as fh:
+        fh.write("manual\n")
+    return stopped
+
+
+def service_resume(service_name, init_dir=None):
+    """Resume a system service.
+
+    Reenable starting again at boot. Start the service"""
+    # XXX: Support systemd too
+    if init_dir is None:
+        init_dir = "/etc/init"
+    override_path = os.path.join(
+        init_dir, '{}.override'.format(service_name))
+    if os.path.exists(override_path):
+        os.unlink(override_path)
+    started = service_start(service_name)
+    return started
+
+
 def service(action, service_name):
     """Control a system service"""
     cmd = ['service', service_name, action]
@@ -149,11 +179,7 @@
 
 def add_user_to_group(username, group):
     """Add a user to a group"""
-    cmd = [
-        'gpasswd', '-a',
-        username,
-        group
-    ]
+    cmd = ['gpasswd', '-a', username, group]
     log("Adding user {} to group {}".format(username, group))
     subprocess.check_call(cmd)
 
 
=== modified file 'charmhelpers/core/services/base.py'
--- charmhelpers/core/services/base.py	2015-05-20 14:52:29 +0000
+++ charmhelpers/core/services/base.py	2015-08-13 08:33:21 +0000
@@ -128,15 +128,18 @@
         """
         Handle the current hook by doing The Right Thing with the registered services.
         """
-        hook_name = hookenv.hook_name()
-        if hook_name == 'stop':
-            self.stop_services()
-        else:
-            self.reconfigure_services()
-            self.provide_data()
-        cfg = hookenv.config()
-        if cfg.implicit_save:
-            cfg.save()
+        hookenv._run_atstart()
+        try:
+            hook_name = hookenv.hook_name()
+            if hook_name == 'stop':
+                self.stop_services()
+            else:
+                self.reconfigure_services()
+                self.provide_data()
+        except SystemExit as x:
+            if x.code is None or x.code == 0:
+                hookenv._run_atexit()
+        hookenv._run_atexit()
 
     def provide_data(self):
         """
 
=== modified file 'charmhelpers/core/services/helpers.py'
--- charmhelpers/core/services/helpers.py	2015-06-12 11:27:22 +0000
+++ charmhelpers/core/services/helpers.py	2015-08-13 08:33:21 +0000
@@ -240,8 +240,7 @@
     action.
 
     :param str source: The template source file, relative to
-    `$CHARM_DIR/templates`
-
+        `$CHARM_DIR/templates`
     :param str target: The target to write the rendered template to
     :param str owner: The owner of the rendered file
     :param str group: The group of the rendered file
 
=== modified file 'charmhelpers/core/unitdata.py'
--- charmhelpers/core/unitdata.py	2015-03-18 15:51:22 +0000
+++ charmhelpers/core/unitdata.py	2015-08-13 08:33:21 +0000
@@ -152,6 +152,7 @@
 import collections
 import contextlib
 import datetime
+import itertools
 import json
 import os
 import pprint
@@ -164,8 +165,7 @@
 class Storage(object):
     """Simple key value database for local unit state within charms.
 
-    Modifications are automatically committed at hook exit. That's
-    currently regardless of exit code.
+    Modifications are not persisted unless :meth:`flush` is called.
 
     To support dicts, lists, integer, floats, and booleans values
     are automatically json encoded/decoded.
@@ -173,8 +173,11 @@
     def __init__(self, path=None):
         self.db_path = path
         if path is None:
-            self.db_path = os.path.join(
-                os.environ.get('CHARM_DIR', ''), '.unit-state.db')
+            if 'UNIT_STATE_DB' in os.environ:
+                self.db_path = os.environ['UNIT_STATE_DB']
+            else:
+                self.db_path = os.path.join(
+                    os.environ.get('CHARM_DIR', ''), '.unit-state.db')
         self.conn = sqlite3.connect('%s' % self.db_path)
         self.cursor = self.conn.cursor()
         self.revision = None
@@ -189,15 +192,8 @@
         self.conn.close()
         self._closed = True
 
-    def _scoped_query(self, stmt, params=None):
-        if params is None:
-            params = []
-        return stmt, params
-
     def get(self, key, default=None, record=False):
-        self.cursor.execute(
-            *self._scoped_query(
-                'select data from kv where key=?', [key]))
+        self.cursor.execute('select data from kv where key=?', [key])
         result = self.cursor.fetchone()
         if not result:
             return default
@@ -206,33 +202,81 @@
         return json.loads(result[0])
 
     def getrange(self, key_prefix, strip=False):
-        stmt = "select key, data from kv where key like '%s%%'" % key_prefix
-        self.cursor.execute(*self._scoped_query(stmt))
+        """
+        Get a range of keys starting with a common prefix as a mapping of
+        keys to values.
+
+        :param str key_prefix: Common prefix among all keys
+        :param bool strip: Optionally strip the common prefix from the key
+            names in the returned dict
+        :return dict: A (possibly empty) dict of key-value mappings
+        """
+        self.cursor.execute("select key, data from kv where key like ?",
+                            ['%s%%' % key_prefix])
         result = self.cursor.fetchall()
 
         if not result:
-            return None
+            return {}
         if not strip:
             key_prefix = ''
         return dict([
             (k[len(key_prefix):], json.loads(v)) for k, v in result])
 
     def update(self, mapping, prefix=""):
+        """
+        Set the values of multiple keys at once.
+
+        :param dict mapping: Mapping of keys to values
+        :param str prefix: Optional prefix to apply to all keys in `mapping`
+            before setting
+        """
         for k, v in mapping.items():
             self.set("%s%s" % (prefix, k), v)
 
     def unset(self, key):
+        """
+        Remove a key from the database entirely.
+        """
         self.cursor.execute('delete from kv where key=?', [key])
         if self.revision and self.cursor.rowcount:
             self.cursor.execute(
                 'insert into kv_revisions values (?, ?, ?)',
                 [key, self.revision, json.dumps('DELETED')])
 
+    def unsetrange(self, keys=None, prefix=""):
+        """
+        Remove a range of keys starting with a common prefix, from the database
+        entirely.
+
+        :param list keys: List of keys to remove.
+        :param str prefix: Optional prefix to apply to all keys in ``keys``
+            before removing.
+        """
+        if keys is not None:
+            keys = ['%s%s' % (prefix, key) for key in keys]
+            self.cursor.execute('delete from kv where key in (%s)' % ','.join(['?'] * len(keys)), keys)
+            if self.revision and self.cursor.rowcount:
+                self.cursor.execute(
+                    'insert into kv_revisions values %s' % ','.join(['(?, ?, ?)'] * len(keys)),
+                    list(itertools.chain.from_iterable((key, self.revision, json.dumps('DELETED')) for key in keys)))
+        else:
+            self.cursor.execute('delete from kv where key like ?',
+                                ['%s%%' % prefix])
+            if self.revision and self.cursor.rowcount:
+                self.cursor.execute(
+                    'insert into kv_revisions values (?, ?, ?)',
+                    ['%s%%' % prefix, self.revision, json.dumps('DELETED')])
+
     def set(self, key, value):
+        """
+        Set a value in the database.
+
+        :param str key: Key to set the value for
+        :param value: Any JSON-serializable value to be set
+        """
         serialized = json.dumps(value)
 
-        self.cursor.execute(
-            'select data from kv where key=?', [key])
+        self.cursor.execute('select data from kv where key=?', [key])
         exists = self.cursor.fetchone()
 
         # Skip mutations to the same value
 
=== modified file 'charmhelpers/fetch/__init__.py'
--- charmhelpers/fetch/__init__.py	2015-04-29 12:52:18 +0000
+++ charmhelpers/fetch/__init__.py	2015-08-13 08:33:21 +0000
@@ -90,6 +90,14 @@
     'kilo/proposed': 'trusty-proposed/kilo',
     'trusty-kilo/proposed': 'trusty-proposed/kilo',
     'trusty-proposed/kilo': 'trusty-proposed/kilo',
+    # Liberty
+    'liberty': 'trusty-updates/liberty',
+    'trusty-liberty': 'trusty-updates/liberty',
+    'trusty-liberty/updates': 'trusty-updates/liberty',
+    'trusty-updates/liberty': 'trusty-updates/liberty',
+    'liberty/proposed': 'trusty-proposed/liberty',
+    'trusty-liberty/proposed': 'trusty-proposed/liberty',
+    'trusty-proposed/liberty': 'trusty-proposed/liberty',
 }
 
 # The order of this list is very important. Handlers should be listed in from
@@ -215,19 +223,27 @@
     _run_apt_command(cmd, fatal)
 
 
+def apt_mark(packages, mark, fatal=False):
+    """Flag one or more packages using apt-mark"""
+    cmd = ['apt-mark', mark]
+    if isinstance(packages, six.string_types):
+        cmd.append(packages)
+    else:
+        cmd.extend(packages)
+    log("Holding {}".format(packages))
+
+    if fatal:
+        subprocess.check_call(cmd, universal_newlines=True)
+    else:
+        subprocess.call(cmd, universal_newlines=True)
+
+
 def apt_hold(packages, fatal=False):
-    """Hold one or more packages"""
-    cmd = ['apt-mark', 'hold']
-    if isinstance(packages, six.string_types):
-        cmd.append(packages)
-    else:
-        cmd.extend(packages)
-    log("Holding {}".format(packages))
-
-    if fatal:
-        subprocess.check_call(cmd)
-    else:
-        subprocess.call(cmd)
+    return apt_mark(packages, 'hold', fatal=fatal)
+
+
+def apt_unhold(packages, fatal=False):
+    return apt_mark(packages, 'unhold', fatal=fatal)
 
 
 def add_source(source, key=None):
@@ -370,8 +386,9 @@
     for handler in handlers:
         try:
             installed_to = handler.install(source, *args, **kwargs)
-        except UnhandledSource:
-            pass
+        except UnhandledSource as e:
+            log('Install source attempt unsuccessful: {}'.format(e),
+                level='WARNING')
     if not installed_to:
         raise UnhandledSource("No handler found for source {}".format(source))
     return installed_to
 
=== modified file 'charmhelpers/fetch/archiveurl.py'
--- charmhelpers/fetch/archiveurl.py	2015-02-11 21:41:57 +0000
+++ charmhelpers/fetch/archiveurl.py	2015-08-13 08:33:21 +0000
@@ -77,6 +77,8 @@
     def can_handle(self, source):
         url_parts = self.parse_url(source)
         if url_parts.scheme not in ('http', 'https', 'ftp', 'file'):
+            # XXX: Why is this returning a boolean and a string? It's
+            # doomed to fail since "bool(can_handle('foo://'))"  will be True.
             return "Wrong source type"
         if get_archive_handler(self.base_url(source)):
             return True
@@ -155,7 +157,11 @@
             else:
                 algorithms = hashlib.algorithms_available
             if key in algorithms:
-                check_hash(dld_file, value, key)
+                if len(value) != 1:
+                    raise TypeError(
+                        "Expected 1 hash value, not %d" % len(value))
+                expected = value[0]
+                check_hash(dld_file, expected, key)
         if checksum:
             check_hash(dld_file, checksum, hash_type)
         return extract(dld_file, dest)
 
=== modified file 'charmhelpers/fetch/giturl.py'
--- charmhelpers/fetch/giturl.py	2015-05-27 12:55:44 +0000
+++ charmhelpers/fetch/giturl.py	2015-08-13 08:33:21 +0000
@@ -67,7 +67,7 @@
         try:
             self.clone(source, dest_dir, branch, depth)
         except GitCommandError as e:
-            raise UnhandledSource(e.message)
+            raise UnhandledSource(e)
         except OSError as e:
             raise UnhandledSource(e.strerror)
         return dest_dir
 
=== added directory 'docs/_extensions'
=== added file 'docs/_extensions/automembersummary.py'
--- docs/_extensions/automembersummary.py	1970-01-01 00:00:00 +0000
+++ docs/_extensions/automembersummary.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,86 @@
+# 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/>.
+
+
+import inspect
+
+from docutils.parsers.rst import directives
+from sphinx.ext.autosummary import Autosummary
+from sphinx.ext.autosummary import get_import_prefixes_from_env
+from sphinx.ext.autosummary import import_by_name
+
+
+class AutoMemberSummary(Autosummary):
+    required_arguments = 0
+    optional_arguments = 0
+    final_argument_whitespace = False
+    has_content = True
+    option_spec = {
+        'toctree': directives.unchanged,
+        'nosignatures': directives.flag,
+        'template': directives.unchanged,
+    }
+
+    def get_items(self, names):
+        env = self.state.document.settings.env
+        prefixes = get_import_prefixes_from_env(env)
+
+        items = []
+        prefix = ''
+        shorten = ''
+
+        def _get_items(name):
+            _items = super(AutoMemberSummary, self).get_items([shorten + name])
+            for dn, sig, summary, rn in _items:
+                items.append(('%s%s' % (prefix, dn), sig, summary, rn))
+
+        for name in names:
+            if '~' in name:
+                prefix, name = name.split('~')
+                shorten = '~'
+            else:
+                prefix = ''
+                shorten = ''
+
+            try:
+                real_name, obj, parent, _ = import_by_name(name, prefixes=prefixes)
+            except ImportError:
+                self.warn('failed to import %s' % name)
+                continue
+
+            if not inspect.ismodule(obj):
+                _get_items(name)
+                continue
+
+            for member in dir(obj):
+                if member.startswith('_'):
+                    continue
+                mobj = getattr(obj, member)
+                if hasattr(mobj, '__module__'):
+                    if not mobj.__module__.startswith(real_name):
+                        continue  # skip imported classes & functions
+                elif hasattr(mobj, '__name__'):
+                    if not mobj.__name__.startswith(real_name):
+                        continue  # skip imported modules
+                else:
+                    continue  # skip instances
+                _get_items('%s.%s' % (name, member))
+
+        return items
+
+
+def setup(app):
+    app.add_directive('automembersummary', AutoMemberSummary)
 
=== added file 'docs/api/charmhelpers.coordinator.rst'
--- docs/api/charmhelpers.coordinator.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.coordinator.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,10 @@
+charmhelpers.coordinator package
+================================
+
+charmhelpers.coordinator module
+-------------------------------
+
+.. automodule:: charmhelpers.coordinator
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.decorators.rst'
--- docs/api/charmhelpers.core.decorators.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.decorators.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,7 @@
+charmhelpers.core.decorators
+============================
+
+.. automodule:: charmhelpers.core.decorators
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.fstab.rst'
--- docs/api/charmhelpers.core.fstab.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.fstab.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,7 @@
+charmhelpers.core.fstab
+=======================
+
+.. automodule:: charmhelpers.core.fstab
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.hookenv.rst'
--- docs/api/charmhelpers.core.hookenv.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.hookenv.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,12 @@
+charmhelpers.core.hookenv
+=========================
+
+.. automembersummary::
+    :nosignatures:
+
+    ~charmhelpers.core.hookenv
+
+.. automodule:: charmhelpers.core.hookenv
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.host.rst'
--- docs/api/charmhelpers.core.host.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.host.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,12 @@
+charmhelpers.core.host
+======================
+
+.. automembersummary::
+    :nosignatures:
+
+    ~charmhelpers.core.host
+
+.. automodule:: charmhelpers.core.host
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== modified file 'docs/api/charmhelpers.core.rst'
--- docs/api/charmhelpers.core.rst	2014-08-05 21:28:01 +0000
+++ docs/api/charmhelpers.core.rst	2015-08-13 08:33:21 +0000
@@ -1,44 +1,17 @@
 charmhelpers.core package
 =========================
 
-charmhelpers.core.fstab module
-------------------------------
-
-.. automodule:: charmhelpers.core.fstab
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-charmhelpers.core.hookenv module
---------------------------------
-
-.. automodule:: charmhelpers.core.hookenv
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-charmhelpers.core.host module
------------------------------
-
-.. automodule:: charmhelpers.core.host
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-charmhelpers.core.services package
-----------------------------------
-
-.. automodule:: charmhelpers.core.services.base
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    :special-members: __init__
-
-.. automodule:: charmhelpers.core.services.helpers
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
+.. toctree::
+
+    charmhelpers.core.decorators
+    charmhelpers.core.fstab
+    charmhelpers.core.hookenv
+    charmhelpers.core.host
+    charmhelpers.core.strutils
+    charmhelpers.core.sysctl
+    charmhelpers.core.templating
+    charmhelpers.core.unitdata
+    charmhelpers.core.services
 
 .. automodule:: charmhelpers.core
     :members:
 
=== added file 'docs/api/charmhelpers.core.services.base.rst'
--- docs/api/charmhelpers.core.services.base.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.services.base.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,12 @@
+charmhelpers.core.services.base
+===============================
+
+.. automembersummary::
+    :nosignatures:
+
+    ~charmhelpers.core.services.base
+
+.. automodule:: charmhelpers.core.services.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.services.helpers.rst'
--- docs/api/charmhelpers.core.services.helpers.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.services.helpers.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,12 @@
+charmhelpers.core.services.helpers
+==================================
+
+.. automembersummary::
+    :nosignatures:
+
+    ~charmhelpers.core.services.helpers
+
+.. automodule:: charmhelpers.core.services.helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.services.rst'
--- docs/api/charmhelpers.core.services.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.services.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,12 @@
+charmhelpers.core.services
+==========================
+
+.. toctree::
+
+    charmhelpers.core.services.base
+    charmhelpers.core.services.helpers
+
+.. automodule:: charmhelpers.core.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.strutils.rst'
--- docs/api/charmhelpers.core.strutils.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.strutils.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,7 @@
+charmhelpers.core.strutils
+============================
+
+.. automodule:: charmhelpers.core.strutils
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.sysctl.rst'
--- docs/api/charmhelpers.core.sysctl.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.sysctl.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,7 @@
+charmhelpers.core.sysctl
+============================
+
+.. automodule:: charmhelpers.core.sysctl
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.templating.rst'
--- docs/api/charmhelpers.core.templating.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.templating.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,7 @@
+charmhelpers.core.templating
+============================
+
+.. automodule:: charmhelpers.core.templating
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== added file 'docs/api/charmhelpers.core.unitdata.rst'
--- docs/api/charmhelpers.core.unitdata.rst	1970-01-01 00:00:00 +0000
+++ docs/api/charmhelpers.core.unitdata.rst	2015-08-13 08:33:21 +0000
@@ -0,0 +1,7 @@
+charmhelpers.core.unitdata
+==========================
+
+.. automodule:: charmhelpers.core.unitdata
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
=== modified file 'docs/api/charmhelpers.rst'
--- docs/api/charmhelpers.rst	2014-06-09 17:10:38 +0000
+++ docs/api/charmhelpers.rst	2015-08-13 08:33:21 +0000
@@ -2,12 +2,14 @@
 =================
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 3
 
+    charmhelpers.core
     charmhelpers.contrib
-    charmhelpers.core
     charmhelpers.fetch
     charmhelpers.payload
+    charmhelpers.cli
+    charmhelpers.coordinator
 
 .. automodule:: charmhelpers
     :members:
 
=== removed file 'docs/api/modules.rst'
--- docs/api/modules.rst	2014-06-09 14:56:35 +0000
+++ docs/api/modules.rst	1970-01-01 00:00:00 +0000
@@ -1,7 +0,0 @@
-charmhelpers
-============
-
-.. toctree::
-   :maxdepth: 4
-
-   charmhelpers
 
=== modified file 'docs/conf.py'
--- docs/conf.py	2014-09-23 16:34:54 +0000
+++ docs/conf.py	2015-08-13 08:33:21 +0000
@@ -19,6 +19,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../'))
+sys.path.append(os.path.abspath('_extensions/'))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,6 +31,8 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'automembersummary',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -72,7 +75,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '_extensions']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 
=== modified file 'setup.py'
--- setup.py	2015-03-04 16:15:18 +0000
+++ setup.py	2015-08-13 08:33:21 +0000
@@ -14,6 +14,13 @@
     'author': "Ubuntu Developers",
     'author_email': "[e-mail]",
     'url': "https://code.launchpad.net/charm-helpers",
+    'install_requires': [
+        'netaddr',
+        'PyYAML',
+        'Tempita',
+        'Jinja2',
+        'six',
+    ],
     'packages': [
         "charmhelpers",
         "charmhelpers.cli",
@@ -22,13 +29,27 @@
         "charmhelpers.fetch",
         "charmhelpers.payload",
         "charmhelpers.contrib",
+        "charmhelpers.contrib.amulet",
         "charmhelpers.contrib.ansible",
         "charmhelpers.contrib.benchmark",
         "charmhelpers.contrib.charmhelpers",
         "charmhelpers.contrib.charmsupport",
+        "charmhelpers.contrib.database",
+        "charmhelpers.contrib.hahelpers",
+        "charmhelpers.contrib.network",
+        "charmhelpers.contrib.network.ovs",
+        "charmhelpers.contrib.openstack",
+        "charmhelpers.contrib.openstack.amulet",
+        "charmhelpers.contrib.openstack.files",
+        "charmhelpers.contrib.openstack.templates",
+        "charmhelpers.contrib.peerstorage",
+        "charmhelpers.contrib.python",
         "charmhelpers.contrib.saltstack",
-        "charmhelpers.contrib.hahelpers",
+        "charmhelpers.contrib.ssl",
+        "charmhelpers.contrib.storage",
+        "charmhelpers.contrib.storage.linux",
         "charmhelpers.contrib.templating",
+        "charmhelpers.contrib.unison",
     ],
     'scripts': [
         "bin/chlp",
 
=== modified file 'test_requirements.txt'
--- test_requirements.txt	2014-11-25 15:07:02 +0000
+++ test_requirements.txt	2015-08-13 08:33:21 +0000
@@ -3,10 +3,12 @@
 pip
 distribute
 coverage>=3.6
-mock>=1.0.1
+mock>=1.0.1,<1.1.0
 nose>=1.3.1
 flake8
 testtools==0.9.14  # Before dependent on modern 'six'
+amulet
+distro-info
 #
 # Specify precise versions of runtime dependencies where possible.
 netaddr==0.7.10    # trusty. precise is 0.7.5, but not in pypi.
 
=== modified file 'tests/cli/test_cmdline.py'
--- tests/cli/test_cmdline.py	2014-11-25 15:04:52 +0000
+++ tests/cli/test_cmdline.py	2015-08-13 08:33:21 +0000
@@ -5,6 +5,7 @@
 from mock import (
     patch,
     MagicMock,
+    ANY,
 )
 import json
 from pprint import pformat
@@ -87,15 +88,61 @@
         @self.cl.subcommand()
         def bar(x, y=None, *vargs):
             "A function that does work."
-            self.bar_called = True
-            return "qux"
-
-        args = ['foo', 'bar', 'baz']
-        self.cl.formatter = MagicMock()
-        with patch("sys.argv", args):
-            self.cl.run()
-        self.assertTrue(self.bar_called)
-        self.assertTrue(self.cl.formatter.format_output.called)
+            self.assertEqual(x, 'baz')
+            self.assertEqual(y, 'why')
+            self.assertEqual(vargs, ('mux', 'zob'))
+            self.bar_called = True
+            return "qux"
+
+        args = ['chlp', 'bar', '--y', 'why', 'baz', 'mux', 'zob']
+        self.cl.formatter = MagicMock()
+        with patch("sys.argv", args):
+            with patch("charmhelpers.core.unitdata._KV") as _KV:
+                self.cl.run()
+                assert _KV.flush.called
+        self.assertTrue(self.bar_called)
+        self.cl.formatter.format_output.assert_called_once_with('qux', ANY)
+
+    def test_no_output(self):
+        self.bar_called = False
+
+        @self.cl.subcommand()
+        @self.cl.no_output
+        def bar(x, y=None, *vargs):
+            "A function that does work."
+            self.bar_called = True
+            return "qux"
+
+        args = ['foo', 'bar', 'baz']
+        self.cl.formatter = MagicMock()
+        with patch("sys.argv", args):
+            self.cl.run()
+        self.assertTrue(self.bar_called)
+        self.cl.formatter.format_output.assert_called_once_with('', ANY)
+
+    def test_test_command(self):
+        self.bar_called = False
+        self.bar_result = True
+
+        @self.cl.subcommand()
+        @self.cl.test_command
+        def bar(x, y=None, *vargs):
+            "A function that does work."
+            self.bar_called = True
+            return self.bar_result
+
+        args = ['foo', 'bar', 'baz']
+        self.cl.formatter = MagicMock()
+        with patch("sys.argv", args):
+            self.cl.run()
+        self.assertTrue(self.bar_called)
+        self.assertEqual(self.cl.exit_code, 0)
+        self.cl.formatter.format_output.assert_called_once_with('', ANY)
+
+        self.bar_result = False
+        with patch("sys.argv", args):
+            self.cl.run()
+        self.assertEqual(self.cl.exit_code, 1)
 
 
 class OutputFormatterTest(TestCase):
 
=== added directory 'tests/contrib/amulet'
=== added file 'tests/contrib/amulet/test_utils.py'
--- tests/contrib/amulet/test_utils.py	1970-01-01 00:00:00 +0000
+++ tests/contrib/amulet/test_utils.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,105 @@
+# Copyright 2015 Canonical Ltd.
+#
+# Authors:
+#  Adam Collard <[e-mail]>
+
+import unittest
+
+from charmhelpers.contrib.amulet.utils import AmuletUtils
+
+
+class FakeSentry(object):
+
+    commands = {}
+
+    info = {"unit_name": "foo"}
+
+    def run(self, command):
+        return self.commands[command]
+
+
+class ValidateServicesByNameTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.utils = AmuletUtils()
+        self.sentry_unit = FakeSentry()
+
+    def test_errors_for_unknown_upstart_service(self):
+        """
+        Returns a message if the Upstart service is unknown.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "trusty", 0
+        self.sentry_unit.commands["sudo status foo"] = (
+            "status: Unknown job: foo", 1)
+
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
+
+    def test_none_for_started_upstart_service(self):
+        """
+        Returns None if the Upstart service is running.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "trusty", 0
+        self.sentry_unit.commands["sudo status foo"] = (
+            "foo start/running, process 42", 0)
+
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNone(result)
+
+    def test_errors_for_stopped_upstart_service(self):
+        """
+        Returns a message if the Upstart service is stopped.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "trusty", 0
+        self.sentry_unit.commands["sudo status foo"] = "foo stop/waiting", 0
+
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
+
+    def test_errors_for_unknown_systemd_service(self):
+        """
+        Returns a message if a systemd service is unknown.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "vivid", 0
+        self.sentry_unit.commands["sudo service foo status"] = (u"""\
+\u25cf foo.service
+   Loaded: not-found (Reason: No such file or directory)
+   Active: inactive (dead)
+""", 3)
+
+        result = self.utils.validate_services_by_name({
+            self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
+
+    def test_none_for_started_systemd_service(self):
+        """
+        Returns None if a systemd service is running.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "vivid", 0
+        self.sentry_unit.commands["sudo service foo status"] = (u"""\
+\u25cf foo.service - Foo
+   Loaded: loaded (/lib/systemd/system/foo.service; enabled)
+   Active: active (exited) since Thu 1970-01-01 00:00:00 UTC; 42h 42min ago
+ Main PID: 3 (code=exited, status=0/SUCCESS)
+   CGroup: /system.slice/foo.service
+""", 0)
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNone(result)
+
+    def test_errors_for_stopped_systemd_service(self):
+        """
+        Returns a message if a systemd service is stopped.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "vivid", 0
+        self.sentry_unit.commands["sudo service foo status"] = (u"""\
+\u25cf foo.service - Foo
+   Loaded: loaded (/lib/systemd/system/foo.service; disabled)
+   Active: inactive (dead)
+""", 3)
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
 
=== modified file 'tests/contrib/benchmark/test_benchmark.py'
--- tests/contrib/benchmark/test_benchmark.py	2015-04-24 16:07:29 +0000
+++ tests/contrib/benchmark/test_benchmark.py	2015-08-13 08:33:21 +0000
@@ -1,3 +1,8 @@
+from functools import partial
+from os.path import join
+from tempfile import mkdtemp
+from shutil import rmtree
+
 import mock
 from testtools import TestCase
 # import unittest
@@ -33,7 +38,8 @@
         self.fake_relation = FakeRelation(FAKE_RELATION)
         # self.hook_name.return_value = 'benchmark-relation-changed'
 
-        self.relation_get.side_effect = self.fake_relation.get
+        self.relation_get.side_effect = partial(
+            self.fake_relation.get, rid="benchmark:0", unit="benchmark/0")
         self.relation_ids.side_effect = self.fake_relation.relation_ids
 
     def _patch(self, method):
@@ -87,34 +93,32 @@
         check_call.assert_any_call(['action-set', 'baz.foo=1'])
         check_call.assert_any_call(['action-set', 'baz.bar=2'])
 
-    @mock.patch('charmhelpers.contrib.benchmark.relation_get')
-    @mock.patch('charmhelpers.contrib.benchmark.relation_set')
     @mock.patch('charmhelpers.contrib.benchmark.relation_ids')
     @mock.patch('charmhelpers.contrib.benchmark.in_relation_hook')
-    def test_benchmark_init(self, in_relation_hook, relation_ids, relation_set, relation_get):
+    def test_benchmark_init(self, in_relation_hook, relation_ids):
 
         in_relation_hook.return_value = True
         relation_ids.return_value = ['benchmark:0']
         actions = ['asdf', 'foobar']
 
-        with patch_open() as (_open, _file):
+        tempdir = mkdtemp(prefix=self.__class__.__name__)
+        self.addCleanup(rmtree, tempdir)
+        conf_path = join(tempdir, "benchmark.conf")
+        with mock.patch.object(Benchmark, "BENCHMARK_CONF", conf_path):
             b = Benchmark(actions)
 
             self.assertIsInstance(b, Benchmark)
 
-            self.assertTrue(relation_get.called)
-            self.assertTrue(relation_set.called)
+            self.assertTrue(self.relation_get.called)
+            self.assertTrue(self.relation_set.called)
 
             relation_ids.assert_called_once_with('benchmark')
 
-            for key in b.required_keys:
-                relation_get.assert_any_call(key)
-
-            relation_set.assert_called_once_with(
+            self.relation_set.assert_called_once_with(
                 relation_id='benchmark:0',
                 relation_settings={'benchmarks': ",".join(actions)}
             )
 
-            _open.assert_called_with('/etc/benchmark.conf', 'w')
+            conf_contents = open(conf_path).readlines()
             for key, val in iter(FAKE_RELATION['benchmark:0']['benchmark/0'].items()):
-                _file.write.assert_any_called("%s=%s\n" % (key, val))
+                self.assertIn("%s=%s\n" % (key, val), conf_contents)
 
=== modified file 'tests/contrib/hahelpers/test_apache_utils.py'
--- tests/contrib/hahelpers/test_apache_utils.py	2014-09-24 09:42:52 +0000
+++ tests/contrib/hahelpers/test_apache_utils.py	2015-08-13 08:33:21 +0000
@@ -115,4 +115,4 @@
             apache_utils.install_ca_cert(cert)
             _open.assert_called_with('/usr/local/share/ca-certificates/keystone_juju_ca_cert.crt', 'w')
             _file.write.assert_called_with(cert)
-        self.subprocess.assertCalledWith(['update-ca-certificates', '--fresh'])
+        self.subprocess.check_call.assert_called_with(['update-ca-certificates', '--fresh'])
 
=== modified file 'tests/contrib/network/test_ufw.py'
--- tests/contrib/network/test_ufw.py	2015-02-12 20:08:28 +0000
+++ tests/contrib/network/test_ufw.py	2015-08-13 08:33:21 +0000
@@ -31,6 +31,12 @@
 xt_LOG                 17702  0
 xt_limit               12711  0
 """
+DEFAULT_POLICY_OUTPUT = """Default incoming policy changed to 'deny'
+(be sure to update your rules accordingly)
+"""
+DEFAULT_POLICY_OUTPUT_OUTGOING = """Default outgoing policy changed to 'allow'
+(be sure to update your rules accordingly)
+"""
 
 
 class TestUFW(unittest.TestCase):
@@ -194,6 +200,24 @@
     @mock.patch('charmhelpers.contrib.network.ufw.is_enabled')
     @mock.patch('charmhelpers.core.hookenv.log')
     @mock.patch('subprocess.Popen')
+    def test_modify_access_with_index(self, popen, log, is_enabled):
+        is_enabled.return_value = True
+        p = mock.Mock()
+        p.configure_mock(**{'communicate.return_value': ('stdout', 'stderr'),
+                            'returncode': 0})
+        popen.return_value = p
+
+        ufw.modify_access('127.0.0.1', dst='127.0.0.1', port='80', index=1)
+        popen.assert_any_call(['ufw', 'insert', '1', 'allow', 'from',
+                               '127.0.0.1', 'to', '127.0.0.1', 'port', '80'],
+                              stdout=subprocess.PIPE)
+        log.assert_any_call(('ufw allow: ufw insert 1 allow from 127.0.0.1 '
+                             'to 127.0.0.1 port 80'), level='DEBUG')
+        log.assert_any_call('stdout', level='INFO')
+
+    @mock.patch('charmhelpers.contrib.network.ufw.is_enabled')
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.Popen')
     def test_grant_access(self, popen, log, is_enabled):
         is_enabled.return_value = True
         p = mock.Mock()
@@ -212,6 +236,24 @@
     @mock.patch('charmhelpers.contrib.network.ufw.is_enabled')
     @mock.patch('charmhelpers.core.hookenv.log')
     @mock.patch('subprocess.Popen')
+    def test_grant_access_with_index(self, popen, log, is_enabled):
+        is_enabled.return_value = True
+        p = mock.Mock()
+        p.configure_mock(**{'communicate.return_value': ('stdout', 'stderr'),
+                            'returncode': 0})
+        popen.return_value = p
+
+        ufw.grant_access('127.0.0.1', dst='127.0.0.1', port='80', index=1)
+        popen.assert_any_call(['ufw', 'insert', '1', 'allow', 'from',
+                               '127.0.0.1', 'to', '127.0.0.1', 'port', '80'],
+                              stdout=subprocess.PIPE)
+        log.assert_any_call(('ufw allow: ufw insert 1 allow from 127.0.0.1 '
+                             'to 127.0.0.1 port 80'), level='DEBUG')
+        log.assert_any_call('stdout', level='INFO')
+
+    @mock.patch('charmhelpers.contrib.network.ufw.is_enabled')
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.Popen')
     def test_revoke_access(self, popen, log, is_enabled):
         is_enabled.return_value = True
         p = mock.Mock()
@@ -366,3 +408,33 @@
         is_enabled.return_value = False
         isdir.return_value = True
         ufw.enable()
+
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.check_output')
+    def test_change_default_policy(self, check_output, log):
+        check_output.return_value = DEFAULT_POLICY_OUTPUT
+        self.assertTrue(ufw.default_policy())
+        check_output.asser_any_call(['ufw', 'default', 'deny', 'incoming'])
+
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.check_output')
+    def test_change_default_policy_allow_outgoing(self, check_output, log):
+        check_output.return_value = DEFAULT_POLICY_OUTPUT_OUTGOING
+        self.assertTrue(ufw.default_policy('allow', 'outgoing'))
+        check_output.asser_any_call(['ufw', 'default', 'allow', 'outgoing'])
+
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.check_output')
+    def test_change_default_policy_unexpected_output(self, check_output, log):
+        check_output.return_value = "asdf"
+        self.assertFalse(ufw.default_policy())
+
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.check_output')
+    def test_change_default_policy_wrong_policy(self, check_output, log):
+        self.assertRaises(ufw.UFWError, ufw.default_policy, 'asdf')
+
+    @mock.patch('charmhelpers.core.hookenv.log')
+    @mock.patch('subprocess.check_output')
+    def test_change_default_policy_wrong_direction(self, check_output, log):
+        self.assertRaises(ufw.UFWError, ufw.default_policy, 'allow', 'asdf')
 
=== modified file 'tests/contrib/openstack/test_openstack_utils.py'
--- tests/contrib/openstack/test_openstack_utils.py	2015-05-11 18:53:44 +0000
+++ tests/contrib/openstack/test_openstack_utils.py	2015-08-13 08:33:21 +0000
@@ -26,6 +26,16 @@
 }
 
 FAKE_REPO = {
+    'neutron-common': {
+        'pkg_vers': '2:7.0.0-0ubuntu1',
+        'os_release': 'liberty',
+        'os_version': '2015.2'
+    },
+    'nova-common': {
+        'pkg_vers': '2:12.0.0~b1-0ubuntu1',
+        'os_release': 'liberty',
+        'os_version': '2015.2'
+    },
     'nova-common': {
         'pkg_vers': '2012.2.3-0ubuntu2.1',
         'os_release': 'folsom',
@@ -489,8 +499,8 @@
         expected_f = '/var/lib/juju/units/testing-foo-0/charm/scripts/scriptrc'
         _open.assert_called_with(expected_f, 'wb')
         _mkdir.assert_called_with(os.path.dirname(expected_f))
-        for line in scriptrc:
-            _file.__enter__().write.assert_has_calls(call(line))
+        _file.__enter__().write.assert_has_calls(
+            list(call(line) for line in scriptrc), any_order=True)
 
     @patch.object(openstack, 'lsb_release')
     @patch.object(openstack, 'get_os_version_package')
@@ -642,11 +652,13 @@
         error_out.assert_called_with(
             'openstack-origin-git key \'%s\' is missing' % key)
 
+    @patch('os.path.join')
     @patch.object(openstack, 'error_out')
     @patch.object(openstack, '_git_clone_and_install_single')
+    @patch.object(openstack, 'pip_install')
     @patch.object(openstack, 'pip_create_virtualenv')
-    def test_git_clone_and_install_errors(self, pip_venv, git_install_single,
-                                          error_out):
+    def test_git_clone_and_install_errors(self, pip_venv, pip_install,
+                                          git_install_single, error_out, join):
         git_missing_repos = """
           repostories:
              - {name: requirements,
@@ -704,19 +716,26 @@
         openstack.git_clone_and_install(git_wrong_order_2, 'keystone', depth=1)
         error_out.assert_called_with('requirements git repo must be specified first')
 
+    @patch('os.path.join')
     @patch.object(openstack, 'charm_dir')
     @patch.object(openstack, 'error_out')
     @patch.object(openstack, '_git_clone_and_install_single')
+    @patch.object(openstack, 'pip_install')
     @patch.object(openstack, 'pip_create_virtualenv')
-    def test_git_clone_and_install_success(self, pip_venv, _git_install_single,
-                                           error_out, charm_dir):
+    def test_git_clone_and_install_success(self, pip_venv, pip_install,
+                                           _git_install_single, error_out,
+                                           charm_dir, join):
         proj = 'keystone'
         charm_dir.return_value = '/var/lib/juju/units/testing-foo-0/charm'
         # the following sets the global requirements_dir
         _git_install_single.return_value = '/mnt/openstack-git/requirements'
+        join.return_value = '/mnt/openstack-git/venv'
 
         openstack.git_clone_and_install(openstack_origin_git, proj, depth=1)
         self.assertTrue(pip_venv.called)
+        pip_install.assert_called_with('setuptools', upgrade=True,
+                                       proxy=None,
+                                       venv='/mnt/openstack-git/venv')
         self.assertTrue(_git_install_single.call_count == 2)
         expected = [
             call('git://git.openstack.org/openstack/requirements',
@@ -775,6 +794,7 @@
         parent_dir = '/mnt/openstack-git/'
         http_proxy = 'http://squid-proxy-url'
         dest_dir = '/mnt/openstack-git'
+        venv_dir = '/mnt/openstack-git'
         reqs_dir = '/mnt/openstack-git/requirements-dir'
         join.return_value = dest_dir
         openstack.requirements_dir = reqs_dir
@@ -786,23 +806,27 @@
         mkdir.assert_called_with(parent_dir)
         install_remote.assert_called_with(repo, dest=parent_dir, depth=1,
                                           branch=branch)
-        _git_update_reqs.assert_called_with(dest_dir, reqs_dir)
+        _git_update_reqs.assert_called_with(venv_dir, dest_dir, reqs_dir)
         pip_install.assert_called_with(dest_dir, venv='/mnt/openstack-git',
                                        proxy='http://squid-proxy-url')
 
+    @patch('os.path.join')
     @patch('os.getcwd')
     @patch('os.chdir')
     @patch('subprocess.check_call')
-    def test_git_update_requirements(self, check_call, chdir, getcwd):
+    def test_git_update_requirements(self, check_call, chdir, getcwd, join):
         pkg_dir = '/mnt/openstack-git/repo-dir'
         reqs_dir = '/mnt/openstack-git/reqs-dir'
         orig_dir = '/var/lib/juju/units/testing-foo-0/charm'
+        venv_dir = '/mnt/openstack-git/venv'
         getcwd.return_value = orig_dir
+        join.return_value = '/mnt/openstack-git/venv/python'
 
-        openstack._git_update_requirements(pkg_dir, reqs_dir)
+        openstack._git_update_requirements(venv_dir, pkg_dir, reqs_dir)
         expected = [call(reqs_dir), call(orig_dir)]
         self.assertEquals(expected, chdir.call_args_list)
-        check_call.assert_called_with(['python', 'update.py', pkg_dir])
+        check_call.assert_called_with(['/mnt/openstack-git/venv/python',
+                                      'update.py', pkg_dir])
 
     @patch('os.path.join')
     @patch('subprocess.check_call')
 
=== modified file 'tests/contrib/openstack/test_os_contexts.py'
--- tests/contrib/openstack/test_os_contexts.py	2015-04-29 12:52:18 +0000
+++ tests/contrib/openstack/test_os_contexts.py	2015-08-13 08:33:21 +0000
@@ -73,7 +73,11 @@
             return None
 
     def relation_ids(self, relation):
-        return self.relation_data.keys()
+        rids = []
+        for rid in self.relation_data.keys():
+            if relation + ':' in rid:
+                rids.append(rid)
+        return rids
 
     def relation_units(self, relation_id):
         if relation_id not in self.relation_data:
@@ -325,6 +329,25 @@
                 - [glance-key2, value2]
 """
 
+NOVA_SUB_CONFIG1 = """
+nova:
+    /etc/nova/nova.conf:
+        sections:
+            DEFAULT:
+                - [nova-key1, value1]
+                - [nova-key2, value2]
+"""
+
+
+NOVA_SUB_CONFIG2 = """
+nova-compute:
+    /etc/nova/nova.conf:
+        sections:
+            DEFAULT:
+                - [nova-key3, value3]
+                - [nova-key4, value4]
+"""
+
 CINDER_SUB_CONFIG1 = """
 cinder:
     /etc/cinder/cinder.conf:
@@ -376,6 +399,21 @@
     },
 }
 
+SUB_CONFIG_RELATION2 = {
+    'nova-ceilometer:6': {
+        'ceilometer-agent/0': {
+            'private-address': 'nova_node1',
+            'subordinate_configuration': json.dumps(yaml.load(NOVA_SUB_CONFIG1)),
+        },
+    },
+    'neutron-plugin:3': {
+        'neutron-ovs-plugin/0': {
+            'private-address': 'nova_node1',
+            'subordinate_configuration': json.dumps(yaml.load(NOVA_SUB_CONFIG2)),
+        },
+    }
+}
+
 NONET_CONFIG = {
     'vip': 'cinderhost1vip',
     'os-internal-network': None,
@@ -2053,6 +2091,27 @@
         # subordinate supplies bad input
         self.assertEquals(foo_sub_ctxt(), {'sections': {}})
 
+    def test_os_subordinate_config_context_multiple(self):
+        relation = FakeRelation(relation_data=SUB_CONFIG_RELATION2)
+        self.relation_get.side_effect = relation.get
+        self.relation_ids.side_effect = relation.relation_ids
+        self.related_units.side_effect = relation.relation_units
+        nova_sub_ctxt = context.SubordinateConfigContext(
+            service=['nova', 'nova-compute'],
+            config_file='/etc/nova/nova.conf',
+            interface=['nova-ceilometer', 'neutron-plugin'],
+        )
+        self.assertEquals(
+            nova_sub_ctxt(),
+            {'sections': {
+                'DEFAULT': [
+                    ['nova-key1', 'value1'],
+                    ['nova-key2', 'value2'],
+                    ['nova-key3', 'value3'],
+                    ['nova-key4', 'value4']]
+            }}
+        )
+
     def test_syslog_context(self):
         self.config.side_effect = fake_config({'use-syslog': 'foo'})
         syslog = context.SyslogContext()
 
=== modified file 'tests/contrib/peerstorage/test_peerstorage.py'
--- tests/contrib/peerstorage/test_peerstorage.py	2015-06-03 14:46:50 +0000
+++ tests/contrib/peerstorage/test_peerstorage.py	2015-08-13 08:33:21 +0000
@@ -202,7 +202,7 @@
         l_settings = {'s3': 3}
         r_settings = {'s1': 1, 's2': 2}
 
-        def mock_relation_get(attribute=None, unit=None):
+        def mock_relation_get(attribute=None, unit=None, rid=None):
             if attribute:
                 if attribute in r_settings:
                     return r_settings.get(attribute)
@@ -237,11 +237,11 @@
             self.assertEqual(_dicta, _dictb)
 
         migration_key = '__leader_get_migrated_settings__'
-        self.relation_get.side_effect = mock_relation_get
+        self._relation_get.side_effect = mock_relation_get
         self._leader_get.side_effect = mock_leader_get
         self.leader_set.side_effect = mock_leader_set
 
-        self.assertEqual({'s1': 1, 's2': 2}, peerstorage.relation_get())
+        self.assertEqual({'s1': 1, 's2': 2}, peerstorage._relation_get())
         self.assertEqual({'s3': 3}, peerstorage._leader_get())
         self.assertEqual({'s1': 1, 's2': 2, 's3': 3}, peerstorage.leader_get())
         check_leader_db({'s1': 1, 's2': 2, 's3': 3,
@@ -274,7 +274,7 @@
 
         peerstorage.leader_set.reset_mock()
         self.assertEqual({'s1': 1, 's2': 2, 's3': 2, 's4': 3},
-                         peerstorage.relation_get())
+                         peerstorage._relation_get())
         check_leader_db({'s1': 1, 's3': 3, 's4': 4,
                          migration_key: '["s1", "s4"]'},
                         peerstorage._leader_get())
@@ -290,7 +290,7 @@
         l_settings = {'s3': 3}
         r_settings = {'s1': 1, 's2': 2}
 
-        def mock_relation_get(attribute=None, unit=None):
+        def mock_relation_get(attribute=None, unit=None, rid=None):
             if attribute:
                 if attribute in r_settings:
                     return r_settings.get(attribute)
@@ -314,10 +314,10 @@
 
             l_settings.update(kwargs)
 
-        self.relation_get.side_effect = mock_relation_get
+        self._relation_get.side_effect = mock_relation_get
         self._leader_get.side_effect = mock_leader_get
         self.leader_set.side_effect = mock_leader_set
-        self.assertEqual({'s1': 1, 's2': 2}, peerstorage.relation_get())
+        self.assertEqual({'s1': 1, 's2': 2}, peerstorage._relation_get())
         self.assertEqual({'s3': 3}, peerstorage._leader_get())
         self.assertEqual({'s3': 3}, peerstorage.leader_get())
         self.assertEqual({'s3': 3}, l_settings)
 
=== modified file 'tests/contrib/python/test_debug.py' (properties changed: -x to +x)
--- tests/contrib/python/test_debug.py	2015-02-11 21:41:57 +0000
+++ tests/contrib/python/test_debug.py	2015-08-13 08:33:21 +0000
@@ -51,4 +51,4 @@
         """
         self.set_trace()
         self.Rpdb.set_trace.side_effect = Exception()
-        self._error.assert_called_once()
+        self.assertTrue(self._error.called)
 
=== modified file 'tests/contrib/storage/test_linux_ceph.py'
--- tests/contrib/storage/test_linux_ceph.py	2015-01-13 11:17:57 +0000
+++ tests/contrib/storage/test_linux_ceph.py	2015-08-13 08:33:21 +0000
@@ -62,7 +62,7 @@
         '''It creates a new ceph keyring'''
         _exists.return_value = True
         ceph_utils.create_keyring('cinder', 'cephkey')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
         self.check_call.assert_not_called()
 
     @patch('os.remove')
@@ -72,7 +72,7 @@
         _exists.return_value = True
         ceph_utils.delete_keyring('cinder')
         _remove.assert_called_with('/etc/ceph/ceph.client.cinder.keyring')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
 
     @patch('os.remove')
     @patch('os.path.exists')
@@ -80,7 +80,7 @@
         '''It creates a new ceph keyring.'''
         _exists.return_value = False
         ceph_utils.delete_keyring('cinder')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
         _remove.assert_not_called()
 
     @patch('os.path.exists')
@@ -90,14 +90,14 @@
         with patch_open() as (_open, _file):
             ceph_utils.create_key_file('cinder', 'cephkey')
             _file.write.assert_called_with('cephkey')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
 
     @patch('os.path.exists')
     def test_create_key_file_already_exists(self, _exists):
         '''It creates a new ceph keyring'''
         _exists.return_value = True
         ceph_utils.create_key_file('cinder', 'cephkey')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
 
     @patch('os.mkdir')
     @patch.object(ceph_utils, 'apt_install')
@@ -171,7 +171,7 @@
         self._patch('pool_exists')
         self.pool_exists.return_value = True
         ceph_utils.create_pool(service='cinder', name='foo')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
         self.check_call.assert_not_called()
 
     def test_keyring_path(self):
@@ -202,14 +202,14 @@
     def test_rbd_exists(self):
         self.check_output.return_value = LS_RBDS
         self.assertTrue(ceph_utils.rbd_exists('service', 'pool', 'rbd1'))
-        self.check_output.assert_call_with(
+        self.check_output.assert_called_with(
             ['rbd', 'list', '--id', 'service', '--pool', 'pool']
         )
 
     def test_rbd_does_not_exist(self):
         self.check_output.return_value = LS_RBDS
         self.assertFalse(ceph_utils.rbd_exists('service', 'pool', 'rbd4'))
-        self.check_output.assert_call_with(
+        self.check_output.assert_called_with(
             ['rbd', 'list', '--id', 'service', '--pool', 'pool']
         )
 
@@ -304,7 +304,7 @@
             _file.read.return_value = 'anothermod\n'
             ceph_utils.modprobe('mymod')
             _open.assert_called_with('/etc/modules', 'r+')
-            _file.read.assert_called()
+            _file.read.assert_called_with()
             _file.write.assert_called_with('mymod')
         self.check_call.assert_called_with(['modprobe', 'mymod'])
 
@@ -318,14 +318,14 @@
     def test_make_filesystem(self, _exists):
         _exists.return_value = True
         ceph_utils.make_filesystem('/dev/sdd')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
         self.check_call.assert_called_with(['mkfs', '-t', 'ext4', '/dev/sdd'])
 
     @patch('os.path.exists')
     def test_make_filesystem_xfs(self, _exists):
         _exists.return_value = True
         ceph_utils.make_filesystem('/dev/sdd', 'xfs')
-        self.log.assert_called()
+        self.assertTrue(self.log.called)
         self.check_call.assert_called_with(['mkfs', '-t', 'xfs', '/dev/sdd'])
 
     @patch('os.chown')
 
=== modified file 'tests/contrib/storage/test_linux_storage_utils.py'
--- tests/contrib/storage/test_linux_storage_utils.py	2014-11-25 13:38:01 +0000
+++ tests/contrib/storage/test_linux_storage_utils.py	2015-08-13 08:33:21 +0000
@@ -16,8 +16,9 @@
         '''It calls sgdisk correctly to zap disk'''
         check_output.return_value = b'200\n'
         storage_utils.zap_disk('/dev/foo')
-        call.assert_any_call(['sgdisk', '--zap-all', '--mbrtogpt',
-                              '--clear', '/dev/foo'])
+        call.assert_any_call(['sgdisk', '--zap-all', '--', '/dev/foo'])
+        call.assert_any_call(['sgdisk', '--clear', '--mbrtogpt',
+                              '--', '/dev/foo'])
         check_output.assert_any_call(['blockdev', '--getsz', '/dev/foo'])
         check_call.assert_any_call(['dd', 'if=/dev/zero', 'of=/dev/foo',
                                     'bs=1M', 'count=1'])
@@ -88,6 +89,14 @@
         self.assertFalse(result)
 
     @patch(STORAGE_LINUX_UTILS + '.check_output')
+    def test_is_device_mounted_full_disks(self, check_output):
+        '''It detects mounted full disks as mounted.'''
+        check_output.return_value = (
+            b"/dev/sda on / type ext4 (rw,errors=remount-ro)\n")
+        result = storage_utils.is_device_mounted('/dev/sda')
+        self.assertTrue(result)
+
+    @patch(STORAGE_LINUX_UTILS + '.check_output')
     def test_is_device_mounted_cciss(self, check_output):
         '''It detects mounted cciss partitions as mounted.'''
         check_output.return_value = (
 
=== modified file 'tests/contrib/unison/test_unison.py'
--- tests/contrib/unison/test_unison.py	2015-04-03 15:23:46 +0000
+++ tests/contrib/unison/test_unison.py	2015-08-13 08:33:21 +0000
@@ -74,7 +74,7 @@
             self.assertIn(call(_call), self.check_call.call_args_list)
 
     @patch('os.path.isfile')
-    def test_create_private_key(self, isfile):
+    def test_create_private_key_rsa(self, isfile):
         create_cmd = [
             'ssh-keygen', '-q', '-N', '', '-t', 'rsa', '-b', '2048',
             '-f', '/home/foo/.ssh/id_rsa']
@@ -100,6 +100,36 @@
         _ensure_perms()
 
     @patch('os.path.isfile')
+    def test_create_private_key_ecdsa(self, isfile):
+        create_cmd = [
+            'ssh-keygen', '-q', '-N', '', '-t', 'ecdsa', '-b', '521',
+            '-f', '/home/foo/.ssh/id_ecdsa']
+
+        def _ensure_perms():
+            cmds = [
+                ['chown', 'foo', '/home/foo/.ssh/id_ecdsa'],
+                ['chmod', '0600', '/home/foo/.ssh/id_ecdsa'],
+            ]
+            self._ensure_calls_in(cmds)
+
+        isfile.return_value = False
+        unison.create_private_key(
+            user='foo',
+            priv_key_path='/home/foo/.ssh/id_ecdsa',
+            key_type='ecdsa')
+        self.assertIn(call(create_cmd), self.check_call.call_args_list)
+        _ensure_perms()
+        self.check_call.call_args_list = []
+
+        isfile.return_value = True
+        unison.create_private_key(
+            user='foo',
+            priv_key_path='/home/foo/.ssh/id_ecdsa',
+            key_type='ecdsa')
+        self.assertNotIn(call(create_cmd), self.check_call.call_args_list)
+        _ensure_perms()
+
+    @patch('os.path.isfile')
     def test_create_public_key(self, isfile):
         create_cmd = ['ssh-keygen', '-y', '-f', '/home/foo/.ssh/id_rsa']
         isfile.return_value = True
@@ -273,6 +303,33 @@
         write_hosts.assert_called_with('foo', ['host1', 'host2'])
         self.relation_set.assert_called_with(ssh_authorized_hosts='host1:host2')
 
+    @patch.object(unison, 'write_known_hosts')
+    @patch.object(unison, 'write_authorized_keys')
+    @patch.object(unison, 'get_keypair')
+    @patch.object(unison, 'ensure_user')
+    def test_ssh_auth_peer_departed(self, ensure_user, get_keypair,
+                                    write_keys, write_hosts):
+        get_keypair.return_value = ('privkey', 'pubkey')
+
+        self.hook_name.return_value = 'cluster-relation-departed'
+
+        self.relation_get.side_effect = [
+            'key1',
+            'host1',
+            'key2',
+            'host2',
+            '', ''
+        ]
+        unison.ssh_authorized_peers(peer_interface='cluster',
+                                    user='foo', group='foo',
+                                    ensure_local_user=True)
+
+        ensure_user.assert_called_with('foo', 'foo')
+        get_keypair.assert_called_with('foo')
+        write_keys.assert_called_with('foo', ['key1', 'key2'])
+        write_hosts.assert_called_with('foo', ['host1', 'host2'])
+        self.relation_set.assert_called_with(ssh_authorized_hosts='host1:host2')
+
     def test_collect_authed_hosts(self):
         # only one of the hosts in fake environment has auth'd
         # the local peer
 
=== added directory 'tests/coordinator'
=== added file 'tests/coordinator/__init__.py'
=== added file 'tests/coordinator/test_coordinator.py'
--- tests/coordinator/test_coordinator.py	1970-01-01 00:00:00 +0000
+++ tests/coordinator/test_coordinator.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,535 @@
+# 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/>.
+from datetime import datetime, timedelta
+import json
+import tempfile
+import unittest
+from mock import call, MagicMock, patch, sentinel
+
+from charmhelpers import coordinator
+from charmhelpers.core import hookenv
+
+
+class TestCoordinator(unittest.TestCase):
+
+    def setUp(self):
+        del hookenv._atstart[:]
+        del hookenv._atexit[:]
+        hookenv.cache.clear()
+        coordinator.Singleton._instances.clear()
+
+        def install(patch):
+            patch.start()
+            self.addCleanup(patch.stop)
+
+        install(patch.object(hookenv, 'local_unit', return_value='foo/1'))
+        install(patch.object(hookenv, 'is_leader', return_value=False))
+        install(patch.object(hookenv, 'metadata',
+                             return_value={'peers': {'cluster': None}}))
+        install(patch.object(hookenv, 'log'))
+
+        # Ensure _timestamp always increases.
+        install(patch.object(coordinator, '_utcnow',
+                             side_effect=self._utcnow))
+
+    _last_utcnow = datetime(2015, 1, 1, 00, 00)
+
+    def _utcnow(self, ts=coordinator._timestamp):
+        self._last_utcnow += timedelta(minutes=1)
+        return self._last_utcnow
+
+    def test_is_singleton(self):
+        # BaseCoordinator and subclasses are singletons. Placing this
+        # burden on charm authors is impractical, particularly if
+        # libraries start wanting to use coordinator instances.
+        # With singletons, we don't need to worry about sharing state
+        # between instances or have them stomping on each other when they
+        # need to serialize their state.
+        self.assertTrue(coordinator.BaseCoordinator()
+                        is coordinator.BaseCoordinator())
+        self.assertTrue(coordinator.Serial() is coordinator.Serial())
+        self.assertFalse(coordinator.BaseCoordinator() is coordinator.Serial())
+
+    @patch.object(hookenv, 'atstart')
+    def test_implicit_initialize_and_handle(self, atstart):
+        # When you construct a BaseCoordinator(), its initialize() and
+        # handle() method are invoked automatically every hook. This
+        # is done using hookenv.atstart
+        c = coordinator.BaseCoordinator()
+        atstart.assert_has_calls([call(c.initialize), call(c.handle)])
+
+    @patch.object(hookenv, 'has_juju_version', return_value=False)
+    def test_initialize_enforces_juju_version(self, has_juju_version):
+        c = coordinator.BaseCoordinator()
+        with self.assertRaises(AssertionError):
+            c.initialize()
+        has_juju_version.assert_called_once_with('1.23')
+
+    @patch.object(hookenv, 'atexit')
+    @patch.object(hookenv, 'has_juju_version', return_value=True)
+    @patch.object(hookenv, 'relation_ids')
+    def test_initialize(self, relation_ids, ver, atexit):
+        # First initialization are done before there is a peer relation.
+        relation_ids.return_value = []
+        c = coordinator.BaseCoordinator()
+
+        with patch.object(c, '_load_state') as _load_state, \
+                patch.object(c, '_emit_state') as _emit_state:  # IGNORE: E127
+            c.initialize()
+            _load_state.assert_called_once_with()
+            _emit_state.assert_called_once_with()
+
+        self.assertEqual(c.relname, 'cluster')
+        self.assertIsNone(c.relid)
+        relation_ids.assert_called_once_with('cluster')
+
+        # Methods installed to save state and release locks if the
+        # hook is successful.
+        atexit.assert_has_calls([call(c._save_state),
+                                 call(c._release_granted)])
+
+        # If we have a peer relation, the id is stored.
+        relation_ids.return_value = ['cluster:1']
+        c = coordinator.BaseCoordinator()
+        with patch.object(c, '_load_state'), patch.object(c, '_emit_state'):
+            c.initialize()
+        self.assertEqual(c.relid, 'cluster:1')
+
+        # If we are already initialized, nothing happens.
+        c.grants = {}
+        c.requests = {}
+        c.initialize()
+
+    def test_acquire(self):
+        c = coordinator.BaseCoordinator()
+        lock = 'mylock'
+        c.grants = {}
+        c.requests = {hookenv.local_unit(): {}}
+
+        # We are not the leader, so first acquire will return False.
+        self.assertFalse(c.acquire(lock))
+
+        # But the request is in the queue.
+        self.assertTrue(c.requested(lock))
+        ts = c.request_timestamp(lock)
+
+        # A further attempts at acquiring the lock do nothing,
+        # and the timestamp of the request remains unchanged.
+        self.assertFalse(c.acquire(lock))
+        self.assertEqual(ts, c.request_timestamp(lock))
+
+        # Once the leader has granted the lock, acquire returns True.
+        with patch.object(c, 'granted') as granted:
+            granted.return_value = True
+            self.assertTrue(c.acquire(lock))
+            granted.assert_called_once_with(lock)
+
+    def test_acquire_leader(self):
+        # When acquire() is called by the leader, it needs
+        # to make a grant decision immediately. It can't defer
+        # making the decision until a future hook, as no future
+        # hooks will be triggered.
+        hookenv.is_leader.return_value = True
+        c = coordinator.Serial()  # Not Base. Test hooks into default_grant.
+        lock = 'mylock'
+        unit = hookenv.local_unit()
+        c.grants = {}
+        c.requests = {unit: {}}
+        with patch.object(c, 'default_grant') as default_grant:
+            default_grant.side_effect = iter([False, True])
+
+            self.assertFalse(c.acquire(lock))
+            ts = c.request_timestamp(lock)
+
+            self.assertTrue(c.acquire(lock))
+            self.assertEqual(ts, c.request_timestamp(lock))
+
+            # If it it granted, the leader doesn't make a decision again.
+            self.assertTrue(c.acquire(lock))
+            self.assertEqual(ts, c.request_timestamp(lock))
+
+            self.assertEqual(default_grant.call_count, 2)
+
+    def test_granted(self):
+        c = coordinator.BaseCoordinator()
+        unit = hookenv.local_unit()
+        lock = 'mylock'
+        ts = coordinator._timestamp()
+        c.grants = {}
+
+        # Unit makes a request, but it isn't granted
+        c.requests = {unit: {lock: ts}}
+        self.assertFalse(c.granted(lock))
+
+        # Once the leader has granted the request, all good.
+        # It does this by mirroring the request timestamp.
+        c.grants = {unit: {lock: ts}}
+        self.assertTrue(c.granted(lock))
+
+        # The unit releases the lock by removing the request.
+        c.requests = {unit: {}}
+        self.assertFalse(c.granted(lock))
+
+        # If the unit makes a new request before the leader
+        # has had a chance to do its housekeeping, the timestamps
+        # do not match and the lock not considered granted.
+        ts = coordinator._timestamp()
+        c.requests = {unit: {lock: ts}}
+        self.assertFalse(c.granted(lock))
+
+        # Until the leader gets around to its duties.
+        c.grants = {unit: {lock: ts}}
+        self.assertTrue(c.granted(lock))
+
+    def test_requested(self):
+        c = coordinator.BaseCoordinator()
+        lock = 'mylock'
+        c.requests = {hookenv.local_unit(): {}}
+        c.grants = {}
+
+        self.assertFalse(c.requested(lock))
+        c.acquire(lock)
+        self.assertTrue(c.requested(lock))
+
+    def test_request_timestamp(self):
+        c = coordinator.BaseCoordinator()
+        lock = 'mylock'
+        unit = hookenv.local_unit()
+
+        c.requests = {unit: {}}
+        c.grants = {}
+        self.assertIsNone(c.request_timestamp(lock))
+
+        now = datetime.utcnow()
+        fmt = coordinator._timestamp_format
+        c.requests = {hookenv.local_unit(): {lock: now.strftime(fmt)}}
+
+        self.assertEqual(c.request_timestamp(lock), now)
+
+    def test_handle_not_leader(self):
+        c = coordinator.BaseCoordinator()
+        # If we are not the leader, handle does nothing. We know this,
+        # because without mocks or initialization it would otherwise crash.
+        c.handle()
+
+    def test_handle(self):
+        hookenv.is_leader.return_value = True
+        lock = 'mylock'
+        c = coordinator.BaseCoordinator()
+        c.relid = 'cluster:1'
+
+        ts = coordinator._timestamp
+        ts1, ts2, ts3 = ts(), ts(), ts()
+
+        # Grant one of these requests.
+        requests = {'foo/1': {lock: ts1},
+                    'foo/2': {lock: ts2},
+                    'foo/3': {lock: ts3}}
+        c.requests = requests.copy()
+        # Because the existing grant should be released.
+        c.grants = {'foo/2': {lock: ts()}}  # No request, release.
+
+        with patch.object(c, 'grant') as grant:
+            c.handle()
+
+            # The requests are unchanged. This is normally state on the
+            # peer relation, and only the units themselves can change it.
+            self.assertDictEqual(requests, c.requests)
+
+            # The grant without a corresponding requests was released.
+            self.assertDictEqual({'foo/2': {}}, c.grants)
+
+            # A potential grant was made for each of the outstanding requests.
+            grant.assert_has_calls([call(lock, 'foo/1'),
+                                    call(lock, 'foo/2'),
+                                    call(lock, 'foo/3')], any_order=True)
+
+    def test_grant_not_leader(self):
+        c = coordinator.BaseCoordinator()
+        c.grant(sentinel.whatever, sentinel.whatever)  # Nothing happens.
+
+    def test_grant(self):
+        hookenv.is_leader.return_value = True
+        c = coordinator.BaseCoordinator()
+        c.default_grant = MagicMock()
+        c.grant_other = MagicMock()
+
+        ts = coordinator._timestamp
+        ts1, ts2 = ts(), ts()
+
+        c.requests = {'foo/1': {'mylock': ts1, 'other': ts()},
+                      'foo/2': {'mylock': ts2},
+                      'foo/3': {'mylock': ts()}}
+        grants = {'foo/1': {'mylock': ts1}}
+        c.grants = grants.copy()
+
+        # foo/1 already has a granted mylock, so returns True.
+        self.assertTrue(c.grant('mylock', 'foo/1'))
+
+        # foo/2 does not have a granted mylock. default_grant will
+        # be called to make a decision (no)
+        c.default_grant.return_value = False
+        self.assertFalse(c.grant('mylock', 'foo/2'))
+        self.assertDictEqual(grants, c.grants)
+        c.default_grant.assert_called_once_with('mylock', 'foo/2',
+                                                set(['foo/1']),
+                                                ['foo/2', 'foo/3'])
+        c.default_grant.reset_mock()
+
+        # Lets say yes.
+        c.default_grant.return_value = True
+        self.assertTrue(c.grant('mylock', 'foo/2'))
+        grants = {'foo/1': {'mylock': ts1}, 'foo/2': {'mylock': ts2}}
+        self.assertDictEqual(grants, c.grants)
+        c.default_grant.assert_called_once_with('mylock', 'foo/2',
+                                                set(['foo/1']),
+                                                ['foo/2', 'foo/3'])
+
+        # The other lock has custom logic, in the form of the overridden
+        # grant_other method.
+        c.grant_other.return_value = False
+        self.assertFalse(c.grant('other', 'foo/1'))
+        c.grant_other.assert_called_once_with('other', 'foo/1',
+                                              set(), ['foo/1'])
+
+        # If there is no request, grant returns False
+        c.grant_other.return_value = True
+        self.assertFalse(c.grant('other', 'foo/2'))
+
+    def test_released(self):
+        c = coordinator.BaseCoordinator()
+        with patch.object(c, 'msg') as msg:
+            c.released('foo/2', 'mylock', coordinator._utcnow())
+            expected = 'Leader released mylock from foo/2, held 0:01:00'
+            msg.assert_called_once_with(expected)
+
+    def test_require(self):
+        c = coordinator.BaseCoordinator()
+        c.acquire = MagicMock()
+        c.granted = MagicMock()
+        guard = MagicMock()
+
+        wrapped = MagicMock()
+
+        @c.require('mylock', guard)
+        def func(*args, **kw):
+            wrapped(*args, **kw)
+
+        # If the lock is granted, the wrapped function is called.
+        c.granted.return_value = True
+        func(arg=True)
+        wrapped.assert_called_once_with(arg=True)
+        wrapped.reset_mock()
+
+        # If the lock is not granted, and the guard returns False,
+        # the lock is not acquired.
+        c.acquire.return_value = False
+        c.granted.return_value = False
+        guard.return_value = False
+        func()
+        self.assertFalse(wrapped.called)
+        self.assertFalse(c.acquire.called)
+
+        # If the lock is not granted, and the guard returns True,
+        # the lock is acquired. But the function still isn't called if
+        # it cannot be acquired immediately.
+        guard.return_value = True
+        func()
+        self.assertFalse(wrapped.called)
+        c.acquire.assert_called_once_with('mylock')
+
+        # Finally, if the lock is not granted, and the guard returns True,
+        # and the lock acquired immediately, the function is called.
+        c.acquire.return_value = True
+        func(sentinel.arg)
+        wrapped.assert_called_once_with(sentinel.arg)
+
+    def test_msg(self):
+        c = coordinator.BaseCoordinator()
+        # Just a wrapper around hookenv.log
+        c.msg('hi')
+        hookenv.log.assert_called_once_with('coordinator.BaseCoordinator hi',
+                                            level=hookenv.INFO)
+
+    def test_name(self):
+        # We use the class name in a few places to avoid conflicts.
+        # We assume we won't be using multiple BaseCoordinator subclasses
+        # with the same name at the same time.
+        c = coordinator.BaseCoordinator()
+        self.assertEqual(c._name(), 'BaseCoordinator')
+        c = coordinator.Serial()
+        self.assertEqual(c._name(), 'Serial')
+
+    @patch.object(hookenv, 'leader_get')
+    def test_load_state(self, leader_get):
+        c = coordinator.BaseCoordinator()
+        unit = hookenv.local_unit()
+
+        # c.granted is just the leader_get decoded.
+        leader_get.return_value = '{"json": true}'
+        c._load_state()
+        self.assertDictEqual(c.grants, {'json': True})
+
+        # With no relid, there is no peer relation so request state
+        # is pulled from a local stash.
+        with patch.object(c, '_load_local_state') as loc_state:
+            loc_state.return_value = {'local': True}
+            c._load_state()
+            self.assertDictEqual(c.requests, {unit: {'local': True}})
+
+        # With a relid, request details are pulled from the peer relation.
+        # If there is no data in the peer relation from the local unit,
+        # we still pull it from the local stash as it means this is the
+        # first time we have joined.
+        c.relid = 'cluster:1'
+        with patch.object(c, '_load_local_state') as loc_state, \
+                patch.object(c, '_load_peer_state') as peer_state:
+            loc_state.return_value = {'local': True}
+            peer_state.return_value = {'foo/2': {'mylock': 'whatever'}}
+            c._load_state()
+            self.assertDictEqual(c.requests, {unit: {'local': True},
+                                              'foo/2': {'mylock': 'whatever'}})
+
+        # If there are local details in the peer relation, the local
+        # stash is ignored.
+        with patch.object(c, '_load_local_state') as loc_state, \
+                patch.object(c, '_load_peer_state') as peer_state:
+            loc_state.return_value = {'local': True}
+            peer_state.return_value = {unit: {},
+                                       'foo/2': {'mylock': 'whatever'}}
+            c._load_state()
+            self.assertDictEqual(c.requests, {unit: {},
+                                              'foo/2': {'mylock': 'whatever'}})
+
+    def test_emit_state(self):
+        c = coordinator.BaseCoordinator()
+        unit = hookenv.local_unit()
+        c.requests = {unit: {'lock_a': sentinel.ts,
+                             'lock_b': sentinel.ts,
+                             'lock_c': sentinel.ts}}
+        c.grants = {unit: {'lock_a': sentinel.ts,
+                           'lock_b': sentinel.ts2}}
+        with patch.object(c, 'msg') as msg:
+            c._emit_state()
+            msg.assert_has_calls([call('Granted lock_a'),
+                                  call('Waiting on lock_b'),
+                                  call('Waiting on lock_c')],
+                                 any_order=True)
+
+    @patch.object(hookenv, 'relation_set')
+    @patch.object(hookenv, 'leader_set')
+    def test_save_state(self, leader_set, relation_set):
+        c = coordinator.BaseCoordinator()
+        unit = hookenv.local_unit()
+        c.grants = {'directdump': True}
+        c.requests = {unit: 'data1', 'foo/2': 'data2'}
+
+        # grants is dumped to leadership settings, if the unit is leader.
+        with patch.object(c, '_save_local_state') as save_loc:
+            c._save_state()
+            self.assertFalse(leader_set.called)
+            hookenv.is_leader.return_value = True
+            c._save_state()
+            leader_set.assert_called_once_with({c.key: '{"directdump": true}'})
+
+        # If there is no relation id, the local units requests is dumped
+        # to a local stash.
+        with patch.object(c, '_save_local_state') as save_loc:
+            c._save_state()
+            save_loc.assert_called_once_with('data1')
+
+        # If there is a relation id, the local units requests is dumped
+        # to the peer relation.
+        with patch.object(c, '_save_local_state') as save_loc:
+            c.relid = 'cluster:1'
+            c._save_state()
+            self.assertFalse(save_loc.called)
+            relation_set.assert_called_once_with(
+                c.relid, relation_settings={c.key: '"data1"'})  # JSON encoded
+
+    @patch.object(hookenv, 'relation_get')
+    @patch.object(hookenv, 'related_units')
+    def test_load_peer_state(self, related_units, relation_get):
+        # Standard relation-get loops, decoding results from JSON.
+        c = coordinator.BaseCoordinator()
+        c.key = sentinel.key
+        c.relid = sentinel.relid
+        related_units.return_value = ['foo/2', 'foo/3']
+        d = {'foo/1': {'foo/1': True},
+             'foo/2': {'foo/2': True},
+             'foo/3': {'foo/3': True}}
+
+        def _get(key, unit, relid):
+            assert key == sentinel.key
+            assert relid == sentinel.relid
+            return json.dumps(d[unit])
+        relation_get.side_effect = _get
+
+        self.assertDictEqual(c._load_peer_state(), d)
+
+    def test_local_state_filename(self):
+        c = coordinator.BaseCoordinator()
+        self.assertEqual(c._local_state_filename(),
+                         '.charmhelpers.coordinator.BaseCoordinator')
+
+    def test_load_local_state(self):
+        c = coordinator.BaseCoordinator()
+        with tempfile.NamedTemporaryFile(mode='w') as f:
+            with patch.object(c, '_local_state_filename') as fn:
+                fn.return_value = f.name
+                d = 'some data'
+                json.dump(d, f)
+                f.flush()
+                d2 = c._load_local_state()
+                self.assertEqual(d, d2)
+
+    def test_save_local_state(self):
+        c = coordinator.BaseCoordinator()
+        with tempfile.NamedTemporaryFile(mode='r') as f:
+            with patch.object(c, '_local_state_filename') as fn:
+                fn.return_value = f.name
+                c._save_local_state('some data')
+                self.assertEqual(json.load(f), 'some data')
+
+    def test_release_granted(self):
+        c = coordinator.BaseCoordinator()
+        unit = hookenv.local_unit()
+        c.requests = {unit: {'lock1': sentinel.ts, 'lock2': sentinel.ts},
+                      'foo/2': {'lock1': sentinel.ts}}
+        c.grants = {unit: {'lock1': sentinel.ts},
+                    'foo/2': {'lock1': sentinel.ts}}
+        # The granted lock for the local unit is released.
+        c._release_granted()
+        self.assertDictEqual(c.requests, {unit: {'lock2': sentinel.ts},
+                                          'foo/2': {'lock1': sentinel.ts}})
+
+    def test_implicit_peer_relation_name(self):
+        self.assertEqual(coordinator._implicit_peer_relation_name(),
+                         'cluster')
+
+    def test_default_grant(self):
+        c = coordinator.Serial()
+        # Lock not granted. First in the queue.
+        self.assertTrue(c.default_grant(sentinel.lock, sentinel.u1,
+                                        set(), [sentinel.u1, sentinel.u2]))
+
+        # Lock not granted. Later in the queue.
+        self.assertFalse(c.default_grant(sentinel.lock, sentinel.u1,
+                                         set(), [sentinel.u2, sentinel.u1]))
+
+        # Lock already granted
+        self.assertFalse(c.default_grant(sentinel.lock, sentinel.u1,
+                                         set([sentinel.u2]), [sentinel.u1]))
 
=== added file 'tests/core/test_files.py'
--- tests/core/test_files.py	1970-01-01 00:00:00 +0000
+++ tests/core/test_files.py	2015-08-13 08:33:21 +0000
@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from charmhelpers.core import files
+
+import mock
+import unittest
+import tempfile
+import os
+
+
+class FileTests(unittest.TestCase):
+
+    @mock.patch("subprocess.check_call")
+    def test_sed(self, check_call):
+        files.sed("/tmp/test-sed-file", "replace", "this")
+        check_call.assert_called_once_with(
+            ['sed', '-i', '-r', '-e', 's/replace/this/g',
+             '/tmp/test-sed-file']
+        )
+
+    def test_sed_file(self):
+        tmp = tempfile.NamedTemporaryFile(mode='w', delete=False)
+        tmp.write("IPV6=yes")
+        tmp.close()
+
+        files.sed(tmp.name, "IPV6=.*", "IPV6=no")
+
+        with open(tmp.name) as tmp:
+            self.assertEquals(tmp.read(), "IPV6=no")