cc941b26b1d2ab090eefa58b2e1233069706be05
[modeling/etsicatalog.git] / genericparser / pub / utils / toscaparsers / vnfdparser / vnfd_sol_base.py
1 # Copyright 2019 ZTE Corporation.
2 #
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
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
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.
14
15 import functools
16 import logging
17 import os
18
19
20 logger = logging.getLogger(__name__)
21
22 SECTIONS = (VDU_COMPUTE_TYPE, VNF_VL_TYPE, VDU_CP_TYPE, VDU_STORAGE_TYPE) = \
23            ('tosca.nodes.nfv.Vdu.Compute', 'tosca.nodes.nfv.VnfVirtualLink', 'tosca.nodes.nfv.VduCp', 'tosca.nodes.nfv.Vdu.VirtualStorage')
24
25
26 class VnfdSOLBase():
27
28     def __init__(self, model):
29         self.model = model
30
31     def build_vnf(self, tosca):
32         vnf = self.model.get_substitution_mappings(tosca)
33         properties = vnf.get("properties", {})
34         metadata = vnf.get("metadata", {})
35         if properties.get("descriptor_id", "") == "":
36             descriptor_id = metadata.get("descriptor_id", "")
37             if descriptor_id == "":
38                 descriptor_id = metadata.get("id", "")
39             if descriptor_id == "":
40                 descriptor_id = metadata.get("UUID", "")
41             properties["descriptor_id"] = descriptor_id
42
43         if properties.get("descriptor_version", "") == "":
44             version = metadata.get("template_version", "")
45             if version == "":
46                 version = metadata.get("version", "")
47             properties["descriptor_version"] = version
48
49         if properties.get("provider", "") == "":
50             provider = metadata.get("template_author", "")
51             if provider == "":
52                 provider = metadata.get("provider", "")
53             properties["provider"] = provider
54
55         if properties.get("template_name", "") == "":
56             template_name = metadata.get("template_name", "")
57             if template_name == "":
58                 template_name = metadata.get("template_name", "")
59             properties["template_name"] = template_name
60         logger.debug("vnf:%s", vnf)
61         return vnf
62
63     def get_all_vl(self, nodeTemplates, node_types):
64         vls = []
65         for node in nodeTemplates:
66             if self.model.isNodeTypeX(node, node_types, VNF_VL_TYPE):
67                 vl = dict()
68                 vl['vl_id'] = node['name']
69                 vl['description'] = node['description']
70                 vl['properties'] = node['properties']
71                 vls.append(vl)
72         return vls
73
74     def get_all_cp(self, nodeTemplates, node_types):
75         cps = []
76         for node in nodeTemplates:
77             if self.model.isNodeTypeX(node, node_types, VDU_CP_TYPE):
78                 cp = {}
79                 cp['cp_id'] = node['name']
80                 cp['cpd_id'] = node['name']
81                 cp['description'] = node['description']
82                 cp['properties'] = node['properties']
83                 cp['vl_id'] = self._get_node_vl_id(node)
84                 cp['vdu_id'] = self._get_node_vdu_id(node)
85                 vls = self._buil_cp_vls(node)
86                 if len(vls) > 1:
87                     cp['vls'] = vls
88                 cps.append(cp)
89         return cps
90
91     def get_all_volume_storage(self, nodeTemplates, node_types):
92         rets = []
93         for node in nodeTemplates:
94             if self.model.isNodeTypeX(node, node_types, VDU_STORAGE_TYPE):
95                 ret = {}
96                 ret['volume_storage_id'] = node['name']
97                 if 'description' in node:
98                     ret['description'] = node['description']
99                 ret['properties'] = node['properties']
100                 rets.append(ret)
101         return rets
102
103     def get_all_vdu(self, nodeTemplates, node_types):
104         rets = []
105         inject_files = []
106         for node in nodeTemplates:
107             logger.debug("nodeTemplates :%s", node)
108             if self.model.isNodeTypeX(node, node_types, VDU_COMPUTE_TYPE):
109                 ret = {}
110                 ret['vdu_id'] = node['name']
111                 ret['type'] = node['nodeType']
112                 if 'description' in node:
113                     ret['description'] = node['description']
114                 ret['properties'] = node['properties']
115                 if 'inject_files' in node['properties']:
116                     inject_files = node['properties']['inject_files']
117                 if inject_files is not None:
118                     if isinstance(inject_files, list):
119                         for inject_file in inject_files:
120                             source_path = os.path.join(self.model.basepath, inject_file['source_path'])
121                             with open(source_path, "rt") as f:
122                                 source_data = f.read()
123                                 inject_file["source_data_base64"] = source_data
124                     if isinstance(inject_files, dict):
125                         source_path = os.path.join(self.model.basepath, inject_files['source_path'])
126                         with open(source_path, "rt") as f:
127                             source_data = f.read()
128                             inject_files["source_data_base64"] = source_data
129                 virtual_storages = self.model.getRequirementByName(node, 'virtual_storage')
130                 ret['virtual_storages'] = list(map(functools.partial(self._trans_virtual_storage), virtual_storages))
131                 ret['dependencies'] = [self.model.get_requirement_node_name(x) for x in self.model.getNodeDependencys(node)]
132                 virtual_compute = self.model.getCapabilityByName(node, 'virtual_compute')
133                 if virtual_compute is not None and 'properties' in virtual_compute:
134                     ret['virtual_compute'] = virtual_compute['properties']
135                 ret['vls'] = self._get_linked_vl_ids(node, nodeTemplates)
136                 ret['cps'] = self._get_virtal_binding_cp_ids(node, nodeTemplates)
137                 ret['artifacts'] = self.model.build_artifacts(node)
138                 rets.append(ret)
139         logger.debug("rets:%s", rets)
140         return rets
141
142     def get_all_endpoint_exposed(self):
143         if self.model.vnf:
144             external_cps = self._get_external_cps(self.model.vnf.get('requirements', None))
145             forward_cps = self._get_forward_cps(self.model.vnf.get('capabilities', None))
146             return {"external_cps": external_cps, "forward_cps": forward_cps}
147         return {}
148
149     def _trans_virtual_storage(self, virtual_storage):
150         if isinstance(virtual_storage, str):
151             return {"virtual_storage_id": virtual_storage}
152         else:
153             ret = {}
154             ret['virtual_storage_id'] = self.model.get_requirement_node_name(virtual_storage)
155             return ret
156
157     def _get_linked_vl_ids(self, node, node_templates):
158         vl_ids = []
159         cps = self._get_virtal_binding_cps(node, node_templates)
160         for cp in cps:
161             vl_reqs = self.model.getRequirementByName(cp, 'virtual_link')
162             for vl_req in vl_reqs:
163                 vl_ids.append(self.model.get_requirement_node_name(vl_req))
164         return vl_ids
165
166     def _get_virtal_binding_cp_ids(self, node, nodeTemplates):
167         return [x['name'] for x in self._get_virtal_binding_cps(node, nodeTemplates)]
168
169     def _get_virtal_binding_cps(self, node, nodeTemplates):
170         cps = []
171         for tmpnode in nodeTemplates:
172             if 'requirements' in tmpnode:
173                 for item in tmpnode['requirements']:
174                     for key, value in list(item.items()):
175                         if key.upper().startswith('VIRTUAL_BINDING'):
176                             req_node_name = self.model.get_requirement_node_name(value)
177                             if req_node_name is not None and req_node_name == node['name']:
178                                 cps.append(tmpnode)
179         return cps
180
181     def _get_node_vdu_id(self, node):
182         vdu_ids = [self.model.get_requirement_node_name(x) for x in self.model.getRequirementByName(node, 'virtual_binding')]
183         if len(vdu_ids) > 0:
184             return vdu_ids[0]
185         return ""
186
187     def _get_node_vl_id(self, node):
188         vl_ids = [self.model.get_requirement_node_name(x) for x in self.model.getRequirementByName(node, 'virtual_link')]
189         if len(vl_ids) > 0:
190             return vl_ids[0]
191         return ""
192
193     def _buil_cp_vls(self, node):
194         return [self._build_cp_vl(x) for x in self.model.getRequirementByName(node, 'virtual_link')]
195
196     def _build_cp_vl(self, req):
197         cp_vl = {}
198         cp_vl['vl_id'] = self.model.get_prop_from_obj(req, 'node')
199         relationship = self.model.get_prop_from_obj(req, 'relationship')
200         if relationship is not None:
201             properties = self.model.get_prop_from_obj(relationship, 'properties')
202             if properties is not None and isinstance(properties, dict):
203                 for key, value in list(properties.items()):
204                     cp_vl[key] = value
205         return cp_vl
206
207     def _get_external_cps(self, vnf_requirements):
208         external_cps = []
209         if vnf_requirements:
210             if isinstance(vnf_requirements, dict):
211                 for key, value in list(vnf_requirements.items()):
212                     if isinstance(value, list) and len(value) > 0:
213                         external_cps.append({"key_name": key, "cpd_id": value[0]})
214                     else:
215                         external_cps.append({"key_name": key, "cpd_id": value})
216             elif isinstance(vnf_requirements, list):
217                 for vnf_requirement in vnf_requirements:
218                     for key, value in list(vnf_requirement.items()):
219                         if isinstance(value, list) and len(value) > 0:
220                             external_cps.append({"key_name": key, "cpd_id": value[0]})
221                         else:
222                             external_cps.append({"key_name": key, "cpd_id": value})
223         return external_cps
224
225     def _get_forward_cps(self, vnf_capabilities):
226         forward_cps = []
227         if vnf_capabilities:
228             for key, value in list(vnf_capabilities.items()):
229                 if isinstance(value, list) and len(value) > 0:
230                     forward_cps.append({"key_name": key, "cpd_id": value[0]})
231                 else:
232                     forward_cps.append({"key_name": key, "cpd_id": value})
233         return forward_cps