genericparser/packages/biz/ns_descriptor.py

   1 # Copyright 2018 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
  16 import json
  17 import logging
  18 import os
  19 import uuid
  20
  21 from genericparser.packages.biz.common import parse_file_range, read, save
  22 from genericparser.packages.const import PKG_STATUS
  23 from genericparser.pub.config.config import GENERICPARSER_ROOT_PATH
  24 from genericparser.pub.database.models import NSPackageModel, PnfPackageModel, VnfPackageModel
  25 from genericparser.pub.exceptions import GenericparserException, ResourceNotFoundException
  26 from genericparser.pub.utils import fileutil, toscaparsers
  27 from genericparser.pub.utils.values import ignore_case_get
  28
  29 logger = logging.getLogger(__name__)
  30
  31 METADATA = "metadata"
  32
  33
  34 class NsDescriptor(object):
  35
  36     def __init__(self):
  37         pass
  38
  39     def create(self, data, id=None):
  40         logger.info('Start to create a NSD...')
  41         user_defined_data = ignore_case_get(data, 'userDefinedData', {})
  42         data = {
  43             'id': id if id else str(uuid.uuid4()),
  44             'nsdOnboardingState': PKG_STATUS.CREATED,
  45             'nsdOperationalState': PKG_STATUS.DISABLED,
  46             'nsdUsageState': PKG_STATUS.NOT_IN_USE,
  47             'userDefinedData': user_defined_data,
  48             '_links': None  # TODO
  49         }
  50         NSPackageModel.objects.create(
  51             nsPackageId=data['id'],
  52             onboardingState=data['nsdOnboardingState'],
  53             operationalState=data['nsdOperationalState'],
  54             usageState=data['nsdUsageState'],
  55             userDefinedData=json.dumps(user_defined_data)
  56         )
  57         logger.info('A NSD(%s) has been created.' % data['id'])
  58         return data
  59
  60     def query_multiple(self, nsdId=None):
  61         if nsdId:
  62             ns_pkgs = NSPackageModel.objects.filter(nsdId=nsdId)
  63         else:
  64             ns_pkgs = NSPackageModel.objects.all()
  65         response_data = []
  66         for ns_pkg in ns_pkgs:
  67             data = self.fill_resp_data(ns_pkg)
  68             response_data.append(data)
  69         return response_data
  70
  71     def query_single(self, nsd_info_id):
  72         ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
  73         if not ns_pkgs.exists():
  74             logger.error('NSD(%s) does not exist.' % nsd_info_id)
  75             raise ResourceNotFoundException('NSD(%s) does not exist.' % nsd_info_id)
  76         return self.fill_resp_data(ns_pkgs[0])
  77
  78     def delete_single(self, nsd_info_id):
  79         logger.info('Start to delete NSD(%s)...' % nsd_info_id)
  80         ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
  81         if not ns_pkgs.exists():
  82             logger.info('NSD(%s) has been deleted.' % nsd_info_id)
  83             return
  84         '''
  85         if ns_pkgs[0].operationalState != PKG_STATUS.DISABLED:
  86             logger.error('NSD(%s) shall be DISABLED.' % nsd_info_id)
  87             raise GenericparserException('NSD(%s) shall be DISABLED.' % nsd_info_id)
  88         if ns_pkgs[0].usageState != PKG_STATUS.NOT_IN_USE:
  89             logger.error('NSD(%s) shall be NOT_IN_USE.' % nsd_info_id)
  90             raise GenericparserException('NSD(%s) shall be NOT_IN_USE.' % nsd_info_id)
  91         '''
  92         ns_pkgs.delete()
  93         ns_pkg_path = os.path.join(GENERICPARSER_ROOT_PATH, nsd_info_id)
  94         fileutil.delete_dirs(ns_pkg_path)
  95         logger.info('NSD(%s) has been deleted.' % nsd_info_id)
  96
  97     def upload(self, nsd_info_id, remote_file):
  98         logger.info('Start to upload NSD(%s)...' % nsd_info_id)
  99         ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
 100         if not ns_pkgs.exists():
 101             logger.error('NSD(%s) does not exist.' % nsd_info_id)
 102             raise GenericparserException('NSD(%s) does not exist.' % nsd_info_id)
 103         ns_pkgs.update(onboardingState=PKG_STATUS.UPLOADING)
 104
 105         local_file_name = save(remote_file, nsd_info_id)
 106         logger.info('NSD(%s) content has been uploaded.' % nsd_info_id)
 107         return local_file_name
 108
 109     def download(self, nsd_info_id, file_range):
 110         logger.info('Start to download NSD(%s)...' % nsd_info_id)
 111         ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
 112         if not ns_pkgs.exists():
 113             logger.error('NSD(%s) does not exist.' % nsd_info_id)
 114             raise ResourceNotFoundException('NSD(%s) does not exist.' % nsd_info_id)
 115         if ns_pkgs[0].onboardingState != PKG_STATUS.ONBOARDED:
 116             logger.error('NSD(%s) is not ONBOARDED.' % nsd_info_id)
 117             raise GenericparserException('NSD(%s) is not ONBOARDED.' % nsd_info_id)
 118
 119         local_file_path = ns_pkgs[0].localFilePath
 120         start, end = parse_file_range(local_file_path, file_range)
 121         logger.info('NSD(%s) has been downloaded.' % nsd_info_id)
 122         return read(local_file_path, start, end)
 123
 124     def parse_nsd_and_save(self, nsd_info_id, local_file_name):
 125         logger.info('Start to process NSD(%s)...' % nsd_info_id)
 126         ns_pkgs = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
 127         ns_pkgs.update(onboardingState=PKG_STATUS.PROCESSING)
 128
 129         nsd_json = toscaparsers.parse_nsd(local_file_name)
 130         logger.debug("%s", nsd_json)
 131         nsd = json.JSONDecoder().decode(nsd_json)
 132
 133         nsd_id = nsd.get("ns", {}).get("properties", {}).get("descriptor_id", "")
 134         nsd_name = nsd.get("ns", {}).get("properties", {}).get("name", "")
 135         nsd_version = nsd.get("ns", {}).get("properties", {}).get("version", "")
 136         nsd_designer = nsd.get("ns", {}).get("properties", {}).get("designer", "")
 137         invariant_id = nsd.get("ns", {}).get("properties", {}).get("invariant_id", "")
 138         if nsd_id == "":
 139             raise GenericparserException("nsd_id(%s) does not exist in metadata." % nsd_id)
 140         other_nspkg = NSPackageModel.objects.filter(nsdId=nsd_id)
 141         if other_nspkg and other_nspkg[0].nsPackageId != nsd_info_id:
 142             logger.warn("NSD(%s,%s) already exists.", nsd_id, other_nspkg[0].nsPackageId)
 143             raise GenericparserException("NSD(%s) already exists." % nsd_id)
 144
 145         for vnf in nsd["vnfs"]:
 146             vnfd_id = vnf["properties"].get("descriptor_id", "undefined")
 147             if vnfd_id == "undefined":
 148                 vnfd_id = vnf["properties"].get("id", "undefined")
 149             pkg = VnfPackageModel.objects.filter(vnfdId=vnfd_id)
 150             if not pkg:
 151                 pkg = VnfPackageModel.objects.filter(vnfPackageId=vnfd_id)
 152             if not pkg:
 153                 vnfd_name = vnf.get("vnf_id", "undefined")
 154                 logger.error("[%s] is not distributed.", vnfd_name)
 155                 raise GenericparserException("VNF package(%s) is not distributed." % vnfd_id)
 156
 157         for pnf in nsd["pnfs"]:
 158             pnfd_id = pnf["properties"].get("descriptor_id", "undefined")
 159             if pnfd_id == "undefined":
 160                 pnfd_id = pnf["properties"].get("id", "undefined")
 161             pkg = PnfPackageModel.objects.filter(pnfdId=pnfd_id)
 162             if not pkg:
 163                 pkg = PnfPackageModel.objects.filter(pnfPackageId=pnfd_id)
 164             if not pkg:
 165                 pnfd_name = pnf.get("pnf_id", "undefined")
 166                 logger.error("[%s] is not distributed.", pnfd_name)
 167                 raise GenericparserException("PNF package(%s) is not distributed." % pnfd_name)
 168
 169         ns_pkgs.update(
 170             nsdId=nsd_id,
 171             nsdName=nsd_name,
 172             nsdDesginer=nsd_designer,
 173             nsdDescription=nsd.get("description", ""),
 174             nsdVersion=nsd_version,
 175             invariantId=invariant_id,
 176             onboardingState=PKG_STATUS.ONBOARDED,
 177             operationalState=PKG_STATUS.ENABLED,
 178             usageState=PKG_STATUS.NOT_IN_USE,
 179             nsPackageUri=local_file_name,
 180             sdcCsarId=nsd_info_id,
 181             localFilePath=local_file_name,
 182             nsdModel=nsd_json
 183         )
 184         logger.info('NSD(%s) has been processed.' % nsd_info_id)
 185
 186     def fill_resp_data(self, ns_pkg):
 187         data = {
 188             'id': ns_pkg.nsPackageId,
 189             'nsdId': ns_pkg.nsdId,
 190             'nsdName': ns_pkg.nsdName,
 191             'nsdVersion': ns_pkg.nsdVersion,
 192             'nsdDesigner': ns_pkg.nsdDesginer,
 193             'nsdInvariantId': ns_pkg.invariantId,
 194             'vnfPkgIds': [],
 195             'pnfdInfoIds': [],  # TODO
 196             'nestedNsdInfoIds': [],  # TODO
 197             'nsdOnboardingState': ns_pkg.onboardingState,
 198             'onboardingFailureDetails': None,  # TODO
 199             'nsdOperationalState': ns_pkg.operationalState,
 200             'nsdUsageState': ns_pkg.usageState,
 201             'userDefinedData': {},
 202             '_links': None  # TODO
 203         }
 204
 205         if ns_pkg.nsdModel:
 206             nsd_model = json.JSONDecoder().decode(ns_pkg.nsdModel)
 207             vnf_pkg_ids = []
 208             for vnf in nsd_model['vnfs']:
 209                 vnfd_id = vnf["properties"].get("descriptor_id", "undefined")
 210                 if vnfd_id == "undefined":
 211                     vnfd_id = vnf["properties"].get("id", "undefined")
 212                 pkgs = VnfPackageModel.objects.filter(vnfdId=vnfd_id)
 213                 if not pkgs:
 214                     pkgs = VnfPackageModel.objects.filter(vnfPackageId=vnfd_id)
 215                 for pkg in pkgs:
 216                     vnf_pkg_ids.append(pkg.vnfPackageId)
 217             data['vnfPkgIds'] = vnf_pkg_ids
 218
 219             pnf_info_ids = []
 220             for pnf in nsd_model['pnfs']:
 221                 pnfd_id = pnf["properties"].get("descriptor_id", "undefined")
 222                 if pnfd_id == "undefined":
 223                     pnfd_id = pnf["properties"].get("id", "undefined")
 224                 pkgs = PnfPackageModel.objects.filter(pnfdId=pnfd_id)
 225                 if not pkgs:
 226                     pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_id)
 227                 for pkg in pkgs:
 228                     pnf_info_ids.append(pkg.pnfPackageId)
 229             data['pnfInfoIds'] = pnf_info_ids  # TODO: need reconfirming
 230
 231         if ns_pkg.userDefinedData:
 232             user_defined_data = json.JSONDecoder().decode(ns_pkg.userDefinedData)
 233             data['userDefinedData'] = user_defined_data
 234
 235         return data
 236
 237     def handle_upload_failed(self, nsd_info_id):
 238         ns_pkg = NSPackageModel.objects.filter(nsPackageId=nsd_info_id)
 239         ns_pkg.update(onboardingState=PKG_STATUS.CREATED)