functest/opnfv_tests/openstack/tempest/conf_utils.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2015 All rights reserved
   4 # This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 #
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 import ConfigParser
  11 import logging
  12 import os
  13 import pkg_resources
  14 import shutil
  15 import subprocess
  16
  17 import yaml
  18
  19 from functest.utils.constants import CONST
  20 import functest.utils.functest_utils as ft_utils
  21 import functest.utils.openstack_utils as os_utils
  22
  23
  24 IMAGE_ID_ALT = None
  25 FLAVOR_ID_ALT = None
  26 GLANCE_IMAGE_PATH = os.path.join(
  27     CONST.__getattribute__('dir_functest_images'),
  28     CONST.__getattribute__('openstack_image_file_name'))
  29 TEMPEST_RESULTS_DIR = os.path.join(CONST.__getattribute__('dir_results'),
  30                                    'tempest')
  31 TEMPEST_CUSTOM = pkg_resources.resource_filename(
  32     'functest', 'opnfv_tests/openstack/tempest/custom_tests/test_list.txt')
  33 TEMPEST_BLACKLIST = pkg_resources.resource_filename(
  34     'functest', 'opnfv_tests/openstack/tempest/custom_tests/blacklist.txt')
  35 TEMPEST_DEFCORE = pkg_resources.resource_filename(
  36     'functest',
  37     'opnfv_tests/openstack/tempest/custom_tests/defcore_req.txt')
  38 TEMPEST_RAW_LIST = os.path.join(TEMPEST_RESULTS_DIR, 'test_raw_list.txt')
  39 TEMPEST_LIST = os.path.join(TEMPEST_RESULTS_DIR, 'test_list.txt')
  40 REFSTACK_RESULTS_DIR = os.path.join(CONST.__getattribute__('dir_results'),
  41                                     'refstack')
  42 TEMPEST_CONF_YAML = pkg_resources.resource_filename(
  43     'functest', 'opnfv_tests/openstack/tempest/custom_tests/tempest_conf.yaml')
  44 TEST_ACCOUNTS_FILE = pkg_resources.resource_filename(
  45     'functest',
  46     'opnfv_tests/openstack/tempest/custom_tests/test_accounts.yaml')
  47
  48 CI_INSTALLER_TYPE = CONST.__getattribute__('INSTALLER_TYPE')
  49 CI_INSTALLER_IP = CONST.__getattribute__('INSTALLER_IP')
  50
  51 """ logging configuration """
  52 logger = logging.getLogger(__name__)
  53
  54
  55 def get_verifier_id():
  56     """
  57     Returns verifier id for current Tempest
  58     """
  59     cmd = ("rally verify list-verifiers | awk '/" +
  60            CONST.__getattribute__('tempest_deployment_name') +
  61            "/ {print $2}'")
  62     p = subprocess.Popen(cmd, shell=True,
  63                          stdout=subprocess.PIPE,
  64                          stderr=subprocess.STDOUT)
  65     deployment_uuid = p.stdout.readline().rstrip()
  66     if deployment_uuid == "":
  67         logger.error("Tempest verifier not found.")
  68         raise Exception('Error with command:%s' % cmd)
  69     return deployment_uuid
  70
  71
  72 def get_verifier_deployment_id():
  73     """
  74     Returns deployment id for active Rally deployment
  75     """
  76     cmd = ("rally deployment list | awk '/" +
  77            CONST.__getattribute__('rally_deployment_name') +
  78            "/ {print $2}'")
  79     p = subprocess.Popen(cmd, shell=True,
  80                          stdout=subprocess.PIPE,
  81                          stderr=subprocess.STDOUT)
  82     deployment_uuid = p.stdout.readline().rstrip()
  83     if deployment_uuid == "":
  84         logger.error("Rally deployment not found.")
  85         raise Exception('Error with command:%s' % cmd)
  86     return deployment_uuid
  87
  88
  89 def get_verifier_repo_dir(verifier_id):
  90     """
  91     Returns installed verifier repo directory for Tempest
  92     """
  93     if not verifier_id:
  94         verifier_id = get_verifier_id()
  95
  96     return os.path.join(CONST.__getattribute__('dir_rally_inst'),
  97                         'verification',
  98                         'verifier-{}'.format(verifier_id),
  99                         'repo')
 100
 101
 102 def get_verifier_deployment_dir(verifier_id, deployment_id):
 103     """
 104     Returns Rally deployment directory for current verifier
 105     """
 106     if not verifier_id:
 107         verifier_id = get_verifier_id()
 108
 109     if not deployment_id:
 110         deployment_id = get_verifier_deployment_id()
 111
 112     return os.path.join(CONST.__getattribute__('dir_rally_inst'),
 113                         'verification',
 114                         'verifier-{}'.format(verifier_id),
 115                         'for-deployment-{}'.format(deployment_id))
 116
 117
 118 def get_repo_tag(repo):
 119     """
 120     Returns last tag of current branch
 121     """
 122     cmd = ("git -C {0} describe --abbrev=0 HEAD".format(repo))
 123     p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
 124     tag = p.stdout.readline().rstrip()
 125
 126     return str(tag)
 127
 128
 129 def backup_tempest_config(conf_file):
 130     """
 131     Copy config file to tempest results directory
 132     """
 133     shutil.copyfile(conf_file,
 134                     os.path.join(TEMPEST_RESULTS_DIR, 'tempest.conf'))
 135
 136
 137 def configure_tempest(deployment_dir, image_id=None, flavor_id=None,
 138                       mode=None):
 139     """
 140     Calls rally verify and updates the generated tempest.conf with
 141     given parameters
 142     """
 143     conf_file = configure_verifier(deployment_dir)
 144     configure_tempest_update_params(conf_file, image_id, flavor_id)
 145
 146
 147 def configure_tempest_defcore(deployment_dir, image_id, flavor_id,
 148                               image_id_alt, flavor_id_alt, tenant_id):
 149     """
 150     Add/update needed parameters into tempest.conf file
 151     """
 152     conf_file = configure_verifier(deployment_dir)
 153     configure_tempest_update_params(conf_file, image_id, flavor_id)
 154
 155     logger.debug("Updating selected tempest.conf parameters for defcore...")
 156     config = ConfigParser.RawConfigParser()
 157     config.read(conf_file)
 158     config.set('DEFAULT', 'log_file', '{}/tempest.log'.format(deployment_dir))
 159     config.set('oslo_concurrency', 'lock_path',
 160                '{}/lock_files'.format(deployment_dir))
 161     generate_test_accounts_file(tenant_id=tenant_id)
 162     config.set('auth', 'test_accounts_file', TEST_ACCOUNTS_FILE)
 163     config.set('scenario', 'img_dir', '{}'.format(deployment_dir))
 164     config.set('scenario', 'img_file', 'tempest-image')
 165     config.set('compute', 'image_ref', image_id)
 166     config.set('compute', 'image_ref_alt', image_id_alt)
 167     config.set('compute', 'flavor_ref', flavor_id)
 168     config.set('compute', 'flavor_ref_alt', flavor_id_alt)
 169
 170     with open(conf_file, 'wb') as config_file:
 171         config.write(config_file)
 172
 173     confpath = pkg_resources.resource_filename(
 174         'functest',
 175         'opnfv_tests/openstack/refstack_client/refstack_tempest.conf')
 176     shutil.copyfile(conf_file, confpath)
 177
 178
 179 def generate_test_accounts_file(tenant_id):
 180     """
 181     Add needed tenant and user params into test_accounts.yaml
 182     """
 183
 184     logger.debug("Add needed params into test_accounts.yaml...")
 185     accounts_list = [
 186         {
 187             'tenant_name':
 188                 CONST.__getattribute__('tempest_identity_tenant_name'),
 189             'tenant_id': str(tenant_id),
 190             'username': CONST.__getattribute__('tempest_identity_user_name'),
 191             'password':
 192                 CONST.__getattribute__('tempest_identity_user_password')
 193         }
 194     ]
 195
 196     with open(TEST_ACCOUNTS_FILE, "w") as f:
 197         yaml.dump(accounts_list, f, default_flow_style=False)
 198
 199
 200 def configure_tempest_update_params(tempest_conf_file,
 201                                     image_id=None, flavor_id=None):
 202     """
 203     Add/update needed parameters into tempest.conf file
 204     """
 205     logger.debug("Updating selected tempest.conf parameters...")
 206     config = ConfigParser.RawConfigParser()
 207     config.read(tempest_conf_file)
 208     config.set(
 209         'compute',
 210         'fixed_network_name',
 211         CONST.__getattribute__('tempest_private_net_name'))
 212     config.set('compute', 'volume_device_name',
 213                CONST.__getattribute__('tempest_volume_device_name'))
 214     if CONST.__getattribute__('tempest_use_custom_images'):
 215         if image_id is not None:
 216             config.set('compute', 'image_ref', image_id)
 217         if IMAGE_ID_ALT is not None:
 218             config.set('compute', 'image_ref_alt', IMAGE_ID_ALT)
 219     if CONST.__getattribute__('tempest_use_custom_flavors'):
 220         if flavor_id is not None:
 221             config.set('compute', 'flavor_ref', flavor_id)
 222         if FLAVOR_ID_ALT is not None:
 223             config.set('compute', 'flavor_ref_alt', FLAVOR_ID_ALT)
 224     config.set('identity', 'region', 'RegionOne')
 225     if os_utils.is_keystone_v3():
 226         auth_version = 'v3'
 227     else:
 228         auth_version = 'v2'
 229     config.set('identity', 'auth_version', auth_version)
 230     config.set(
 231         'validation', 'ssh_timeout',
 232         CONST.__getattribute__('tempest_validation_ssh_timeout'))
 233     config.set('object-storage', 'operator_role',
 234                CONST.__getattribute__('tempest_object_storage_operator_role'))
 235
 236     if CONST.__getattribute__('OS_ENDPOINT_TYPE') is not None:
 237         sections = config.sections()
 238         if os_utils.is_keystone_v3():
 239             config.set('identity', 'v3_endpoint_type',
 240                        CONST.__getattribute__('OS_ENDPOINT_TYPE'))
 241             if 'identity-feature-enabled' not in sections:
 242                 config.add_section('identity-feature-enabled')
 243                 config.set('identity-feature-enabled', 'api_v2', False)
 244                 config.set('identity-feature-enabled', 'api_v2_admin', False)
 245         services_list = ['compute',
 246                          'volume',
 247                          'image',
 248                          'network',
 249                          'data-processing',
 250                          'object-storage',
 251                          'orchestration']
 252         for service in services_list:
 253             if service not in sections:
 254                 config.add_section(service)
 255             config.set(service, 'endpoint_type',
 256                        CONST.__getattribute__('OS_ENDPOINT_TYPE'))
 257
 258     logger.debug('Add/Update required params defined in tempest_conf.yaml '
 259                  'into tempest.conf file')
 260     with open(TEMPEST_CONF_YAML) as f:
 261         conf_yaml = yaml.safe_load(f)
 262     if conf_yaml:
 263         sections = config.sections()
 264         for section in conf_yaml:
 265             if section not in sections:
 266                 config.add_section(section)
 267             sub_conf = conf_yaml.get(section)
 268             for key, value in sub_conf.items():
 269                 config.set(section, key, value)
 270
 271     with open(tempest_conf_file, 'wb') as config_file:
 272         config.write(config_file)
 273
 274     backup_tempest_config(tempest_conf_file)
 275
 276
 277 def configure_verifier(deployment_dir):
 278     """
 279     Execute rally verify configure-verifier, which generates tempest.conf
 280     """
 281     tempest_conf_file = os.path.join(deployment_dir, "tempest.conf")
 282     if os.path.isfile(tempest_conf_file):
 283         logger.debug("Verifier is already configured.")
 284         logger.debug("Reconfiguring the current verifier...")
 285         cmd = "rally verify configure-verifier --reconfigure"
 286     else:
 287         logger.info("Configuring the verifier...")
 288         cmd = "rally verify configure-verifier"
 289     ft_utils.execute_command(cmd)
 290
 291     logger.debug("Looking for tempest.conf file...")
 292     if not os.path.isfile(tempest_conf_file):
 293         logger.error("Tempest configuration file %s NOT found."
 294                      % tempest_conf_file)
 295         raise Exception("Tempest configuration file %s NOT found."
 296                         % tempest_conf_file)
 297     else:
 298         return tempest_conf_file