Rebase and resync

Makefile

@@ -2,10 +2,11 @@
 PYTHON := /usr/bin/env python
 
 lint:
-	@flake8 --exclude hooks/charmhelpers hooks unit_tests
+	@flake8 --exclude hooks/charmhelpers hooks unit_tests tests
 	@charm proof
 
-test:
+unit_test:
+	@echo Starting unit tests...
 	@$(PYTHON) /usr/bin/nosetests --nologcapture --with-coverage unit_tests
 
 bin/charm_helpers_sync.py:
@@ -14,8 +15,16 @@ bin/charm_helpers_sync.py:
         > bin/charm_helpers_sync.py
 
 sync: bin/charm_helpers_sync.py
-	@$(PYTHON) bin/charm_helpers_sync.py -c charm-helpers.yaml
+	@$(PYTHON) bin/charm_helpers_sync.py -c charm-helpers-hooks.yaml
+	@$(PYTHON) bin/charm_helpers_sync.py -c charm-helpers-tests.yaml
 
-publish: lint test
+test:
+	@echo Starting Amulet tests...
+	# coreycb note: The -v should only be temporary until Amulet sends
+	# raise_status() messages to stderr:
+	#   https://bugs.launchpad.net/amulet/+bug/1320357
+	@juju test -v -p AMULET_HTTP_PROXY
+
+publish: lint unit_test
 	bzr push lp:charms/nova-compute
 	bzr push lp:charms/trusty/nova-compute

charm-helpers-hooks.yaml

@@ -8,6 +8,5 @@ include:
     - contrib.hahelpers:
         - apache
         - cluster
-    - contrib.network.ovs
+    - contrib.network
     - payload.execd
-    - contrib.network.ip

charm-helpers-tests.yaml

@@ -0,0 +1,5 @@
+branch: lp:charm-helpers
+destination: tests/charmhelpers
+include:
+    - contrib.amulet
+    - contrib.openstack.amulet

hooks/charmhelpers/contrib/openstack/context.py

@@ -753,6 +753,17 @@ class SubordinateConfigContext(OSContextGenerator):
         return ctxt
 
 
+class LogLevelContext(OSContextGenerator):
+
+    def __call__(self):
+        ctxt = {}
+        ctxt['debug'] = \
+            False if config('debug') is None else config('debug')
+        ctxt['verbose'] = \
+            False if config('verbose') is None else config('verbose')
+        return ctxt
+
+
 class SyslogContext(OSContextGenerator):
 
     def __call__(self):

tests/00-setup

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -ex
+
+sudo add-apt-repository --yes ppa:juju/stable
+sudo apt-get update --yes
+sudo apt-get install --yes python-amulet
+sudo apt-get install --yes python-glanceclient
+sudo apt-get install --yes python-keystoneclient
+sudo apt-get install --yes python-novaclient

tests/10-basic-precise-essex

@@ -0,0 +1,9 @@
+#!/usr/bin/python
+
+"""Amulet tests on a basic nova compute deployment on precise-essex."""
+
+from basic_deployment import NovaBasicDeployment
+
+if __name__ == '__main__':
+    deployment = NovaBasicDeployment(series='precise')
+    deployment.run_tests()

tests/11-basic-precise-folsom

@@ -0,0 +1,17 @@
+#!/usr/bin/python
+
+"""Amulet tests on a basic nova compute deployment on precise-folsom."""
+
+import amulet
+from basic_deployment import NovaBasicDeployment
+
+if __name__ == '__main__':
+    # NOTE(coreycb): Skipping failing test until resolved. 'nova-manage db sync'
+    #                fails in shared-db-relation-changed (only fails on folsom)
+    message = "Skipping failing test until resolved"
+    amulet.raise_status(amulet.SKIP, msg=message)
+
+    deployment = NovaBasicDeployment(series='precise',
+                                     openstack='cloud:precise-folsom',
+                                     source='cloud:precise-updates/folsom')
+    deployment.run_tests()

tests/12-basic-precise-grizzly

@@ -0,0 +1,11 @@
+#!/usr/bin/python
+
+"""Amulet tests on a basic nova compute deployment on precise-grizzly."""
+
+from basic_deployment import NovaBasicDeployment
+
+if __name__ == '__main__':
+    deployment = NovaBasicDeployment(series='precise',
+                                     openstack='cloud:precise-grizzly',
+                                     source='cloud:precise-updates/grizzly')
+    deployment.run_tests()

tests/13-basic-precise-havana

@@ -0,0 +1,11 @@
+#!/usr/bin/python
+
+"""Amulet tests on a basic nova compute deployment on precise-havana."""
+
+from basic_deployment import NovaBasicDeployment
+
+if __name__ == '__main__':
+    deployment = NovaBasicDeployment(series='precise',
+                                     openstack='cloud:precise-havana',
+                                     source='cloud:precise-updates/havana')
+    deployment.run_tests()

tests/14-basic-precise-icehouse

