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