From 2a151168680e1bbe983a2f29604267094ff4d774 Mon Sep 17 00:00:00 2001
From: Liam Young <liam.young@canonical.com>
Date: Wed, 25 Sep 2019 17:44:14 +0000
Subject: [PATCH] Add aodh api test

---
 zaza/openstack/charm_tests/aodh/tests.py | 41 +++++++++++
 zaza/openstack/configure/telemetry.py    | 93 +++++++++++++++++++++++-
 zaza/openstack/utilities/openstack.py    | 12 +++
 3 files changed, 145 insertions(+), 1 deletion(-)

diff --git a/zaza/openstack/charm_tests/aodh/tests.py b/zaza/openstack/charm_tests/aodh/tests.py
index cabbac3..6276bfd 100644
--- a/zaza/openstack/charm_tests/aodh/tests.py
+++ b/zaza/openstack/charm_tests/aodh/tests.py
@@ -18,13 +18,17 @@
 
 import logging
 
+import zaza.model
 import zaza.openstack.charm_tests.test_utils as test_utils
 import zaza.openstack.utilities.openstack as openstack_utils
+import zaza.openstack.configure.telemetry as telemetry_utils
 
 
 class AodhTest(test_utils.OpenStackBaseTest):
     """Encapsulate Aodh tests."""
 
+    RESOURCE_PREFIX = 'zaza-aodhtests'
+
     @classmethod
     def setUpClass(cls):
         """Run class setup for running tests."""
@@ -33,6 +37,27 @@ class AodhTest(test_utils.OpenStackBaseTest):
         cls.xenial_newton = openstack_utils.get_os_release('xenial_newton')
         cls.bionic_stein = openstack_utils.get_os_release('bionic_stein')
         cls.release = openstack_utils.get_os_release()
+        cls.keystone_session = openstack_utils.get_overcloud_keystone_session()
+        cls.model_name = zaza.model.get_juju_model()
+        cls.aodh_client = openstack_utils.get_aodh_session_client(
+            cls.keystone_session)
+
+    @classmethod
+    def tearDown(cls):
+        """Remove test resources."""
+        logging.info('Running teardown')
+        cache_wait = False
+        for alarm in cls.aodh_client.alarm.list():
+            if alarm['name'].startswith(cls.RESOURCE_PREFIX):
+                cache_wait = True
+                logging.info('Removing Alarm {}'.format(alarm['name']))
+                telemetry_utils.delete_alarm(
+                    cls.aodh_client,
+                    alarm['name'],
+                    cache_wait=False)
+        if cache_wait:
+            logging.info('Waiting for alarm cache to clear')
+            telemetry_utils.alarm_cache_wait()
 
     @property
     def services(self):
@@ -60,6 +85,22 @@ class AodhTest(test_utils.OpenStackBaseTest):
                 'aodh-listener']
         return services
 
+    def test_100_test_api(self):
+        """Check api by creating an alarm."""
+        alarm_name = '{}_test_api_alarm'.format(self.RESOURCE_PREFIX)
+        logging.info('Creating alarm {}'.format(alarm_name))
+        alarm = telemetry_utils.create_server_power_off_alarm(
+            self.aodh_client,
+            alarm_name,
+            'some-uuid')
+        alarm_state = telemetry_utils.get_alarm_state(
+            self.aodh_client,
+            alarm['alarm_id'])
+        logging.info('alarm_state: {}'.format(alarm_state))
+        # Until data is collected alarm come up in an 'insufficient data'
+        # state.
+        self.assertEqual(alarm_state, 'insufficient data')
+
     def test_900_restart_on_config_change(self):
         """Checking restart happens on config change.
 
diff --git a/zaza/openstack/configure/telemetry.py b/zaza/openstack/configure/telemetry.py
index 144d447..86102ac 100644
--- a/zaza/openstack/configure/telemetry.py
+++ b/zaza/openstack/configure/telemetry.py
@@ -18,13 +18,104 @@ Functions for managing masakari resources and simulating compute node loss
 and recovery.
 """
 
+import time
+
 import zaza.model
 
 
 def ceilometer_upgrade(application_name=None, model_name=None):
