utils/openstack_utils.py

   1 #!/usr/bin/env python
   2 #
   3 # jose.lausuch@ericsson.com
   4 # valentin.boucher@orange.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 os
  12 import os.path
  13 import subprocess
  14 import sys
  15 import time
  16
  17 from cinderclient import client as cinderclient
  18 import functest.utils.functest_logger as ft_logger
  19 import functest.utils.functest_utils as ft_utils
  20 from glanceclient import client as glanceclient
  21 from keystoneclient.v2_0 import client as keystoneclient
  22 from neutronclient.v2_0 import client as neutronclient
  23 from novaclient import client as novaclient
  24
  25 logger = ft_logger.Logger("openstack_utils").getLogger()
  26
  27
  28 # *********************************************
  29 #   CREDENTIALS
  30 # *********************************************
  31 def check_credentials():
  32     """
  33     Check if the OpenStack credentials (openrc) are sourced
  34     """
  35     env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
  36     return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
  37
  38
  39 def get_credentials(service):
  40     """Returns a creds dictionary filled with the following keys:
  41     * username
  42     * password/api_key (depending on the service)
  43     * tenant_name/project_id (depending on the service)
  44     * auth_url
  45     :param service: a string indicating the name of the service
  46                     requesting the credentials.
  47     """
  48     creds = {}
  49
  50     # Check that the env vars exists:
  51     envvars = ('OS_USERNAME', 'OS_PASSWORD', 'OS_AUTH_URL', 'OS_TENANT_NAME')
  52     for envvar in envvars:
  53         if os.getenv(envvar) is None:
  54             logger.error("'%s' is not exported as an env variable." % envvar)
  55             exit(-1)
  56
  57     # Unfortunately, each of the OpenStack client will request slightly
  58     # different entries in their credentials dict.
  59     if service.lower() in ("nova", "cinder"):
  60         password = "api_key"
  61         tenant = "project_id"
  62     else:
  63         password = "password"
  64         tenant = "tenant_name"
  65
  66     # The most common way to pass these info to the script is to do it through
  67     # environment variables.
  68     creds.update({
  69         "username": os.environ.get("OS_USERNAME"),
  70         password: os.environ.get("OS_PASSWORD"),
  71         "auth_url": os.environ.get("OS_AUTH_URL"),
  72         tenant: os.environ.get("OS_TENANT_NAME")
  73     })
  74     if os.getenv('OS_ENDPOINT_TYPE') is not None:
  75         creds.update({
  76             "endpoint_type": os.environ.get("OS_ENDPOINT_TYPE")
  77         })
  78     if os.getenv('OS_REGION_NAME') is not None:
  79         creds.update({
  80             "region_name": os.environ.get("OS_REGION_NAME")
  81         })
  82     cacert = os.environ.get("OS_CACERT")
  83     if cacert is not None:
  84         # each openstack client uses differnt kwargs for this
  85         creds.update({"cacert": cacert,
  86                       "ca_cert": cacert,
  87                       "https_ca_cert": cacert,
  88                       "https_cacert": cacert,
  89                       "ca_file": cacert})
  90         creds.update({"insecure": "True", "https_insecure": "True"})
  91         if not os.path.isfile(cacert):
  92             logger.info("WARNING: The 'OS_CACERT' environment variable is "
  93                         "set to %s but the file does not exist." % cacert)
  94     return creds
  95
  96
  97 def source_credentials(rc_file):
  98     pipe = subprocess.Popen(". %s; env" % rc_file, stdout=subprocess.PIPE,
  99                             shell=True)
 100     output = pipe.communicate()[0]
 101     env = dict((line.split("=", 1) for line in output.splitlines()))
 102     os.environ.update(env)
 103     return env
 104
 105
 106 def get_credentials_for_rally():
 107     creds = get_credentials("keystone")
 108     admin_keys = ['username', 'tenant_name', 'password']
 109     endpoint_types = [('internalURL', 'internal'),
 110                       ('publicURL', 'public'), ('adminURL', 'admin')]
 111     if 'endpoint_type' in creds.keys():
 112         for k, v in endpoint_types:
 113             if creds['endpoint_type'] == k:
 114                 creds['endpoint_type'] = v
 115     rally_conf = {"type": "ExistingCloud", "admin": {}}
 116     for key in creds:
 117         if key in admin_keys:
 118             rally_conf['admin'][key] = creds[key]
 119         else:
 120             rally_conf[key] = creds[key]
 121     return rally_conf
 122
 123
 124 # *********************************************
 125 #   CLIENTS
 126 # *********************************************
 127 def get_keystone_client():
 128     creds_keystone = get_credentials("keystone")
 129     return keystoneclient.Client(**creds_keystone)
 130
 131
 132 def get_nova_client():
 133     creds_nova = get_credentials("nova")
 134     return novaclient.Client('2', **creds_nova)
 135
 136
 137 def get_cinder_client():
 138     creds_cinder = get_credentials("cinder")
 139     creds_cinder.update({
 140         "service_type": "volume"
 141     })
 142     return cinderclient.Client('2', **creds_cinder)
 143
 144
 145 def get_neutron_client():
 146     creds_neutron = get_credentials("neutron")
 147     return neutronclient.Client(**creds_neutron)
 148
 149
 150 def get_glance_client():
 151     keystone_client = get_keystone_client()
 152     glance_endpoint_type = 'publicURL'
 153     os_endpoint_type = os.getenv('OS_ENDPOINT_TYPE')
 154     if os_endpoint_type is not None:
 155         glance_endpoint_type = os_endpoint_type
 156     glance_endpoint = keystone_client.service_catalog.url_for(
 157         service_type='image', endpoint_type=glance_endpoint_type)
 158     return glanceclient.Client(1, glance_endpoint,
 159                                token=keystone_client.auth_token)
 160
 161 # *********************************************
 162 #   NOVA
 163 # *********************************************
 164
 165
 166 def get_instances(nova_client):
 167     try:
 168         instances = nova_client.servers.list(search_opts={'all_tenants': 1})
 169         return instances
 170     except Exception, e:
 171         logger.error("Error [get_instances(nova_client)]: %s" % e)
 172         return None
 173
 174
 175 def get_instance_status(nova_client, instance):
 176     try:
 177         instance = nova_client.servers.get(instance.id)
 178         return instance.status
 179     except Exception, e:
 180         logger.error("Error [get_instance_status(nova_client)]: %s" % e)
 181         return None
 182
 183
 184 def get_instance_by_name(nova_client, instance_name):
 185     try:
 186         instance = nova_client.servers.find(name=instance_name)
 187         return instance
 188     except Exception, e:
 189         logger.error("Error [get_instance_by_name(nova_client, '%s')]: %s"
 190                      % (instance_name, e))
 191         return None
 192
 193
 194 def get_flavor_id(nova_client, flavor_name):
 195     flavors = nova_client.flavors.list(detailed=True)
 196     id = ''
 197     for f in flavors:
 198         if f.name == flavor_name:
 199             id = f.id
 200             break
 201     return id
 202
 203
 204 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
 205     flavors = nova_client.flavors.list(detailed=True)
 206     id = ''
 207     for f in flavors:
 208         if min_ram <= f.ram and f.ram <= max_ram:
 209             id = f.id
 210             break
 211     return id
 212
 213
 214 def get_floating_ips(nova_client):
 215     try:
 216         floating_ips = nova_client.floating_ips.list()
 217         return floating_ips
 218     except Exception, e:
 219         logger.error("Error [get_floating_ips(nova_client)]: %s" % e)
 220         return None
 221
 222
 223 def get_hypervisors(nova_client):
 224     try:
 225         nodes = []
 226         hypervisors = nova_client.hypervisors.list()
 227         for hypervisor in hypervisors:
 228             if hypervisor.state == "up":
 229                 nodes.append(hypervisor.hypervisor_hostname)
 230         return nodes
 231     except Exception, e:
 232         logger.error("Error [get_hypervisors(nova_client)]: %s" % e)
 233         return None
 234
 235
 236 def create_flavor(nova_client, flavor_name, ram, disk, vcpus):
 237     try:
 238         flavor = nova_client.flavors.create(flavor_name, ram, vcpus, disk)
 239         try:
 240             extra_specs = ft_utils.get_functest_config(
 241                 'general.flavor_extra_specs')
 242             flavor.set_keys(extra_specs)
 243         except ValueError:
 244             # flavor extra specs are not configured, therefore skip the update
 245             pass
 246
 247     except Exception, e:
 248         logger.error("Error [create_flavor(nova_client, '%s', '%s', '%s', "
 249                      "'%s')]: %s" % (flavor_name, ram, disk, vcpus, e))
 250         return None
 251     return flavor.id
 252
 253
 254 def create_instance(flavor_name,
 255                     image_id,
 256                     network_id,
 257                     instance_name="functest-vm",
 258                     confdrive=True,
 259                     userdata=None,
 260                     av_zone='',
 261                     fixed_ip=None,
 262                     files=None):
 263     nova_client = get_nova_client()
 264     try:
 265         flavor = nova_client.flavors.find(name=flavor_name)
 266     except:
 267         flavors = nova_client.flavors.list()
 268         logger.error("Error: Flavor '%s' not found. Available flavors are: "
 269                      "\n%s" % (flavor_name, flavors))
 270         return None
 271     if fixed_ip is not None:
 272         nics = {"net-id": network_id, "v4-fixed-ip": fixed_ip}
 273     else:
 274         nics = {"net-id": network_id}
 275     if userdata is None:
 276         instance = nova_client.servers.create(
 277             name=instance_name,
 278             flavor=flavor,
 279             image=image_id,
 280             nics=[nics],
 281             availability_zone=av_zone,
 282             files=files
 283         )
 284     else:
 285         instance = nova_client.servers.create(
 286             name=instance_name,
 287             flavor=flavor,
 288             image=image_id,
 289             nics=[nics],
 290             config_drive=confdrive,
 291             userdata=userdata,
 292             availability_zone=av_zone,
 293             files=files
 294         )
 295     return instance
 296
 297
 298 def create_instance_and_wait_for_active(flavor_name,
 299                                         image_id,
 300                                         network_id,
 301                                         instance_name="",
 302                                         config_drive=False,
 303                                         userdata="",
 304                                         av_zone='',
 305                                         fixed_ip=None,
 306                                         files=None):
 307     SLEEP = 3
 308     VM_BOOT_TIMEOUT = 180
 309     nova_client = get_nova_client()
 310     instance = create_instance(flavor_name,
 311                                image_id,
 312                                network_id,
 313                                instance_name,
 314                                config_drive,
 315                                userdata,
 316                                av_zone=av_zone,
 317                                fixed_ip=fixed_ip,
 318                                files=files)
 319     count = VM_BOOT_TIMEOUT / SLEEP
 320     for n in range(count, -1, -1):
 321         status = get_instance_status(nova_client, instance)
 322         if status.lower() == "active":
 323             return instance
 324         elif status.lower() == "error":
 325             logger.error("The instance %s went to ERROR status."
 326                          % instance_name)
 327             return None
 328         time.sleep(SLEEP)
 329     logger.error("Timeout booting the instance %s." % instance_name)
 330     return None
 331
 332
 333 def create_floating_ip(neutron_client):
 334     extnet_id = get_external_net_id(neutron_client)
 335     props = {'floating_network_id': extnet_id}
 336     try:
 337         ip_json = neutron_client.create_floatingip({'floatingip': props})
 338         fip_addr = ip_json['floatingip']['floating_ip_address']
 339         fip_id = ip_json['floatingip']['id']
 340     except Exception, e:
 341         logger.error("Error [create_floating_ip(neutron_client)]: %s" % e)
 342         return None
 343     return {'fip_addr': fip_addr, 'fip_id': fip_id}
 344
 345
 346 def add_floating_ip(nova_client, server_id, floatingip_id):
 347     try:
 348         nova_client.servers.add_floating_ip(server_id, floatingip_id)
 349         return True
 350     except Exception, e:
 351         logger.error("Error [add_floating_ip(nova_client, '%s', '%s')]: %s"
 352                      % (server_id, floatingip_id, e))
 353         return False
 354
 355
 356 def delete_instance(nova_client, instance_id):
 357     try:
 358         nova_client.servers.force_delete(instance_id)
 359         return True
 360     except Exception, e:
 361         logger.error("Error [delete_instance(nova_client, '%s')]: %s"
 362                      % (instance_id, e))
 363         return False
 364
 365
 366 def delete_floating_ip(nova_client, floatingip_id):
 367     try:
 368         nova_client.floating_ips.delete(floatingip_id)
 369         return True
 370     except Exception, e:
 371         logger.error("Error [delete_floating_ip(nova_client, '%s')]:"
 372                      % (floatingip_id, e))
 373         return False
 374
 375
 376 # *********************************************
 377 #   NEUTRON
 378 # *********************************************
 379 def get_network_list(neutron_client):
 380     network_list = neutron_client.list_networks()['networks']
 381     if len(network_list) == 0:
 382         return None
 383     else:
 384         return network_list
 385
 386
 387 def get_router_list(neutron_client):
 388     router_list = neutron_client.list_routers()['routers']
 389     if len(router_list) == 0:
 390         return None
 391     else:
 392         return router_list
 393
 394
 395 def get_port_list(neutron_client):
 396     port_list = neutron_client.list_ports()['ports']
 397     if len(port_list) == 0:
 398         return None
 399     else:
 400         return port_list
 401
 402
 403 def get_network_id(neutron_client, network_name):
 404     networks = neutron_client.list_networks()['networks']
 405     id = ''
 406     for n in networks:
 407         if n['name'] == network_name:
 408             id = n['id']
 409             break
 410     return id
 411
 412
 413 def get_subnet_id(neutron_client, subnet_name):
 414     subnets = neutron_client.list_subnets()['subnets']
 415     id = ''
 416     for s in subnets:
 417         if s['name'] == subnet_name:
 418             id = s['id']
 419             break
 420     return id
 421
 422
 423 def get_router_id(neutron_client, router_name):
 424     routers = neutron_client.list_routers()['routers']
 425     id = ''
 426     for r in routers:
 427         if r['name'] == router_name:
 428             id = r['id']
 429             break
 430     return id
 431
 432
 433 def get_private_net(neutron_client):
 434     # Checks if there is an existing shared private network
 435     networks = neutron_client.list_networks()['networks']
 436     if len(networks) == 0:
 437         return None
 438     for net in networks:
 439         if (net['router:external'] is False) and (net['shared'] is True):
 440             return net
 441     return None
 442
 443
 444 def get_external_net(neutron_client):
 445     for network in neutron_client.list_networks()['networks']:
 446         if network['router:external']:
 447             return network['name']
 448     return None
 449
 450
 451 def get_external_net_id(neutron_client):
 452     for network in neutron_client.list_networks()['networks']:
 453         if network['router:external']:
 454             return network['id']
 455     return None
 456
 457
 458 def check_neutron_net(neutron_client, net_name):
 459     for network in neutron_client.list_networks()['networks']:
 460         if network['name'] == net_name:
 461             for subnet in network['subnets']:
 462                 return True
 463     return False
 464
 465
 466 def create_neutron_net(neutron_client, name):
 467     json_body = {'network': {'name': name,
 468                              'admin_state_up': True}}
 469     try:
 470         network = neutron_client.create_network(body=json_body)
 471         network_dict = network['network']
 472         return network_dict['id']
 473     except Exception, e:
 474         logger.error("Error [create_neutron_net(neutron_client, '%s')]: %s"
 475                      % (name, e))
 476         return None
 477
 478
 479 def create_neutron_subnet(neutron_client, name, cidr, net_id):
 480     json_body = {'subnets': [{'name': name, 'cidr': cidr,
 481                               'ip_version': 4, 'network_id': net_id}]}
 482     try:
 483         subnet = neutron_client.create_subnet(body=json_body)
 484         return subnet['subnets'][0]['id']
 485     except Exception, e:
 486         logger.error("Error [create_neutron_subnet(neutron_client, '%s', "
 487                      "'%s', '%s')]: %s" % (name, cidr, net_id, e))
 488         return None
 489
 490
 491 def create_neutron_router(neutron_client, name):
 492     json_body = {'router': {'name': name, 'admin_state_up': True}}
 493     try:
 494         router = neutron_client.create_router(json_body)
 495         return router['router']['id']
 496     except Exception, e:
 497         logger.error("Error [create_neutron_router(neutron_client, '%s')]: %s"
 498                      % (name, e))
 499         return None
 500
 501
 502 def create_neutron_port(neutron_client, name, network_id, ip):
 503     json_body = {'port': {
 504                  'admin_state_up': True,
 505                  'name': name,
 506                  'network_id': network_id,
 507                  'fixed_ips': [{"ip_address": ip}]
 508                  }}
 509     try:
 510         port = neutron_client.create_port(body=json_body)
 511         return port['port']['id']
 512     except Exception, e:
 513         logger.error("Error [create_neutron_port(neutron_client, '%s', '%s', "
 514                      "'%s')]: %s" % (name, network_id, ip, e))
 515         return None
 516
 517
 518 def update_neutron_net(neutron_client, network_id, shared=False):
 519     json_body = {'network': {'shared': shared}}
 520     try:
 521         neutron_client.update_network(network_id, body=json_body)
 522         return True
 523     except Exception, e:
 524         logger.error("Error [update_neutron_net(neutron_client, '%s', '%s')]: "
 525                      "%s" % (network_id, str(shared), e))
 526         return False
 527
 528
 529 def update_neutron_port(neutron_client, port_id, device_owner):
 530     json_body = {'port': {
 531                  'device_owner': device_owner,
 532                  }}
 533     try:
 534         port = neutron_client.update_port(port=port_id,
 535                                           body=json_body)
 536         return port['port']['id']
 537     except Exception, e:
 538         logger.error("Error [update_neutron_port(neutron_client, '%s', '%s')]:"
 539                      " %s" % (port_id, device_owner, e))
 540         return None
 541
 542
 543 def add_interface_router(neutron_client, router_id, subnet_id):
 544     json_body = {"subnet_id": subnet_id}
 545     try:
 546         neutron_client.add_interface_router(router=router_id, body=json_body)
 547         return True
 548     except Exception, e:
 549         logger.error("Error [add_interface_router(neutron_client, '%s', "
 550                      "'%s')]: %s" % (router_id, subnet_id, e))
 551         return False
 552
 553
 554 def add_gateway_router(neutron_client, router_id):
 555     ext_net_id = get_external_net_id(neutron_client)
 556     router_dict = {'network_id': ext_net_id}
 557     try:
 558         neutron_client.add_gateway_router(router_id, router_dict)
 559         return True
 560     except Exception, e:
 561         logger.error("Error [add_gateway_router(neutron_client, '%s')]: %s"
 562                      % (router_id, e))
 563         return False
 564
 565
 566 def delete_neutron_net(neutron_client, network_id):
 567     try:
 568         neutron_client.delete_network(network_id)
 569         return True
 570     except Exception, e:
 571         logger.error("Error [delete_neutron_net(neutron_client, '%s')]: %s"
 572                      % (network_id, e))
 573         return False
 574
 575
 576 def delete_neutron_subnet(neutron_client, subnet_id):
 577     try:
 578         neutron_client.delete_subnet(subnet_id)
 579         return True
 580     except Exception, e:
 581         logger.error("Error [delete_neutron_subnet(neutron_client, '%s')]: %s"
 582                      % (subnet_id, e))
 583         return False
 584
 585
 586 def delete_neutron_router(neutron_client, router_id):
 587     try:
 588         neutron_client.delete_router(router=router_id)
 589         return True
 590     except Exception, e:
 591         logger.error("Error [delete_neutron_router(neutron_client, '%s')]: %s"
 592                      % (router_id, e))
 593         return False
 594
 595
 596 def delete_neutron_port(neutron_client, port_id):
 597     try:
 598         neutron_client.delete_port(port_id)
 599         return True
 600     except Exception, e:
 601         logger.error("Error [delete_neutron_port(neutron_client, '%s')]: %s"
 602                      % (port_id, e))
 603         return False
 604
 605
 606 def remove_interface_router(neutron_client, router_id, subnet_id):
 607     json_body = {"subnet_id": subnet_id}
 608     try:
 609         neutron_client.remove_interface_router(router=router_id,
 610                                                body=json_body)
 611         return True
 612     except Exception, e:
 613         logger.error("Error [remove_interface_router(neutron_client, '%s', "
 614                      "'%s')]: %s" % (router_id, subnet_id, e))
 615         return False
 616
 617
 618 def remove_gateway_router(neutron_client, router_id):
 619     try:
 620         neutron_client.remove_gateway_router(router_id)
 621         return True
 622     except Exception, e:
 623         logger.error("Error [remove_gateway_router(neutron_client, '%s')]: %s"
 624                      % (router_id, e))
 625         return False
 626
 627
 628 def create_network_full(neutron_client,
 629                         net_name,
 630                         subnet_name,
 631                         router_name,
 632                         cidr):
 633
 634     # Check if the network already exists
 635     network_id = get_network_id(neutron_client, net_name)
 636     subnet_id = get_subnet_id(neutron_client, subnet_name)
 637     router_id = get_router_id(neutron_client, router_name)
 638
 639     if network_id != '' and subnet_id != '' and router_id != '':
 640         logger.info("A network with name '%s' already exists..." % net_name)
 641     else:
 642         neutron_client.format = 'json'
 643         logger.info('Creating neutron network %s...' % net_name)
 644         network_id = create_neutron_net(neutron_client, net_name)
 645
 646         if not network_id:
 647             return False
 648
 649         logger.debug("Network '%s' created successfully" % network_id)
 650         logger.debug('Creating Subnet....')
 651         subnet_id = create_neutron_subnet(neutron_client, subnet_name,
 652                                           cidr, network_id)
 653         if not subnet_id:
 654             return None
 655
 656         logger.debug("Subnet '%s' created successfully" % subnet_id)
 657         logger.debug('Creating Router...')
 658         router_id = create_neutron_router(neutron_client, router_name)
 659
 660         if not router_id:
 661             return None
 662
 663         logger.debug("Router '%s' created successfully" % router_id)
 664         logger.debug('Adding router to subnet...')
 665
 666         if not add_interface_router(neutron_client, router_id, subnet_id):
 667             return None
 668
 669         logger.debug("Interface added successfully.")
 670
 671         logger.debug('Adding gateway to router...')
 672         if not add_gateway_router(neutron_client, router_id):
 673             return None
 674
 675         logger.debug("Gateway added successfully.")
 676
 677     network_dic = {'net_id': network_id,
 678                    'subnet_id': subnet_id,
 679                    'router_id': router_id}
 680     return network_dic
 681
 682
 683 def create_shared_network_full(net_name, subnt_name, router_name, subnet_cidr):
 684     neutron_client = get_neutron_client()
 685
 686     network_dic = create_network_full(neutron_client,
 687                                       net_name,
 688                                       subnt_name,
 689                                       router_name,
 690                                       subnet_cidr)
 691     if network_dic:
 692         if not update_neutron_net(neutron_client,
 693                                   network_dic['net_id'],
 694                                   shared=True):
 695             logger.error("Failed to update network %s..." % net_name)
 696             return None
 697         else:
 698             logger.debug("Network '%s' is available..." % net_name)
 699     else:
 700         logger.error("Network %s creation failed" % net_name)
 701         return None
 702     return network_dic
 703
 704
 705 def create_bgpvpn(neutron_client, **kwargs):
 706     # route_distinguishers
 707     # route_targets
 708     json_body = {"bgpvpn": kwargs}
 709     return neutron_client.create_bgpvpn(json_body)
 710
 711
 712 def create_network_association(neutron_client, bgpvpn_id, neutron_network_id):
 713     json_body = {"network_association": {"network_id": neutron_network_id}}
 714     return neutron_client.create_network_association(bgpvpn_id, json_body)
 715
 716
 717 def create_router_association(neutron_client, bgpvpn_id, router_id):
 718     json_body = {"router_association": {"router_id": router_id}}
 719     return neutron_client.create_router_association(bgpvpn_id, json_body)
 720
 721
 722 def update_bgpvpn(neutron_client, bgpvpn_id, **kwargs):
 723     json_body = {"bgpvpn": kwargs}
 724     return neutron_client.update_bgpvpn(bgpvpn_id, json_body)
 725
 726
 727 def delete_bgpvpn(neutron_client, bgpvpn_id):
 728     return neutron_client.delete_bgpvpn(bgpvpn_id)
 729
 730 # *********************************************
 731 #   SEC GROUPS
 732 # *********************************************
 733
 734
 735 def get_security_groups(neutron_client):
 736     try:
 737         security_groups = neutron_client.list_security_groups()[
 738             'security_groups']
 739         return security_groups
 740     except Exception, e:
 741         logger.error("Error [get_security_groups(neutron_client)]: %s" % e)
 742         return None
 743
 744
 745 def get_security_group_id(neutron_client, sg_name):
 746     security_groups = get_security_groups(neutron_client)
 747     id = ''
 748     for sg in security_groups:
 749         if sg['name'] == sg_name:
 750             id = sg['id']
 751             break
 752     return id
 753
 754
 755 def create_security_group(neutron_client, sg_name, sg_description):
 756     json_body = {'security_group': {'name': sg_name,
 757                                     'description': sg_description}}
 758     try:
 759         secgroup = neutron_client.create_security_group(json_body)
 760         return secgroup['security_group']
 761     except Exception, e:
 762         logger.error("Error [create_security_group(neutron_client, '%s', "
 763                      "'%s')]: %s" % (sg_name, sg_description, e))
 764         return None
 765
 766
 767 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
 768                          port_range_min=None, port_range_max=None):
 769     if port_range_min is None and port_range_max is None:
 770         json_body = {'security_group_rule': {'direction': direction,
 771                                              'security_group_id': sg_id,
 772                                              'protocol': protocol}}
 773     elif port_range_min is not None and port_range_max is not None:
 774         json_body = {'security_group_rule': {'direction': direction,
 775                                              'security_group_id': sg_id,
 776                                              'port_range_min': port_range_min,
 777                                              'port_range_max': port_range_max,
 778                                              'protocol': protocol}}
 779     else:
 780         logger.error("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
 781                      "'%s', '%s', '%s', '%s')]:" % (neutron_client,
 782                                                     sg_id, direction,
 783                                                     port_range_min,
 784                                                     port_range_max,
 785                                                     protocol),
 786                      " Invalid values for port_range_min, port_range_max")
 787         return False
 788     try:
 789         neutron_client.create_security_group_rule(json_body)
 790         return True
 791     except Exception, e:
 792         logger.error("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
 793                      "'%s', '%s', '%s', '%s')]: %s" % (neutron_client,
 794                                                        sg_id,
 795                                                        direction,
 796                                                        port_range_min,
 797                                                        port_range_max,
 798                                                        protocol, e))
 799         return False
 800
 801
 802 def create_security_group_full(neutron_client,
 803                                sg_name, sg_description):
 804     sg_id = get_security_group_id(neutron_client, sg_name)
 805     if sg_id != '':
 806         logger.info("Using existing security group '%s'..." % sg_name)
 807     else:
 808         logger.info("Creating security group  '%s'..." % sg_name)
 809         SECGROUP = create_security_group(neutron_client,
 810                                          sg_name,
 811                                          sg_description)
 812         if not SECGROUP:
 813             logger.error("Failed to create the security group...")
 814             return None
 815
 816         sg_id = SECGROUP['id']
 817
 818         logger.debug("Security group '%s' with ID=%s created successfully."
 819                      % (SECGROUP['name'], sg_id))
 820
 821         logger.debug("Adding ICMP rules in security group '%s'..."
 822                      % sg_name)
 823         if not create_secgroup_rule(neutron_client, sg_id,
 824                                     'ingress', 'icmp'):
 825             logger.error("Failed to create the security group rule...")
 826             return None
 827
 828         logger.debug("Adding SSH rules in security group '%s'..."
 829                      % sg_name)
 830         if not create_secgroup_rule(
 831                 neutron_client, sg_id, 'ingress', 'tcp', '22', '22'):
 832             logger.error("Failed to create the security group rule...")
 833             return None
 834
 835         if not create_secgroup_rule(
 836                 neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
 837             logger.error("Failed to create the security group rule...")
 838             return None
 839     return sg_id
 840
 841
 842 def add_secgroup_to_instance(nova_client, instance_id, secgroup_id):
 843     try:
 844         nova_client.servers.add_security_group(instance_id, secgroup_id)
 845         return True
 846     except Exception, e:
 847         logger.error("Error [add_secgroup_to_instance(nova_client, '%s', "
 848                      "'%s')]: %s" % (instance_id, secgroup_id, e))
 849         return False
 850
 851
 852 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
 853     json_body = {"quota": {
 854         "security_group": sg_quota,
 855         "security_group_rule": sg_rule_quota
 856     }}
 857
 858     try:
 859         neutron_client.update_quota(tenant_id=tenant_id,
 860                                     body=json_body)
 861         return True
 862     except Exception, e:
 863         logger.error("Error [update_sg_quota(neutron_client, '%s', '%s', "
 864                      "'%s')]: %s" % (tenant_id, sg_quota, sg_rule_quota, e))
 865         return False
 866
 867
 868 def delete_security_group(neutron_client, secgroup_id):
 869     try:
 870         neutron_client.delete_security_group(secgroup_id)
 871         return True
 872     except Exception, e:
 873         logger.error("Error [delete_security_group(neutron_client, '%s')]: %s"
 874                      % (secgroup_id, e))
 875         return False
 876
 877
 878 # *********************************************
 879 #   GLANCE
 880 # *********************************************
 881 def get_images(nova_client):
 882     try:
 883         images = nova_client.images.list()
 884         return images
 885     except Exception, e:
 886         logger.error("Error [get_images]: %s" % e)
 887         return None
 888
 889
 890 def get_image_id(glance_client, image_name):
 891     images = glance_client.images.list()
 892     id = ''
 893     for i in images:
 894         if i.name == image_name:
 895             id = i.id
 896             break
 897     return id
 898
 899
 900 def create_glance_image(glance_client, image_name, file_path, disk="qcow2",
 901                         container="bare", public=True):
 902     if not os.path.isfile(file_path):
 903         logger.error("Error: file %s does not exist." % file_path)
 904         return None
 905     try:
 906         image_id = get_image_id(glance_client, image_name)
 907         if image_id != '':
 908             if logger:
 909                 logger.info("Image %s already exists." % image_name)
 910         else:
 911             if logger:
 912                 logger.info("Creating image '%s' from '%s'..." % (image_name,
 913                                                                   file_path))
 914             try:
 915                 properties = ft_utils.get_functest_config(
 916                     'general.image_properties')
 917             except ValueError:
 918                 # image properties are not configured
 919                 # therefore don't add any properties
 920                 properties = {}
 921             with open(file_path) as fimage:
 922                 image = glance_client.images.create(name=image_name,
 923                                                     is_public=public,
 924                                                     disk_format=disk,
 925                                                     container_format=container,
 926                                                     properties=properties,
 927                                                     data=fimage)
 928             image_id = image.id
 929         return image_id
 930     except Exception, e:
 931         logger.error("Error [create_glance_image(glance_client, '%s', '%s', "
 932                      "'%s')]: %s" % (image_name, file_path, str(public), e))
 933         return None
 934
 935
 936 def get_or_create_image(name, path, format):
 937     image_exists = False
 938     glance_client = get_glance_client()
 939
 940     image_id = get_image_id(glance_client, name)
 941     if image_id != '':
 942         logger.info("Using existing image '%s'..." % name)
 943         image_exists = True
 944     else:
 945         logger.info("Creating image '%s' from '%s'..." % (name, path))
 946         image_id = create_glance_image(glance_client, name, path, format)
 947         if not image_id:
 948             logger.error("Failed to create a Glance image...")
 949         else:
 950             logger.debug("Image '%s' with ID=%s created successfully."
 951                          % (name, image_id))
 952
 953     return image_exists, image_id
 954
 955
 956 def delete_glance_image(nova_client, image_id):
 957     try:
 958         nova_client.images.delete(image_id)
 959         return True
 960     except Exception, e:
 961         logger.error("Error [delete_glance_image(nova_client, '%s')]: %s"
 962                      % (image_id, e))
 963         return False
 964
 965
 966 # *********************************************
 967 #   CINDER
 968 # *********************************************
 969 def get_volumes(cinder_client):
 970     try:
 971         volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
 972         return volumes
 973     except Exception, e:
 974         logger.error("Error [get_volumes(cinder_client)]: %s" % e)
 975         return None
 976
 977
 978 def list_volume_types(cinder_client, public=True, private=True):
 979     try:
 980         volume_types = cinder_client.volume_types.list()
 981         if not public:
 982             volume_types = [vt for vt in volume_types if not vt.is_public]
 983         if not private:
 984             volume_types = [vt for vt in volume_types if vt.is_public]
 985         return volume_types
 986     except Exception, e:
 987         logger.error("Error [list_volume_types(cinder_client)]: %s" % e)
 988         return None
 989
 990
 991 def create_volume_type(cinder_client, name):
 992     try:
 993         volume_type = cinder_client.volume_types.create(name)
 994         return volume_type
 995     except Exception, e:
 996         logger.error("Error [create_volume_type(cinder_client, '%s')]: %s"
 997                      % (name, e))
 998         return None
 999
1000
1001 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
1002                         snapshots_quota, gigabytes_quota):
1003     quotas_values = {"volumes": vols_quota,
1004                      "snapshots": snapshots_quota,
1005                      "gigabytes": gigabytes_quota}
1006
1007     try:
1008         cinder_client.quotas.update(tenant_id, **quotas_values)
1009         return True
1010     except Exception, e:
1011         logger.error("Error [update_cinder_quota(cinder_client, '%s', '%s', "
1012                      "'%s' '%s')]: %s" % (tenant_id, vols_quota,
1013                                           snapshots_quota, gigabytes_quota, e))
1014         return False
1015
1016
1017 def delete_volume(cinder_client, volume_id, forced=False):
1018     try:
1019         if forced:
1020             try:
1021                 cinder_client.volumes.detach(volume_id)
1022             except:
1023                 logger.error(sys.exc_info()[0])
1024             cinder_client.volumes.force_delete(volume_id)
1025         else:
1026             cinder_client.volumes.delete(volume_id)
1027         return True
1028     except Exception, e:
1029         logger.error("Error [delete_volume(cinder_client, '%s', '%s')]: %s"
1030                      % (volume_id, str(forced), e))
1031         return False
1032
1033
1034 def delete_volume_type(cinder_client, volume_type):
1035     try:
1036         cinder_client.volume_types.delete(volume_type)
1037         return True
1038     except Exception, e:
1039         logger.error("Error [delete_volume_type(cinder_client, '%s')]: %s"
1040                      % (volume_type, e))
1041         return False
1042
1043
1044 # *********************************************
1045 #   KEYSTONE
1046 # *********************************************
1047 def get_tenants(keystone_client):
1048     try:
1049         tenants = keystone_client.tenants.list()
1050         return tenants
1051     except Exception, e:
1052         logger.error("Error [get_tenants(keystone_client)]: %s" % e)
1053         return None
1054
1055
1056 def get_users(keystone_client):
1057     try:
1058         users = keystone_client.users.list()
1059         return users
1060     except Exception, e:
1061         logger.error("Error [get_users(keystone_client)]: %s" % e)
1062         return None
1063
1064
1065 def get_tenant_id(keystone_client, tenant_name):
1066     tenants = keystone_client.tenants.list()
1067     id = ''
1068     for t in tenants:
1069         if t.name == tenant_name:
1070             id = t.id
1071             break
1072     return id
1073
1074
1075 def get_user_id(keystone_client, user_name):
1076     users = keystone_client.users.list()
1077     id = ''
1078     for u in users:
1079         if u.name == user_name:
1080             id = u.id
1081             break
1082     return id
1083
1084
1085 def get_role_id(keystone_client, role_name):
1086     roles = keystone_client.roles.list()
1087     id = ''
1088     for r in roles:
1089         if r.name == role_name:
1090             id = r.id
1091             break
1092     return id
1093
1094
1095 def create_tenant(keystone_client, tenant_name, tenant_description):
1096     try:
1097         tenant = keystone_client.tenants.create(tenant_name,
1098                                                 tenant_description,
1099                                                 enabled=True)
1100         return tenant.id
1101     except Exception, e:
1102         logger.error("Error [create_tenant(keystone_client, '%s', '%s')]: %s"
1103                      % (tenant_name, tenant_description, e))
1104         return None
1105
1106
1107 def create_user(keystone_client, user_name, user_password,
1108                 user_email, tenant_id):
1109     try:
1110         user = keystone_client.users.create(user_name, user_password,
1111                                             user_email, tenant_id,
1112                                             enabled=True)
1113         return user.id
1114     except Exception, e:
1115         logger.error("Error [create_user(keystone_client, '%s', '%s', '%s'"
1116                      "'%s')]: %s" % (user_name, user_password,
1117                                      user_email, tenant_id, e))
1118         return None
1119
1120
1121 def add_role_user(keystone_client, user_id, role_id, tenant_id):
1122     try:
1123         keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
1124         return True
1125     except Exception, e:
1126         logger.error("Error [add_role_user(keystone_client, '%s', '%s'"
1127                      "'%s')]: %s " % (user_id, role_id, tenant_id, e))
1128         return False
1129
1130
1131 def delete_tenant(keystone_client, tenant_id):
1132     try:
1133         keystone_client.tenants.delete(tenant_id)
1134         return True
1135     except Exception, e:
1136         logger.error("Error [delete_tenant(keystone_client, '%s')]: %s"
1137                      % (tenant_id, e))
1138         return False
1139
1140
1141 def delete_user(keystone_client, user_id):
1142     try:
1143         keystone_client.users.delete(user_id)
1144         return True
1145     except Exception, e:
1146         logger.error("Error [delete_user(keystone_client, '%s')]: %s"
1147                      % (user_id, e))
1148         return False