testcases/functest_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
  12 import os
  13 import urllib2
  14 import subprocess
  15 import sys
  16 import requests
  17 import json
  18 from git import Repo
  19
  20
  21 # ############ CREDENTIALS OPENSTACK #############
  22 def check_credentials():
  23     """
  24     Check if the OpenStack credentials (openrc) are sourced
  25     """
  26     # TODO: there must be a short way to do this
  27     # doing if os.environ["something"] == "" throws an error
  28     try:
  29         os.environ['OS_AUTH_URL']
  30     except KeyError:
  31         return False
  32     try:
  33         os.environ['OS_USERNAME']
  34     except KeyError:
  35         return False
  36     try:
  37         os.environ['OS_PASSWORD']
  38     except KeyError:
  39         return False
  40     try:
  41         os.environ['OS_TENANT_NAME']
  42     except KeyError:
  43         return False
  44     return True
  45
  46
  47 def get_credentials(service):
  48     """Returns a creds dictionary filled with the following keys:
  49     * username
  50     * password/api_key (depending on the service)
  51     * tenant_name/project_id (depending on the service)
  52     * auth_url
  53     :param service: a string indicating the name of the service
  54                     requesting the credentials.
  55     """
  56     creds = {}
  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', "admin"),
  70         password: os.environ.get("OS_PASSWORD", 'admin'),
  71         "auth_url": os.environ.get("OS_AUTH_URL",
  72                                    "http://192.168.20.71:5000/v2.0"),
  73         tenant: os.environ.get("OS_TENANT_NAME", "admin"),
  74     })
  75
  76     return creds
  77
  78
  79 # ################ NOVA #################
  80 def get_instance_status(nova_client, instance):
  81     try:
  82         instance = nova_client.servers.get(instance.id)
  83         return instance.status
  84     except:
  85         return None
  86
  87
  88 def get_instance_by_name(nova_client, instance_name):
  89     try:
  90         instance = nova_client.servers.find(name=instance_name)
  91         return instance
  92     except:
  93         return None
  94
  95
  96 def get_flavor_id(nova_client, flavor_name):
  97     flavors = nova_client.flavors.list(detailed=True)
  98     id = ''
  99     for f in flavors:
 100         if f.name == flavor_name:
 101             id = f.id
 102             break
 103     return id
 104
 105
 106 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
 107     flavors = nova_client.flavors.list(detailed=True)
 108     id = ''
 109     for f in flavors:
 110         if min_ram <= f.ram and f.ram <= max_ram:
 111             id = f.id
 112             break
 113     return id
 114
 115
 116 # ################ NEUTRON #################
 117 def create_neutron_net(neutron_client, name):
 118     json_body = {'network': {'name': name,
 119                              'admin_state_up': True}}
 120     try:
 121         network = neutron_client.create_network(body=json_body)
 122         network_dict = network['network']
 123         return network_dict['id']
 124     except:
 125         print "Error:", sys.exc_info()[0]
 126         return False
 127
 128
 129 def delete_neutron_net(neutron_client, network_id):
 130     try:
 131         neutron_client.delete_network(network_id)
 132         return True
 133     except:
 134         print "Error:", sys.exc_info()[0]
 135         return False
 136
 137
 138 def create_neutron_subnet(neutron_client, name, cidr, net_id):
 139     json_body = {'subnets': [{'name': name, 'cidr': cidr,
 140                              'ip_version': 4, 'network_id': net_id}]}
 141     try:
 142         subnet = neutron_client.create_subnet(body=json_body)
 143         return subnet['subnets'][0]['id']
 144     except:
 145         print "Error:", sys.exc_info()[0]
 146         return False
 147
 148
 149 def delete_neutron_subnet(neutron_client, subnet_id):
 150     try:
 151         neutron_client.delete_subnet(subnet_id)
 152         return True
 153     except:
 154         print "Error:", sys.exc_info()[0]
 155         return False
 156
 157
 158 def create_neutron_router(neutron_client, name):
 159     json_body = {'router': {'name': name, 'admin_state_up': True}}
 160     try:
 161         router = neutron_client.create_router(json_body)
 162         return router['router']['id']
 163     except:
 164         print "Error:", sys.exc_info()[0]
 165         return False
 166
 167
 168 def delete_neutron_router(neutron_client, router_id):
 169     json_body = {'router': {'id': router_id}}
 170     try:
 171         neutron_client.delete_router(router=router_id)
 172         return True
 173     except:
 174         print "Error:", sys.exc_info()[0]
 175         return False
 176
 177
 178 def add_interface_router(neutron_client, router_id, subnet_id):
 179     json_body = {"subnet_id": subnet_id}
 180     try:
 181         neutron_client.add_interface_router(router=router_id, body=json_body)
 182         return True
 183     except:
 184         print "Error:", sys.exc_info()[0]
 185         return False
 186
 187
 188 def remove_interface_router(neutron_client, router_id, subnet_id):
 189     json_body = {"subnet_id": subnet_id}
 190     try:
 191         neutron_client.remove_interface_router(router=router_id,
 192                                                body=json_body)
 193         return True
 194     except:
 195         print "Error:", sys.exc_info()[0]
 196         return False
 197
 198
 199 def create_neutron_port(neutron_client, name, network_id, ip):
 200     json_body = {'port': {
 201                  'admin_state_up': True,
 202                  'name': name,
 203                  'network_id': network_id,
 204                  'fixed_ips': [{"ip_address": ip}]
 205                  }}
 206     try:
 207         port = neutron_client.create_port(body=json_body)
 208         return port['port']['id']
 209     except:
 210         print "Error:", sys.exc_info()[0]
 211         return False
 212
 213 def delete_neutron_port(neutron_client, port_id):
 214     try:
 215         neutron_client.delete_port(port_id)
 216         return True
 217     except:
 218         print "Error:", sys.exc_info()[0]
 219         return False
 220
 221 def get_network_id(neutron_client, network_name):
 222     networks = neutron_client.list_networks()['networks']
 223     id = ''
 224     for n in networks:
 225         if n['name'] == network_name:
 226             id = n['id']
 227             break
 228     return id
 229
 230
 231 def check_neutron_net(neutron_client, net_name):
 232     for network in neutron_client.list_networks()['networks']:
 233         if network['name'] == net_name:
 234             for subnet in network['subnets']:
 235                 return True
 236     return False
 237
 238
 239 def get_network_list(neutron_client):
 240     network_list = neutron_client.list_networks()['networks']
 241     if len(network_list) == 0:
 242         return None
 243     else:
 244         return network_list
 245
 246
 247 def get_external_net(neutron_client):
 248     for network in neutron_client.list_networks()['networks']:
 249         if network['router:external']:
 250             return network['name']
 251     return False
 252
 253
 254 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
 255     json_body = {"quota": {
 256         "security_group": sg_quota,
 257         "security_group_rule": sg_rule_quota
 258     }}
 259
 260     try:
 261         quota = neutron_client.update_quota(tenant_id=tenant_id,
 262                                             body=json_body)
 263         return True
 264     except:
 265         print "Error:", sys.exc_info()[0]
 266         return False
 267
 268 # ################ GLANCE #################
 269
 270
 271 def get_image_id(glance_client, image_name):
 272     images = glance_client.images.list()
 273     id = ''
 274     for i in images:
 275         if i.name == image_name:
 276             id = i.id
 277             break
 278     return id
 279
 280
 281 def create_glance_image(glance_client, image_name, file_path, is_public=True):
 282     try:
 283         with open(file_path) as fimage:
 284             image = glance_client.images.create(name=image_name,
 285                                                 is_public=is_public,
 286                                                 disk_format="qcow2",
 287                                                 container_format="bare",
 288                                                 data=fimage)
 289         return image.id
 290     except:
 291         return False
 292
 293
 294 # ################ KEYSTONE #################
 295 def get_tenant_id(keystone_client, tenant_name):
 296     tenants = keystone_client.tenants.list()
 297     id = ''
 298     for t in tenants:
 299         if t.name == tenant_name:
 300             id = t.id
 301             break
 302     return id
 303
 304
 305 def get_role_id(keystone_client, role_name):
 306     roles = keystone_client.roles.list()
 307     id = ''
 308     for r in roles:
 309         if r.name == role_name:
 310             id = r.id
 311             break
 312     return id
 313
 314
 315 def get_user_id(keystone_client, user_name):
 316     users = keystone_client.users.list()
 317     id = ''
 318     for u in users:
 319         if u.name == user_name:
 320             id = u.id
 321             break
 322     return id
 323
 324
 325 def create_tenant(keystone_client, tenant_name, tenant_description):
 326     try:
 327         tenant = keystone_client.tenants.create(tenant_name,
 328                                                 tenant_description,
 329                                                 enabled=True)
 330         return tenant.id
 331     except:
 332         print "Error:", sys.exc_info()[0]
 333         return False
 334
 335
 336 def delete_tenant(keystone_client, tenant_id):
 337     try:
 338         tenant = keystone_client.tenants.delete(tenant_id)
 339         return True
 340     except:
 341         print "Error:", sys.exc_info()[0]
 342         return False
 343
 344
 345 def create_user(keystone_client, user_name, user_password,
 346                 user_email, tenant_id):
 347     try:
 348         user = keystone_client.users.create(user_name, user_password,
 349                                             user_email, tenant_id,
 350                                             enabled=True)
 351         return user.id
 352     except:
 353         print "Error:", sys.exc_info()[0]
 354         return False
 355
 356
 357 def delete_user(keystone_client, user_id):
 358     try:
 359         tenant = keystone_client.users.delete(user_id)
 360         return True
 361     except:
 362         print "Error:", sys.exc_info()[0]
 363         return False
 364
 365
 366 def add_role_user(keystone_client, user_id, role_id, tenant_id):
 367     try:
 368         keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
 369         return True
 370     except:
 371         print "Error:", sys.exc_info()[0]
 372         return False
 373
 374
 375 # ################ UTILS #################
 376 def check_internet_connectivity(url='http://www.opnfv.org/'):
 377     """
 378     Check if there is access to the internet
 379     """
 380     try:
 381         urllib2.urlopen(url, timeout=5)
 382         return True
 383     except urllib2.URLError:
 384         return False
 385
 386
 387 def download_url(url, dest_path):
 388     """
 389     Download a file to a destination path given a URL
 390     """
 391     name = url.rsplit('/')[-1]
 392     dest = dest_path + "/" + name
 393     try:
 394         response = urllib2.urlopen(url)
 395     except (urllib2.HTTPError, urllib2.URLError):
 396         return False
 397
 398     with open(dest, 'wb') as f:
 399         f.write(response.read())
 400     return True
 401
 402
 403 def execute_command(cmd, logger=None):
 404     """
 405     Execute Linux command
 406     """
 407     if logger:
 408         logger.debug('Executing command : {}'.format(cmd))
 409     output_file = "output.txt"
 410     f = open(output_file, 'w+')
 411     p = subprocess.call(cmd, shell=True, stdout=f, stderr=subprocess.STDOUT)
 412     f.close()
 413     f = open(output_file, 'r')
 414     result = f.read()
 415     if result != "" and logger:
 416         logger.debug(result)
 417     if p == 0:
 418         return True
 419     else:
 420         if logger:
 421             logger.error("Error when executing command %s" % cmd)
 422         exit(-1)
 423
 424
 425 def get_git_branch(repo_path):
 426     """
 427     Get git branch name
 428     """
 429     repo = Repo(repo_path)
 430     branch = repo.active_branch
 431     return branch.name
 432
 433
 434 def get_installer_type(logger=None):
 435     """
 436     Get installer type (fuel, foreman, apex, joid, compass)
 437     """
 438     try:
 439         installer = os.environ['INSTALLER_TYPE']
 440     except KeyError:
 441         if logger:
 442             logger.error("Impossible to retrieve the installer type")
 443         installer = "Unkown"
 444
 445     return installer
 446
 447 def push_results_to_db(db_url, case_name, logger, pod_name, git_version, payload):
 448     url = db_url + "/results"
 449     installer = get_installer_type(logger)
 450     params = {"project_name": "functest", "case_name": case_name,
 451               "pod_name": pod_name, "installer": installer,
 452               "version": git_version, "details": payload}
 453
 454     headers = {'Content-Type': 'application/json'}
 455     try:
 456         r = requests.post(url, data=json.dumps(params), headers=headers)
 457         logger.debug(r)
 458         return True
 459     except:
 460         print "Error:", sys.exc_info()[0]
 461         return False