-    """Run ceilometer upgrade action."""
+    """Run ceilometer upgrade action.
+
+    :param application_name: Name of application to run action against.
+    :type application_name: str
+    :param model_name: Name of model application_name resides in.
+    :type model_name: str
+    """
     zaza.model.run_action_on_leader(
         application_name,
         'ceilometer-upgrade',
         model_name=model_name,
         action_params={})
+
+
+def get_alarm(aodh_client, alarm_name):
+    """Return the alarm with the given name.
+
+    :param aodh_client: Authenticated aodh v2 client
+    :type aodh_client: aodhclient.v2.client.Client
+    :param alarm_name: Name of alarm to search for
+    :type alarm_name: str
+    :returns: Returns a dict of alarm data.
+    :rtype: {} or None
+    """
+    for alarm in aodh_client.alarm.list():
+        if alarm['name'] == alarm_name:
+            return alarm
+    return None
+
+
+def alarm_cache_wait():
+    """Wait for alarm cache to clear."""
+    # AODH has an alarm cache (see event_alarm_cache_ttl in aodh.conf). This
+    # means deleted alarms can persist and fire. The default is 60s and is
+    # currently not configrable via the charm so 61s is a safe assumption.
+    time.sleep(61)
+
+
+def delete_alarm(aodh_client, alarm_name, cache_wait=False):
+    """Delete alarm with given name.
+
+    :param aodh_client: Authenticated aodh v2 client
+    :type aodh_client: aodhclient.v2.client.Client
+    :param alarm_name: Name of alarm to delete
+    :type alarm_name: str
+    :param cache_wait: Whether to wait for cache to clear after deletion.
+    :type cache_wait: bool
+    """
+    alarm = get_alarm(aodh_client, alarm_name)
+    if alarm:
+        aodh_client.alarm.delete(alarm['alarm_id'])
+    if cache_wait:
+        alarm_cache_wait()
+
+
+def get_alarm_state(aodh_client, alarm_id):
+    """Return the state of the alarm with the given name.
+
+    :param aodh_client: Authenticated aodh v2 client
+    :type aodh_client: aodhclient.v2.client.Client
+    :param alarm_id: ID of provided alarm
+    :param alarm_id: str
+    :returns: State of given alarm
+    :rtype: str
+    """
+    alarm = aodh_client.alarm.get(alarm_id)
+    return alarm['state']
+
+
+def create_server_power_off_alarm(aodh_client, alarm_name, server_uuid):
+    """Create an alarm which triggers when an instance powers off.
+
+    :param aodh_client: Authenticated aodh v2 client
+    :type aodh_client: aodhclient.v2.client.Client
+    :param alarm_name: Name of alarm to delete
+    :type alarm_name: str
+    :param server_uuid: UUID of server to monitor
+    :type server_uuid: str
+    :returns: Dict of alarm data
+    :rtype: {}
+    """
+    alarm_def = {
+        'type': 'event',
+        'name': alarm_name,
+        'description': 'Instance powered OFF',
+        'alarm_actions': ['log://'],
+        'ok_actions': ['log://'],
+        'insufficient_data_actions': ['log://'],
+        'event_rule': {
+            'event_type': 'compute.instance.power_off.*',
+            'query': [{'field': 'traits.instance_id',
+                       'op': 'eq',
+                       'type': 'string',
+                       'value': server_uuid}]}}
+    return aodh_client.alarm.create(alarm_def)
diff --git a/zaza/openstack/utilities/openstack.py b/zaza/openstack/utilities/openstack.py
index 6769de6..f4b36c4 100644
--- a/zaza/openstack/utilities/openstack.py
+++ b/zaza/openstack/utilities/openstack.py
@@ -25,6 +25,7 @@ from .os_versions import (
 
 from openstack import connection
 
+from aodhclient.v2 import client as aodh_client
 from cinderclient import client as cinderclient
 from glanceclient import Client as GlanceClient
 
@@ -288,6 +289,17 @@ def get_masakari_session_client(session, interface='internal',
     return conn.instance_ha
 
 
+def get_aodh_session_client(session):
+    """Return aodh client authenticated by keystone session.
+
+    :param session: Keystone session object
+    :type session: keystoneauth1.session.Session object
+    :returns: Authenticated aodh client
+    :rtype: openstack.instance_ha.v1._proxy.Proxy
+    """
+    return aodh_client.Client(session=session)
+
+
 def get_keystone_scope():
     """Return Keystone scope based on OpenStack release of the overcloud.