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 create_flavor(nova_client, flavor_name, ram, disk, vcpus, public=True):
 215     try:
 216         flavor = nova_client.flavors.create(
 217             flavor_name, ram, vcpus, disk, is_public=public)
 218         try:
 219             extra_specs = ft_utils.get_functest_config(
 220                 'general.flavor_extra_specs')
 221             flavor.set_keys(extra_specs)
 222         except ValueError:
 223             # flavor extra specs are not configured, therefore skip the update
 224             pass
 225
 226     except Exception, e:
 227         logger.error("Error [create_flavor(nova_client, '%s', '%s', '%s', "
 228                      "'%s')]: %s" % (flavor_name, ram, disk, vcpus, e))
 229         return None
 230     return flavor.id
 231
 232
 233 def get_or_create_flavor(flavor_name, ram, disk, vcpus, public=True):
 234     flavor_exists = False
 235     nova_client = get_nova_client()
 236
 237     flavor_id = get_flavor_id(nova_client, flavor_name)
 238     if flavor_id != '':
 239         logger.info("Using existing flavor '%s'..." % flavor_name)
 240         flavor_exists = True
 241     else:
 242         logger.info("Creating flavor '%s' with '%s' RAM, '%s' disk size, "
 243                     "'%s' vcpus..." % (flavor_name, ram, disk, vcpus))
 244         flavor_id = create_flavor(
 245             nova_client, flavor_name, ram, disk, vcpus, public=public)
 246         if not flavor_id:
 247             logger.error("Failed to create flavor '%s'..." % (flavor_name))
 248         else:
 249             logger.debug("Flavor '%s' with ID=%s created successfully."
 250                          % (flavor_name, flavor_id))
 251
 252     return flavor_exists, flavor_id
 253
 254
 255 def get_floating_ips(nova_client):
 256     try:
 257         floating_ips = nova_client.floating_ips.list()
 258         return floating_ips
 259     except Exception, e:
 260         logger.error("Error [get_floating_ips(nova_client)]: %s" % e)
 261         return None
 262
 263
 264 def get_hypervisors(nova_client):
 265     try:
 266         nodes = []
 267         hypervisors = nova_client.hypervisors.list()
 268         for hypervisor in hypervisors:
 269             if hypervisor.state == "up":
 270                 nodes.append(hypervisor.hypervisor_hostname)
 271         return nodes
 272     except Exception, e:
 273         logger.error("Error [get_hypervisors(nova_client)]: %s" % e)
 274         return None
 275
 276
 277 def create_instance(flavor_name,
 278                     image_id,
 279                     network_id,
 280                     instance_name="functest-vm",
 281                     confdrive=True,
 282                     userdata=None,
 283                     av_zone='',
 284                     fixed_ip=None,
 285                     files=None):
 286     nova_client = get_nova_client()
 287     try:
 288         flavor = nova_client.flavors.find(name=flavor_name)
 289     except:
 290         flavors = nova_client.flavors.list()
 291         logger.error("Error: Flavor '%s' not found. Available flavors are: "
 292                      "\n%s" % (flavor_name, flavors))
 293         return None
 294     if fixed_ip is not None:
 295         nics = {"net-id": network_id, "v4-fixed-ip": fixed_ip}
 296     else:
 297         nics = {"net-id": network_id}
 298     if userdata is None:
 299         instance = nova_client.servers.create(
 300             name=instance_name,
 301             flavor=flavor,
 302             image=image_id,
 303             nics=[nics],
 304             availability_zone=av_zone,
 305             files=files
 306         )
 307     else:
 308         instance = nova_client.servers.create(
 309             name=instance_name,
 310             flavor=flavor,
 311             image=image_id,
 312             nics=[nics],
 313             config_drive=confdrive,
 314             userdata=userdata,
 315             availability_zone=av_zone,
 316             files=files
 317         )
 318     return instance
 319
 320
 321 def create_instance_and_wait_for_active(flavor_name,
 322                                         image_id,
 323                                         network_id,
 324                                         instance_name="",
 325                                         config_drive=False,
 326                                         userdata="",
 327                                         av_zone='',
 328                                         fixed_ip=None,
 329                                         files=None):
 330     SLEEP = 3
 331     VM_BOOT_TIMEOUT = 180
 332     nova_client = get_nova_client()
 333     instance = create_instance(flavor_name,
 334                                image_id,
 335                                network_id,
 336                                instance_name,
 337                                config_drive,
 338                                userdata,
 339                                av_zone=av_zone,
 340                                fixed_ip=fixed_ip,
 341                                files=files)
 342     count = VM_BOOT_TIMEOUT / SLEEP
 343     for n in range(count, -1, -1):
 344         status = get_instance_status(nova_client, instance)
 345         if status.lower() == "active":
 346             return instance
 347         elif status.lower() == "error":
 348             logger.error("The instance %s went to ERROR status."
 349                          % instance_name)
 350             return None
 351         time.sleep(SLEEP)
 352     logger.error("Timeout booting the instance %s." % instance_name)
 353     return None
 354
 355
 356 def create_floating_ip(neutron_client):
 357     extnet_id = get_external_net_id(neutron_client)
 358     props = {'floating_network_id': extnet_id}
 359     try:
 360         ip_json = neutron_client.create_floatingip({'floatingip': props})
 361         fip_addr = ip_json['floatingip']['floating_ip_address']
 362         fip_id = ip_json['floatingip']['id']
 363     except Exception, e:
 364         logger.error("Error [create_floating_ip(neutron_client)]: %s" % e)
 365         return None
 366     return {'fip_addr': fip_addr, 'fip_id': fip_id}
 367
 368
 369 def add_floating_ip(nova_client, server_id, floatingip_id):
 370     try:
 371         nova_client.servers.add_floating_ip(server_id, floatingip_id)
 372         return True
 373     except Exception, e:
 374         logger.error("Error [add_floating_ip(nova_client, '%s', '%s')]: %s"
 375                      % (server_id, floatingip_id, e))
 376         return False
 377
 378
 379 def delete_instance(nova_client, instance_id):
 380     try:
 381         nova_client.servers.force_delete(instance_id)
 382         return True
 383     except Exception, e:
 384         logger.error("Error [delete_instance(nova_client, '%s')]: %s"
 385                      % (instance_id, e))
 386         return False
 387
 388
 389 def delete_floating_ip(nova_client, floatingip_id):
 390     try:
 391         nova_client.floating_ips.delete(floatingip_id)
 392         return True
 393     except Exception, e:
 394         logger.error("Error [delete_floating_ip(nova_client, '%s')]: %s"
 395                      % (floatingip_id, e))
 396         return False
 397
 398
 399 # *********************************************
 400 #   NEUTRON
 401 # *********************************************
 402 def get_network_list(neutron_client):
 403     network_list = neutron_client.list_networks()['networks']
 404     if len(network_list) == 0:
 405         return None
 406     else:
 407         return network_list
 408
 409
 410 def get_router_list(neutron_client):
 411     router_list = neutron_client.list_routers()['routers']
 412     if len(router_list) == 0:
 413         return None
 414     else:
 415         return router_list
 416
 417
 418 def get_port_list(neutron_client):
 419     port_list = neutron_client.list_ports()['ports']
 420     if len(port_list) == 0:
 421         return None
 422     else:
 423         return port_list
 424
 425
 426 def get_network_id(neutron_client, network_name):
 427     networks = neutron_client.list_networks()['networks']
 428     id = ''
 429     for n in networks:
 430         if n['name'] == network_name:
 431             id = n['id']
 432             break
 433     return id
 434
 435
 436 def get_subnet_id(neutron_client, subnet_name):
 437     subnets = neutron_client.list_subnets()['subnets']
 438     id = ''
 439     for s in subnets:
 440         if s['name'] == subnet_name:
 441             id = s['id']
 442             break
 443     return id
 444
 445
 446 def get_router_id(neutron_client, router_name):
 447     routers = neutron_client.list_routers()['routers']
 448     id = ''
 449     for r in routers:
 450         if r['name'] == router_name:
 451             id = r['id']
 452             break
 453     return id
 454
 455
 456 def get_private_net(neutron_client):
 457     # Checks if there is an existing shared private network
 458     networks = neutron_client.list_networks()['networks']
 459     if len(networks) == 0:
 460         return None
 461     for net in networks:
 462         if (net['router:external'] is False) and (net['shared'] is True):
 463             return net
 464     return None
 465
 466
 467 def get_external_net(neutron_client):
 468     for network in neutron_client.list_networks()['networks']:
 469         if network['router:external']:
 470             return network['name']
 471     return None
 472
 473
 474 def get_external_net_id(neutron_client):
 475     for network in neutron_client.list_networks()['networks']:
 476         if network['router:external']:
 477             return network['id']
 478     return None
 479
 480
 481 def check_neutron_net(neutron_client, net_name):
 482     for network in neutron_client.list_networks()['networks']:
 483         if network['name'] == net_name:
 484             for subnet in network['subnets']:
 485                 return True
 486     return False
 487
 488
 489 def create_neutron_net(neutron_client, name):
 490     json_body = {'network': {'name': name,
 491                              'admin_state_up': True}}
 492     try:
 493         network = neutron_client.create_network(body=json_body)
 494         network_dict = network['network']
 495         return network_dict['id']
 496     except Exception, e:
 497         logger.error("Error [create_neutron_net(neutron_client, '%s')]: %s"
 498                      % (name, e))
 499         return None
 500
 501
 502 def create_neutron_subnet(neutron_client, name, cidr, net_id):
 503     json_body = {'subnets': [{'name': name, 'cidr': cidr,
 504                               'ip_version': 4, 'network_id': net_id}]}
 505     try:
 506         subnet = neutron_client.create_subnet(body=json_body)
 507         return subnet['subnets'][0]['id']
 508     except Exception, e:
 509         logger.error("Error [create_neutron_subnet(neutron_client, '%s', "
 510                      "'%s', '%s')]: %s" % (name, cidr, net_id, e))
 511         return None
 512
 513
 514 def create_neutron_router(neutron_client, name):
 515     json_body = {'router': {'name': name, 'admin_state_up': True}}
 516     try:
 517         router = neutron_client.create_router(json_body)
 518         return router['router']['id']
 519     except Exception, e:
 520         logger.error("Error [create_neutron_router(neutron_client, '%s')]: %s"
 521                      % (name, e))
 522         return None
 523
 524
 525 def create_neutron_port(neutron_client, name, network_id, ip):
 526     json_body = {'port': {
 527                  'admin_state_up': True,
 528                  'name': name,
 529                  'network_id': network_id,
 530                  'fixed_ips': [{"ip_address": ip}]
 531                  }}
 532     try:
 533         port = neutron_client.create_port(body=json_body)
 534         return port['port']['id']
 535     except Exception, e:
 536         logger.error("Error [create_neutron_port(neutron_client, '%s', '%s', "
 537                      "'%s')]: %s" % (name, network_id, ip, e))
 538         return None
 539
 540
 541 def update_neutron_net(neutron_client, network_id, shared=False):
 542     json_body = {'network': {'shared': shared}}
 543     try:
 544         neutron_client.update_network(network_id, body=json_body)
 545         return True
 546     except Exception, e:
 547         logger.error("Error [update_neutron_net(neutron_client, '%s', '%s')]: "
 548                      "%s" % (network_id, str(shared), e))
 549         return False
 550
 551
 552 def update_neutron_port(neutron_client, port_id, device_owner):
 553     json_body = {'port': {
 554                  'device_owner': device_owner,
 555                  }}
 556     try:
 557         port = neutron_client.update_port(port=port_id,
 558                                           body=json_body)
 559         return port['port']['id']
 560     except Exception, e:
 561         logger.error("Error [update_neutron_port(neutron_client, '%s', '%s')]:"
 562                      " %s" % (port_id, device_owner, e))
 563         return None
 564
 565
 566 def add_interface_router(neutron_client, router_id, subnet_id):
 567     json_body = {"subnet_id": subnet_id}
 568     try:
 569         neutron_client.add_interface_router(router=router_id, body=json_body)
 570         return True
 571     except Exception, e:
 572         logger.error("Error [add_interface_router(neutron_client, '%s', "
 573                      "'%s')]: %s" % (router_id, subnet_id, e))
 574         return False
 575
 576
 577 def add_gateway_router(neutron_client, router_id):
 578     ext_net_id = get_external_net_id(neutron_client)
 579     router_dict = {'network_id': ext_net_id}
 580     try:
 581         neutron_client.add_gateway_router(router_id, router_dict)
 582         return True
 583     except Exception, e:
 584         logger.error("Error [add_gateway_router(neutron_client, '%s')]: %s"
 585                      % (router_id, e))
 586         return False
 587
 588
 589 def delete_neutron_net(neutron_client, network_id):
 590     try:
 591         neutron_client.delete_network(network_id)
 592         return True
 593     except Exception, e:
 594         logger.error("Error [delete_neutron_net(neutron_client, '%s')]: %s"
 595                      % (network_id, e))
 596         return False
 597
 598
 599 def delete_neutron_subnet(neutron_client, subnet_id):
 600     try:
 601         neutron_client.delete_subnet(subnet_id)
 602         return True
 603     except Exception, e:
 604         logger.error("Error [delete_neutron_subnet(neutron_client, '%s')]: %s"
 605                      % (subnet_id, e))
 606         return False
 607
 608
 609 def delete_neutron_router(neutron_client, router_id):
 610     try:
 611         neutron_client.delete_router(router=router_id)
 612         return True
 613     except Exception, e:
 614         logger.error("Error [delete_neutron_router(neutron_client, '%s')]: %s"
 615                      % (router_id, e))
 616         return False
 617
 618
 619 def delete_neutron_port(neutron_client, port_id):
 620     try:
 621         neutron_client.delete_port(port_id)
 622         return True
 623     except Exception, e:
 624         logger.error("Error [delete_neutron_port(neutron_client, '%s')]: %s"
 625                      % (port_id, e))
 626         return False
 627
 628
 629 def remove_interface_router(neutron_client, router_id, subnet_id):
 630     json_body = {"subnet_id": subnet_id}
 631     try:
 632         neutron_client.remove_interface_router(router=router_id,
 633                                                body=json_body)
 634         return True
 635     except Exception, e:
 636         logger.error("Error [remove_interface_router(neutron_client, '%s', "
 637                      "'%s')]: %s" % (router_id, subnet_id, e))
 638         return False
 639
 640
 641 def remove_gateway_router(neutron_client, router_id):
 642     try:
 643         neutron_client.remove_gateway_router(router_id)
 644         return True
 645     except Exception, e:
 646         logger.error("Error [remove_gateway_router(neutron_client, '%s')]: %s"
 647                      % (router_id, e))
 648         return False
 649
 650
 651 def create_network_full(neutron_client,
 652                         net_name,
 653                         subnet_name,
 654                         router_name,
 655                         cidr):
 656
 657     # Check if the network already exists
 658     network_id = get_network_id(neutron_client, net_name)
 659     subnet_id = get_subnet_id(neutron_client, subnet_name)
 660     router_id = get_router_id(neutron_client, router_name)
 661
 662     if network_id != '' and subnet_id != '' and router_id != '':
 663         logger.info("A network with name '%s' already exists..." % net_name)
 664     else:
 665         neutron_client.format = 'json'
 666         logger.info('Creating neutron network %s...' % net_name)
 667         network_id = create_neutron_net(neutron_client, net_name)
 668
 669         if not network_id:
 670             return False
 671
 672         logger.debug("Network '%s' created successfully" % network_id)
 673         logger.debug('Creating Subnet....')
 674         subnet_id = create_neutron_subnet(neutron_client, subnet_name,
 675                                           cidr, network_id)
 676         if not subnet_id:
 677             return None
 678
 679         logger.debug("Subnet '%s' created successfully" % subnet_id)
 680         logger.debug('Creating Router...')
 681         router_id = create_neutron_router(neutron_client, router_name)
 682
 683         if not router_id:
 684             return None
 685
 686         logger.debug("Router '%s' created successfully" % router_id)
 687         logger.debug('Adding router to subnet...')
 688
 689         if not add_interface_router(neutron_client, router_id, subnet_id):
 690             return None
 691
 692         logger.debug("Interface added successfully.")
 693
 694         logger.debug('Adding gateway to router...')
 695         if not add_gateway_router(neutron_client, router_id):
 696             return None
 697
 698         logger.debug("Gateway added successfully.")
 699
 700     network_dic = {'net_id': network_id,
 701                    'subnet_id': subnet_id,
 702                    'router_id': router_id}
 703     return network_dic
 704
 705
 706 def create_shared_network_full(net_name, subnt_name, router_name, subnet_cidr):
 707     neutron_client = get_neutron_client()
 708
 709     network_dic = create_network_full(neutron_client,
 710                                       net_name,
 711                                       subnt_name,
 712                                       router_name,
 713                                       subnet_cidr)
 714     if network_dic:
 715         if not update_neutron_net(neutron_client,
 716                                   network_dic['net_id'],
 717                                   shared=True):
 718             logger.error("Failed to update network %s..." % net_name)
 719             return None
 720         else:
 721             logger.debug("Network '%s' is available..." % net_name)
 722     else:
 723         logger.error("Network %s creation failed" % net_name)
 724         return None
 725     return network_dic
 726
 727
 728 def create_bgpvpn(neutron_client, **kwargs):
 729     # route_distinguishers
 730     # route_targets
 731     json_body = {"bgpvpn": kwargs}
 732     return neutron_client.create_bgpvpn(json_body)
 733
 734
 735 def create_network_association(neutron_client, bgpvpn_id, neutron_network_id):
 736     json_body = {"network_association": {"network_id": neutron_network_id}}
 737     return neutron_client.create_network_association(bgpvpn_id, json_body)
 738
 739
 740 def create_router_association(neutron_client, bgpvpn_id, router_id):
 741     json_body = {"router_association": {"router_id": router_id}}
 742     return neutron_client.create_router_association(bgpvpn_id, json_body)
 743
 744
 745 def update_bgpvpn(neutron_client, bgpvpn_id, **kwargs):
 746     json_body = {"bgpvpn": kwargs}
 747     return neutron_client.update_bgpvpn(bgpvpn_id, json_body)
 748
 749
 750 def delete_bgpvpn(neutron_client, bgpvpn_id):
 751     return neutron_client.delete_bgpvpn(bgpvpn_id)
 752
 753
 754 def get_bgpvpn(neutron_client, bgpvpn_id):
 755     return neutron_client.show_bgpvpn(bgpvpn_id)
 756
 757
 758 def get_bgpvpn_routers(neutron_client, bgpvpn_id):
 759     return get_bgpvpn(neutron_client, bgpvpn_id)['bgpvpn']['routers']
 760
 761
 762 def get_bgpvpn_networks(neutron_client, bgpvpn_id):
 763     return get_bgpvpn(neutron_client, bgpvpn_id)['bgpvpn']['networks']
 764
 765 # *********************************************
 766 #   SEC GROUPS
 767 # *********************************************
 768
 769
 770 def get_security_groups(neutron_client):
 771     try:
 772         security_groups = neutron_client.list_security_groups()[
 773             'security_groups']
 774         return security_groups
 775     except Exception, e:
 776         logger.error("Error [get_security_groups(neutron_client)]: %s" % e)
 777         return None
 778
 779
 780 def get_security_group_id(neutron_client, sg_name):
 781     security_groups = get_security_groups(neutron_client)
 782     id = ''
 783     for sg in security_groups:
 784         if sg['name'] == sg_name:
 785             id = sg['id']
 786             break
 787     return id
 788
 789
 790 def create_security_group(neutron_client, sg_name, sg_description):
 791     json_body = {'security_group': {'name': sg_name,
 792                                     'description': sg_description}}
 793     try:
 794         secgroup = neutron_client.create_security_group(json_body)
 795         return secgroup['security_group']
 796     except Exception, e:
 797         logger.error("Error [create_security_group(neutron_client, '%s', "
 798                      "'%s')]: %s" % (sg_name, sg_description, e))
 799         return None
 800
 801
 802 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
 803                          port_range_min=None, port_range_max=None):
 804     if port_range_min is None and port_range_max is None:
 805         json_body = {'security_group_rule': {'direction': direction,
 806                                              'security_group_id': sg_id,
 807                                              'protocol': protocol}}
 808     elif port_range_min is not None and port_range_max is not None:
 809         json_body = {'security_group_rule': {'direction': direction,
 810                                              'security_group_id': sg_id,
 811                                              'port_range_min': port_range_min,
 812                                              'port_range_max': port_range_max,
 813                                              'protocol': protocol}}
 814     else:
 815         logger.error("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
 816                      "'%s', '%s', '%s', '%s')]:" % (neutron_client,
 817                                                     sg_id, direction,
 818                                                     port_range_min,
 819                                                     port_range_max,
 820                                                     protocol),
 821                      " Invalid values for port_range_min, port_range_max")
 822         return False
 823     try:
 824         neutron_client.create_security_group_rule(json_body)
 825         return True
 826     except Exception, e:
 827         logger.error("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
 828                      "'%s', '%s', '%s', '%s')]: %s" % (neutron_client,
 829                                                        sg_id,
 830                                                        direction,
 831                                                        port_range_min,
 832                                                        port_range_max,
 833                                                        protocol, e))
 834         return False
 835
 836
 837 def create_security_group_full(neutron_client,
 838                                sg_name, sg_description):
 839     sg_id = get_security_group_id(neutron_client, sg_name)
 840     if sg_id != '':
 841         logger.info("Using existing security group '%s'..." % sg_name)
 842     else:
 843         logger.info("Creating security group  '%s'..." % sg_name)
 844         SECGROUP = create_security_group(neutron_client,
 845                                          sg_name,
 846                                          sg_description)
 847         if not SECGROUP:
 848             logger.error("Failed to create the security group...")
 849             return None
 850
 851         sg_id = SECGROUP['id']
 852
 853         logger.debug("Security group '%s' with ID=%s created successfully."
 854                      % (SECGROUP['name'], sg_id))
 855
 856         logger.debug("Adding ICMP rules in security group '%s'..."
 857                      % sg_name)
 858         if not create_secgroup_rule(neutron_client, sg_id,
 859                                     'ingress', 'icmp'):
 860             logger.error("Failed to create the security group rule...")
 861             return None
 862
 863         logger.debug("Adding SSH rules in security group '%s'..."
 864                      % sg_name)
 865         if not create_secgroup_rule(
 866                 neutron_client, sg_id, 'ingress', 'tcp', '22', '22'):
 867             logger.error("Failed to create the security group rule...")
 868             return None
 869
 870         if not create_secgroup_rule(
 871                 neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
 872             logger.error("Failed to create the security group rule...")
 873             return None
 874     return sg_id
 875
 876
 877 def add_secgroup_to_instance(nova_client, instance_id, secgroup_id):
 878     try:
 879         nova_client.servers.add_security_group(instance_id, secgroup_id)
 880         return True
 881     except Exception, e:
 882         logger.error("Error [add_secgroup_to_instance(nova_client, '%s', "
 883                      "'%s')]: %s" % (instance_id, secgroup_id, e))
 884         return False
 885
 886
 887 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
 888     json_body = {"quota": {
 889         "security_group": sg_quota,
 890         "security_group_rule": sg_rule_quota
 891     }}
 892
 893     try:
 894         neutron_client.update_quota(tenant_id=tenant_id,
 895                                     body=json_body)
 896         return True
 897     except Exception, e:
 898         logger.error("Error [update_sg_quota(neutron_client, '%s', '%s', "
 899                      "'%s')]: %s" % (tenant_id, sg_quota, sg_rule_quota, e))
 900         return False
 901
 902
 903 def delete_security_group(neutron_client, secgroup_id):
 904     try:
 905         neutron_client.delete_security_group(secgroup_id)
 906         return True
 907     except Exception, e:
 908         logger.error("Error [delete_security_group(neutron_client, '%s')]: %s"
 909                      % (secgroup_id, e))
 910         return False
 911
 912
 913 # *********************************************
 914 #   GLANCE
 915 # *********************************************
 916 def get_images(nova_client):
 917     try:
 918         images = nova_client.images.list()
 919         return images
 920     except Exception, e:
 921         logger.error("Error [get_images]: %s" % e)
 922         return None
 923
 924
 925 def get_image_id(glance_client, image_name):
 926     images = glance_client.images.list()
 927     id = ''
 928     for i in images:
 929         if i.name == image_name:
 930             id = i.id
 931             break
 932     return id
 933
 934
 935 def create_glance_image(glance_client, image_name, file_path, disk="qcow2",
 936                         container="bare", public=True):
 937     if not os.path.isfile(file_path):
 938         logger.error("Error: file %s does not exist." % file_path)
 939         return None
 940     try:
 941         image_id = get_image_id(glance_client, image_name)
 942         if image_id != '':
 943             if logger:
 944                 logger.info("Image %s already exists." % image_name)
 945         else:
 946             if logger:
 947                 logger.info("Creating image '%s' from '%s'..." % (image_name,
 948                                                                   file_path))
 949             try:
 950                 properties = ft_utils.get_functest_config(
 951                     'general.image_properties')
 952             except ValueError:
 953                 # image properties are not configured
 954                 # therefore don't add any properties
 955                 properties = {}
 956             with open(file_path) as fimage:
 957                 image = glance_client.images.create(name=image_name,
 958                                                     is_public=public,
 959                                                     disk_format=disk,
 960                                                     container_format=container,
 961                                                     properties=properties,
 962                                                     data=fimage)
 963             image_id = image.id
 964         return image_id
 965     except Exception, e:
 966         logger.error("Error [create_glance_image(glance_client, '%s', '%s', "
 967                      "'%s')]: %s" % (image_name, file_path, str(public), e))
 968         return None
 969
 970
 971 def get_or_create_image(name, path, format):
 972     image_exists = False
 973     glance_client = get_glance_client()
 974
 975     image_id = get_image_id(glance_client, name)
 976     if image_id != '':
 977         logger.info("Using existing image '%s'..." % name)
 978         image_exists = True
 979     else:
 980         logger.info("Creating image '%s' from '%s'..." % (name, path))
 981         image_id = create_glance_image(glance_client, name, path, format)
 982         if not image_id:
 983             logger.error("Failed to create a Glance image...")
 984         else:
 985             logger.debug("Image '%s' with ID=%s created successfully."
 986                          % (name, image_id))
 987
 988     return image_exists, image_id
 989
 990
 991 def delete_glance_image(nova_client, image_id):
 992     try:
 993         nova_client.images.delete(image_id)
 994         return True
 995     except Exception, e:
 996         logger.error("Error [delete_glance_image(nova_client, '%s')]: %s"
 997                      % (image_id, e))
 998         return False
 999
1000
1001 # *********************************************
1002 #   CINDER
1003 # *********************************************
1004 def get_volumes(cinder_client):
1005     try:
1006         volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
1007         return volumes
1008     except Exception, e:
1009         logger.error("Error [get_volumes(cinder_client)]: %s" % e)
1010         return None
1011
1012
1013 def list_volume_types(cinder_client, public=True, private=True):
1014     try:
1015         volume_types = cinder_client.volume_types.list()
1016         if not public:
1017             volume_types = [vt for vt in volume_types if not vt.is_public]
1018         if not private:
1019             volume_types = [vt for vt in volume_types if vt.is_public]
1020         return volume_types
1021     except Exception, e:
1022         logger.error("Error [list_volume_types(cinder_client)]: %s" % e)
1023         return None
1024
1025
1026 def create_volume_type(cinder_client, name):
1027     try:
1028         volume_type = cinder_client.volume_types.create(name)
1029         return volume_type
1030     except Exception, e:
1031         logger.error("Error [create_volume_type(cinder_client, '%s')]: %s"
1032                      % (name, e))
1033         return None
1034
1035
1036 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
1037                         snapshots_quota, gigabytes_quota):
1038     quotas_values = {"volumes": vols_quota,
1039                      "snapshots": snapshots_quota,
1040                      "gigabytes": gigabytes_quota}
1041
1042     try:
1043         cinder_client.quotas.update(tenant_id, **quotas_values)
1044         return True
1045     except Exception, e:
1046         logger.error("Error [update_cinder_quota(cinder_client, '%s', '%s', "
1047                      "'%s' '%s')]: %s" % (tenant_id, vols_quota,
1048                                           snapshots_quota, gigabytes_quota, e))
1049         return False
1050
1051
1052 def delete_volume(cinder_client, volume_id, forced=False):
1053     try:
1054         if forced:
1055             try:
1056                 cinder_client.volumes.detach(volume_id)
1057             except:
1058                 logger.error(sys.exc_info()[0])
1059             cinder_client.volumes.force_delete(volume_id)
1060         else:
1061             cinder_client.volumes.delete(volume_id)
1062         return True
1063     except Exception, e:
1064         logger.error("Error [delete_volume(cinder_client, '%s', '%s')]: %s"
1065                      % (volume_id, str(forced), e))
1066         return False
1067
1068
1069 def delete_volume_type(cinder_client, volume_type):
1070     try:
1071         cinder_client.volume_types.delete(volume_type)
1072         return True
1073     except Exception, e:
1074         logger.error("Error [delete_volume_type(cinder_client, '%s')]: %s"
1075                      % (volume_type, e))
1076         return False
1077
1078
1079 # *********************************************
1080 #   KEYSTONE
1081 # *********************************************
1082 def get_tenants(keystone_client):
1083     try:
1084         tenants = keystone_client.tenants.list()
1085         return tenants
1086     except Exception, e:
1087         logger.error("Error [get_tenants(keystone_client)]: %s" % e)
1088         return None
1089
1090
1091 def get_users(keystone_client):
1092     try:
1093         users = keystone_client.users.list()
1094         return users
1095     except Exception, e:
1096         logger.error("Error [get_users(keystone_client)]: %s" % e)
1097         return None
1098
1099
1100 def get_tenant_id(keystone_client, tenant_name):
1101     tenants = keystone_client.tenants.list()
1102     id = ''
1103     for t in tenants:
1104         if t.name == tenant_name:
1105             id = t.id
1106             break
1107     return id
1108
1109
1110 def get_user_id(keystone_client, user_name):
1111     users = keystone_client.users.list()
1112     id = ''
1113     for u in users:
1114         if u.name == user_name:
1115             id = u.id
1116             break
1117     return id
1118
1119
1120 def get_role_id(keystone_client, role_name):
1121     roles = keystone_client.roles.list()
1122     id = ''
1123     for r in roles:
1124         if r.name == role_name:
1125             id = r.id
1126             break
1127     return id
1128
1129
1130 def create_tenant(keystone_client, tenant_name, tenant_description):
1131     try:
1132         tenant = keystone_client.tenants.create(tenant_name,
1133                                                 tenant_description,
1134                                                 enabled=True)
1135         return tenant.id
1136     except Exception, e:
1137         logger.error("Error [create_tenant(keystone_client, '%s', '%s')]: %s"
1138                      % (tenant_name, tenant_description, e))
1139         return None
1140
1141
1142 def create_user(keystone_client, user_name, user_password,
1143                 user_email, tenant_id):
1144     try:
1145         user = keystone_client.users.create(user_name, user_password,
1146                                             user_email, tenant_id,
1147                                             enabled=True)
1148         return user.id
1149     except Exception, e:
1150         logger.error("Error [create_user(keystone_client, '%s', '%s', '%s'"
1151                      "'%s')]: %s" % (user_name, user_password,
1152                                      user_email, tenant_id, e))
1153         return None
1154
1155
1156 def add_role_user(keystone_client, user_id, role_id, tenant_id):
1157     try:
1158         keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
1159         return True
1160     except Exception, e:
1161         logger.error("Error [add_role_user(keystone_client, '%s', '%s'"
1162                      "'%s')]: %s " % (user_id, role_id, tenant_id, e))
1163         return False
1164
1165
1166 def delete_tenant(keystone_client, tenant_id):
1167     try:
1168         keystone_client.tenants.delete(tenant_id)
1169         return True
1170     except Exception, e:
1171         logger.error("Error [delete_tenant(keystone_client, '%s')]: %s"
1172                      % (tenant_id, e))
1173         return False
1174
1175
1176 def delete_user(keystone_client, user_id):
1177     try:
1178         keystone_client.users.delete(user_id)
1179         return True
1180     except Exception, e:
1181         logger.error("Error [delete_user(keystone_client, '%s')]: %s"
1182                      % (user_id, e))
1183         return False