1 # Copyright 2018 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.
21 from catalog.packages.biz.common import parse_file_range, read, save
22 from catalog.packages.const import PKG_STATUS
23 from catalog.pub.config.config import CATALOG_ROOT_PATH
24 from catalog.pub.database.models import NSPackageModel, PnfPackageModel, VnfPackageModel
25 from catalog.pub.exceptions import CatalogException, ResourceNotFoundException
26 from catalog.pub.utils import fileutil, toscaparser
27 from catalog.pub.utils.values import ignore_case_get
28 from catalog.packages.biz.notificationsutil import NsdNotifications
29 from catalog.packages import const
31 logger = logging.getLogger(__name__)
36 class NsDescriptor(object):
41 def create(self, data, id=None):
42 logger.info('Start to create a NSD...')
43 user_defined_data = ignore_case_get(data, 'userDefinedData', {})
45 'id': id if id else str(uuid.uuid4()),
46 'nsdOnboardingState': const.PKG_STATUS.CREATED,
47 'nsdOperationalState': const.PKG_STATUS.DISABLED,
48 'nsdUsageState': const.PKG_STATUS.NOT_IN_USE,
49 'userDefinedData': user_defined_data,
52 NSPackageModel.objects.create(
53 nsPackageId=data['id'],
54 onboardingState=data['nsdOnboardingState'],
55 operationalState=data['nsdOperationalState'],
56 usageState=data['nsdUsageState'],
57 userDefinedData=json.dumps(user_defined_data)
59 logger.info('A NSD(%s) has been created.' % data['id'])
62 def update(self, data, nsd_info_id):
63 usageState = PKG_STATUS.IN_USE if data["usageState"] else PKG_STATUS.NOT_IN_USE
64 NSPackageModel.objects.filter(nsPackageId=nsd_info_id).update(usageState=usageState)
66 def query_multiple(self, nsdId=None):
68 ns_pkgs = NSPackageModel.objects.filter(nsdId=nsdId)
70 ns_pkgs = NSPackageModel.objects.all()
72 for ns_pkg in ns_pkgs:
73 data = self.fill_resp_data(ns_pkg)
74 response_data.append(data)
77 def query_single(self, nsd_info_id):
78 ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
79 if not ns_pkgs.exists():
80 logger.error('NSD(%s) does not exist.' % nsd_info_id)
81 raise ResourceNotFoundException('NSD(%s) does not exist.' % nsd_info_id)
82 return self.fill_resp_data(ns_pkgs[0])
84 def delete_single(self, nsd_info_id):
85 logger.info('Start to delete NSD(%s)...' % nsd_info_id)
86 ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
87 if not ns_pkgs.exists():
88 logger.info('NSD(%s) has been deleted.' % nsd_info_id)
91 if ns_pkgs[0].operationalState != PKG_STATUS.DISABLED:
92 logger.error('NSD(%s) shall be DISABLED.' % nsd_info_id)
93 raise CatalogException('NSD(%s) shall be DISABLED.' % nsd_info_id)
94 if ns_pkgs[0].usageState != PKG_STATUS.NOT_IN_USE:
95 logger.error('NSD(%s) shall be NOT_IN_USE.' % nsd_info_id)
96 raise CatalogException('NSD(%s) shall be NOT_IN_USE.' % nsd_info_id)
99 ns_pkg_path = os.path.join(CATALOG_ROOT_PATH, nsd_info_id)
100 fileutil.delete_dirs(ns_pkg_path)
101 send_notification(const.NSD_NOTIFICATION_TYPE.NSD_DELETION, nsd_info_id)
102 logger.info('NSD(%s) has been deleted.' % nsd_info_id)
104 def upload(self, nsd_info_id, remote_file):
105 logger.info('Start to upload NSD(%s)...' % nsd_info_id)
106 ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
107 if not ns_pkgs.exists():
108 logger.error('NSD(%s) does not exist.' % nsd_info_id)
109 raise CatalogException('NSD(%s) does not exist.' % nsd_info_id)
110 ns_pkgs.update(onboardingState=const.PKG_STATUS.UPLOADING)
112 local_file_name = save(remote_file, nsd_info_id)
113 logger.info('NSD(%s) content has been uploaded.' % nsd_info_id)
114 return local_file_name
116 def download(self, nsd_info_id, file_range):
117 logger.info('Start to download NSD(%s)...' % nsd_info_id)
118 ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
119 if not ns_pkgs.exists():
120 logger.error('NSD(%s) does not exist.' % nsd_info_id)
121 raise ResourceNotFoundException('NSD(%s) does not exist.' % nsd_info_id)
122 if ns_pkgs[0].onboardingState != const.PKG_STATUS.ONBOARDED:
123 logger.error('NSD(%s) is not ONBOARDED.' % nsd_info_id)
124 raise CatalogException('NSD(%s) is not ONBOARDED.' % nsd_info_id)
126 local_file_path = ns_pkgs[0].localFilePath
127 start, end = parse_file_range(local_file_path, file_range)
128 logger.info('NSD(%s) has been downloaded.' % nsd_info_id)
129 return read(local_file_path, start, end)
131 def parse_nsd_and_save(self, nsd_info_id, local_file_name):
132 logger.info('Start to process NSD(%s)...' % nsd_info_id)
133 ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
134 ns_pkgs.update(onboardingState=const.PKG_STATUS.PROCESSING)
136 nsd_json = toscaparser.parse_nsd(local_file_name)
137 logger.debug("%s", nsd_json)
138 nsd = json.JSONDecoder().decode(nsd_json)
140 nsd_id = nsd.get("ns", {}).get("properties", {}).get("descriptor_id", "")
141 nsd_name = nsd.get("ns", {}).get("properties", {}).get("name", "")
142 nsd_version = nsd.get("ns", {}).get("properties", {}).get("version", "")
143 nsd_designer = nsd.get("ns", {}).get("properties", {}).get("designer", "")
144 invariant_id = nsd.get("ns", {}).get("properties", {}).get("invariant_id", "")
146 raise CatalogException("nsd_id(%s) does not exist in metadata." % nsd_id)
147 other_nspkg = NSPackageModel.objects.filter(nsdId=nsd_id)
148 if other_nspkg and other_nspkg[0].nsPackageId != nsd_info_id:
149 failure_details = "NSD(%s,%s) already exists.", nsd_id, other_nspkg[0].nsPackageId
150 logger.warn(failure_details)
151 send_notification(const.NSD_NOTIFICATION_TYPE.NSD_ONBOARDING_FAILURE, nsd_info_id, nsd_id,
152 failure_details=failure_details)
153 raise CatalogException("NSD(%s) already exists." % nsd_id)
155 for vnf in nsd["vnfs"]:
156 vnfd_id = vnf["properties"].get("descriptor_id", "undefined")
157 if vnfd_id == "undefined":
158 vnfd_id = vnf["properties"].get("id", "undefined")
159 pkg = VnfPackageModel.objects.filter(vnfdId=vnfd_id)
161 pkg = VnfPackageModel.objects.filter(vnfPackageId=vnfd_id)
163 vnfd_name = vnf.get("vnf_id", "undefined")
164 logger.error("[%s] is not distributed.", vnfd_name)
165 raise CatalogException("VNF package(%s) is not distributed." % vnfd_id)
167 for pnf in nsd["pnfs"]:
168 pnfd_id = pnf["properties"].get("descriptor_id", "undefined")
169 if pnfd_id == "undefined":
170 pnfd_id = pnf["properties"].get("id", "undefined")
171 pkg = PnfPackageModel.objects.filter(pnfdId=pnfd_id)
173 pkg = PnfPackageModel.objects.filter(pnfPackageId=pnfd_id)
175 pnfd_name = pnf.get("pnf_id", "undefined")
176 logger.error("[%s] is not distributed.", pnfd_name)
177 raise CatalogException("PNF package(%s) is not distributed." % pnfd_name)
182 nsdDesginer=nsd_designer,
183 nsdDescription=nsd.get("description", ""),
184 nsdVersion=nsd_version,
185 invariantId=invariant_id,
186 onboardingState=const.PKG_STATUS.ONBOARDED,
187 operationalState=const.PKG_STATUS.ENABLED,
188 usageState=const.PKG_STATUS.NOT_IN_USE,
189 nsPackageUri=local_file_name,
190 sdcCsarId=nsd_info_id,
191 localFilePath=local_file_name,
194 send_notification(const.NSD_NOTIFICATION_TYPE.NSD_ONBOARDING, nsd_info_id, nsd_id)
195 logger.info('NSD(%s) has been processed.' % nsd_info_id)
197 def fill_resp_data(self, ns_pkg):
199 'id': ns_pkg.nsPackageId,
200 'nsdId': ns_pkg.nsdId,
201 'nsdName': ns_pkg.nsdName,
202 'nsdVersion': ns_pkg.nsdVersion,
203 'nsdDesigner': ns_pkg.nsdDesginer,
204 'nsdInvariantId': ns_pkg.invariantId,
206 'pnfdInfoIds': [], # TODO
207 'nestedNsdInfoIds': [], # TODO
208 'nsdOnboardingState': ns_pkg.onboardingState,
209 'onboardingFailureDetails': None, # TODO
210 'nsdOperationalState': ns_pkg.operationalState,
211 'nsdUsageState': ns_pkg.usageState,
212 'userDefinedData': {},
213 '_links': None # TODO
217 nsd_model = json.JSONDecoder().decode(ns_pkg.nsdModel)
219 for vnf in nsd_model['vnfs']:
220 vnfd_id = vnf["properties"].get("descriptor_id", "undefined")
221 if vnfd_id == "undefined":
222 vnfd_id = vnf["properties"].get("id", "undefined")
223 pkgs = VnfPackageModel.objects.filter(vnfdId=vnfd_id)
225 pkgs = VnfPackageModel.objects.filter(vnfPackageId=vnfd_id)
227 vnf_pkg_ids.append(pkg.vnfPackageId)
228 data['vnfPkgIds'] = vnf_pkg_ids
231 for pnf in nsd_model['pnfs']:
232 pnfd_id = pnf["properties"].get("descriptor_id", "undefined")
233 if pnfd_id == "undefined":
234 pnfd_id = pnf["properties"].get("id", "undefined")
235 pkgs = PnfPackageModel.objects.filter(pnfdId=pnfd_id)
237 pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_id)
239 pnf_info_ids.append(pkg.pnfPackageId)
240 data['pnfInfoIds'] = pnf_info_ids # TODO: need reconfirming
242 if ns_pkg.userDefinedData:
243 user_defined_data = json.JSONDecoder().decode(ns_pkg.userDefinedData)
244 data['userDefinedData'] = user_defined_data
248 def handle_upload_failed(self, nsd_info_id):
249 ns_pkg = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
250 ns_pkg.update(onboardingState=const.PKG_STATUS.CREATED)
253 def send_notification(type, nsd_info_id, nsd_id=None, failure_details=None, operational_state=None):
254 notify = NsdNotifications(type, nsd_info_id, nsd_id,
255 failure_details=failure_details,
256 operational_state=operational_state)
257 notify.send_notification()