functest/utils/openstack_tacker.py

   1 ###########################################################################
   2 # Copyright (c) 2016 Ericsson AB and others.
   3 # Author: George Paraskevopoulos <geopar@intracom-telecom.com>
   4 #
   5 # Wrappers for trozet's python-tackerclient v1.0
   6 # (https://github.com/trozet/python-tackerclient)
   7 #
   8 # All rights reserved. This program and the accompanying materials
   9 # are made available under the terms of the Apache License, Version 2.0
  10 # which accompanies this distribution, and is available at
  11 # http://www.apache.org/licenses/LICENSE-2.0
  12 ##########################################################################
  13
  14
  15 from tackerclient.v1_0 import client as tackerclient
  16 import functest.utils.functest_logger as ft_logger
  17 import functest.utils.openstack_utils as os_utils
  18 import time
  19
  20 logger = ft_logger.Logger("tacker_utils").getLogger()
  21
  22
  23 def get_tacker_client():
  24     creds_tacker = os_utils.get_credentials('tacker')
  25     return tackerclient.Client(**creds_tacker)
  26
  27
  28 # *********************************************
  29 #   TACKER
  30 # *********************************************
  31 def get_id_from_name(tacker_client, resource_type, resource_name):
  32     try:
  33         req_params = {'fields': 'id', 'name': resource_name}
  34         endpoint = '/{0}s'.format(resource_type)
  35         resp = tacker_client.get(endpoint, params=req_params)
  36         endpoint = endpoint.replace('-', '_')
  37         return resp[endpoint[1:]][0]['id']
  38     except Exception, e:
  39         logger.error("Error [get_id_from_name(tacker_client, "
  40                      "resource_type, resource_name)]: %s" % e)
  41         return None
  42
  43
  44 def get_vnfd_id(tacker_client, vnfd_name):
  45     return get_id_from_name(tacker_client, 'vnfd', vnfd_name)
  46
  47
  48 def get_vnf_id(tacker_client, vnf_name):
  49     return get_id_from_name(tacker_client, 'vnf', vnf_name)
  50
  51
  52 def get_sfc_id(tacker_client, sfc_name):
  53     return get_id_from_name(tacker_client, 'sfc', sfc_name)
  54
  55
  56 def get_sfc_classifier_id(tacker_client, sfc_clf_name):
  57     return get_id_from_name(tacker_client, 'sfc-classifier', sfc_clf_name)
  58
  59
  60 def list_vnfds(tacker_client, verbose=False):
  61     try:
  62         vnfds = tacker_client.list_vnfds(retrieve_all=True)
  63         if not verbose:
  64             vnfds = [vnfd['id'] for vnfd in vnfds['vnfds']]
  65         return vnfds
  66     except Exception, e:
  67         logger.error("Error [list_vnfds(tacker_client)]: %s" % e)
  68         return None
  69
  70
  71 def create_vnfd(tacker_client, tosca_file=None):
  72     try:
  73         vnfd_body = {}
  74         if tosca_file is not None:
  75             with open(tosca_file) as tosca_fd:
  76                 vnfd_body = tosca_fd.read()
  77             logger.error(vnfd_body)
  78         return tacker_client.create_vnfd(
  79             body={"vnfd": {"attributes": {"vnfd": vnfd_body}}})
  80     except Exception, e:
  81         logger.exception("Error [create_vnfd(tacker_client, '%s')]: %s"
  82                          % (tosca_file, e))
  83         return None
  84
  85
  86 def delete_vnfd(tacker_client, vnfd_id=None, vnfd_name=None):
  87     try:
  88         vnfd = vnfd_id
  89         if vnfd is None:
  90             if vnfd_name is None:
  91                 raise Exception('You need to provide VNFD id or VNFD name')
  92             vnfd = get_vnfd_id(tacker_client, vnfd_name)
  93         return tacker_client.delete_vnfd(vnfd)
  94     except Exception, e:
  95         logger.error("Error [delete_vnfd(tacker_client, '%s', '%s')]: %s"
  96                      % (vnfd_id, vnfd_name, e))
  97         return None
  98
  99
 100 def list_vnfs(tacker_client, verbose=False):
 101     try:
 102         vnfs = tacker_client.list_vnfs(retrieve_all=True)
 103         if not verbose:
 104             vnfs = [vnf['id'] for vnf in vnfs['vnfs']]
 105         return vnfs
 106     except Exception, e:
 107         logger.error("Error [list_vnfs(tacker_client)]: %s" % e)
 108         return None
 109
 110
 111 def create_vnf(tacker_client, vnf_name, vnfd_id=None, vnfd_name=None):
 112     try:
 113         vnf_body = {
 114             'vnf': {
 115                 'attributes': {},
 116                 'name': vnf_name
 117             }
 118         }
 119         if vnfd_id is not None:
 120             vnf_body['vnf']['vnfd_id'] = vnfd_id
 121         else:
 122             if vnfd_name is None:
 123                 raise Exception('vnfd id or vnfd name is required')
 124             vnf_body['vnf']['vnfd_id'] = get_vnfd_id(tacker_client, vnfd_name)
 125         return tacker_client.create_vnf(body=vnf_body)
 126     except Exception, e:
 127         logger.error("error [create_vnf(tacker_client, '%s', '%s', '%s')]: %s"
 128                      % (vnf_name, vnfd_id, vnfd_name, e))
 129         return None
 130
 131
 132 def wait_for_vnf(tacker_client, vnf_id=None, vnf_name=None):
 133     try:
 134         _id = None
 135         if vnf_id is not None:
 136             _id = vnf_id
 137         elif vnf_name is not None:
 138             while _id is None:
 139                 try:
 140                     _id = get_vnf_id(tacker_client, vnf_name)
 141                 except:
 142                     logger.error("Bazinga")
 143         else:
 144             raise Exception('You must specify vnf_id or vnf_name')
 145         while True:
 146             vnf = [v for v in list_vnfs(tacker_client, verbose=True)['vnfs']
 147                    if v['id'] == _id]
 148             vnf = vnf[0]
 149             logger.info('Waiting for vnf {0}'.format(str(vnf)))
 150             if vnf['status'] == 'ERROR':
 151                 raise Exception('Error when booting vnf %s' % _id)
 152             elif vnf['status'] == 'PENDING_CREATE':
 153                 time.sleep(3)
 154                 continue
 155             else:
 156                 break
 157         return _id
 158     except Exception, e:
 159         logger.error("error [wait_for_vnf(tacker_client, '%s', '%s')]: %s"
 160                      % (vnf_id, vnf_name, e))
 161         return None
 162
 163
 164 def delete_vnf(tacker_client, vnf_id=None, vnf_name=None):
 165     try:
 166         vnf = vnf_id
 167         if vnf is None:
 168             if vnf_name is None:
 169                 raise Exception('You need to provide a VNF id or name')
 170             vnf = get_vnf_id(tacker_client, vnf_name)
 171         return tacker_client.delete_vnf(vnf)
 172     except Exception, e:
 173         logger.error("Error [delete_vnf(tacker_client, '%s', '%s')]: %s"
 174                      % (vnf_id, vnf_name, e))
 175         return None
 176
 177
 178 def list_sfcs(tacker_client, verbose=False):
 179     try:
 180         sfcs = tacker_client.list_sfcs(retrieve_all=True)
 181         if not verbose:
 182             sfcs = [sfc['id'] for sfc in sfcs['sfcs']]
 183         return sfcs
 184     except Exception, e:
 185         logger.error("Error [list_sfcs(tacker_client)]: %s" % e)
 186         return None
 187
 188
 189 def create_sfc(tacker_client, sfc_name,
 190                chain_vnf_ids=None,
 191                chain_vnf_names=None):
 192     try:
 193         sfc_body = {
 194             'sfc': {
 195                 'attributes': {},
 196                 'name': sfc_name,
 197                 'chain': []
 198             }
 199         }
 200         if chain_vnf_ids is not None:
 201             sfc_body['sfc']['chain'] = chain_vnf_ids
 202         else:
 203             if chain_vnf_names is None:
 204                 raise Exception('You need to provide a chain of VNFs')
 205             sfc_body['sfc']['chain'] = [get_vnf_id(tacker_client, name)
 206                                         for name in chain_vnf_names]
 207         return tacker_client.create_sfc(body=sfc_body)
 208     except Exception, e:
 209         logger.error("error [create_sfc(tacker_client, '%s', '%s', '%s')]: %s"
 210                      % (sfc_name, chain_vnf_ids, chain_vnf_names, e))
 211         return None
 212
 213
 214 def delete_sfc(tacker_client, sfc_id=None, sfc_name=None):
 215     try:
 216         sfc = sfc_id
 217         if sfc is None:
 218             if sfc_name is None:
 219                 raise Exception('You need to provide an SFC id or name')
 220             sfc = get_sfc_id(tacker_client, sfc_name)
 221         return tacker_client.delete_sfc(sfc)
 222     except Exception, e:
 223         logger.error("Error [delete_sfc(tacker_client, '%s', '%s')]: %s"
 224                      % (sfc_id, sfc_name, e))
 225         return None
 226
 227
 228 def list_sfc_clasifiers(tacker_client, verbose=False):
 229     try:
 230         sfc_clfs = tacker_client.list_sfc_classifiers(retrieve_all=True)
 231         if not verbose:
 232             sfc_clfs = [sfc_clf['id']
 233                         for sfc_clf in sfc_clfs['sfc_classifiers']]
 234         return sfc_clfs
 235     except Exception, e:
 236         logger.error("Error [list_sfc_classifiers(tacker_client)]: %s" % e)
 237         return None
 238
 239
 240 def create_sfc_classifier(tacker_client, sfc_clf_name, sfc_id=None,
 241                           sfc_name=None, match={}):
 242     # Example match:
 243     # match: {
 244     #     "source_port": "0",
 245     #     "protocol": "6",
 246     #     "dest_port": "80"
 247     # }
 248     try:
 249         sfc_clf_body = {
 250             'sfc_classifier': {
 251                 'attributes': {},
 252                 'name': sfc_clf_name,
 253                 'match': match,
 254                 'chain': ''
 255             }
 256         }
 257         if sfc_id is not None:
 258             sfc_clf_body['sfc_classifier']['chain'] = sfc_id
 259         else:
 260             if sfc_name is None:
 261                 raise Exception('You need to provide an SFC id or name')
 262             sfc_clf_body['sfc_classifier']['chain'] = get_sfc_id(
 263                 tacker_client, sfc_name)
 264         return tacker_client.create_sfc_classifier(body=sfc_clf_body)
 265     except Exception, e:
 266         logger.error("error [create_sfc_classifier(tacker_client, '%s', '%s',"
 267                      " '%s', '%s')]: '%s'"
 268                      % (sfc_clf_name, sfc_id, sfc_name, str(match), e))
 269         return None
 270
 271
 272 def delete_sfc_classifier(tacker_client,
 273                           sfc_clf_id=None,
 274                           sfc_clf_name=None):
 275     try:
 276         sfc_clf = sfc_clf_id
 277         if sfc_clf is None:
 278             if sfc_clf_name is None:
 279                 raise Exception('You need to provide an SFC'
 280                                 'classifier id or name')
 281             sfc_clf = get_sfc_classifier_id(tacker_client, sfc_clf_name)
 282         return tacker_client.delete_sfc_classifier(sfc_clf)
 283     except Exception, e:
 284         logger.error("Error [delete_sfc_classifier(tacker_client, '%s', "
 285                      "'%s')]: %s" % (sfc_clf_id, sfc_clf_name, e))
 286         return None