genericparser/packages/biz/pnf_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 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
  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
  32 class PnfDescriptor(object):
  33
  34     def __init__(self):
  35         pass
  36
  37     def create(self, data):
  38         logger.info('Start to create a PNFD...')
  39         user_defined_data = ignore_case_get(data, 'userDefinedData', {})
  40         data = {
  41             'id': str(uuid.uuid4()),
  42             'pnfdOnboardingState': PKG_STATUS.CREATED,
  43             'pnfdUsageState': PKG_STATUS.NOT_IN_USE,
  44             'userDefinedData': user_defined_data,
  45             '_links': None  # TODO
  46         }
  47         PnfPackageModel.objects.create(
  48             pnfPackageId=data['id'],
  49             onboardingState=data['pnfdOnboardingState'],
  50             usageState=data['pnfdUsageState'],
  51             userDefinedData=json.dumps(user_defined_data)
  52         )
  53         logger.info('A PNFD(%s) has been created.' % data['id'])
  54         return data
  55
  56     def query_multiple(self, pnfdId=None):
  57         if pnfdId:
  58             pnf_pkgs = PnfPackageModel.objects.filter(pnfdId=pnfdId)
  59         else:
  60             pnf_pkgs = PnfPackageModel.objects.all()
  61         response_data = []
  62         for pnf_pkg in pnf_pkgs:
  63             data = self.fill_response_data(pnf_pkg)
  64             response_data.append(data)
  65         return response_data
  66
  67     def query_single(self, pnfd_info_id):
  68         pnf_pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_info_id)
  69         if not pnf_pkgs.exists():
  70             logger.error('PNFD(%s) does not exist.' % pnfd_info_id)
  71             raise ResourceNotFoundException('PNFD(%s) does not exist.' % pnfd_info_id)
  72         return self.fill_response_data(pnf_pkgs[0])
  73
  74     def upload(self, remote_file, pnfd_info_id):
  75         logger.info('Start to upload PNFD(%s)...' % pnfd_info_id)
  76         pnf_pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_info_id)
  77         if not pnf_pkgs.exists():
  78             logger.info('PNFD(%s) does not exist.' % pnfd_info_id)
  79             raise GenericparserException('PNFD (%s) does not exist.' % pnfd_info_id)
  80         pnf_pkgs.update(onboardingState=PKG_STATUS.UPLOADING)
  81
  82         local_file_name = save(remote_file, pnfd_info_id)
  83         logger.info('PNFD(%s) content has been uploaded.' % pnfd_info_id)
  84         return local_file_name
  85
  86     def delete_single(self, pnfd_info_id):
  87         logger.info('Start to delete PNFD(%s)...' % pnfd_info_id)
  88         pnf_pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_info_id)
  89         if not pnf_pkgs.exists():
  90             logger.info('PNFD(%s) has been deleted.' % pnfd_info_id)
  91             return
  92         '''
  93         if pnf_pkgs[0].usageState != PKG_STATUS.NOT_IN_USE:
  94             logger.info('PNFD(%s) shall be NOT_IN_USE.' % pnfd_info_id)
  95             raise GenericparserException('PNFD(%s) shall be NOT_IN_USE.' % pnfd_info_id)
  96         '''
  97         del_pnfd_id = pnf_pkgs[0].pnfdId
  98         ns_pkgs = NSPackageModel.objects.all()
  99         for ns_pkg in ns_pkgs:
 100             nsd_model = None
 101             if ns_pkg.nsdModel:
 102                 nsd_model = json.JSONDecoder().decode(ns_pkg.nsdModel)
 103             if not nsd_model:
 104                 continue
 105             for pnf in nsd_model['pnfs']:
 106                 if del_pnfd_id == pnf["properties"]["id"]:
 107                     logger.warn("PNFD(%s) is referenced in NSD", del_pnfd_id)
 108                     raise GenericparserException('PNFD(%s) is referenced.' % pnfd_info_id)
 109         pnf_pkgs.delete()
 110         pnf_pkg_path = os.path.join(GENERICPARSER_ROOT_PATH, pnfd_info_id)
 111         fileutil.delete_dirs(pnf_pkg_path)
 112         logger.debug('PNFD(%s) has been deleted.' % pnfd_info_id)
 113
 114     def download(self, pnfd_info_id):
 115         logger.info('Start to download PNFD(%s)...' % pnfd_info_id)
 116         pnf_pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_info_id)
 117         if not pnf_pkgs.exists():
 118             logger.error('PNFD(%s) does not exist.' % pnfd_info_id)
 119             raise ResourceNotFoundException('PNFD(%s) does not exist.' % pnfd_info_id)
 120         if pnf_pkgs[0].onboardingState != PKG_STATUS.ONBOARDED:
 121             logger.error('PNFD(%s) is not ONBOARDED.' % pnfd_info_id)
 122             raise GenericparserException('PNFD(%s) is not ONBOARDED.' % pnfd_info_id)
 123
 124         local_file_path = pnf_pkgs[0].localFilePath
 125         start, end = 0, os.path.getsize(local_file_path)
 126         logger.info('PNFD(%s) has been downloaded.' % pnfd_info_id)
 127         return read(local_file_path, start, end)
 128
 129     def parse_pnfd_and_save(self, pnfd_info_id, local_file_name):
 130         logger.info('Start to process PNFD(%s)...' % pnfd_info_id)
 131         pnf_pkgs = PnfPackageModel.objects.filter(pnfPackageId=pnfd_info_id)
 132         pnf_pkgs.update(onboardingState=PKG_STATUS.PROCESSING)
 133         pnfd_json = toscaparsers.parse_pnfd(local_file_name)
 134         pnfd = json.JSONDecoder().decode(pnfd_json)
 135
 136         logger.debug("pnfd_json is %s" % pnfd_json)
 137         pnfd_id = ""
 138         pnfdVersion = ""
 139         pnfdProvider = ""
 140         pnfdName = ""
 141         if pnfd.get("pnf", "") != "":
 142             if pnfd["pnf"].get("properties", "") != "":
 143                 pnfd_id = pnfd["pnf"].get("properties", "").get("descriptor_id", "")
 144                 pnfdVersion = pnfd["pnf"].get("properties", "").get("version", "")
 145                 pnfdProvider = pnfd["pnf"].get("properties", "").get("provider", "")
 146                 pnfdName = pnfd["pnf"].get("properties", "").get("name", "")
 147         if pnfd_id == "":
 148             pnfd_id = pnfd["metadata"].get("descriptor_id", "")
 149             if pnfd_id == "":
 150                 pnfd_id = pnfd["metadata"].get("id", "")
 151             if pnfd_id == "":
 152                 pnfd_id = pnfd["metadata"].get("UUID", "")
 153             if pnfd_id == "":
 154                 raise GenericparserException('pnfd_id is Null.')
 155
 156         if pnfdVersion == "":
 157             pnfdVersion = pnfd["metadata"].get("template_version", "")
 158             if pnfdVersion == "":
 159                 pnfdVersion = pnfd["metadata"].get("version", "")
 160
 161         if pnfdProvider == "":
 162             pnfdProvider = pnfd["metadata"].get("template_author", "")
 163             if pnfdVersion == "":
 164                 pnfdVersion = pnfd["metadata"].get("provider", "")
 165
 166         if pnfdName == "":
 167             pnfdName = pnfd["metadata"].get("template_name", "")
 168             if pnfdVersion == "":
 169                 pnfdName = pnfd["metadata"].get("name", "")
 170
 171         if pnfd_id:
 172             other_pnf = PnfPackageModel.objects.filter(pnfdId=pnfd_id)
 173             if other_pnf and other_pnf[0].pnfPackageId != pnfd_info_id:
 174                 logger.info('PNFD(%s) already exists.' % pnfd_id)
 175                 raise GenericparserException("PNFD(%s) already exists." % pnfd_id)
 176
 177         pnf_pkgs.update(
 178             pnfdId=pnfd_id,
 179             pnfdName=pnfdName,
 180             pnfdVersion=pnfdVersion,
 181             pnfVendor=pnfdProvider,
 182             pnfPackageUri=local_file_name,
 183             onboardingState=PKG_STATUS.ONBOARDED,
 184             usageState=PKG_STATUS.NOT_IN_USE,
 185             localFilePath=local_file_name,
 186             pnfdModel=pnfd_json
 187         )
 188         logger.info('PNFD(%s) has been processed.' % pnfd_info_id)
 189
 190     def fill_response_data(self, pnf_pkg):
 191         data = {
 192             'id': pnf_pkg.pnfPackageId,
 193             'pnfdId': pnf_pkg.pnfdId,
 194             'pnfdName': pnf_pkg.pnfdName,
 195             'pnfdVersion': pnf_pkg.pnfdVersion,
 196             'pnfdProvider': pnf_pkg.pnfVendor,
 197             'pnfdInvariantId': None,  # TODO
 198             'pnfdOnboardingState': pnf_pkg.onboardingState,
 199             'onboardingFailureDetails': None,  # TODO
 200             'pnfdUsageState': pnf_pkg.usageState,
 201             'userDefinedData': {},
 202             '_links': None  # TODO
 203         }
 204         if pnf_pkg.userDefinedData:
 205             user_defined_data = json.JSONDecoder().decode(pnf_pkg.userDefinedData)
 206             data['userDefinedData'] = user_defined_data
 207
 208         return data
 209
 210     def handle_upload_failed(self, pnf_pkg_id):
 211         pnf_pkg = PnfPackageModel.objects.filter(pnfPackageId=pnf_pkg_id)
 212         pnf_pkg.update(onboardingState=PKG_STATUS.CREATED)
 213
 214     def parse_pnfd(self, csar_id, inputs):
 215         ret = None
 216         try:
 217             pnf_pkg = PnfPackageModel.objects.filter(pnfPackageId=csar_id)
 218             if not pnf_pkg:
 219                 raise GenericparserException("PNF CSAR(%s) does not exist." % csar_id)
 220             csar_path = pnf_pkg[0].localFilePath
 221             ret = {"model": toscaparsers.parse_pnfd(csar_path, inputs)}
 222         except GenericparserException as e:
 223             return [1, e.message]
 224         except Exception as e:
 225             logger.error(e.message)
 226             return [1, e.message]
 227         return [0, ret]