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(other_creds={}):
  24     sess = os_utils.get_session(other_creds)
  25     return tackerclient.Client(session=sess)
  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.info('VNFD template:\n{0}'.format(vnfd_body))
  78         return tacker_client.create_vnfd(
  79             body={"vnfd": {"attributes": {"vnfd": vnfd_body}}})
  80     except Exception, e:
  81         logger.error("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,"
 128                      " '%s', '%s', '%s')]: %s"
 129                      % (vnf_name, vnfd_id, vnfd_name, e))
 130         return None
 131
 132
 133 def wait_for_vnf(tacker_client, vnf_id=None, vnf_name=None):
 134     try:
 135         _id = None
 136         if vnf_id is not None:
 137             _id = vnf_id
 138         elif vnf_name is not None:
 139             while _id is None:
 140                 try:
 141                     _id = get_vnf_id(tacker_client, vnf_name)
 142                 except:
 143                     logger.error("Bazinga")
 144         else:
 145             raise Exception('You must specify vnf_id or vnf_name')
 146         while True:
 147             vnf = [v for v in list_vnfs(tacker_client, verbose=True)['vnfs']
 148                    if v['id'] == _id]
 149             vnf = vnf[0]
 150             logger.info('Waiting for vnf {0}'.format(str(vnf)))
 151             if vnf['status'] == 'ERROR':
 152                 raise Exception('Error when booting vnf %s' % _id)
 153             elif vnf['status'] == 'PENDING_CREATE':
 154                 time.sleep(3)
 155                 continue
 156             else:
 157                 break
 158         return _id
 159     except Exception, e:
 160         logger.error("error [wait_for_vnf(tacker_client, '%s', '%s')]: %s"
 161                      % (vnf_id, vnf_name, e))
 162         return None
 163
 164
 165 def delete_vnf(tacker_client, vnf_id=None, vnf_name=None):
 166     try:
 167         vnf = vnf_id
 168         if vnf is None:
 169             if vnf_name is None:
 170                 raise Exception('You need to provide a VNF id or name')
 171             vnf = get_vnf_id(tacker_client, vnf_name)
 172         return tacker_client.delete_vnf(vnf)
 173     except Exception, e:
 174         logger.error("Error [delete_vnf(tacker_client, '%s', '%s')]: %s"
 175                      % (vnf_id, vnf_name, e))
 176         return None
 177
 178
 179 def list_sfcs(tacker_client, verbose=False):
 180     try:
 181         sfcs = tacker_client.list_sfcs(retrieve_all=True)
 182         if not verbose:
 183             sfcs = [sfc['id'] for sfc in sfcs['sfcs']]
 184         return sfcs
 185     except Exception, e:
 186         logger.error("Error [list_sfcs(tacker_client)]: %s" % e)
 187         return None
 188
 189
 190 def create_sfc(tacker_client, sfc_name,
 191                chain_vnf_ids=None,
 192                chain_vnf_names=None):
 193     try:
 194         sfc_body = {
 195             'sfc': {
 196                 'attributes': {},
 197                 'name': sfc_name,
 198                 'chain': []
 199             }
 200         }
 201         if chain_vnf_ids is not None:
 202             sfc_body['sfc']['chain'] = chain_vnf_ids
 203         else:
 204             if chain_vnf_names is None:
 205                 raise Exception('You need to provide a chain of VNFs')
 206             sfc_body['sfc']['chain'] = [get_vnf_id(tacker_client, name)
 207                                         for name in chain_vnf_names]
 208         return tacker_client.create_sfc(body=sfc_body)
 209     except Exception, e:
 210         logger.error("error [create_sfc(tacker_client,"
 211                      " '%s', '%s', '%s')]: %s"
 212                      % (sfc_name, chain_vnf_ids, chain_vnf_names, e))
 213         return None
 214
 215
 216 def delete_sfc(tacker_client, sfc_id=None, sfc_name=None):
 217     try:
 218         sfc = sfc_id
 219         if sfc is None:
 220             if sfc_name is None:
 221                 raise Exception('You need to provide an SFC id or name')
 222             sfc = get_sfc_id(tacker_client, sfc_name)
 223         return tacker_client.delete_sfc(sfc)
 224     except Exception, e:
 225         logger.error("Error [delete_sfc(tacker_client, '%s', '%s')]: %s"
 226                      % (sfc_id, sfc_name, e))
 227         return None
 228
 229
 230 def list_sfc_classifiers(tacker_client, verbose=False):
 231     try:
 232         sfc_clfs = tacker_client.list_sfc_classifiers(retrieve_all=True)
 233         if not verbose:
 234             sfc_clfs = [sfc_clf['id']
 235                         for sfc_clf in sfc_clfs['sfc_classifiers']]
 236         return sfc_clfs
 237     except Exception, e:
 238         logger.error("Error [list_sfc_classifiers(tacker_client)]: %s" % e)
 239         return None
 240
 241
 242 def create_sfc_classifier(tacker_client, sfc_clf_name, sfc_id=None,
 243                           sfc_name=None, match={}):
 244     # Example match:
 245     # match: {
 246     #     "source_port": "0",
 247     #     "protocol": "6",
 248     #     "dest_port": "80"
 249     # }
 250     try:
 251         sfc_clf_body = {
 252             'sfc_classifier': {
 253                 'attributes': {},
 254                 'name': sfc_clf_name,
 255                 'match': match,
 256                 'chain': ''
 257             }
 258         }
 259         if sfc_id is not None:
 260             sfc_clf_body['sfc_classifier']['chain'] = sfc_id
 261         else:
 262             if sfc_name is None:
 263                 raise Exception('You need to provide an SFC id or name')
 264             sfc_clf_body['sfc_classifier']['chain'] = get_sfc_id(
 265                 tacker_client, sfc_name)
 266         return tacker_client.create_sfc_classifier(body=sfc_clf_body)
 267     except Exception, e:
 268         logger.error("error [create_sfc_classifier(tacker_client,"
 269                      " '%s', '%s','%s', '%s')]: '%s'"
 270                      % (sfc_clf_name, sfc_id, sfc_name, str(match), e))
 271         return None
 272
 273
 274 def delete_sfc_classifier(tacker_client,
 275                           sfc_clf_id=None,
 276                           sfc_clf_name=None):
 277     try:
 278         sfc_clf = sfc_clf_id
 279         if sfc_clf is None:
 280             if sfc_clf_name is None:
 281                 raise Exception('You need to provide an SFC'
 282                                 'classifier id or name')
 283             sfc_clf = get_sfc_classifier_id(tacker_client, sfc_clf_name)
 284         return tacker_client.delete_sfc_classifier(sfc_clf)
 285     except Exception, e:
 286         logger.error("Error [delete_sfc_classifier(tacker_client, '%s', "
 287                      "'%s')]: %s" % (sfc_clf_id, sfc_clf_name, e))
 288         return None