bpmn/so-bpmn-infrastructure-common/src/main/groovy/org/onap/so/bpmn/infrastructure/scripts/DoUpdateVnfAndModules.groovy

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.so.bpmn.infrastructure.scripts
  24
  25 import org.onap.so.client.HttpClientFactory
  26
  27 import javax.ws.rs.core.Response
  28 import org.camunda.bpm.engine.delegate.BpmnError
  29 import org.camunda.bpm.engine.delegate.DelegateExecution;
  30 import org.onap.so.bpmn.common.scripts.AaiUtil
  31 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
  32 import org.onap.so.bpmn.common.scripts.ExceptionUtil
  33 import org.onap.so.bpmn.common.scripts.MsoUtils
  34 import org.onap.so.bpmn.core.domain.ModelInfo
  35 import org.onap.so.bpmn.core.domain.ModuleResource
  36 import org.onap.so.bpmn.core.domain.VnfResource
  37 import org.onap.so.bpmn.core.json.JsonUtils
  38 import org.onap.so.client.graphinventory.entities.uri.Depth
  39 import org.onap.so.client.HttpClient
  40 import org.onap.so.client.aai.AAIObjectType
  41 import org.onap.so.client.aai.entities.uri.AAIResourceUri
  42 import org.onap.so.client.aai.entities.uri.AAIUriFactory;
  43 import org.onap.so.logger.MessageEnum
  44 import org.onap.so.logger.MsoLogger
  45 import org.slf4j.Logger
  46 import org.slf4j.LoggerFactory
  47 import org.onap.so.utils.TargetEntity
  48
  49 /**
  50  * This class supports the VID Flow
  51  * with the update of a generic vnf and related VF modules.
  52  */
  53 class DoUpdateVnfAndModules extends AbstractServiceTaskProcessor {
  54     private static final Logger logger = LoggerFactory.getLogger( DoUpdateVnfAndModules.class);
  55
  56         String Prefix="DUVAM_"
  57         ExceptionUtil exceptionUtil = new ExceptionUtil()
  58         JsonUtils jsonUtil = new JsonUtils()
  59
  60         /**
  61          * This method gets and validates the incoming
  62          * request.
  63          *
  64          * @param - execution
  65          *
  66          */
  67         public void preProcessRequest(DelegateExecution execution) {
  68
  69                 execution.setVariable("prefix",Prefix)
  70                 logger.trace("STARTED DoUpdateVnfAndModules PreProcessRequest Process")
  71
  72                 try{
  73                         // Get Variables
  74
  75                         String requestId = execution.getVariable("msoRequestId")
  76                         execution.setVariable("requestId", requestId)
  77                         execution.setVariable("mso-request-id", requestId)
  78                         logger.debug("Incoming Request Id is: " + requestId)
  79
  80                         String serviceInstanceId = execution.getVariable("serviceInstanceId")
  81                         logger.debug("Incoming Service Instance Id is: " + serviceInstanceId)
  82
  83                         String vnfId = execution.getVariable("vnfId")
  84                         logger.debug("Incoming Vnf Id is: " + vnfId)
  85
  86                         String source = "VID"
  87                         execution.setVariable("DUVAM_source", source)
  88                         logger.debug("Incoming Source is: " + source)
  89
  90                         String sdncVersion = execution.getVariable("sdncVersion")
  91                         if (sdncVersion == null) {
  92                                 sdncVersion = "1702"
  93                         }
  94                         execution.setVariable("DUVAM_sdncVersion", sdncVersion)
  95                         logger.debug("Incoming Sdnc Version is: " + sdncVersion)
  96
  97                         VnfResource vnfResource = (VnfResource) execution.getVariable("vnfResourceDecomposition")
  98
  99                         String vnfModelInfo = execution.getVariable("vnfModelInfo")
 100                         String serviceModelInfo = execution.getVariable("serviceModelInfo")
 101
 102                         String serviceId = execution.getVariable("productFamilyId")
 103                         execution.setVariable("DUVAM_serviceId", serviceId)
 104                         logger.debug("Incoming Service Id is: " + serviceId)
 105
 106                         String modelUuid = jsonUtil.getJsonValue(vnfModelInfo, "modelUuid")
 107                         execution.setVariable("DUVAM_modelUuid", modelUuid)
 108                         logger.debug("Incoming modelUuid is: " + modelUuid)
 109
 110                         String modelCustomizationUuid = jsonUtil.getJsonValue(vnfModelInfo, "modelCustomizationUuid")
 111                         execution.setVariable("DUVAM_modelCustomizationUuid", modelCustomizationUuid)
 112                         logger.debug("Incoming Model Customization Uuid is: " + modelCustomizationUuid)
 113
 114                         String cloudSiteId = execution.getVariable("lcpCloudRegionId")
 115                         execution.setVariable("DUVAM_cloudSiteId", cloudSiteId)
 116                         logger.debug("Incoming Cloud Site Id is: " + cloudSiteId)
 117
 118                         String tenantId = execution.getVariable("tenantId")
 119                         execution.setVariable("DUVAM_tenantId", tenantId)
 120                         logger.debug("Incoming Tenant Id is: " + tenantId)
 121
 122                         String globalSubscriberId = execution.getVariable("globalSubscriberId")
 123                         if (globalSubscriberId == null) {
 124                                 globalSubscriberId = ""
 125                         }
 126                         execution.setVariable("DUVAM_globalSubscriberId", globalSubscriberId)
 127                         logger.debug("Incoming Global Subscriber Id is: " + globalSubscriberId)
 128
 129                         execution.setVariable("DUVAM_moduleCount", 0)
 130                         execution.setVariable("DUVAM_nextModule", 0)
 131
 132
 133                 }catch(BpmnError b){
 134                         logger.debug("Rethrowing MSOWorkflowException")
 135                         throw b
 136                 }catch(Exception e){
 137                         logger.debug(" Error Occured in DoUpdateVnfAndModules PreProcessRequest method!" + e.getMessage())
 138                         exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Internal Error - Occured in DoUpdateVnfAndModules PreProcessRequest")
 139
 140                 }
 141                 logger.trace("COMPLETED DoUpdateVnfAndModules PreProcessRequest Process ")
 142         }
 143
 144         /**
 145          * Using the received vnfId and vfModuleId, query AAI to get the corresponding VNF info.
 146          * A 200 response is expected with the VNF info in the response body. Will find out the base module info.
 147          *
 148          * @param execution The flow's execution instance.
 149          */
 150         public void queryAAIVfModule(DelegateExecution execution) {
 151
 152                 def method = getClass().getSimpleName() + '.queryAAIVfModule(' +
 153                         'execution=' + execution.getId() +
 154                         ')'
 155                 logger.trace('Entered ' + method)
 156
 157                 try {
 158                         def vnfId = execution.getVariable('vnfId')
 159
 160                         AaiUtil aaiUriUtil = new AaiUtil(this)
 161                         AAIResourceUri uri = AAIUriFactory.createResourceUri(AAIObjectType.GENERIC_VNF, vnfId).depth(Depth.ONE)
 162                         String endPoint = aaiUriUtil.createAaiUri(uri)
 163                         logger.debug("AAI endPoint: " + endPoint)
 164
 165                         try {
 166                                 HttpClient client = new HttpClientFactory().newXmlClient(new URL(endPoint), TargetEntity.AAI)
 167                                 client.addAdditionalHeader('X-TransactionId', UUID.randomUUID().toString())
 168                                 client.addAdditionalHeader('X-FromAppId', 'MSO')
 169                                 client.addAdditionalHeader('Content-Type', 'application/xml')
 170                                 client.addAdditionalHeader('Accept','application/xml')
 171
 172                                 def responseData = ''
 173
 174                                 logger.debug('sending GET to AAI endpoint \'' + endPoint + '\'')
 175                                 Response response = client.get()
 176                                 logger.debug("createVfModule - invoking httpGet() to AAI")
 177
 178                                 responseData = response.readEntity(String.class)
 179                                 if (responseData != null) {
 180                                         logger.debug("Received generic VNF data: " + responseData)
 181
 182                                 }
 183
 184                                 logger.debug("createVfModule - queryAAIVfModule Response: " + responseData)
 185                                 logger.debug("createVfModule - queryAAIVfModule ResponseCode: " + response.getStatus())
 186
 187                                 execution.setVariable('DUVAM_queryAAIVfModuleResponseCode', response.getStatus())
 188                                 execution.setVariable('DUVAM_queryAAIVfModuleResponse', responseData)
 189                                 logger.debug('Response code:' + response.getStatus())
 190                                 logger.debug('Response:' + System.lineSeparator() + responseData)
 191                                 //Map<String, String>[] vfModules = new HashMap<String,String>[]
 192                                 def vfModulesList = new ArrayList<Map<String,String>>()
 193                                 def vfModules = null
 194                                 def vfModuleBaseEntry = null
 195                                 if (response.getStatus() == 200) {
 196                                         // Parse the VNF record from A&AI to find base module info
 197                                         logger.debug('Parsing the VNF data to find base module info')
 198                                         if (responseData != null) {
 199                                                 def vfModulesText = utils.getNodeXml(responseData, "vf-modules")
 200                                                 logger.debug("vModulesText: " + vfModulesText)
 201                                                 if (vfModulesText != null && !vfModulesText.trim().isEmpty()) {
 202                                                         def xmlVfModules= new XmlSlurper().parseText(vfModulesText)
 203                                                         vfModules = xmlVfModules.'**'.findAll {it.name() == "vf-module"}
 204                                                         execution.setVariable("DUVAM_moduleCount", vfModules.size())
 205                                                         int vfModulesSize = 0
 206                                                         for (i in 0..vfModules.size()-1) {
 207                                                                 def vfModuleXml = groovy.xml.XmlUtil.serialize(vfModules[i])
 208
 209                                                                 Map<String, String> vfModuleEntry = new HashMap<String, String>()
 210                                                                 def vfModuleId = utils.getNodeText(vfModuleXml, "vf-module-id")
 211                                                                 vfModuleEntry.put("vfModuleId", vfModuleId)
 212                                                                 def vfModuleName = utils.getNodeText(vfModuleXml, "vf-module-name")
 213                                                                 vfModuleEntry.put("vfModuleName", vfModuleName)
 214                                                                 def modelInvariantUuid = utils.getNodeText(vfModuleXml, "model-invariant-id")
 215                                                                 vfModuleEntry.put("modelInvariantUuid", modelInvariantUuid)
 216                                                                 def modelUuid = utils.getNodeText(vfModuleXml, "model-version-id")
 217                                                                 vfModuleEntry.put("modelUuid", modelUuid)
 218                                                                 def modelCustomizationUuid = utils.getNodeText(vfModuleXml, "model-customization-id")
 219                                                                 vfModuleEntry.put("modelCustomizationUuid", modelCustomizationUuid)
 220
 221                                                                 def isBaseVfModule = utils.getNodeText(vfModuleXml, "is-base-vf-module")
 222                                                                 vfModuleEntry.put("isBaseVfModule", isBaseVfModule)
 223
 224                                                                 String volumeGroupId = ''
 225
 226                                                                 logger.debug("Next module!")
 227                                                                 def vfModuleRelationships = vfModules[i].'**'.findAll {it.name() == 'relationship-data'}
 228                                                                 if (vfModuleRelationships.size() > 0) {
 229                                                                         for (j in 0..vfModuleRelationships.size()-1) {
 230                                                                                 if (vfModuleRelationships[j] != null) {
 231
 232                                                                                         def relationshipKey = vfModuleRelationships[j].'**'.findAll {it.name() == 'relationship-key'}
 233
 234                                                                                         if (relationshipKey[0] == 'volume-group.volume-group-id') {
 235                                                                                                 def relationshipValue = vfModuleRelationships[j].'**'.findAll {it.name() == 'relationship-value'}
 236                                                                                                 volumeGroupId = relationshipValue[0]
 237                                                                                                 break
 238                                                                                         }
 239                                                                                 }
 240                                                                         }
 241                                                                 }
 242
 243                                                                 vfModuleEntry.put("volumeGroupId", volumeGroupId)
 244                                                                 logger.debug("volumeGroupId is: " + volumeGroupId)
 245
 246                                                                 // Save base vf module to add it to the start of the list later
 247                                                                 if (isBaseVfModule == "true") {
 248                                                                         vfModuleBaseEntry = vfModuleEntry
 249                                                                 }
 250                                                                 else {
 251                                                                         vfModulesList.add(vfModuleEntry)
 252                                                                 }
 253                                                         }
 254                                                         // Start the list with the base module if any
 255                                                         if (vfModuleBaseEntry != null) {
 256                                                                 vfModulesList.add(0, vfModuleBaseEntry)
 257                                                         }
 258                                                 }
 259
 260                                         }
 261                                 }
 262                                 else {
 263                                         logger.debug('Response code from AAI GET is: ' + response.getStatusCode())
 264                                         exceptionUtil.buildAndThrowWorkflowException(execution, 1002, 'Response code from AAI GET is: ' + response.getStatusCode())
 265                                 }
 266                                 execution.setVariable("DUVAM_vfModules", vfModulesList)
 267                         } catch (Exception ex) {
 268                                 ex.printStackTrace()
 269                                 logger.debug('Exception occurred while executing AAI GET:' + ex.getMessage())
 270                                 exceptionUtil.buildAndThrowWorkflowException(execution, 1002, 'AAI GET Failed:' + ex.getMessage())
 271                         }
 272                         logger.trace('Exited ' + method)
 273                 } catch (BpmnError e) {
 274                         throw e;
 275                 } catch (Exception e) {
 276                         logger.error("{} {} {} {} {} {}", MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
 277                                         'Caught exception in ' + method, "BPMN", MsoLogger.getServiceName(),
 278                                         MsoLogger.ErrorCode.UnknownError.getValue(), "Exception is:\n" + e);
 279                         exceptionUtil.buildAndThrowWorkflowException(execution, 1002, 'Error in queryAAIVfModule(): ' + e.getMessage())
 280                 }
 281         }
 282
 283         public void prepareNextModuleToUpdate(DelegateExecution execution){
 284
 285                 execution.setVariable("prefix", Prefix)
 286                 logger.trace("STARTED prepareNextModuleToUpdate ")
 287
 288                 try {
 289                         int i = execution.getVariable("DUVAM_nextModule")
 290                         def vfModules = execution.getVariable("DUVAM_vfModules")
 291                         def vfModule = vfModules[i]
 292
 293                         def vfModuleId = vfModule.get("vfModuleId")
 294                         execution.setVariable("DUVAM_vfModuleId", vfModuleId)
 295
 296                         def vfModuleName = vfModule.get("vfModuleName")
 297                         execution.setVariable("DUVAM_vfModuleName", vfModuleName)
 298
 299                         def isBaseVfModule = vfModule.get("isBaseVfModule")
 300                         execution.setVariable("DUVAM_isBaseVfModule", isBaseVfModule)
 301
 302                         String modelInvariantUuid = vfModule.get("modelInvariantUuid")
 303                         logger.debug("ModelInvariantUuid: " + modelInvariantUuid)
 304
 305                         def volumeGroupId = vfModule.get("volumeGroupId")
 306                         execution.setVariable("DUVAM_volumeGroupId", volumeGroupId)
 307
 308                         execution.setVariable("DUVAM_volumeGroupName", "")
 309
 310                         VnfResource vnfResource = (VnfResource) execution.getVariable("vnfResourceDecomposition")
 311                         List<ModuleResource> moduleResources = vnfResource.getVfModules()
 312
 313                         if (moduleResources != null && !moduleResources.isEmpty()) {
 314
 315                                 for (j in 0..moduleResources.size()-1) {
 316                                         ModelInfo modelInfo = moduleResources[j].getModelInfo()
 317                                         String modelInvariantUuidFromDecomposition = modelInfo.getModelInvariantUuid()
 318                                         logger.debug("modelInvariantUuidFromDecomposition: " + modelInvariantUuidFromDecomposition)
 319
 320                                         if (modelInvariantUuid.equals(modelInvariantUuidFromDecomposition)) {
 321                                                 String vfModuleModelInfo = modelInfo.toJsonString()
 322                                                 String vfModuleModelInfoValue = jsonUtil.getJsonValue(vfModuleModelInfo, "modelInfo")
 323                                                 execution.setVariable("DUVAM_vfModuleModelInfo", vfModuleModelInfoValue)
 324                                                 logger.debug("vfModuleModelInfo: " + vfModuleModelInfoValue)
 325                                                 break
 326                                         }
 327
 328                                 }
 329                         }
 330
 331                 }catch(Exception e){
 332                         logger.error("{} {} {} {} {} {}", MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
 333                                         "Exception Occured Processing preProcessAddOnModule. Exception is:\n" + e, "BPMN",
 334                                         MsoLogger.getServiceName(), MsoLogger.ErrorCode.UnknownError.getValue(), "Exception is:\n" + e);
 335                         exceptionUtil.buildAndThrowWorkflowException(execution, 1002, "Error Occurred during prepareNextModuleToUpdate Method:\n" + e.getMessage())
 336                 }
 337                 logger.trace("COMPLETED prepareNextModuleToUpdate ")
 338         }
 339
 340
 341         /**
 342          * Prepare a Request for invoking the UpdateAAIGenericVnf subflow.
 343          *
 344          * @param execution The flow's execution instance.
 345          */
 346         public void prepUpdateAAIGenericVnf(DelegateExecution execution) {
 347                 def method = getClass().getSimpleName() + '.prepUpdateAAIGenericVnf(' +
 348                         'execution=' + execution.getId() +
 349                         ')'
 350
 351                 logger.trace('Entered ' + method)
 352
 353                 try {
 354                         def vnfId = execution.getVariable('vnfId')
 355                         VnfResource vnfResource = (VnfResource) execution.getVariable("vnfResourceDecomposition")
 356                         ModelInfo vnfDecompModelInfo = vnfResource.getModelInfo()
 357                         String vnfModelInfo = execution.getVariable("vnfModelInfo")
 358                         String modelUuid = execution.getVariable("DUVAM_modelUuid")
 359                         if (modelUuid == null || modelUuid.isEmpty()) {
 360                                 modelUuid = vnfDecompModelInfo.getModelUuid()
 361                         }
 362                         String modelCustomizationUuid = execution.getVariable("DUVAM_modelCustomizationUuid")
 363                         if (modelCustomizationUuid == null || modelCustomizationUuid.isEmpty()) {
 364                                 modelCustomizationUuid = vnfDecompModelInfo.getModelCustomizationUuid()
 365                         }
 366                         String nfType = vnfResource.getNfType()
 367                         String nfTypeString = ''
 368                         if (nfType != null && !nfType.isEmpty()) {
 369                                 nfTypeString = "<nf-type>" + nfType + "</nf-type>"
 370                         }
 371                         String nfRole = vnfResource.getNfRole()
 372                         String nfRoleString = ''
 373                         if (nfRole != null && !nfRole.isEmpty()) {
 374                                 nfRoleString = "<nf-role>" + nfRole + "</nf-role>"
 375                         }
 376                         String nfFunction = vnfResource.getNfFunction()
 377                         String nfFunctionString = ''
 378                         if (nfFunction != null && !nfFunction.isEmpty()) {
 379                                 nfFunctionString = "<nf-function>" + nfFunction + "</nf-function>"
 380                         }
 381                         String nfNamingCode = vnfResource.getNfNamingCode()
 382                         String nfNamingCodeString = ''
 383                         if (nfNamingCode != null && !nfNamingCode.isEmpty()) {
 384                                 nfNamingCodeString = "<nf-naming-code>" + nfNamingCode + "</nf-naming-code>"
 385                         }
 386
 387                         String updateAAIGenericVnfRequest = """
 388                                         <UpdateAAIGenericVnfRequest>
 389                                                 <vnf-id>${MsoUtils.xmlEscape(vnfId)}</vnf-id>
 390                                                 <model-version-id>${MsoUtils.xmlEscape(modelUuid)}</model-version-id>
 391                                                 <model-customization-id>${MsoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-id>
 392                                                 ${nfTypeString}
 393                                                 ${nfRoleString}
 394                                                 ${nfFunctionString}
 395                                                 ${nfNamingCodeString}
 396                                         </UpdateAAIGenericVnfRequest>
 397                                 """
 398                                 updateAAIGenericVnfRequest = utils.formatXml(updateAAIGenericVnfRequest)
 399                                 execution.setVariable('DUVAM_updateAAIGenericVnfRequest', updateAAIGenericVnfRequest)
 400                                 logger.debug("updateAAIGenericVnfRequest : " + updateAAIGenericVnfRequest)
 401                                 logger.debug('Request for UpdateAAIGenericVnf:\n' + updateAAIGenericVnfRequest)
 402
 403
 404                         logger.trace('Exited ' + method)
 405                 } catch (BpmnError e) {
 406                         throw e;
 407                 } catch (Exception e) {
 408                         logger.error("{} {} {} {} {} {}", MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(),
 409                                         'Caught exception in ' + method, "BPMN", MsoLogger.getServiceName(),
 410                                         MsoLogger.ErrorCode.UnknownError.getValue(), "Exception is:\n" + e);
 411                         exceptionUtil.buildAndThrowWorkflowException(execution, 1002, 'Error in prepUpdateAAIGenericVnf(): ' + e.getMessage())
 412                 }
 413         }
 414
 415         /**
 416          * APP-C Call - placeholder.
 417          *
 418          * @param execution The flow's execution instance.
 419          */
 420         public void callAppCf(DelegateExecution execution) {
 421                 def method = getClass().getSimpleName() + '.callAppC(' +
 422                         'execution=' + execution.getId() +
 423                         ')'
 424
 425                 logger.trace('Entered ' + method)
 426         }
 427 }