testcases/config_functest.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2015 Ericsson
   4 # jose.lausuch@ericsson.com
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10
  11 import re, json, os, urllib2, argparse, logging, shutil, subprocess, yaml, sys, getpass
  12 import functest_utils
  13 from git import Repo
  14 from os import stat
  15 from pwd import getpwuid
  16 from neutronclient.v2_0 import client as neutronclient
  17
  18 actions = ['start', 'check', 'clean']
  19 parser = argparse.ArgumentParser()
  20 parser.add_argument("action", help="Possible actions are: '{d[0]}|{d[1]}|{d[2]}' ".format(d=actions))
  21 parser.add_argument("-d", "--debug", help="Debug mode",  action="store_true")
  22 parser.add_argument("-f", "--force", help="Force",  action="store_true")
  23 args = parser.parse_args()
  24
  25
  26 """ logging configuration """
  27 logger = logging.getLogger('config_functest')
  28 logger.setLevel(logging.DEBUG)
  29
  30 ch = logging.StreamHandler()
  31 if args.debug:
  32     ch.setLevel(logging.DEBUG)
  33 else:
  34     ch.setLevel(logging.INFO)
  35
  36 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
  37 ch.setFormatter(formatter)
  38 logger.addHandler(ch)
  39
  40 REPO_PATH=os.environ['repos_dir']+'/functest/'
  41 if not os.path.exists(REPO_PATH):
  42     logger.error("Functest repository directory not found '%s'" % REPO_PATH)
  43     exit(-1)
  44 sys.path.append(REPO_PATH + "testcases/")
  45
  46 with open(REPO_PATH+"testcases/config_functest.yaml") as f:
  47     functest_yaml = yaml.safe_load(f)
  48 f.close()
  49
  50
  51 """ global variables """
  52 # Directories
  53 RALLY_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_rally")
  54 RALLY_REPO_DIR = functest_yaml.get("general").get("directories").get("dir_repo_rally")
  55 RALLY_INSTALLATION_DIR = functest_yaml.get("general").get("directories").get("dir_rally_inst")
  56 RALLY_RESULT_DIR = functest_yaml.get("general").get("directories").get("dir_rally_res")
  57 VPING_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_vping")
  58 ODL_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_odl")
  59 DATA_DIR = functest_yaml.get("general").get("directories").get("dir_functest_data")
  60
  61 # Tempest/Rally configuration details
  62 DEPLOYMENT_MAME = "opnfv-rally"
  63 RALLY_COMMIT = functest_yaml.get("general").get("openstack").get("rally_stable_commit")
  64
  65 #Image (cirros)
  66 IMAGE_FILE_NAME = functest_yaml.get("general").get("openstack").get("image_file_name")
  67 IMAGE_PATH = DATA_DIR + "/" + IMAGE_FILE_NAME
  68
  69 # NEUTRON Private Network parameters
  70 NEUTRON_PRIVATE_NET_NAME = functest_yaml.get("general"). \
  71     get("openstack").get("neutron_private_net_name")
  72 NEUTRON_PRIVATE_SUBNET_NAME = functest_yaml.get("general"). \
  73     get("openstack").get("neutron_private_subnet_name")
  74 NEUTRON_PRIVATE_SUBNET_CIDR = functest_yaml.get("general"). \
  75     get("openstack").get("neutron_private_subnet_cidr")
  76 NEUTRON_ROUTER_NAME = functest_yaml.get("general"). \
  77     get("openstack").get("neutron_router_name")
  78
  79 creds_neutron = functest_utils.get_credentials("neutron")
  80 neutron_client = neutronclient.Client(**creds_neutron)
  81
  82 def action_start():
  83     """
  84     Start the functest environment installation
  85     """
  86     if not functest_utils.check_internet_connectivity():
  87         logger.error("There is no Internet connectivity. Please check the network configuration.")
  88         exit(-1)
  89
  90     if action_check():
  91         logger.info("Functest environment already installed. Nothing to do.")
  92         exit(0)
  93
  94     else:
  95         # Clean in case there are left overs
  96         logger.debug("Cleaning possible functest environment leftovers.")
  97         action_clean()
  98         logger.info("Starting installation of functest environment")
  99
 100         private_net = functest_utils.get_private_net(neutron_client)
 101         if private_net is None:
 102             # If there is no private network in the deployment we create one
 103             if not create_private_neutron_net(neutron_client):
 104                 logger.error("There has been a problem while creating the functest network.")
 105                 action_clean()
 106                 exit(-1)
 107         else:
 108             logger.info("Private network '%s' already existing in the deployment."
 109                  % private_net['name'])
 110
 111
 112         logger.info("Installing Rally...")
 113         if not install_rally():
 114             logger.error("There has been a problem while installing Rally.")
 115             action_clean()
 116             exit(-1)
 117
 118         logger.info("Configuring Tempest...")
 119         if not configure_tempest():
 120             logger.error("There has been a problem while configuring Tempest.")
 121             action_clean()
 122             exit(-1)
 123
 124         # Create result folder under functest if necessary
 125         if not os.path.exists(RALLY_RESULT_DIR):
 126             os.makedirs(RALLY_RESULT_DIR)
 127
 128         exit(0)
 129
 130
 131 def action_check():
 132     """
 133     Check if the functest environment is properly installed
 134     """
 135     errors_all = False
 136     errors = False
 137     logger.info("Checking current functest configuration...")
 138
 139     logger.debug("Checking script directories...")
 140
 141     dirs = [RALLY_DIR, RALLY_INSTALLATION_DIR, VPING_DIR, ODL_DIR]
 142     for dir in dirs:
 143         if not os.path.exists(dir):
 144             logger.debug("The directory '%s' does NOT exist." % dir)
 145             errors = True
 146             errors_all = True
 147         else:
 148             logger.debug("   %s found" % dir)
 149     if not errors:
 150         logger.debug("...OK")
 151     else:
 152         logger.debug("...FAIL")
 153
 154
 155     logger.debug("Checking Rally deployment...")
 156     if not check_rally():
 157         logger.debug("   Rally deployment NOT installed.")
 158         errors_all = True
 159         logger.debug("...FAIL")
 160     else:
 161         logger.debug("...OK")
 162
 163     logger.debug("Checking Image...")
 164     errors = False
 165     if not os.path.isfile(IMAGE_PATH):
 166         logger.debug("   Image file '%s' NOT found." % IMAGE_PATH)
 167         errors = True
 168         errors_all = True
 169     else:
 170         logger.debug("   Image file found in %s" % IMAGE_PATH)
 171
 172
 173     if not errors:
 174         logger.debug("...OK")
 175     else:
 176         logger.debug("...FAIL")
 177
 178     #TODO: check OLD environment setup
 179     return not errors_all
 180
 181
 182
 183 def action_clean():
 184     """
 185     Clean the existing functest environment
 186     """
 187     logger.info("Removing current functest environment...")
 188     if os.path.exists(RALLY_INSTALLATION_DIR):
 189         logger.debug("Removing Rally installation directory %s" % RALLY_INSTALLATION_DIR)
 190         shutil.rmtree(RALLY_INSTALLATION_DIR,ignore_errors=True)
 191
 192     if os.path.exists(RALLY_RESULT_DIR):
 193         logger.debug("Removing Result directory")
 194         shutil.rmtree(RALLY_RESULT_DIR,ignore_errors=True)
 195
 196     logger.debug("Cleaning up the OpenStack deployment...")
 197     cmd='python ' + REPO_PATH + \
 198         '/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py -d '
 199     functest_utils.execute_command(cmd,logger)
 200     logger.info("Functest environment clean!")
 201
 202
 203
 204 def install_rally():
 205     if check_rally():
 206         logger.info("Rally is already installed.")
 207     else:
 208         logger.debug("Executing %s/install_rally.sh..." %RALLY_REPO_DIR)
 209         install_script = RALLY_REPO_DIR + "/install_rally.sh --yes"
 210         cmd = 'sudo ' + install_script
 211         functest_utils.execute_command(cmd,logger)
 212
 213         logger.debug("Creating Rally environment...")
 214         cmd = "rally deployment create --fromenv --name="+DEPLOYMENT_MAME
 215         functest_utils.execute_command(cmd,logger)
 216
 217         logger.debug("Installing tempest...")
 218         cmd = "rally verify install"
 219         functest_utils.execute_command(cmd,logger)
 220
 221         cmd = "rally deployment check"
 222         functest_utils.execute_command(cmd,logger)
 223         #TODO: check that everything is 'Available' and warn if not
 224
 225         cmd = "rally show images"
 226         functest_utils.execute_command(cmd,logger)
 227
 228         cmd = "rally show flavors"
 229         functest_utils.execute_command(cmd,logger)
 230
 231     return True
 232
 233
 234 def configure_tempest():
 235     """
 236     Add/update needed parameters into tempest.conf file generated by Rally
 237     """
 238
 239     creds_neutron = functest_utils.get_credentials("neutron")
 240     neutron_client = neutronclient.Client(**creds_neutron)
 241
 242     logger.debug("Generating tempest.conf file...")
 243     cmd = "rally verify genconfig"
 244     functest_utils.execute_command(cmd,logger)
 245
 246     logger.debug("Resolving deployment UUID...")
 247     cmd = "rally deployment list | awk '/"+DEPLOYMENT_MAME+"/ {print $2}'"
 248     p = subprocess.Popen(cmd, shell=True,
 249                          stdout=subprocess.PIPE,
 250                          stderr=subprocess.STDOUT);
 251     deployment_uuid = p.stdout.readline().rstrip()
 252     if deployment_uuid == "":
 253         logger.debug("   Rally deployment NOT found")
 254         return False
 255
 256     logger.debug("Finding tempest.conf file...")
 257     tempest_conf_file = RALLY_INSTALLATION_DIR+"/tempest/for-deployment-" \
 258                         +deployment_uuid+"/tempest.conf"
 259
 260     logger.debug("  Updating fixed_network_name...")
 261     fixed_network = functest_utils.get_network_list(neutron_client)[0]['name']
 262     if fixed_network != None:
 263         cmd = "crudini --set "+tempest_conf_file+" compute fixed_network_name "+fixed_network
 264         functest_utils.execute_command(cmd,logger)
 265
 266     return True
 267
 268
 269 def check_rally():
 270     """
 271     Check if Rally is installed and properly configured
 272     """
 273     if os.path.exists(RALLY_INSTALLATION_DIR):
 274         logger.debug("   Rally installation directory found in %s" % RALLY_INSTALLATION_DIR)
 275         FNULL = open(os.devnull, 'w');
 276         cmd="rally deployment list | grep "+DEPLOYMENT_MAME
 277         logger.debug('   Executing command : {}'.format(cmd))
 278         p=subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE,stderr=FNULL);
 279         #if the command does not exist or there is no deployment
 280         line = p.stdout.readline()
 281         if line == "":
 282             logger.debug("   Rally deployment NOT found")
 283             return False
 284         logger.debug("   Rally deployment found")
 285         return True
 286     else:
 287         return False
 288
 289
 290 def create_private_neutron_net(neutron):
 291     neutron.format = 'json'
 292     logger.info('Creating neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
 293     network_id = functest_utils. \
 294         create_neutron_net(neutron, NEUTRON_PRIVATE_NET_NAME)
 295
 296     if not network_id:
 297         return False
 298     logger.debug("Network '%s' created successfully" % network_id)
 299     logger.debug('Creating Subnet....')
 300     subnet_id = functest_utils. \
 301         create_neutron_subnet(neutron,
 302                               NEUTRON_PRIVATE_SUBNET_NAME,
 303                               NEUTRON_PRIVATE_SUBNET_CIDR,
 304                               network_id)
 305     if not subnet_id:
 306         return False
 307     logger.debug("Subnet '%s' created successfully" % subnet_id)
 308     logger.debug('Creating Router...')
 309     router_id = functest_utils. \
 310         create_neutron_router(neutron, NEUTRON_ROUTER_NAME)
 311
 312     if not router_id:
 313         return False
 314
 315     logger.debug("Router '%s' created successfully" % router_id)
 316     logger.debug('Adding router to subnet...')
 317
 318     result = functest_utils.add_interface_router(neutron, router_id, subnet_id)
 319
 320     if not result:
 321         return False
 322
 323     logger.debug("Interface added successfully.")
 324     network_dic = {'net_id': network_id,
 325                    'subnet_id': subnet_id,
 326                    'router_id': router_id}
 327     return True
 328
 329
 330 def main():
 331     if not (args.action in actions):
 332         logger.error('argument not valid')
 333         exit(-1)
 334
 335
 336     if not functest_utils.check_credentials():
 337         logger.error("Please source the openrc credentials and run the script again.")
 338         #TODO: source the credentials in this script
 339         exit(-1)
 340
 341
 342     if args.action == "start":
 343         action_start()
 344
 345     if args.action == "check":
 346         if action_check():
 347             logger.info("Functest environment correctly installed")
 348         else:
 349             logger.info("Functest environment not found or faulty")
 350
 351     if args.action == "clean":
 352         if args.force :
 353             action_clean()
 354         else :
 355             while True:
 356                 print("Are you sure? [y|n]")
 357                 answer = raw_input("")
 358                 if answer == "y":
 359                     action_clean()
 360                     break
 361                 elif answer == "n":
 362                     break
 363                 else:
 364                     print("Invalid option.")
 365     exit(0)
 366
 367
 368 if __name__ == '__main__':
 369     main()
 370