@@ -0,0 +1,11 @@
+#!/usr/bin/python
+
+"""Amulet tests on a basic nova compute deployment on precise-icehouse."""
+
+from basic_deployment import NovaBasicDeployment
+
+if __name__ == '__main__':
+    deployment = NovaBasicDeployment(series='precise',
+                                     openstack='cloud:precise-icehouse',
+                                     source='cloud:precise-updates/icehouse')
+    deployment.run_tests()

tests/15-basic-trusty-icehouse

@@ -0,0 +1,9 @@
+#!/usr/bin/python
+
+"""Amulet tests on a basic nova compute deployment on trusty-icehouse."""
+
+from basic_deployment import NovaBasicDeployment
+
+if __name__ == '__main__':
+    deployment = NovaBasicDeployment(series='trusty')
+    deployment.run_tests()

tests/README

@@ -0,0 +1,47 @@
+This directory provides Amulet tests that focus on verification of nova-compute
+deployments.
+
+If you use a web proxy server to access the web, you'll need to set the
+AMULET_HTTP_PROXY environment variable to the http URL of the proxy server.
+
+The following examples demonstrate different ways that tests can be executed.
+All examples are run from the charm's root directory.
+
+  * To run all tests (starting with 00-setup):
+
+      make test
+
+  * To run a specific test module (or modules):
+
+      juju test -v -p AMULET_HTTP_PROXY 15-basic-trusty-icehouse
+
+  * To run a specific test module (or modules), and keep the environment
+    deployed after a failure:
+
+      juju test --set-e -v -p AMULET_HTTP_PROXY 15-basic-trusty-icehouse
+
+  * To re-run a test module against an already deployed environment (one
+    that was deployed by a previous call to 'juju test --set-e'):
+
+      ./tests/15-basic-trusty-icehouse
+
+For debugging and test development purposes, all code should be idempotent.
+In other words, the code should have the ability to be re-run without changing
+the results beyond the initial run.  This enables editing and re-running of a
+test module against an already deployed environment, as described above.
+
+Manual debugging tips:
+
+  * Set the following env vars before using the OpenStack CLI as admin:
+      export OS_AUTH_URL=http://`juju-deployer -f keystone 2>&1 | tail -n 1`:5000/v2.0
+      export OS_TENANT_NAME=admin
+      export OS_USERNAME=admin
+      export OS_PASSWORD=openstack
+      export OS_REGION_NAME=RegionOne
+
+  * Set the following env vars before using the OpenStack CLI as demoUser:
+      export OS_AUTH_URL=http://`juju-deployer -f keystone 2>&1 | tail -n 1`:5000/v2.0
+      export OS_TENANT_NAME=demoTenant
+      export OS_USERNAME=demoUser
+      export OS_PASSWORD=password
+      export OS_REGION_NAME=RegionOne

tests/basic_deployment.py

