1 # Copyright 2017 ZTE Corporation.
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
17 from lcm.pub.utils.toscaparser.basemodel import BaseInfoModel
20 class EtsiNsdInfoModel(BaseInfoModel):
22 def __init__(self, path, params):
23 tosca = self.buildToscaTemplate(path, params)
24 self.parseModel(tosca)
26 def parseModel(self, tosca):
27 self.buidMetadata(tosca)
28 if hasattr(tosca, 'topology_template') and hasattr(tosca.topology_template, 'inputs'):
29 self.inputs = self.buildInputs(tosca.topology_template.inputs)
31 nodeTemplates = map(functools.partial(self.buildNode, inputs=tosca.inputs, parsed_params=tosca.parsed_params),
34 self.vnfs = self._get_all_vnf(nodeTemplates)
35 self.pnfs = self._get_all_pnf(nodeTemplates)
36 self.vls = self.get_all_vl(nodeTemplates)
37 self.cps = self.get_all_cp(nodeTemplates)
38 self.routers = self.get_all_router(nodeTemplates)
39 self.fps = self._get_all_fp(nodeTemplates)
40 self.vnffgs = self._get_all_vnffg(tosca.topology_template.groups)
41 self.server_groups = self.get_all_server_group(tosca.topology_template.groups)
42 self.ns_exposed = self.get_all_endpoint_exposed(tosca.topology_template)
43 self.policies = self._get_policies_scaling(tosca.topology_template.policies)
44 self.ns_flavours = self.get_all_flavour(tosca.topology_template.groups)
47 def buildInputs(self, top_inputs):
49 for tmpinput in top_inputs:
51 tmp['type'] = tmpinput.type
52 tmp['description'] = tmpinput.description
53 tmp['default'] = tmpinput.default
55 ret[tmpinput.name] = tmp
58 def buildNode(self, nodeTemplate, inputs, parsed_params):
60 ret['name'] = nodeTemplate.name
61 ret['nodeType'] = nodeTemplate.type
62 if 'description' in nodeTemplate.entity_tpl:
63 ret['description'] = nodeTemplate.entity_tpl['description']
65 ret['description'] = ''
66 props = self.buildProperties(nodeTemplate, parsed_params)
67 ret['properties'] = self.verify_properties(props, inputs, parsed_params)
68 ret['requirements'] = self.build_requirements(nodeTemplate)
69 self.buildCapabilities(nodeTemplate, inputs, ret)
70 self.buildArtifacts(nodeTemplate, inputs, ret)
71 interfaces = self.build_interfaces(nodeTemplate)
72 if interfaces: ret['interfaces'] = interfaces
75 def _get_all_vnf(self, nodeTemplates):
77 for node in nodeTemplates:
80 vnf['vnf_id'] = node['name']
81 vnf['description'] = node['description']
82 vnf['properties'] = node['properties']
83 vnf['dependencies'] = map(lambda x: self.get_requirement_node_name(x), self.getNodeDependencys(node))
84 vnf['networks'] = self.get_networks(node)
89 def _get_all_pnf(self, nodeTemplates):
91 for node in nodeTemplates:
94 pnf['pnf_id'] = node['name']
95 pnf['description'] = node['description']
96 pnf['properties'] = node['properties']
97 pnf['cps'] = self.getVirtalBindingCpIds(node, nodeTemplates)
102 def getVirtalBindingCpIds(self, node, nodeTemplates):
103 return map(lambda x: x['name'], self.getVirtalBindingCps(node, nodeTemplates))
105 def getVirtalBindingCps(self, node, nodeTemplates):
107 for tmpnode in nodeTemplates:
108 if 'requirements' in tmpnode:
109 for item in tmpnode['requirements']:
110 for key, value in item.items():
111 if key.upper().startswith('VIRTUALBINDING'):
112 req_node_name = self.get_requirement_node_name(value)
113 if req_node_name != None and req_node_name == node['name']:
117 def get_all_vl(self, nodeTemplates):
119 for node in nodeTemplates:
122 vl['vl_id'] = node['name']
123 vl['description'] = node['description']
124 vl['properties'] = node['properties']
125 vl['route_external'] = False
126 vl['route_id'] = self._get_vl_route_id(node)
128 if self._isExternalVL(node):
130 vl['vl_id'] = node['name']
131 vl['description'] = node['description']
132 vl['properties'] = node['properties']
133 vl['route_external'] = True
137 def _get_vl_route_id(self, node):
138 route_ids = map(lambda x: self.get_requirement_node_name(x),
139 self.getRequirementByName(node, 'virtual_route'))
140 if len(route_ids) > 0:
144 def _isExternalVL(self, node):
145 return node['nodeType'].upper().find('.ROUTEEXTERNALVL') >= 0
147 def get_all_cp(self, nodeTemplates):
149 for node in nodeTemplates:
152 cp['cp_id'] = node['name']
153 cp['cpd_id'] = node['name']
154 cp['description'] = node['description']
155 cp['properties'] = node['properties']
156 cp['vl_id'] = self.get_node_vl_id(node)
157 binding_node_ids = map(lambda x: self.get_requirement_node_name(x), self.getVirtualbindings(node))
158 # cp['vnf_id'] = self._filter_vnf_id(binding_node_ids, nodeTemplates)
159 cp['pnf_id'] = self._filter_pnf_id(binding_node_ids, nodeTemplates)
160 vls = self.buil_cp_vls(node)
166 def buil_cp_vls(self, node):
167 return map(lambda x: self._build_cp_vl(x), self.getVirtualLinks(node))
169 def _build_cp_vl(self, req):
171 cp_vl['vl_id'] = self.get_prop_from_obj(req, 'node')
172 relationship = self.get_prop_from_obj(req, 'relationship')
173 if relationship != None:
174 properties = self.get_prop_from_obj(relationship, 'properties')
175 if properties != None and isinstance(properties, dict):
176 for key, value in properties.items():
180 def _filter_pnf_id(self, node_ids, node_templates):
181 for node_id in node_ids:
182 node = self.get_node_by_name(node_templates, node_id)
187 def get_all_router(self, nodeTemplates):
189 for node in nodeTemplates:
190 if self._isRouter(node):
192 ret['router_id'] = node['name']
193 ret['description'] = node['description']
194 ret['properties'] = node['properties']
195 ret['external_vl_id'] = self._get_router_external_vl_id(node)
196 ret['external_ip_addresses'] = self._get_external_ip_addresses(node)
201 def _isRouter(self, node):
202 return node['nodeType'].upper().find('.ROUTER.') >= 0 or node['nodeType'].upper().endswith('.ROUTER')
204 def _get_router_external_vl(self, node):
205 return self.getRequirementByName(node, 'external_virtual_link')
207 def _get_router_external_vl_id(self, node):
208 ids = map(lambda x: self.get_requirement_node_name(x), self._get_router_external_vl(node))
213 def _get_external_ip_addresses(self, node):
214 external_vls = self._get_router_external_vl(node)
215 if len(external_vls) > 0:
216 if 'relationship' in external_vls[0] and 'properties' in external_vls[0]['relationship'] and 'router_ip_address' in external_vls[0]['relationship']['properties']:
217 return external_vls[0]['relationship']['properties']['router_ip_address']
220 def _get_all_fp(self, nodeTemplates):
222 for node in nodeTemplates:
225 fp['fp_id'] = node['name']
226 fp['description'] = node['description']
227 fp['properties'] = node['properties']
228 fp['forwarder_list'] = self._getForwarderList(node, nodeTemplates)
233 def _isFp(self, node):
234 return node['nodeType'].upper().find('.FP.') >= 0 or node['nodeType'].upper().find('.SFP.') >= 0 or node[
235 'nodeType'].upper().endswith('.FP') or node['nodeType'].upper().endswith('.SFP')
237 def _getForwarderList(self, node, node_templates):
239 if 'requirements' in node:
240 for item in node['requirements']:
241 for key, value in item.items():
242 if key == 'forwarder':
243 tmpnode = self.get_node_by_req(node_templates, value)
244 type = 'cp' if self.isCp(tmpnode) else 'vnf'
245 req_node_name = self.get_requirement_node_name(value)
246 if isinstance(value, dict) and 'capability' in value:
247 forwarderList.append(
248 {"type": type, "node_name": req_node_name, "capability": value['capability']})
250 forwarderList.append({"type": type, "node_name": req_node_name, "capability": ""})
254 def get_node_by_req(self, node_templates, req):
255 req_node_name = self.get_requirement_node_name(req)
256 return self.get_node_by_name(node_templates, req_node_name)
258 def _get_all_vnffg(self, groups):
261 if self._isVnffg(group):
263 vnffg['vnffg_id'] = group.name
264 vnffg['description'] = group.description
265 if 'properties' in group.tpl:
266 vnffg['properties'] = group.tpl['properties']
267 vnffg['members'] = group.members
272 def _isVnffg(self, group):
273 return group.type.upper().find('.VNFFG.') >= 0 or group.type.upper().find(
274 '.SFC.') >= 0 or group.type.upper().endswith('.VNFFG') or group.type.upper().endswith('.SFC')
276 def get_all_server_group(self, groups):
279 if self._isServerGroup(group):
281 ret['group_id'] = group.name
282 ret['description'] = group.description
283 if 'properties' in group.tpl:
284 ret['properties'] = group.tpl['properties']
285 ret['members'] = group.members
290 def _isServerGroup(self, group):
291 return group.type.upper().find('.AFFINITYORANTIAFFINITYGROUP.') >= 0 or group.type.upper().endswith(
292 '.AFFINITYORANTIAFFINITYGROUP')
294 def get_all_endpoint_exposed(self, topo_tpl):
295 if 'substitution_mappings' in topo_tpl.tpl:
296 external_cps = self._get_external_cps(topo_tpl.tpl['substitution_mappings'])
297 forward_cps = self._get_forward_cps(topo_tpl.tpl['substitution_mappings'])
298 return {"external_cps": external_cps, "forward_cps": forward_cps}
301 def _get_external_cps(self, subs_mappings):
303 if 'requirements' in subs_mappings:
304 for key, value in subs_mappings['requirements'].items():
305 if isinstance(value, list) and len(value) > 0:
306 external_cps.append({"key_name": key, "cpd_id": value[0]})
308 external_cps.append({"key_name": key, "cpd_id": value})
311 def _get_forward_cps(self, subs_mappings):
313 if 'capabilities' in subs_mappings:
314 for key, value in subs_mappings['capabilities'].items():
315 if isinstance(value, list) and len(value) > 0:
316 forward_cps.append({"key_name": key, "cpd_id": value[0]})
318 forward_cps.append({"key_name": key, "cpd_id": value})
321 def _get_policies_scaling(self, top_policies):
322 policies_scaling = []
323 scaling_policies = self.get_scaling_policies(top_policies)
324 if len(scaling_policies) > 0:
325 policies_scaling.append({"scaling": scaling_policies})
326 return policies_scaling
328 def get_policies_by_keyword(self, top_policies, keyword):
330 for policy in top_policies:
331 if policy.type.upper().find(keyword) >= 0:
333 tmp['policy_id'] = policy.name
334 tmp['description'] = policy.description
335 if 'properties' in policy.entity_tpl:
336 tmp['properties'] = policy.entity_tpl['properties']
337 tmp['targets'] = policy.targets
342 def get_scaling_policies(self, top_policies):
343 return self.get_policies_by_keyword(top_policies, '.SCALING')
345 def get_all_flavour(self, groups):
348 if self._isFlavour(group):
350 ret['flavour_id'] = group.name
351 ret['description'] = group.description
352 if 'properties' in group.tpl:
353 ret['properties'] = group.tpl['properties']
354 ret['members'] = group.members
359 def _isFlavour(self, group):
360 return group.type.upper().find('FLAVOUR') >= 0