Add Gnocchi S3 storage backend functional test (#334)

Add tests for Gnocchi S3 storage backend support.

zaza/openstack/charm_tests/gnocchi/setup.py

@@ -0,0 +1,69 @@
+# Copyright 2020 Canonical Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Setup for Gnocchi tests."""
+
+import logging
+
+import zaza.model as model
+import zaza.openstack.utilities.openstack as openstack_utils
+
+
+def configure_s3_backend():
+    """Inject S3 parameters from Swift for Gnocchi config."""
+    session = openstack_utils.get_overcloud_keystone_session()
+    ks_client = openstack_utils.get_keystone_session_client(session)
+
+    logging.info('Retrieving S3 connection data from Swift')
+    token_data = ks_client.tokens.get_token_data(session.get_token())
+    project_id = token_data['token']['project']['id']
+    user_id = token_data['token']['user']['id']
+
+    # Store URL to service providing S3 compatible API
+    for entry in token_data['token']['catalog']:
+        if entry['type'] == 's3':
+            for endpoint in entry['endpoints']:
+                if endpoint['interface'] == 'public':
+                    s3_region = endpoint['region']
+                    s3_endpoint = endpoint['url']
+
+    # Create AWS compatible application credentials in Keystone
+    ec2_creds = ks_client.ec2.create(user_id, project_id)
+
+    logging.info('Changing Gnocchi charm config to connect to S3')
+    model.set_application_config(
+        'gnocchi',
+        {'s3-endpoint-url': s3_endpoint,
+            's3-region-name': s3_region,
+            's3-access-key-id': ec2_creds.access,
+            's3-secret-access-key': ec2_creds.secret}
+    )
+    logging.info('Waiting for units to execute config-changed hook')
+    model.wait_for_agent_status()
+    logging.info('Waiting for units to reach target states')
+    model.wait_for_application_states(
+        states={
+            'gnocchi': {
+                'workload-status-': 'active',
+                'workload-status-message': 'Unit is ready'
+            },
+            'ceilometer': {
+                'workload-status': 'blocked',
+                'workload-status-message': 'Run the ' +
+                'ceilometer-upgrade action on the leader ' +
+                'to initialize ceilometer and gnocchi'
+            }
+        }
+    )
+    model.block_until_all_units_idle()

zaza/openstack/charm_tests/gnocchi/tests.py

@@ -16,9 +16,11 @@
 
 """Encapsulate Gnocchi testing."""
 
+import boto3
 import logging
-
+import pprint
 from gnocchiclient.v1 import client as gnocchi_client
+
 import zaza.openstack.charm_tests.test_utils as test_utils
 import zaza.openstack.utilities.openstack as openstack_utils
 
@@ -58,3 +60,53 @@ class GnocchiTest(test_utils.OpenStackBaseTest):
         """
         with self.pause_resume(self.services):
             logging.info("Testing pause and resume")
+
+
+class GnocchiS3Test(test_utils.OpenStackBaseTest):
+    """Test Gnocchi for S3 storage backend."""
+
+    @classmethod
+    def setUpClass(cls):
+        """Run class setup for running tests."""
+        super(GnocchiS3Test, cls).setUpClass()
+
+        session = openstack_utils.get_overcloud_keystone_session()
+        ks_client = openstack_utils.get_keystone_session_client(session)
+
+        # Get token data so we can glean our user_id and project_id
+        token_data = ks_client.tokens.get_token_data(session.get_token())
+        project_id = token_data['token']['project']['id']
+        user_id = token_data['token']['user']['id']
+
+        # Store URL to service providing S3 compatible API
+        for entry in token_data['token']['catalog']:
+            if entry['type'] == 's3':
+                for endpoint in entry['endpoints']:
+                    if endpoint['interface'] == 'public':
+                        cls.s3_region = endpoint['region']
+                        cls.s3_endpoint = endpoint['url']
+
+        # Create AWS compatible application credentials in Keystone
+        cls.ec2_creds = ks_client.ec2.create(user_id, project_id)
+
+    def test_s3_list_gnocchi_buckets(self):
+        """Verify that the gnocchi buckets were created in the S3 backend."""
+        kwargs = {
+            'region_name': self.s3_region,
+            'aws_access_key_id': self.ec2_creds.access,
+            'aws_secret_access_key': self.ec2_creds.secret,
+            'endpoint_url': self.s3_endpoint,
+            'verify': self.cacert,
+        }
+        s3_client = boto3.client('s3', **kwargs)
+
+        bucket_names = ['gnocchi-measure', 'gnocchi-aggregates']
+        # Validate their presence
+        bucket_list = s3_client.list_buckets()
+        logging.info(pprint.pformat(bucket_list))
+        for bkt in bucket_list['Buckets']:
+            for gnocchi_bkt in bucket_names:
+                if bkt['Name'] == gnocchi_bkt:
+                    break
+                else:
+                    AssertionError('Bucket "{}" not found'.format(gnocchi_bkt))