@@ -0,0 +1,406 @@
+#!/usr/bin/python
+
+import amulet
+
+from charmhelpers.contrib.openstack.amulet.deployment import (
+    OpenStackAmuletDeployment
+)
+
+from charmhelpers.contrib.openstack.amulet.utils import (
+    OpenStackAmuletUtils,
+    DEBUG, # flake8: noqa
+    ERROR
+)
+
+# Use DEBUG to turn on debug logging
+u = OpenStackAmuletUtils(ERROR)
+
+
+class NovaBasicDeployment(OpenStackAmuletDeployment):
+    """Amulet tests on a basic nova compute deployment."""
+
+    def __init__(self, series=None, openstack=None, source=None):
+        """Deploy the entire test environment."""
+        super(NovaBasicDeployment, self).__init__(series, openstack, source)
+        self._add_services()
+        self._add_relations()
+        self._configure_services()
+        self._deploy()
+        self._initialize_tests()
+
+    def _add_services(self):
+        """Add the service that we're testing, including the number of units,
+           where nova-compute is local, and the other charms are from
+           the charm store."""
+        this_service = ('nova-compute', 1)
+        other_services = [('mysql', 1), ('rabbitmq-server', 1),
+                          ('nova-cloud-controller', 1), ('keystone', 1),
+                          ('glance', 1)]
+        super(NovaBasicDeployment, self)._add_services(this_service,
+                                                       other_services)
+
+    def _add_relations(self):
+        """Add all of the relations for the services."""
+        relations = {
+          'nova-compute:image-service': 'glance:image-service',
+          'nova-compute:shared-db': 'mysql:shared-db',
+          'nova-compute:amqp': 'rabbitmq-server:amqp',
+          'nova-cloud-controller:shared-db': 'mysql:shared-db',
+          'nova-cloud-controller:identity-service': 'keystone:identity-service',
+          'nova-cloud-controller:amqp': 'rabbitmq-server:amqp',
+          'nova-cloud-controller:cloud-compute': 'nova-compute:cloud-compute',
+          'nova-cloud-controller:image-service': 'glance:image-service',
+          'keystone:shared-db': 'mysql:shared-db',
+          'glance:identity-service': 'keystone:identity-service',
+          'glance:shared-db': 'mysql:shared-db',
+          'glance:amqp': 'rabbitmq-server:amqp'
+        }
+        super(NovaBasicDeployment, self)._add_relations(relations)
+
+    def _configure_services(self):
+        """Configure all of the services."""
+        nova_config = {'config-flags': 'auto_assign_floating_ip=False',
+                       'enable-live-migration': 'False'}
+        keystone_config = {'admin-password': 'openstack',
+                           'admin-token': 'ubuntutesting'}
+        configs = {'nova-compute': nova_config, 'keystone': keystone_config}
+        super(NovaBasicDeployment, self)._configure_services(configs)
+
+    def _initialize_tests(self):
+        """Perform final initialization before tests get run."""
+        # Access the sentries for inspecting service units
+        self.mysql_sentry = self.d.sentry.unit['mysql/0']
+        self.keystone_sentry = self.d.sentry.unit['keystone/0']
+        self.rabbitmq_sentry = self.d.sentry.unit['rabbitmq-server/0']
+        self.nova_compute_sentry = self.d.sentry.unit['nova-compute/0']
+        self.nova_cc_sentry = self.d.sentry.unit['nova-cloud-controller/0']
+        self.glance_sentry = self.d.sentry.unit['glance/0']
+
+        # Authenticate admin with keystone
+        self.keystone = u.authenticate_keystone_admin(self.keystone_sentry,
+                                                      user='admin',
+                                                      password='openstack',
+                                                      tenant='admin')
+
+        # Authenticate admin with glance endpoint
+        self.glance = u.authenticate_glance_admin(self.keystone)
+
+        # Create a demo tenant/role/user
+        self.demo_tenant = 'demoTenant'
+        self.demo_role = 'demoRole'
+        self.demo_user = 'demoUser'
+        if not u.tenant_exists(self.keystone, self.demo_tenant):
+            tenant = self.keystone.tenants.create(tenant_name=self.demo_tenant,
+                                                  description='demo tenant',
+                                                  enabled=True)
+            self.keystone.roles.create(name=self.demo_role)
+            self.keystone.users.create(name=self.demo_user,
+                                       password='password',
+                                       tenant_id=tenant.id,
+                                       email='demo@demo.com')
+
+        # Authenticate demo user with keystone
+        self.keystone_demo = \
+            u.authenticate_keystone_user(self.keystone, user=self.demo_user,
+                                         password='password',
+                                         tenant=self.demo_tenant)
+
+        # Authenticate demo user with nova-api
+        self.nova_demo = u.authenticate_nova_user(self.keystone,
+                                                  user=self.demo_user,
+                                                  password='password',
+                                                  tenant=self.demo_tenant)
+
+    def test_services(self):
+        """Verify the expected services are running on the corresponding
+           service units."""
+        commands = {
+            self.mysql_sentry: ['status mysql'],
+            self.rabbitmq_sentry: ['sudo service rabbitmq-server status'],
+            self.nova_compute_sentry: ['status nova-compute',
+                                       'status nova-network',
+                                       'status nova-api'],
+            self.nova_cc_sentry: ['status nova-api-ec2',
+                                  'status nova-api-os-compute',
+                                  'status nova-objectstore',
+                                  'status nova-cert',
+                                  'status nova-scheduler'],
+            self.keystone_sentry: ['status keystone'],
+            self.glance_sentry: ['status glance-registry', 'status glance-api']
+        }
+        if self._get_openstack_release() >= self.precise_grizzly:
+            commands[self.nova_cc_sentry] = ['status nova-conductor']
+
+        ret = u.validate_services(commands)
+        if ret:
+            amulet.raise_status(amulet.FAIL, msg=ret)
+
+    def test_service_catalog(self):
+        """Verify that the service catalog endpoint data is valid."""
+        endpoint_vol = {'adminURL': u.valid_url,
+                        'region': 'RegionOne',
+                        'publicURL': u.valid_url,
+                        'internalURL': u.valid_url}
+        endpoint_id = {'adminURL': u.valid_url,
+                       'region': 'RegionOne',
+                       'publicURL': u.valid_url,
+                       'internalURL': u.valid_url}
+        if self._get_openstack_release() >= self.precise_folsom:
+            endpoint_vol['id'] = u.not_null
+            endpoint_id['id'] = u.not_null
+        expected = {'s3': [endpoint_vol], 'compute': [endpoint_vol],
+                    'ec2': [endpoint_vol], 'identity': [endpoint_id]}
+        actual = self.keystone_demo.service_catalog.get_endpoints()
+
+        ret = u.validate_svc_catalog_endpoint_data(expected, actual)
+        if ret:
+            amulet.raise_status(amulet.FAIL, msg=ret)
+
+    def test_openstack_compute_api_endpoint(self):
+        """Verify the openstack compute api (osapi) endpoint data."""
+        endpoints = self.keystone.endpoints.list()
+        admin_port = internal_port = public_port = '8774'
+        expected = {'id': u.not_null,
+                    'region': 'RegionOne',
+                    'adminurl': u.valid_url,
+                    'internalurl': u.valid_url,
+                    'publicurl': u.valid_url,
+                    'service_id': u.not_null}
+
+        ret = u.validate_endpoint_data(endpoints, admin_port, internal_port,
+                                       public_port, expected)
+        if ret:
+            message = 'osapi endpoint: {}'.format(ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_ec2_api_endpoint(self):
+        """Verify the EC2 api endpoint data."""
+        endpoints = self.keystone.endpoints.list()
+        admin_port = internal_port = public_port = '8773'
+        expected = {'id': u.not_null,
+                    'region': 'RegionOne',
+                    'adminurl': u.valid_url,
+                    'internalurl': u.valid_url,
+                    'publicurl': u.valid_url,
+                    'service_id': u.not_null}
+
+        ret = u.validate_endpoint_data(endpoints, admin_port, internal_port,
+                                       public_port, expected)
+        if ret:
+            message = 'EC2 endpoint: {}'.format(ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_s3_api_endpoint(self):
+        """Verify the S3 api endpoint data."""
+        endpoints = self.keystone.endpoints.list()
+        admin_port = internal_port = public_port = '3333'
+        expected = {'id': u.not_null,
+                    'region': 'RegionOne',
+                    'adminurl': u.valid_url,
+                    'internalurl': u.valid_url,
+                    'publicurl': u.valid_url,
+                    'service_id': u.not_null}
+
+        ret = u.validate_endpoint_data(endpoints, admin_port, internal_port,
+                                       public_port, expected)
+        if ret:
+            message = 'S3 endpoint: {}'.format(ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_nova_shared_db_relation(self):
+        """Verify the nova-compute to mysql shared-db relation data"""
+        unit = self.nova_compute_sentry
+        relation = ['shared-db', 'mysql:shared-db']
+        expected = {
+            'private-address': u.valid_ip,
+            'nova_database': 'nova',
+            'nova_username': 'nova',
+            'nova_hostname': u.valid_ip
+        }
+
+        ret = u.validate_relation_data(unit, relation, expected)
+        if ret:
+            message = u.relation_error('nova-compute shared-db', ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_mysql_shared_db_relation(self):
+        """Verify the mysql to nova-compute shared-db relation data"""
+        unit = self.mysql_sentry
+        relation = ['shared-db', 'nova-compute:shared-db']
+        expected = {
+            'private-address': u.valid_ip,
+            'nova_password': u.not_null,
+            'db_host': u.valid_ip
+        }
+
+        ret = u.validate_relation_data(unit, relation, expected)
+        if ret:
+            message = u.relation_error('mysql shared-db', ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_nova_amqp_relation(self):
+        """Verify the nova-compute to rabbitmq-server amqp relation data"""
+        unit = self.nova_compute_sentry
+        relation = ['amqp', 'rabbitmq-server:amqp']
+        expected = {
+            'username': 'nova',
+            'private-address': u.valid_ip,
+            'vhost': 'openstack'
+        }
+
+        ret = u.validate_relation_data(unit, relation, expected)
+        if ret:
+            message = u.relation_error('nova-compute amqp', ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_rabbitmq_amqp_relation(self):
+        """Verify the rabbitmq-server to nova-compute amqp relation data"""
+        unit = self.rabbitmq_sentry
+        relation = ['amqp', 'nova-compute:amqp']
+        expected = {
+            'private-address': u.valid_ip,
+            'password': u.not_null,
+            'hostname': u.valid_ip
+        }
+
+        ret = u.validate_relation_data(unit, relation, expected)
+        if ret:
+            message = u.relation_error('rabbitmq amqp', ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_nova_cloud_compute_relation(self):
+        """Verify the nova-compute to nova-cc cloud-compute relation data"""
+        unit = self.nova_compute_sentry
+        relation = ['cloud-compute', 'nova-cloud-controller:cloud-compute']
+        expected = {
+            'private-address': u.valid_ip,
+        }
+
+        ret = u.validate_relation_data(unit, relation, expected)
+        if ret:
+            message = u.relation_error('nova-compute cloud-compute', ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_nova_cc_cloud_compute_relation(self):
+        """Verify the nova-cc to nova-compute cloud-compute relation data"""
+        unit = self.nova_cc_sentry
+        relation = ['cloud-compute', 'nova-compute:cloud-compute']
+        expected = {
+            'volume_service': 'cinder',
+            'network_manager': 'flatdhcpmanager',
+            'ec2_host': u.valid_ip,
+            'private-address': u.valid_ip,
+            'restart_trigger': u.not_null
+        }
+        if self._get_openstack_release() == self.precise_essex:
+            expected['volume_service'] = 'nova-volume'
+
+        ret = u.validate_relation_data(unit, relation, expected)
+        if ret:
+            message = u.relation_error('nova-cc cloud-compute', ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_restart_on_config_change(self):
+        """Verify that the specified services are restarted when the config
+           is changed."""
+        # NOTE(coreycb): Skipping failing test on essex until resolved.
+        #                config-flags don't take effect on essex.
+        if self._get_openstack_release() == self.precise_essex:
+            u.log.error("Skipping failing test until resolved")
+            return
+
+        services = ['nova-compute', 'nova-api', 'nova-network']
+        self.d.configure('nova-compute', {'config-flags': 'verbose=False'})
+
+        time = 20
+        for s in services:
+            if not u.service_restarted(self.nova_compute_sentry, s,
+                                       '/etc/nova/nova.conf', sleep_time=time):
+                msg = "service {} didn't restart after config change".format(s)
+                amulet.raise_status(amulet.FAIL, msg=msg)
+            time = 0
+
+        self.d.configure('nova-compute', {'config-flags': 'verbose=True'})
+
+    def test_nova_config(self):
+        """Verify the data in the nova config file."""
+        # NOTE(coreycb): Currently no way to test on essex because config file
+        #                has no section headers.
+        if self._get_openstack_release() == self.precise_essex:
+            return
+
+        unit = self.nova_compute_sentry
+        conf = '/etc/nova/nova.conf'
+        rabbitmq_relation = self.rabbitmq_sentry.relation('amqp',
+                                                          'nova-compute:amqp')
+        glance_relation = self.glance_sentry.relation('image-service',
+                                                   'nova-compute:image-service')
+        mysql_relation = self.mysql_sentry.relation('shared-db',
+                                                    'nova-compute:shared-db')
+        db_uri = "mysql://{}:{}@{}/{}".format('nova',
+                                              mysql_relation['nova_password'],
+                                              mysql_relation['db_host'],
+                                              'nova')
+
+        expected = {'dhcpbridge_flagfile': '/etc/nova/nova.conf',
+                    'dhcpbridge': '/usr/bin/nova-dhcpbridge',
+                    'logdir': '/var/log/nova',
+                    'state_path': '/var/lib/nova',
+                    'lock_path': '/var/lock/nova',
+                    'force_dhcp_release': 'True',
+                    'libvirt_use_virtio_for_bridges': 'True',
+                    'verbose': 'True',
+                    'use_syslog': 'False',
+                    'ec2_private_dns_show_ip': 'True',
+                    'api_paste_config': '/etc/nova/api-paste.ini',
+                    'enabled_apis': 'ec2,osapi_compute,metadata',
+                    'auth_strategy': 'keystone',
+                    'compute_driver': 'libvirt.LibvirtDriver',
+                    'sql_connection': db_uri,
+                    'rabbit_userid': 'nova',
+                    'rabbit_virtual_host': 'openstack',
+                    'rabbit_password': rabbitmq_relation['password'],
+                    'rabbit_host': rabbitmq_relation['hostname'],
+                    'glance_api_servers': glance_relation['glance-api-server'],
+                    'flat_interface': 'eth1',
+                    'network_manager': 'nova.network.manager.FlatDHCPManager',
+                    'volume_api_class': 'nova.volume.cinder.API',
+                    'verbose': 'True'}
+
+        ret = u.validate_config_data(unit, conf, 'DEFAULT', expected)
+        if ret:
+            message = "nova config error: {}".format(ret)
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+    def test_image_instance_create(self):
+        """Create an image/instance, verify they exist, and delete them."""
+        # NOTE(coreycb): Skipping failing test on essex until resolved. essex
+        #                nova API calls are getting "Malformed request url (HTTP
+        #                400)".
+        if self._get_openstack_release() == self.precise_essex:
+            u.log.error("Skipping failing test until resolved")
+            return
+
+        image = u.create_cirros_image(self.glance, "cirros-image")
+        if not image:
+            amulet.raise_status(amulet.FAIL, msg="Image create failed")
+
+        instance = u.create_instance(self.nova_demo, "cirros-image", "cirros",
+                                     "m1.tiny")
+        if not instance:
+            amulet.raise_status(amulet.FAIL, msg="Instance create failed")
+
+        found = False
+        for instance in self.nova_demo.servers.list():
+            if instance.name == 'cirros':
+                found = True
+                if instance.status != 'ACTIVE':
+                    msg = "cirros instance is not active"
+                    amulet.raise_status(amulet.FAIL, msg=message)
+
+        if not found:
+            message = "nova cirros instance does not exist"
+            amulet.raise_status(amulet.FAIL, msg=message)
+
+        u.delete_image(self.glance, image)
+        u.delete_instance(self.nova_demo, instance)

tests/charmhelpers/contrib/amulet/deployment.py

@@ -0,0 +1,58 @@
+import amulet
+
+
+class AmuletDeployment(object):
+    """This class provides generic Amulet deployment and test runner
+       methods."""
+
+    def __init__(self, series=None):
+        """Initialize the deployment environment."""
+        self.series = None
+
+        if series:
+            self.series = series
+            self.d = amulet.Deployment(series=self.series)
+        else:
+            self.d = amulet.Deployment()
+
+    def _add_services(self, this_service, other_services):
+        """Add services to the deployment where this_service is the local charm
+           that we're focused on testing and other_services are the other
+           charms that come from the charm store."""
+        name, units = range(2)
+        self.this_service = this_service[name]
+        self.d.add(this_service[name], units=this_service[units])
+
+        for svc in other_services:
+            if self.series:
+                self.d.add(svc[name],
+                           charm='cs:{}/{}'.format(self.series, svc[name]),
+                           units=svc[units])
+            else:
+                self.d.add(svc[name], units=svc[units])
+
+    def _add_relations(self, relations):
+        """Add all of the relations for the services."""
+        for k, v in relations.iteritems():
+            self.d.relate(k, v)
+
+    def _configure_services(self, configs):
+        """Configure all of the services."""
+        for service, config in configs.iteritems():
+            self.d.configure(service, config)
+
+    def _deploy(self):
+        """Deploy environment and wait for all hooks to finish executing."""
+        try:
+            self.d.setup()
+            self.d.sentry.wait()
+        except amulet.helpers.TimeoutError:
+            amulet.raise_status(amulet.FAIL, msg="Deployment timed out")
+        except:
+            raise
+
+    def run_tests(self):
+        """Run all of the methods that are prefixed with 'test_'."""
+        for test in dir(self):
+            if test.startswith('test_'):
+                getattr(self, test)()

tests/charmhelpers/contrib/amulet/utils.py

@@ -0,0 +1,157 @@
+import ConfigParser
+import io
+import logging
+import re
+import sys
+from time import sleep
+
+
+class AmuletUtils(object):
+    """This class provides common utility functions that are used by Amulet
+       tests."""
+
+    def __init__(self, log_level=logging.ERROR):
+        self.log = self.get_logger(level=log_level)
+
+    def get_logger(self, name="amulet-logger", level=logging.DEBUG):
+        """Get a logger object that will log to stdout."""
+        log = logging
+        logger = log.getLogger(name)
+        fmt = \
+            log.Formatter("%(asctime)s %(funcName)s %(levelname)s: %(message)s")
+
+        handler = log.StreamHandler(stream=sys.stdout)
+        handler.setLevel(level)
+        handler.setFormatter(fmt)
+
+        logger.addHandler(handler)
+        logger.setLevel(level)
+
+        return logger
+
+    def valid_ip(self, ip):
+        if re.match(r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$", ip):
+            return True
+        else:
+            return False
+
+    def valid_url(self, url):
+        p = re.compile(
+            r'^(?:http|ftp)s?://'
+            r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|' # flake8: noqa
+            r'localhost|'
+            r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})'
+            r'(?::\d+)?'
+            r'(?:/?|[/?]\S+)$',
+            re.IGNORECASE)
+        if p.match(url):
+            return True
+        else:
+            return False
+
+    def validate_services(self, commands):
+        """Verify the specified services are running on the corresponding
+           service units."""
+        for k, v in commands.iteritems():
+            for cmd in v:
+                output, code = k.run(cmd)
+                if code != 0:
+                    return "command `{}` returned {}".format(cmd, 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)
+        config = ConfigParser.ConfigParser()
+        config.readfp(io.StringIO(file_contents))
+        return config
+
+    def validate_config_data(self, sentry_unit, config_file, section, expected):
+        """Verify that the specified section of the config file contains
+           the expected option key:value pairs."""
+        config = self._get_config(sentry_unit, config_file)
+
+        if section != 'DEFAULT' and not config.has_section(section):
+            return "section [{}] does not exist".format(section)
+
+        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]:
+                return "section [{}] {}:{} != expected {}:{}".format(section,
+                       k, config.get(section, k), k, expected[k])
+        return None
+
+    def _validate_dict_data(self, expected, actual):
+        """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
+           bool."""
+        for k, v in expected.iteritems():
+            if k in actual:
+                if isinstance(v, basestring) or \
+                   isinstance(v, bool) or \
+                   isinstance(v, (int, long)):
+                    if v != actual[k]:
+                        return "{}:{}".format(k, actual[k])
+                elif not v(actual[k]):
+                    return "{}:{}".format(k, actual[k])
+            else:
+                return "key '{}' does not exist".format(k)
+        return None
+
+    def validate_relation_data(self, sentry_unit, relation, expected):
+        """Validate actual relation data based on expected relation data."""
+        actual = sentry_unit.relation(relation[0], relation[1])
+        self.log.debug('actual: {}'.format(repr(actual)))
+        return self._validate_dict_data(expected, actual)
+
+    def _validate_list_data(self, expected, actual):
+        """Compare expected list vs actual list data."""
+        for e in expected:
+            if e not in actual:
+                return "expected item {} not found in actual list".format(e)
+        return None
+
+    def not_null(self, string):
+        if string != None:
+            return True
+        else:
+            return False
+
+    def _get_file_mtime(self, sentry_unit, filename):
+        """Get last modification time of file."""
+        return sentry_unit.file_stat(filename)['mtime']
+
+    def _get_dir_mtime(self, sentry_unit, directory):
+        """Get last modification time of directory."""
+        return sentry_unit.directory_stat(directory)['mtime']
+
+    def _get_proc_start_time(self, sentry_unit, service, pgrep_full=False):
+        """Determine start time of the process based on the last modification
+           time of the /proc/pid directory. If pgrep_full is True, the process
+           name is matched against the full command line."""
+        if pgrep_full:
+            cmd = 'pgrep -o -f {}'.format(service)
+        else:
+            cmd = 'pgrep -o {}'.format(service)
+        proc_dir = '/proc/{}'.format(sentry_unit.run(cmd)[0].strip())
+        return self._get_dir_mtime(sentry_unit, proc_dir)
+
+    def service_restarted(self, sentry_unit, service, filename,
+                          pgrep_full=False):
+        """Compare a service's start time vs a file's last modification time
+           (such as a config file for that service) to determine if the service
+           has been restarted."""
+        sleep(10)
+        if self._get_proc_start_time(sentry_unit, service, pgrep_full) >= \
+           self._get_file_mtime(sentry_unit, filename):
+            return True
+        else:
+            return False
+
+    def relation_error(self, name, data):
+        return 'unexpected relation data in {} - {}'.format(name, data)
+
+    def endpoint_error(self, name, data):
+        return 'unexpected endpoint data in {} - {}'.format(name, data)

tests/charmhelpers/contrib/openstack/amulet/deployment.py

@@ -0,0 +1,55 @@
+from charmhelpers.contrib.amulet.deployment import (
+    AmuletDeployment
+)
+
+
+class OpenStackAmuletDeployment(AmuletDeployment):
+    """This class inherits from AmuletDeployment and has additional support
+       that is specifically for use by OpenStack charms."""
+
+    def __init__(self, series=None, openstack=None, source=None):
+        """Initialize the deployment environment."""
+        super(OpenStackAmuletDeployment, self).__init__(series)
+        self.openstack = openstack
+        self.source = source
+
+    def _add_services(self, this_service, other_services):
+        """Add services to the deployment and set openstack-origin."""
+        super(OpenStackAmuletDeployment, self)._add_services(this_service,
+                                                             other_services)
+        name = 0
+        services = other_services
+        services.append(this_service)
+        use_source = ['mysql', 'mongodb', 'rabbitmq-server', 'ceph']
+
+        if self.openstack:
+            for svc in services:
+                if svc[name] not in use_source:
+                    config = {'openstack-origin': self.openstack}
+                    self.d.configure(svc[name], config)
+
+        if self.source:
+            for svc in services:
+                if svc[name] in use_source:
+                    config = {'source': self.source}
+                    self.d.configure(svc[name], config)
+
+    def _configure_services(self, configs):
+        """Configure all of the services."""
+        for service, config in configs.iteritems():
+            self.d.configure(service, config)
+
+    def _get_openstack_release(self):
+        """Return an integer representing the enum value of the openstack
+           release."""
+        self.precise_essex, self.precise_folsom, self.precise_grizzly, \
+            self.precise_havana, self.precise_icehouse, \
+            self.trusty_icehouse = range(6)
+        releases = {
+            ('precise', None): self.precise_essex,
+            ('precise', 'cloud:precise-folsom'): self.precise_folsom,
+            ('precise', 'cloud:precise-grizzly'): self.precise_grizzly,
+            ('precise', 'cloud:precise-havana'): self.precise_havana,
+            ('precise', 'cloud:precise-icehouse'): self.precise_icehouse,
+            ('trusty', None): self.trusty_icehouse}
+        return releases[(self.series, self.openstack)]

tests/charmhelpers/contrib/openstack/amulet/utils.py

@@ -0,0 +1,209 @@
+import logging
+import os
+import time
+import urllib
+
+import glanceclient.v1.client as glance_client
+import keystoneclient.v2_0 as keystone_client
+import novaclient.v1_1.client as nova_client
+
+from charmhelpers.contrib.amulet.utils import (
+    AmuletUtils
+)
+
+DEBUG = logging.DEBUG
+ERROR = logging.ERROR
+
+
+class OpenStackAmuletUtils(AmuletUtils):
+    """This class inherits from AmuletUtils and has additional support
+       that is specifically for use by OpenStack charms."""
+
+    def __init__(self, log_level=ERROR):
+        """Initialize the deployment environment."""
+        super(OpenStackAmuletUtils, self).__init__(log_level)
+
+    def validate_endpoint_data(self, endpoints, admin_port, internal_port,
+                               public_port, expected):
+        """Validate actual endpoint data vs expected endpoint data. The ports
+           are used to find the matching endpoint."""
+        found = False
+        for ep in endpoints:
+            self.log.debug('endpoint: {}'.format(repr(ep)))
+            if admin_port in ep.adminurl and internal_port in ep.internalurl \
+               and public_port in ep.publicurl:
+                found = True
+                actual = {'id': ep.id,
+                          'region': ep.region,
+                          'adminurl': ep.adminurl,
+                          'internalurl': ep.internalurl,
+                          'publicurl': ep.publicurl,
+                          'service_id': ep.service_id}
+                ret = self._validate_dict_data(expected, actual)
+                if ret:
+                    return 'unexpected endpoint data - {}'.format(ret)
+
+        if not found:
+            return 'endpoint not found'
+
+    def validate_svc_catalog_endpoint_data(self, expected, actual):
+        """Validate a list of actual service catalog endpoints vs a list of
+           expected service catalog endpoints."""
+        self.log.debug('actual: {}'.format(repr(actual)))
+        for k, v in expected.iteritems():
+            if k in actual:
+                ret = self._validate_dict_data(expected[k][0], actual[k][0])
+                if ret:
+                    return self.endpoint_error(k, ret)
+            else:
+                return "endpoint {} does not exist".format(k)
+        return ret
+
+    def validate_tenant_data(self, expected, actual):
+        """Validate a list of actual tenant data vs list of expected tenant
+           data."""
+        self.log.debug('actual: {}'.format(repr(actual)))
+        for e in expected:
+            found = False
+            for act in actual:
+                a = {'enabled': act.enabled, 'description': act.description,
+                     'name': act.name, 'id': act.id}
+                if e['name'] == a['name']:
+                    found = True
+                    ret = self._validate_dict_data(e, a)
+                    if ret:
+                        return "unexpected tenant data - {}".format(ret)
+            if not found:
+                return "tenant {} does not exist".format(e['name'])
+        return ret
+
+    def validate_role_data(self, expected, actual):
+        """Validate a list of actual role data vs a list of expected role
+           data."""
+        self.log.debug('actual: {}'.format(repr(actual)))
+        for e in expected:
+            found = False
+            for act in actual:
+                a = {'name': act.name, 'id': act.id}
+                if e['name'] == a['name']:
+                    found = True
+                    ret = self._validate_dict_data(e, a)
+                    if ret:
+                        return "unexpected role data - {}".format(ret)
+            if not found:
+                return "role {} does not exist".format(e['name'])
+        return ret
+
+    def validate_user_data(self, expected, actual):
+        """Validate a list of actual user data vs a list of expected user
+           data."""
+        self.log.debug('actual: {}'.format(repr(actual)))
+        for e in expected:
+            found = False
+            for act in actual:
+                a = {'enabled': act.enabled, 'name': act.name,
+                     'email': act.email, 'tenantId': act.tenantId,
+                     'id': act.id}
+                if e['name'] == a['name']:
+                    found = True
+                    ret = self._validate_dict_data(e, a)
+                    if ret:
+                        return "unexpected user data - {}".format(ret)
+            if not found:
+                return "user {} does not exist".format(e['name'])
+        return ret
+
+    def validate_flavor_data(self, expected, actual):
+        """Validate a list of actual flavors vs a list of expected flavors."""
+        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"""
+        return tenant in [t.name for t in keystone.tenants.list()]
+
+    def authenticate_keystone_admin(self, keystone_sentry, user, password,
+                                    tenant):
+        """Authenticates admin user with the keystone admin endpoint."""
+        service_ip = \
+            keystone_sentry.relation('shared-db',
+                                     'mysql:shared-db')['private-address']
+        ep = "http://{}:35357/v2.0".format(service_ip.strip().decode('utf-8'))
+        return keystone_client.Client(username=user, password=password,
+                                      tenant_name=tenant, auth_url=ep)
+
+    def authenticate_keystone_user(self, keystone, user, password, tenant):
+        """Authenticates a regular user with the keystone public endpoint."""
+        ep = keystone.service_catalog.url_for(service_type='identity',
+                                              endpoint_type='publicURL')
+        return keystone_client.Client(username=user, password=password,
+                                      tenant_name=tenant, auth_url=ep)
+
+    def authenticate_glance_admin(self, keystone):
+        """Authenticates admin user with glance."""
+        ep = keystone.service_catalog.url_for(service_type='image',
+                                              endpoint_type='adminURL')
+        return glance_client.Client(ep, token=keystone.auth_token)
+
+    def authenticate_nova_user(self, keystone, user, password, tenant):
+        """Authenticates a regular user with nova-api."""
+        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 create_cirros_image(self, glance, image_name):
+        """Download the latest cirros image and upload it to glance."""
+        http_proxy = os.getenv('AMULET_HTTP_PROXY')
+        self.log.debug('AMULET_HTTP_PROXY: {}'.format(http_proxy))
+        if http_proxy:
+            proxies = {'http': http_proxy}
+            opener = urllib.FancyURLopener(proxies)
+        else:
+            opener = urllib.FancyURLopener()
+
+        f = opener.open("http://download.cirros-cloud.net/version/released")
+        version = f.read().strip()
+        cirros_img = "tests/cirros-{}-x86_64-disk.img".format(version)
+
+        if not os.path.exists(cirros_img):
+            cirros_url = "http://{}/{}/{}".format("download.cirros-cloud.net",
+                                                  version, cirros_img)
+            opener.retrieve(cirros_url, cirros_img)
+        f.close()
+
+        with open(cirros_img) as f:
+            image = glance.images.create(name=image_name, is_public=True,
+                                         disk_format='qcow2',
+                                         container_format='bare', data=f)
+        return image
+
+    def delete_image(self, glance, image):
+        """Delete the specified image."""
+        glance.images.delete(image)
+
+    def create_instance(self, nova, image_name, instance_name, flavor):
+        """Create the specified instance."""
+        image = nova.images.find(name=image_name)
+        flavor = nova.flavors.find(name=flavor)
+        instance = nova.servers.create(name=instance_name, image=image,
+                                       flavor=flavor)
+
+        count = 1
+        status = instance.status
+        while status != 'ACTIVE' and count < 60:
+            time.sleep(3)
+            instance = nova.servers.get(instance.id)
+            status = instance.status
+            self.log.debug('instance status: {}'.format(status))
+            count += 1
+
+        if status == 'BUILD':
+            return None
+
+        return instance
+
+    def delete_instance(self, nova, instance):
+        """Delete the specified instance."""
+        nova.servers.delete(instance)