yardstick/common/openstack_utils.py

   1 ##############################################################################
   2 # Copyright (c) 2016 Huawei Technologies Co.,Ltd and others.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9
  10 import os
  11 import time
  12 import sys
  13 import logging
  14
  15 from keystoneauth1 import loading
  16 from keystoneauth1 import session
  17 import shade
  18 from shade import exc
  19
  20 from cinderclient import client as cinderclient
  21 from novaclient import client as novaclient
  22 from glanceclient import client as glanceclient
  23 from neutronclient.neutron import client as neutronclient
  24
  25
  26 log = logging.getLogger(__name__)
  27
  28 DEFAULT_HEAT_API_VERSION = '1'
  29 DEFAULT_API_VERSION = '2'
  30
  31
  32 # *********************************************
  33 #   CREDENTIALS
  34 # *********************************************
  35 def get_credentials():
  36     """Returns a creds dictionary filled with parsed from env
  37
  38     Keystone API version used is 3; v2 was deprecated in 2014 (Icehouse). Along
  39     with this deprecation, environment variable 'OS_TENANT_NAME' is replaced by
  40     'OS_PROJECT_NAME'.
  41     """
  42     creds = {'username': os.environ.get('OS_USERNAME'),
  43              'password': os.environ.get('OS_PASSWORD'),
  44              'auth_url': os.environ.get('OS_AUTH_URL'),
  45              'project_name': os.environ.get('OS_PROJECT_NAME')
  46              }
  47
  48     if os.getenv('OS_USER_DOMAIN_NAME'):
  49         creds['user_domain_name'] = os.getenv('OS_USER_DOMAIN_NAME')
  50     if os.getenv('OS_PROJECT_DOMAIN_NAME'):
  51         creds['project_domain_name'] = os.getenv('OS_PROJECT_DOMAIN_NAME')
  52
  53     return creds
  54
  55
  56 def get_session_auth():
  57     loader = loading.get_plugin_loader('password')
  58     creds = get_credentials()
  59     auth = loader.load_from_options(**creds)
  60     return auth
  61
  62
  63 def get_session():
  64     auth = get_session_auth()
  65     try:
  66         cacert = os.environ['OS_CACERT']
  67     except KeyError:
  68         return session.Session(auth=auth)
  69     else:
  70         insecure = os.getenv('OS_INSECURE', '').lower() == 'true'
  71         cacert = False if insecure else cacert
  72         return session.Session(auth=auth, verify=cacert)
  73
  74
  75 def get_endpoint(service_type, endpoint_type='publicURL'):
  76     auth = get_session_auth()
  77     # for multi-region, we need to specify region
  78     # when finding the endpoint
  79     return get_session().get_endpoint(auth=auth,
  80                                       service_type=service_type,
  81                                       endpoint_type=endpoint_type,
  82                                       region_name=os.environ.get(
  83                                           "OS_REGION_NAME"))
  84
  85
  86 # *********************************************
  87 #   CLIENTS
  88 # *********************************************
  89 def get_heat_api_version():     # pragma: no cover
  90     try:
  91         api_version = os.environ['HEAT_API_VERSION']
  92     except KeyError:
  93         return DEFAULT_HEAT_API_VERSION
  94     else:
  95         log.info("HEAT_API_VERSION is set in env as '%s'", api_version)
  96         return api_version
  97
  98
  99 def get_cinder_client_version():      # pragma: no cover
 100     try:
 101         api_version = os.environ['OS_VOLUME_API_VERSION']
 102     except KeyError:
 103         return DEFAULT_API_VERSION
 104     else:
 105         log.info("OS_VOLUME_API_VERSION is set in env as '%s'", api_version)
 106         return api_version
 107
 108
 109 def get_cinder_client():      # pragma: no cover
 110     sess = get_session()
 111     return cinderclient.Client(get_cinder_client_version(), session=sess)
 112
 113
 114 def get_nova_client_version():      # pragma: no cover
 115     try:
 116         api_version = os.environ['OS_COMPUTE_API_VERSION']
 117     except KeyError:
 118         return DEFAULT_API_VERSION
 119     else:
 120         log.info("OS_COMPUTE_API_VERSION is set in env as '%s'", api_version)
 121         return api_version
 122
 123
 124 def get_nova_client():      # pragma: no cover
 125     sess = get_session()
 126     return novaclient.Client(get_nova_client_version(), session=sess)
 127
 128
 129 def get_neutron_client_version():   # pragma: no cover
 130     try:
 131         api_version = os.environ['OS_NETWORK_API_VERSION']
 132     except KeyError:
 133         return DEFAULT_API_VERSION
 134     else:
 135         log.info("OS_NETWORK_API_VERSION is set in env as '%s'", api_version)
 136         return api_version
 137
 138
 139 def get_neutron_client():   # pragma: no cover
 140     sess = get_session()
 141     return neutronclient.Client(get_neutron_client_version(), session=sess)
 142
 143
 144 def get_glance_client_version():    # pragma: no cover
 145     try:
 146         api_version = os.environ['OS_IMAGE_API_VERSION']
 147     except KeyError:
 148         return DEFAULT_API_VERSION
 149     else:
 150         log.info("OS_IMAGE_API_VERSION is set in env as '%s'", api_version)
 151         return api_version
 152
 153
 154 def get_glance_client():    # pragma: no cover
 155     sess = get_session()
 156     return glanceclient.Client(get_glance_client_version(), session=sess)
 157
 158
 159 def get_shade_client():
 160     return shade.openstack_cloud()
 161
 162
 163 # *********************************************
 164 #   NOVA
 165 # *********************************************
 166 def get_instances(nova_client):
 167     try:
 168         return nova_client.servers.list(search_opts={'all_tenants': 1})
 169     except Exception:  # pylint: disable=broad-except
 170         log.exception("Error [get_instances(nova_client)]")
 171
 172
 173 def get_instance_status(nova_client, instance):     # pragma: no cover
 174     try:
 175         return nova_client.servers.get(instance.id).status
 176     except Exception:  # pylint: disable=broad-except
 177         log.exception("Error [get_instance_status(nova_client)]")
 178
 179
 180 def get_instance_by_name(nova_client, instance_name):   # pragma: no cover
 181     try:
 182         return nova_client.servers.find(name=instance_name)
 183     except Exception:  # pylint: disable=broad-except
 184         log.exception("Error [get_instance_by_name(nova_client, '%s')]",
 185                       instance_name)
 186
 187
 188 def get_aggregates(nova_client):    # pragma: no cover
 189     try:
 190         return nova_client.aggregates.list()
 191     except Exception:  # pylint: disable=broad-except
 192         log.exception("Error [get_aggregates(nova_client)]")
 193
 194
 195 def get_availability_zones(nova_client):    # pragma: no cover
 196     try:
 197         return nova_client.availability_zones.list()
 198     except Exception:  # pylint: disable=broad-except
 199         log.exception("Error [get_availability_zones(nova_client)]")
 200
 201
 202 def get_availability_zone_names(nova_client):   # pragma: no cover
 203     try:
 204         return [az.zoneName for az in get_availability_zones(nova_client)]
 205     except Exception:  # pylint: disable=broad-except
 206         log.exception("Error [get_availability_zone_names(nova_client)]")
 207
 208
 209 def create_aggregate(nova_client, aggregate_name, av_zone):  # pragma: no cover
 210     try:
 211         nova_client.aggregates.create(aggregate_name, av_zone)
 212     except Exception:  # pylint: disable=broad-except
 213         log.exception("Error [create_aggregate(nova_client, %s, %s)]",
 214                       aggregate_name, av_zone)
 215         return False
 216     else:
 217         return True
 218
 219
 220 def get_aggregate_id(nova_client, aggregate_name):      # pragma: no cover
 221     try:
 222         aggregates = get_aggregates(nova_client)
 223         _id = next((ag.id for ag in aggregates if ag.name == aggregate_name))
 224     except Exception:  # pylint: disable=broad-except
 225         log.exception("Error [get_aggregate_id(nova_client, %s)]",
 226                       aggregate_name)
 227     else:
 228         return _id
 229
 230
 231 def add_host_to_aggregate(nova_client, aggregate_name,
 232                           compute_host):    # pragma: no cover
 233     try:
 234         aggregate_id = get_aggregate_id(nova_client, aggregate_name)
 235         nova_client.aggregates.add_host(aggregate_id, compute_host)
 236     except Exception:  # pylint: disable=broad-except
 237         log.exception("Error [add_host_to_aggregate(nova_client, %s, %s)]",
 238                       aggregate_name, compute_host)
 239         return False
 240     else:
 241         return True
 242
 243
 244 def create_aggregate_with_host(nova_client, aggregate_name, av_zone,
 245                                compute_host):    # pragma: no cover
 246     try:
 247         create_aggregate(nova_client, aggregate_name, av_zone)
 248         add_host_to_aggregate(nova_client, aggregate_name, compute_host)
 249     except Exception:  # pylint: disable=broad-except
 250         log.exception("Error [create_aggregate_with_host("
 251                       "nova_client, %s, %s, %s)]",
 252                       aggregate_name, av_zone, compute_host)
 253         return False
 254     else:
 255         return True
 256
 257
 258 def create_keypair(name, key_path=None):    # pragma: no cover
 259     try:
 260         with open(key_path) as fpubkey:
 261             keypair = get_nova_client().keypairs.create(
 262                 name=name, public_key=fpubkey.read())
 263             return keypair
 264     except Exception:  # pylint: disable=broad-except
 265         log.exception("Error [create_keypair(nova_client)]")
 266
 267
 268 def create_instance(json_body):    # pragma: no cover
 269     try:
 270         return get_nova_client().servers.create(**json_body)
 271     except Exception:  # pylint: disable=broad-except
 272         log.exception("Error create instance failed")
 273         return None
 274
 275
 276 def create_instance_and_wait_for_active(json_body):    # pragma: no cover
 277     SLEEP = 3
 278     VM_BOOT_TIMEOUT = 180
 279     nova_client = get_nova_client()
 280     instance = create_instance(json_body)
 281     for _ in range(int(VM_BOOT_TIMEOUT / SLEEP)):
 282         status = get_instance_status(nova_client, instance)
 283         if status.lower() == "active":
 284             return instance
 285         elif status.lower() == "error":
 286             log.error("The instance went to ERROR status.")
 287             return None
 288         time.sleep(SLEEP)
 289     log.error("Timeout booting the instance.")
 290     return None
 291
 292
 293 def attach_server_volume(server_id, volume_id,
 294                          device=None):    # pragma: no cover
 295     try:
 296         get_nova_client().volumes.create_server_volume(server_id,
 297                                                        volume_id, device)
 298     except Exception:  # pylint: disable=broad-except
 299         log.exception("Error [attach_server_volume(nova_client, '%s', '%s')]",
 300                       server_id, volume_id)
 301         return False
 302     else:
 303         return True
 304
 305
 306 def delete_instance(nova_client, instance_id):      # pragma: no cover
 307     try:
 308         nova_client.servers.force_delete(instance_id)
 309     except Exception:  # pylint: disable=broad-except
 310         log.exception("Error [delete_instance(nova_client, '%s')]",
 311                       instance_id)
 312         return False
 313     else:
 314         return True
 315
 316
 317 def remove_host_from_aggregate(nova_client, aggregate_name,
 318                                compute_host):  # pragma: no cover
 319     try:
 320         aggregate_id = get_aggregate_id(nova_client, aggregate_name)
 321         nova_client.aggregates.remove_host(aggregate_id, compute_host)
 322     except Exception:  # pylint: disable=broad-except
 323         log.exception("Error remove_host_from_aggregate(nova_client, %s, %s)",
 324                       aggregate_name, compute_host)
 325         return False
 326     else:
 327         return True
 328
 329
 330 def remove_hosts_from_aggregate(nova_client,
 331                                 aggregate_name):   # pragma: no cover
 332     aggregate_id = get_aggregate_id(nova_client, aggregate_name)
 333     hosts = nova_client.aggregates.get(aggregate_id).hosts
 334     assert(
 335         all(remove_host_from_aggregate(nova_client, aggregate_name, host)
 336             for host in hosts))
 337
 338
 339 def delete_aggregate(nova_client, aggregate_name):  # pragma: no cover
 340     try:
 341         remove_hosts_from_aggregate(nova_client, aggregate_name)
 342         nova_client.aggregates.delete(aggregate_name)
 343     except Exception:  # pylint: disable=broad-except
 344         log.exception("Error [delete_aggregate(nova_client, %s)]",
 345                       aggregate_name)
 346         return False
 347     else:
 348         return True
 349
 350
 351 def get_server_by_name(name):   # pragma: no cover
 352     try:
 353         return get_nova_client().servers.list(search_opts={'name': name})[0]
 354     except IndexError:
 355         log.exception('Failed to get nova client')
 356         raise
 357
 358
 359 def create_flavor(name, ram, vcpus, disk, **kwargs):   # pragma: no cover
 360     try:
 361         return get_nova_client().flavors.create(name, ram, vcpus,
 362                                                 disk, **kwargs)
 363     except Exception:  # pylint: disable=broad-except
 364         log.exception("Error [create_flavor(nova_client, %s, %s, %s, %s, %s)]",
 365                       name, ram, disk, vcpus, kwargs['is_public'])
 366         return None
 367
 368
 369 def get_image_by_name(name):    # pragma: no cover
 370     images = get_nova_client().images.list()
 371     try:
 372         return next((a for a in images if a.name == name))
 373     except StopIteration:
 374         log.exception('No image matched')
 375
 376
 377 def get_flavor_id(nova_client, flavor_name):    # pragma: no cover
 378     flavors = nova_client.flavors.list(detailed=True)
 379     flavor_id = ''
 380     for f in flavors:
 381         if f.name == flavor_name:
 382             flavor_id = f.id
 383             break
 384     return flavor_id
 385
 386
 387 def get_flavor_by_name(name):   # pragma: no cover
 388     flavors = get_nova_client().flavors.list()
 389     try:
 390         return next((a for a in flavors if a.name == name))
 391     except StopIteration:
 392         log.exception('No flavor matched')
 393
 394
 395 def check_status(status, name, iterations, interval):   # pragma: no cover
 396     for _ in range(iterations):
 397         try:
 398             server = get_server_by_name(name)
 399         except IndexError:
 400             log.error('Cannot found %s server', name)
 401             raise
 402
 403         if server.status == status:
 404             return True
 405
 406         time.sleep(interval)
 407     return False
 408
 409
 410 def delete_flavor(flavor_id):    # pragma: no cover
 411     try:
 412         get_nova_client().flavors.delete(flavor_id)
 413     except Exception:  # pylint: disable=broad-except
 414         log.exception("Error [delete_flavor(nova_client, %s)]", flavor_id)
 415         return False
 416     else:
 417         return True
 418
 419
 420 def delete_keypair(nova_client, key):     # pragma: no cover
 421     try:
 422         nova_client.keypairs.delete(key=key)
 423         return True
 424     except Exception:  # pylint: disable=broad-except
 425         log.exception("Error [delete_keypair(nova_client)]")
 426         return False
 427
 428
 429 # *********************************************
 430 #   NEUTRON
 431 # *********************************************
 432 def get_network_id(shade_client, network_name):
 433     networks = shade_client.list_networks({'name': network_name})
 434     if networks:
 435         return networks[0]['id']
 436
 437
 438 def create_neutron_net(neutron_client, json_body):      # pragma: no cover
 439     try:
 440         network = neutron_client.create_network(body=json_body)
 441         return network['network']['id']
 442     except Exception:  # pylint: disable=broad-except
 443         log.error("Error [create_neutron_net(neutron_client)]")
 444         raise Exception("operation error")
 445
 446
 447 def delete_neutron_net(shade_client, network_id):
 448     try:
 449         return shade_client.delete_network(network_id)
 450     except exc.OpenStackCloudException:
 451         log.error("Error [delete_neutron_net(shade_client, '%s')]", network_id)
 452         return False
 453
 454
 455 def create_neutron_subnet(neutron_client, json_body):      # pragma: no cover
 456     try:
 457         subnet = neutron_client.create_subnet(body=json_body)
 458         return subnet['subnets'][0]['id']
 459     except Exception:  # pylint: disable=broad-except
 460         log.error("Error [create_neutron_subnet")
 461         raise Exception("operation error")
 462
 463
 464 def create_neutron_router(neutron_client, json_body):      # pragma: no cover
 465     try:
 466         router = neutron_client.create_router(json_body)
 467         return router['router']['id']
 468     except Exception:  # pylint: disable=broad-except
 469         log.error("Error [create_neutron_router(neutron_client)]")
 470         raise Exception("operation error")
 471
 472
 473 def delete_neutron_router(neutron_client, router_id):      # pragma: no cover
 474     try:
 475         neutron_client.delete_router(router=router_id)
 476         return True
 477     except Exception:  # pylint: disable=broad-except
 478         log.error("Error [delete_neutron_router(neutron_client, '%s')]",
 479                   router_id)
 480         return False
 481
 482
 483 def remove_gateway_router(neutron_client, router_id):      # pragma: no cover
 484     try:
 485         neutron_client.remove_gateway_router(router_id)
 486         return True
 487     except Exception:  # pylint: disable=broad-except
 488         log.error("Error [remove_gateway_router(neutron_client, '%s')]",
 489                   router_id)
 490         return False
 491
 492
 493 def remove_interface_router(neutron_client, router_id, subnet_id,
 494                             **json_body):      # pragma: no cover
 495     json_body.update({"subnet_id": subnet_id})
 496     try:
 497         neutron_client.remove_interface_router(router=router_id,
 498                                                body=json_body)
 499         return True
 500     except Exception:  # pylint: disable=broad-except
 501         log.error("Error [remove_interface_router(neutron_client, '%s', "
 502                   "'%s')]", router_id, subnet_id)
 503         return False
 504
 505
 506 def create_floating_ip(neutron_client, extnet_id):      # pragma: no cover
 507     props = {'floating_network_id': extnet_id}
 508     try:
 509         ip_json = neutron_client.create_floatingip({'floatingip': props})
 510         fip_addr = ip_json['floatingip']['floating_ip_address']
 511         fip_id = ip_json['floatingip']['id']
 512     except Exception:  # pylint: disable=broad-except
 513         log.error("Error [create_floating_ip(neutron_client)]")
 514         return None
 515     return {'fip_addr': fip_addr, 'fip_id': fip_id}
 516
 517
 518 def delete_floating_ip(nova_client, floatingip_id):      # pragma: no cover
 519     try:
 520         nova_client.floating_ips.delete(floatingip_id)
 521         return True
 522     except Exception:  # pylint: disable=broad-except
 523         log.error("Error [delete_floating_ip(nova_client, '%s')]",
 524                   floatingip_id)
 525         return False
 526
 527
 528 def get_security_groups(neutron_client):      # pragma: no cover
 529     try:
 530         security_groups = neutron_client.list_security_groups()[
 531             'security_groups']
 532         return security_groups
 533     except Exception:  # pylint: disable=broad-except
 534         log.error("Error [get_security_groups(neutron_client)]")
 535         return None
 536
 537
 538 def get_security_group_id(neutron_client, sg_name):      # pragma: no cover
 539     security_groups = get_security_groups(neutron_client)
 540     id = ''
 541     for sg in security_groups:
 542         if sg['name'] == sg_name:
 543             id = sg['id']
 544             break
 545     return id
 546
 547
 548 def create_security_group(neutron_client, sg_name,
 549                           sg_description):      # pragma: no cover
 550     json_body = {'security_group': {'name': sg_name,
 551                                     'description': sg_description}}
 552     try:
 553         secgroup = neutron_client.create_security_group(json_body)
 554         return secgroup['security_group']
 555     except Exception:  # pylint: disable=broad-except
 556         log.error("Error [create_security_group(neutron_client, '%s', "
 557                   "'%s')]", sg_name, sg_description)
 558         return None
 559
 560
 561 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
 562                          port_range_min=None, port_range_max=None,
 563                          **json_body):      # pragma: no cover
 564     # We create a security group in 2 steps
 565     # 1 - we check the format and set the json body accordingly
 566     # 2 - we call neturon client to create the security group
 567
 568     # Format check
 569     json_body.update({'security_group_rule': {'direction': direction,
 570                      'security_group_id': sg_id, 'protocol': protocol}})
 571     # parameters may be
 572     # - both None => we do nothing
 573     # - both Not None => we add them to the json description
 574     # but one cannot be None is the other is not None
 575     if (port_range_min is not None and port_range_max is not None):
 576         # add port_range in json description
 577         json_body['security_group_rule']['port_range_min'] = port_range_min
 578         json_body['security_group_rule']['port_range_max'] = port_range_max
 579         log.debug("Security_group format set (port range included)")
 580     else:
 581         # either both port range are set to None => do nothing
 582         # or one is set but not the other => log it and return False
 583         if port_range_min is None and port_range_max is None:
 584             log.debug("Security_group format set (no port range mentioned)")
 585         else:
 586             log.error("Bad security group format."
 587                       "One of the port range is not properly set:"
 588                       "range min: %s, range max: %s", port_range_min,
 589                       port_range_max)
 590             return False
 591
 592     # Create security group using neutron client
 593     try:
 594         neutron_client.create_security_group_rule(json_body)
 595         return True
 596     except Exception:  # pylint: disable=broad-except
 597         log.exception("Impossible to create_security_group_rule,"
 598                       "security group rule probably already exists")
 599         return False
 600
 601
 602 def create_security_group_full(neutron_client, sg_name,
 603                                sg_description):      # pragma: no cover
 604     sg_id = get_security_group_id(neutron_client, sg_name)
 605     if sg_id != '':
 606         log.info("Using existing security group '%s'...", sg_name)
 607     else:
 608         log.info("Creating security group  '%s'...", sg_name)
 609         SECGROUP = create_security_group(neutron_client,
 610                                          sg_name,
 611                                          sg_description)
 612         if not SECGROUP:
 613             log.error("Failed to create the security group...")
 614             return None
 615
 616         sg_id = SECGROUP['id']
 617
 618         log.debug("Security group '%s' with ID=%s created successfully.",
 619                   SECGROUP['name'], sg_id)
 620
 621         log.debug("Adding ICMP rules in security group '%s'...", sg_name)
 622         if not create_secgroup_rule(neutron_client, sg_id,
 623                                     'ingress', 'icmp'):
 624             log.error("Failed to create the security group rule...")
 625             return None
 626
 627         log.debug("Adding SSH rules in security group '%s'...", sg_name)
 628         if not create_secgroup_rule(
 629                 neutron_client, sg_id, 'ingress', 'tcp', '22', '22'):
 630             log.error("Failed to create the security group rule...")
 631             return None
 632
 633         if not create_secgroup_rule(
 634                 neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
 635             log.error("Failed to create the security group rule...")
 636             return None
 637     return sg_id
 638
 639
 640 # *********************************************
 641 #   GLANCE
 642 # *********************************************
 643 def get_image_id(glance_client, image_name):    # pragma: no cover
 644     images = glance_client.images.list()
 645     return next((i.id for i in images if i.name == image_name), None)
 646
 647
 648 def create_image(glance_client, image_name, file_path, disk_format,
 649                  container_format, min_disk, min_ram, protected, tag,
 650                  public, **kwargs):    # pragma: no cover
 651     if not os.path.isfile(file_path):
 652         log.error("Error: file %s does not exist.", file_path)
 653         return None
 654     try:
 655         image_id = get_image_id(glance_client, image_name)
 656         if image_id is not None:
 657             log.info("Image %s already exists.", image_name)
 658         else:
 659             log.info("Creating image '%s' from '%s'...", image_name, file_path)
 660
 661             image = glance_client.images.create(
 662                 name=image_name, visibility=public, disk_format=disk_format,
 663                 container_format=container_format, min_disk=min_disk,
 664                 min_ram=min_ram, tags=tag, protected=protected, **kwargs)
 665             image_id = image.id
 666             with open(file_path) as image_data:
 667                 glance_client.images.upload(image_id, image_data)
 668         return image_id
 669     except Exception:  # pylint: disable=broad-except
 670         log.error(
 671             "Error [create_glance_image(glance_client, '%s', '%s', '%s')]",
 672             image_name, file_path, public)
 673         return None
 674
 675
 676 def delete_image(glance_client, image_id):    # pragma: no cover
 677     try:
 678         glance_client.images.delete(image_id)
 679
 680     except Exception:  # pylint: disable=broad-except
 681         log.exception("Error [delete_flavor(glance_client, %s)]", image_id)
 682         return False
 683     else:
 684         return True
 685
 686
 687 # *********************************************
 688 #   CINDER
 689 # *********************************************
 690 def get_volume_id(volume_name):    # pragma: no cover
 691     volumes = get_cinder_client().volumes.list()
 692     return next((v.id for v in volumes if v.name == volume_name), None)
 693
 694
 695 def create_volume(cinder_client, volume_name, volume_size,
 696                   volume_image=False):    # pragma: no cover
 697     try:
 698         if volume_image:
 699             volume = cinder_client.volumes.create(name=volume_name,
 700                                                   size=volume_size,
 701                                                   imageRef=volume_image)
 702         else:
 703             volume = cinder_client.volumes.create(name=volume_name,
 704                                                   size=volume_size)
 705         return volume
 706     except Exception:  # pylint: disable=broad-except
 707         log.exception("Error [create_volume(cinder_client, %s)]",
 708                       (volume_name, volume_size))
 709         return None
 710
 711
 712 def delete_volume(cinder_client, volume_id,
 713                   forced=False):      # pragma: no cover
 714     try:
 715         if forced:
 716             try:
 717                 cinder_client.volumes.detach(volume_id)
 718             except Exception:  # pylint: disable=broad-except
 719                 log.error(sys.exc_info()[0])
 720             cinder_client.volumes.force_delete(volume_id)
 721         else:
 722             while True:
 723                 volume = get_cinder_client().volumes.get(volume_id)
 724                 if volume.status.lower() == 'available':
 725                     break
 726             cinder_client.volumes.delete(volume_id)
 727         return True
 728     except Exception:  # pylint: disable=broad-except
 729         log.exception("Error [delete_volume(cinder_client, '%s')]", volume_id)
 730         return False
 731
 732
 733 def detach_volume(server_id, volume_id):      # pragma: no cover
 734     try:
 735         get_nova_client().volumes.delete_server_volume(server_id, volume_id)
 736         return True
 737     except Exception:  # pylint: disable=broad-except
 738         log.exception("Error [detach_server_volume(nova_client, '%s', '%s')]",
 739                       server_id, volume_id)
 740         return False