1 ###########################################################################
2 # Copyright (c) 2016 Ericsson AB and others.
3 # Author: George Paraskevopoulos <geopar@intracom-telecom.com>
5 # Wrappers for trozet's python-tackerclient v1.0
6 # (https://github.com/trozet/python-tackerclient)
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 ##########################################################################
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
20 logger = ft_logger.Logger("tacker_utils").getLogger()
23 def get_tacker_client(other_creds={}):
24 sess = os_utils.get_session(other_creds)
25 return tackerclient.Client(session=sess)
28 # *********************************************
30 # *********************************************
31 def get_id_from_name(tacker_client, resource_type, resource_name):
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']
39 logger.error("Error [get_id_from_name(tacker_client, "
40 "resource_type, resource_name)]: %s" % e)
44 def get_vnfd_id(tacker_client, vnfd_name):
45 return get_id_from_name(tacker_client, 'vnfd', vnfd_name)
48 def get_vnf_id(tacker_client, vnf_name, timeout=5):
50 while vnf_id is None and timeout >= 0:
52 vnf_id = get_id_from_name(tacker_client, 'vnf', vnf_name)
54 logger.info("Could not retrieve ID for vnf with name [%s]."
55 " Retrying." % vnf_name)
61 def get_sfc_id(tacker_client, sfc_name):
62 return get_id_from_name(tacker_client, 'sfc', sfc_name)
65 def get_sfc_classifier_id(tacker_client, sfc_clf_name):
66 return get_id_from_name(tacker_client, 'sfc-classifier', sfc_clf_name)
69 def list_vnfds(tacker_client, verbose=False):
71 vnfds = tacker_client.list_vnfds(retrieve_all=True)
73 vnfds = [vnfd['id'] for vnfd in vnfds['vnfds']]
76 logger.error("Error [list_vnfds(tacker_client)]: %s" % e)
80 def create_vnfd(tacker_client, tosca_file=None):
83 if tosca_file is not None:
84 with open(tosca_file) as tosca_fd:
85 vnfd_body = tosca_fd.read()
86 logger.info('VNFD template:\n{0}'.format(vnfd_body))
87 return tacker_client.create_vnfd(
88 body={"vnfd": {"attributes": {"vnfd": vnfd_body}}})
90 logger.error("Error [create_vnfd(tacker_client, '%s')]: %s"
95 def delete_vnfd(tacker_client, vnfd_id=None, vnfd_name=None):
100 raise Exception('You need to provide VNFD id or VNFD name')
101 vnfd = get_vnfd_id(tacker_client, vnfd_name)
102 return tacker_client.delete_vnfd(vnfd)
104 logger.error("Error [delete_vnfd(tacker_client, '%s', '%s')]: %s"
105 % (vnfd_id, vnfd_name, e))
109 def list_vnfs(tacker_client, verbose=False):
111 vnfs = tacker_client.list_vnfs(retrieve_all=True)
113 vnfs = [vnf['id'] for vnf in vnfs['vnfs']]
116 logger.error("Error [list_vnfs(tacker_client)]: %s" % e)
120 def create_vnf(tacker_client, vnf_name, vnfd_id=None,
121 vnfd_name=None, param_file=None):
129 if param_file is not None:
131 with open(param_file) as f:
133 vnf_body['vnf']['attributes']['param_values'] = params
134 if vnfd_id is not None:
135 vnf_body['vnf']['vnfd_id'] = vnfd_id
137 if vnfd_name is None:
138 raise Exception('vnfd id or vnfd name is required')
139 vnf_body['vnf']['vnfd_id'] = get_vnfd_id(tacker_client, vnfd_name)
140 return tacker_client.create_vnf(body=vnf_body)
142 logger.error("error [create_vnf(tacker_client,"
143 " '%s', '%s', '%s')]: %s"
144 % (vnf_name, vnfd_id, vnfd_name, e))
148 def wait_for_vnf(tacker_client, vnf_id=None, vnf_name=None, timeout=60):
150 if vnf_id is None and vnf_name is None:
151 raise Exception('You must specify vnf_id or vnf_name')
152 _id = get_vnf_id(tacker_client, vnf_name) if vnf_id is None else vnf_id
154 vnf = next((v for v in list_vnfs(tacker_client, verbose=True)['vnfs']
155 if v['id'] == _id), None)
157 raise Exception("Could not retrieve VNF with ID [%s]" % _id)
158 logger.info('Waiting for vnf {0}'.format(str(vnf)))
159 while True and timeout >= 0:
160 if vnf['status'] == 'ERROR':
161 raise Exception('Error when booting vnf %s' % _id)
162 elif vnf['status'] == 'PENDING_CREATE':
170 logger.error("error [wait_for_vnf(tacker_client, '%s', '%s')]: %s"
171 % (vnf_id, vnf_name, e))
175 def delete_vnf(tacker_client, vnf_id=None, vnf_name=None):
180 raise Exception('You need to provide a VNF id or name')
181 vnf = get_vnf_id(tacker_client, vnf_name)
182 return tacker_client.delete_vnf(vnf)
184 logger.error("Error [delete_vnf(tacker_client, '%s', '%s')]: %s"
185 % (vnf_id, vnf_name, e))
189 def list_sfcs(tacker_client, verbose=False):
191 sfcs = tacker_client.list_sfcs(retrieve_all=True)
193 sfcs = [sfc['id'] for sfc in sfcs['sfcs']]
196 logger.error("Error [list_sfcs(tacker_client)]: %s" % e)
200 def create_sfc(tacker_client, sfc_name,
202 chain_vnf_names=None,
213 sfc_body['sfc']['symmetrical'] = True
214 if chain_vnf_ids is not None:
215 sfc_body['sfc']['chain'] = chain_vnf_ids
217 if chain_vnf_names is None:
218 raise Exception('You need to provide a chain of VNFs')
219 sfc_body['sfc']['chain'] = [get_vnf_id(tacker_client, name)
220 for name in chain_vnf_names]
221 return tacker_client.create_sfc(body=sfc_body)
223 logger.error("error [create_sfc(tacker_client,"
224 " '%s', '%s', '%s')]: %s"
225 % (sfc_name, chain_vnf_ids, chain_vnf_names, e))
229 def delete_sfc(tacker_client, sfc_id=None, sfc_name=None):
234 raise Exception('You need to provide an SFC id or name')
235 sfc = get_sfc_id(tacker_client, sfc_name)
236 return tacker_client.delete_sfc(sfc)
238 logger.error("Error [delete_sfc(tacker_client, '%s', '%s')]: %s"
239 % (sfc_id, sfc_name, e))
243 def list_sfc_classifiers(tacker_client, verbose=False):
245 sfc_clfs = tacker_client.list_sfc_classifiers(retrieve_all=True)
247 sfc_clfs = [sfc_clf['id']
248 for sfc_clf in sfc_clfs['sfc_classifiers']]
251 logger.error("Error [list_sfc_classifiers(tacker_client)]: %s" % e)
255 def create_sfc_classifier(tacker_client, sfc_clf_name, sfc_id=None,
256 sfc_name=None, match={}):
259 # "source_port": "0",
267 'name': sfc_clf_name,
272 if sfc_id is not None:
273 sfc_clf_body['sfc_classifier']['chain'] = sfc_id
276 raise Exception('You need to provide an SFC id or name')
277 sfc_clf_body['sfc_classifier']['chain'] = get_sfc_id(
278 tacker_client, sfc_name)
279 return tacker_client.create_sfc_classifier(body=sfc_clf_body)
281 logger.error("error [create_sfc_classifier(tacker_client,"
282 " '%s', '%s','%s', '%s')]: '%s'"
283 % (sfc_clf_name, sfc_id, sfc_name, str(match), e))
287 def delete_sfc_classifier(tacker_client,
293 if sfc_clf_name is None:
294 raise Exception('You need to provide an SFC'
295 'classifier id or name')
296 sfc_clf = get_sfc_classifier_id(tacker_client, sfc_clf_name)
297 return tacker_client.delete_sfc_classifier(sfc_clf)
299 logger.error("Error [delete_sfc_classifier(tacker_client, '%s', "
300 "'%s')]: %s" % (sfc_clf_id, sfc_clf_name, e))