Automatic Tempest Configuration Generator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

293 lines
11 KiB

# Copyright 2013, 2016, 2018 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
# 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 importlib
import pkgutil
import pyclbr
from six.moves import urllib
from config_tempest import constants as C
from import horizon
from tempest.lib import exceptions
class Services(object):
def __init__(self, clients, conf, creds):
self._clients = clients
self._conf = conf
self._creds = creds
self._ssl_validation = creds.disable_ssl_certificate_validation
self._region = clients.identity_region
self._services = []
self._service_classes = []
self.available_services = self.get_available_services()
def service_classes(self):
"""Return the list of classes available under
This return the list of classes that inherit from base.Service
if not self._service_classes:
path =
prefix = + '.'
for importer, modname, ispkg in pkgutil.walk_packages(
path=path, prefix=prefix, onerror=lambda x: None):
module_info = pyclbr.readmodule(modname)
for item in module_info.values():
m = importlib.import_module(modname)
c = getattr(m,
if issubclass(c,
return self._service_classes
def get_available_services(self):
services = self._clients.service_client.list_services()['services']
except exceptions.Forbidden:
C.LOG.warning("User has no permissions to list services, using "
"catalog. Services without endpoint will not be "
services = self.catalog
return services
def get_service_data(self, s_name, s_type):
for s in self.catalog:
if s['name'] == s_name and s['type'] == s_type:
return s
return None
def discover(self):
# We loop through the classes we have for each service, and if we find
# a class that match a service enabled, we add it in our services list.
# some services doesn't have endpoints, so we need to check first
for s_class in self.service_classes:
s_types = s_class.get_service_type()
for s_type in s_types:
s_name = [t['name'] for t in self.available_services
if t['type'] == s_type]
if s_name:
# In the general case, there should only be one service in
# a deployment per service type
# service-catalog.html#services
if len(s_name) > 1:
C.LOG.warning("There are more service names ('%s') for"
" '%s' service type, which is undefined"
" behavior. Continuing with '%s'.",
str(s_name), s_type, s_name[0])
s_name = s_name[0]
service_data = self.get_service_data(s_name, s_type)
url = None
if not service_data:
C.LOG.warning('No endpoint data found for %s', s_name)
url = self.parse_endpoints(self.get_endpoints(
service_data), s_type)
# Create the service class and add it to services list
service = s_class(s_name, s_type, url, self.token,
# discover extensions of the service
# discover versions of the service
# default tempest options
service.set_availability(self._conf, True)
# service is not available
# quickly instantiate a class in order to set
# availability of the service
s = s_class(None, None, None, None, None)
s.set_availability(self._conf, False)
def merge_exts_multiversion_service(self, service):
"""Merges extensions of a service given by its name
Looking for extensions from all versions of the service
defined by name and merges them to that provided service.
:param service: Service object
versions = service.get_supported_versions()
service_type = service.get_unversioned_service_type()
services_lst = []
for v in versions:
if self.is_service(**{'type': service_type + v}):
services_lst.append(self.get_service(service_type + v))
service.extensions = self.merge_extensions(services_lst)
def get_endpoints(self, entry):
for ep in entry['endpoints']:
if self._creds.api_version == 3:
if (ep['region'] == self._region and
ep['interface'] == 'public'):
return ep
if ep['region'] == self._region:
return ep
return entry['endpoints'][0]
except IndexError:
return []
def set_catalog_and_url(self):
if self._creds.api_version == 3:
service_catalog = 'catalog'
self.public_url = 'url'
service_catalog = 'serviceCatalog'
self.public_url = 'publicURL'
self.token, auth_data = self._clients.auth_provider.get_auth()
self.catalog = auth_data[service_catalog]
def parse_endpoints(self, ep, name):
"""Parse an endpoint(s).
:param ep: endpoint(s)
:type ep: dict or list in case of no endpoints
:param name: name of a service
:type name: string
:return: url
:rtype: string
# endpoint list can be empty
if len(ep) == 0:
url = """Service %s has no endpoints", name)
url = ep[self.public_url]
if 'identity' in urllib.parse.urlparse(url).path:
url = self.edit_identity_url(ep[self.public_url])
return url
def edit_identity_url(self, url):
"""A port and identity version are added to url if contains 'identity'
:param url: url address of an endpoint
:type url: string
:rtype: string
# self._clients.auth_provider.auth_url stores identity.uri(_v3) value
# from TempestConf
port = urllib.parse.urlparse(self._clients.auth_provider.auth_url).port
if port is None:
port = ""
port = ":" + str(port)
replace_text = port + "/identity/" + self._creds.identity_version
return url.replace("/identity", replace_text)
def get_service(self, s_type):
"""Finds and returns a service object
:param s_type: Type of a service
:type s_type: string
:return: Service object
for service in self._services:
if service.s_type == s_type:
return service
return None
def is_service(self, **kwargs):
"""Returns true if a service is available, false otherwise
:param kwargs: Search parameters (accepts service name or type)
:rtype: boolean
a_s = self.available_services
if kwargs.get('name'):
if [s for s in a_s if s['name'] == kwargs.get('name')]:
return True
return False
if kwargs.get('type'):
if [s for s in a_s if s['type'] == kwargs.get('type')]:
return True
return False
return False
def post_configuration(self):
for s in self._services:
s.post_configuration(self._conf, self.is_service)
horizon_kwargs = {
"disable_ssl_certificate_validation": self._ssl_validation
horizon.configure_horizon(self._conf, **horizon_kwargs)
def set_supported_api_versions(self):
# set supported API versions for services with more of them
for service in self._services:
versions = service.get_versions()
supported_versions = service.get_supported_versions()
if versions:
section = service.get_feature_name() + '-feature-enabled'
for s_version in supported_versions:
is_supported = any(s_version in item
for item in versions)
section, 'api_' + s_version, str(is_supported))
def merge_extensions(self, service_objects):
"""Merges extensions from all provided service objects
:param service_objects:
:type service_objects: list
:return: Merged extensions
:rtype: list
extensions = []
for o in service_objects:
if o:
extensions += o.extensions
return extensions
def set_service_extensions(self):
postfix = "-feature-enabled"
keystone_v3_support = self._conf.getboolean('identity' + postfix,
except ValueError:
keystone_v3_support = False
if keystone_v3_support:
for service in self._services:
ext_key = service.get_service_extension_key()
if ext_key:
extensions = ','.join(service.get_extensions())
service_name = service.get_feature_name()
self._conf.set(service_name + postfix, ext_key, extensions)