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.

166 lines
6.4 KiB

# Copyright 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 requests
from tempest.lib import auth
from config_tempest import utils
class Credentials(object):
"""Class contains all needed credentials.
Wrapps credentials obtained from TempestConf object and Tempest
credentialsfrom auth library.
def __init__(self, conf, admin, **kwargs):
"""Init method of Credentials.
:type conf: TempestConf object
:param admin: True if the user is admin, False otherwise
:type admin: Boolean
self.admin = admin
self._conf = conf
self.verify = kwargs.get('verify', True)
self.cert = kwargs.get('cert', None)
self.username = self.get_credential('username')
self.password = self.get_credential('password')
self.project_name = self.get_credential('project_name')
self.identity_version = self._get_identity_version()
self.api_version = 3 if self.identity_version == "v3" else 2
self.identity_region = self._conf.get_defaulted('identity', 'region')
def set_ssl_certificate_validation(self):
# is there a specific CA bundle to use?
# self.verify is either a boolean, in which case it controls whether
# server's TLS certificates are verified, or a string, in which case
# it is a path to a CA bundle to use, default in requests package
# is True.
if isinstance(self.verify, str):
self.disable_ssl_certificate_validation = False
self.ca_certs = self.verify
self._conf.set('identity', 'ca_certificates_file', self.ca_certs)
self.disable_ssl_certificate_validation = self._conf.get_defaulted(
'identity', 'disable_ssl_certificate_validation'
self.ca_certs = self._conf.get_defaulted('identity',
self._conf.set('identity', 'disable_ssl_certificate_validation',
def get_ssl_certificate_validation(self):
return {
'ca_certs': self.ca_certs,
def get_credential(self, key):
"""Helper for getting credential by its name.
:param key: credential name
:type key: string
:returns: credential
:rtype: string
if self.admin:
# admin credentials are stored in auth section
# and are prefixed by 'admin_'
return self._conf.get_defaulted('auth', 'admin_' + key)
# Tempest doesn't have non admin credentials, but the
# tool keeps them in identity section for further usage
return self._conf.get_defaulted('identity', key)
def _list_versions(self, base_url, **kwargs):
resp = requests.get(base_url, **kwargs)
data = resp.json()
return data["versions"]["values"]
def _get_identity_version(self):
"""Looks for identity version in TempestConf object.
:returns: identity version
:rtype: string
base_url = utils.get_base_url(self._conf.get("identity", "uri"))
kwargs = {
'verify': self.verify,
'cert': self.cert,
versions = self._list_versions(base_url, **kwargs)
for version in versions:
if version["status"] == "stable" and "v3" in version["id"]:
return "v3"
return "v2"
def _get_creds_kwargs(self):
"""Creates kwargs.
Kwargs based on the identity version, for obtaining
Tempest credentials.
:returns: kwargs
:rtype: dict
creds_kwargs = {'username': self.username,
'password': self.password}
if self.identity_version == 'v3':
creds_kwargs.update({'project_name': self.project_name,
'domain_name': 'Default',
'user_domain_name': 'Default'})
creds_kwargs.update({'project_name': self.project_name})
return creds_kwargs
def set_credentials(self):
"""Gets and saves Tempest credentials from auth library."""
creds_kwargs = self._get_creds_kwargs()
disable_ssl = self.disable_ssl_certificate_validation
self.tempest_creds = auth.get_credentials(
def get_auth_provider(self):
"""Gets auth provider based on the type of Tempest credentials.
:returns: auth provider
:rtype: auth.KeystoneV2AuthProvider/auth.KeystoneV3AuthProvider
if isinstance(self.tempest_creds, auth.KeystoneV3Credentials):
# We set uri and uri_v3 to /v3 here because if the endpoint on the
# rc file don't set the /v3 it will fail with a error 404
uri = self._conf.get_defaulted('identity', 'uri_v3')
uri = utils.get_base_url(uri) + 'v3'
self._conf.set('identity', 'uri_v3', uri)
return auth.KeystoneV3AuthProvider(
self._conf.get_defaulted('identity', 'uri_v3'),
return auth.KeystoneV2AuthProvider(
self._conf.get_defaulted('identity', 'uri'),