Merge "Add tempest coverage for new cache API"

This commit is contained in:
Zuul 2022-07-27 19:50:21 +00:00 committed by Gerrit Code Review
commit 5d85eb5da2
3 changed files with 176 additions and 0 deletions

View File

@ -0,0 +1,153 @@
# Copyright 2022 Red Hat, Inc.
# All Rights Reserved.
#
# 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.
import io
from oslo_log import log as logging
from tempest.api.image import base
from tempest.common import waiters
from tempest import config
from tempest.lib.common.utils import data_utils
from tempest.lib import decorators
from tempest.lib import exceptions as lib_exc
CONF = config.CONF
LOG = logging.getLogger(__name__)
class ImageCachingTest(base.BaseV2ImageTest):
"""Here we test the caching operations for image"""
credentials = ['primary', 'admin']
def setUp(self):
super(ImageCachingTest, self).setUp()
# NOTE(abhishekk): As caching is enabled instance boot or volume
# boot or image download can also cache image, so we are going to
# maintain our caching information to avoid disturbing other tests
self.cached_info = {}
def tearDown(self):
# Delete all from cache/queue if we exit abruptly
for image_id in self.cached_info:
self.os_admin.image_cache_client.cache_delete(
image_id)
super(ImageCachingTest, self).tearDown()
@classmethod
def skip_checks(cls):
super(ImageCachingTest, cls).skip_checks()
# Check to see if we should even be running these tests.
if not CONF.image.image_caching_enabled:
raise cls.skipException('Target system is not configured with '
'glance caching')
def image_create_and_upload(self, upload=True, **kwargs):
"""Wrapper that returns a test image."""
if 'name' not in kwargs:
name = data_utils.rand_name(self.__name__ + "-image")
kwargs['name'] = name
params = dict(kwargs)
image = self.create_image(**params)
self.assertEqual('queued', image['status'])
if not upload:
return image
file_content = data_utils.random_bytes()
image_file = io.BytesIO(file_content)
self.client.store_image_file(image['id'], image_file)
image = self.client.show_image(image['id'])
return image
def _assertCheckQueues(self, queued_images):
for image in self.cached_info:
if self.cached_info[image] == 'queued':
self.assertIn(image, queued_images)
def _assertCheckCache(self, cached_images):
cached_list = []
for image in cached_images:
cached_list.append(image['image_id'])
for image in self.cached_info:
if self.cached_info[image] == 'cached':
self.assertIn(image, cached_list)
@decorators.idempotent_id('4bf6adba-2f9f-47e9-a6d5-37f21ad4387c')
def test_image_caching_cycle(self):
"""Test image cache APIs"""
# Ensure that non-admin user is not allowed to perform caching
# operations
self.assertRaises(lib_exc.Forbidden,
self.os_primary.image_cache_client.list_cache)
# Check there is nothing is queued for cached by us
output = self.os_admin.image_cache_client.list_cache()
self._assertCheckQueues(output['queued_images'])
self._assertCheckCache(output['cached_images'])
# Non-existing image should raise NotFound exception
self.assertRaises(lib_exc.NotFound,
self.os_admin.image_cache_client.cache_queue,
'non-existing-image-id')
# Verify that we can not use queued image for queueing
image = self.image_create_and_upload(name='queued', upload=False)
self.assertRaises(lib_exc.BadRequest,
self.os_admin.image_cache_client.cache_queue,
image['id'])
# Create one image
image = self.image_create_and_upload(name='first',
container_format='bare',
disk_format='raw',
visibility='private')
self.assertEqual('active', image['status'])
# Queue image for caching
self.os_admin.image_cache_client.cache_queue(image['id'])
self.cached_info[image['id']] = 'queued'
# Verify that we have 1 image for queueing and 0 for caching
output = self.os_admin.image_cache_client.list_cache()
self._assertCheckQueues(output['queued_images'])
self._assertCheckCache(output['cached_images'])
# Wait for image caching
LOG.info("Waiting for image %s to get cached", image['id'])
caching = waiters.wait_for_caching(
self.client,
self.os_admin.image_cache_client,
image['id'])
self.cached_info[image['id']] = 'cached'
# verify that we have image in cache and not in queued
self._assertCheckQueues(caching['queued_images'])
self._assertCheckCache(caching['cached_images'])
# Verify that we can delete images from caching and queueing with
# api call.
self.os_admin.image_cache_client.cache_clear()
output = self.os_admin.image_cache_client.list_cache()
self.assertEqual(0, len(output['queued_images']))
self.assertEqual(0, len(output['cached_images']))
# Verify that invalid header value for target returns 400 response
self.assertRaises(lib_exc.BadRequest,
self.os_admin.image_cache_client.cache_clear,
target="invalid")
# Remove all data from local information
self.cached_info = {}

View File

@ -594,3 +594,21 @@ def wait_for_ssh(ssh_client, timeout=30):
except lib_exc.SSHTimeout:
pass
raise lib_exc.TimeoutException()
def wait_for_caching(client, cache_client, image_id):
"""Waits until image is cached"""
start = int(time.time())
while int(time.time()) - start < client.build_timeout:
caching = cache_client.list_cache()
output = [image['image_id'] for image in caching['cached_images']]
if output and image_id in output:
return caching
time.sleep(client.build_interval)
message = ('Image %s failed to cache in time.' % image_id)
caller = test_utils.find_test_caller()
if caller:
message = '(%s) %s' % (caller, message)
raise lib_exc.TimeoutException(message)

View File

@ -674,6 +674,11 @@ ImageGroup = [
'publicURL', 'adminURL', 'internalURL'],
help=("The endpoint type to use for the alternate image "
"service.")),
cfg.BoolOpt('image_caching_enabled',
default=False,
help=("Flag to enable if caching is enabled by image "
"service, operator should set this parameter to True"
"if 'image_cache_dir' is set in glance-api.conf")),
cfg.StrOpt('http_image',
default='http://download.cirros-cloud.net/0.3.1/'
'cirros-0.3.1-x86_64-uec.tar.gz',