gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * OPENECOMP - SO
   4  * ================================================================================
   5  * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.bpmn.infrastructure.scripts
  22
  23 import org.onap.so.logger.MsoLogger
  24
  25 import static org.apache.commons.lang3.StringUtils.*;
  26
  27 import org.apache.commons.lang3.*
  28 import org.camunda.bpm.engine.delegate.BpmnError
  29 import org.camunda.bpm.engine.delegate.DelegateExecution
  30 import org.onap.so.bpmn.common.recipe.ResourceInput;
  31 import org.onap.so.bpmn.common.resource.ResourceRequestBuilder
  32 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
  33 import org.onap.so.bpmn.common.scripts.ExceptionUtil
  34 import org.onap.so.bpmn.common.scripts.MsoUtils
  35 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
  36 import org.onap.so.bpmn.core.json.JsonUtils
  37
  38 import groovy.json.*
  39
  40 /**
  41  * This groovy class supports the <class>DeleteSDNCCNetworkResource.bpmn</class> process.
  42  * flow for SDNC Network Resource
  43  */
  44 public class DeleteSDNCNetworkResource extends AbstractServiceTaskProcessor {
  45     private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL,
  46             CreateSDNCNetworkResource.class);
  47
  48     String Prefix="DELSDNCRES_"
  49
  50     ExceptionUtil exceptionUtil = new ExceptionUtil()
  51
  52     JsonUtils jsonUtil = new JsonUtils()
  53
  54     SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
  55
  56     public void preProcessRequest(DelegateExecution execution){
  57         msoLogger.info("***** Started preProcessRequest *****")
  58         try {
  59
  60             //get bpmn inputs from resource request.
  61             String requestId = execution.getVariable("mso-request-id")
  62             String requestAction = execution.getVariable("requestAction")
  63             msoLogger.info("The requestAction is: " + requestAction)
  64             String recipeParamsFromRequest = execution.getVariable("recipeParams")
  65             msoLogger.info("The recipeParams is: " + recipeParamsFromRequest)
  66             String resourceInput = execution.getVariable("resourceInput")
  67             msoLogger.info("The resourceInput is: " + resourceInput)
  68             //Get ResourceInput Object
  69             ResourceInput resourceInputObj = ResourceRequestBuilder.getJsonObject(resourceInput, ResourceInput.class)
  70             execution.setVariable(Prefix + "resourceInput", resourceInputObj)
  71
  72             //Deal with recipeParams
  73             String recipeParamsFromWf = execution.getVariable("recipeParamXsd")
  74             String resourceModelName = resourceInputObj.getResourceModelInfo().getModelName()
  75             //For sdnc requestAction default is "NetworkInstance"
  76             String operationType = "Network"
  77             if(!StringUtils.isBlank(recipeParamsFromRequest) && "null" != recipeParamsFromRequest){
  78                 //the operationType from worflow(first node) is second priority.
  79                 operationType = jsonUtil.getJsonValue(recipeParamsFromRequest, "operationType")
  80             }
  81             if(!StringUtils.isBlank(recipeParamsFromWf)){
  82                 //the operationType from worflow(first node) is highest priority.
  83                 operationType = jsonUtil.getJsonValue(recipeParamsFromWf, "operationType")
  84             }
  85
  86
  87             //For sdnc, generate svc_action and request_action
  88             String sdnc_svcAction = "delete"
  89             if(StringUtils.containsIgnoreCase(resourceModelName, "overlay")){
  90                 //This will be resolved in R3.
  91                 sdnc_svcAction ="deactivate"
  92                 operationType = "NCINetwork"
  93             }
  94             if(StringUtils.containsIgnoreCase(resourceModelName, "underlay")){
  95                 //This will be resolved in R3.
  96                 operationType ="Network"
  97             }
  98             String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
  99             execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
 100             execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
 101             execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
 102             execution.setVariable("mso-request-id", requestId)
 103             execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
 104             //TODO Here build networkrequest
 105
 106         } catch (BpmnError e) {
 107             throw e;
 108         } catch (Exception ex){
 109             msg = "Exception in preProcessRequest " + ex.getMessage()
 110             msoLogger.debug(msg)
 111             exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
 112         }
 113     }
 114
 115     /**
 116      * Pre Process the BPMN Flow Request
 117      * Inclouds:
 118      * generate the nsOperationKey
 119      * generate the nsParameters
 120      */
 121     public void prepareSDNCRequest (DelegateExecution execution) {
 122         msoLogger.info("***** Started prepareSDNCRequest *****")
 123
 124         try {
 125             // get variables
 126             String sdnc_svcAction = execution.getVariable(Prefix + "svcAction")
 127             String sdnc_requestAction = execution.getVariable(Prefix + "requestAction")
 128             String sdncCallback = execution.getVariable("URN_mso_workflow_sdncadapter_callback")
 129             String deleteNetworkInput = execution.getVariable(Prefix + "networkRequest")
 130
 131             String hdrRequestId = execution.getVariable("mso-request-id")
 132             String serviceInstanceId = execution.getVariable(Prefix + "serviceInstanceId")
 133             String source = execution.getVariable("source")
 134             String sdnc_service_id = execution.getVariable(Prefix + "sdncServiceId")
 135             ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
 136             String serviceType = resourceInputObj.getServiceType()
 137             String serviceModelInvariantUuid = resourceInputObj.getServiceModelInfo().getModelInvariantUuid()
 138             String serviceModelUuid = resourceInputObj.getServiceModelInfo().getModelUuid()
 139             String serviceModelVersion = resourceInputObj.getServiceModelInfo().getModelVersion()
 140             String serviceModelName = resourceInputObj.getServiceModelInfo().getModelName()
 141             String globalCustomerId = resourceInputObj.getGlobalSubscriberId()
 142             String modelInvariantUuid = resourceInputObj.getResourceModelInfo().getModelInvariantUuid();
 143             String modelCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
 144             String modelUuid = resourceInputObj.getResourceModelInfo().getModelUuid()
 145             String modelName = resourceInputObj.getResourceModelInfo().getModelName()
 146             String modelVersion = resourceInputObj.getResourceModelInfo().getModelVersion()
 147             // 1. prepare assign topology via SDNC Adapter SUBFLOW call
 148             String sndcTopologyDeleteRequest = ""
 149
 150             switch (modelName) {
 151                 case ~/^Site$/:
 152                     sndcTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
 153                                                               xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
 154                                                               xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
 155                                  <sdncadapter:RequestHeader>
 156                                     <sdncadapter:RequestId>${MsoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
 157                                     <sdncadapter:SvcInstanceId>${MsoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
 158                                     <sdncadapter:SvcAction>${MsoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
 159                                     <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
 160                                     <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
 161                                     <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
 162                                  </sdncadapter:RequestHeader>
 163                                  <sdncadapterworkflow:SDNCRequestData>
 164                                      <request-information>
 165                                         <request-id>${MsoUtils.xmlEscape(hdrRequestId)}</request-id>
 166                                         <request-action>${MsoUtils.xmlEscape(sdnc_requestAction)}</request-action>
 167                                         <source>${MsoUtils.xmlEscape(source)}</source>
 168                                         <notification-url></notification-url>
 169                                         <order-number></order-number>
 170                                         <order-version></order-version>
 171                                      </request-information>
 172                                      <service-information>
 173                                         <service-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-id>
 174                                         <subscription-service-type>${MsoUtils.xmlEscape(serviceType)}</subscription-service-type>
 175                                         <onap-model-information>
 176                                              <model-invariant-uuid>${MsoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
 177                                              <model-uuid>${MsoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
 178                                              <model-version>${MsoUtils.xmlEscape(serviceModelVersion)}</model-version>
 179                                              <model-name>${MsoUtils.xmlEscape(serviceModelName)}</model-name>
 180                                         </onap-model-information>
 181                                         <service-instance-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
 182                                         <global-customer-id>${MsoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
 183                                         <subscriber-name></subscriber-name>
 184                                      </service-information>
 185                                      <vnf-information>
 186                                         <!-- TODO: to be filled as per the request input -->
 187                                         <vnf-id></vnf-id>
 188                                         <vnf-type></vnf-type>
 189                                         <onap-model-information>
 190                                              <model-invariant-uuid>${MsoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
 191                                              <model-customization-uuid>${MsoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
 192                                              <model-uuid>${MsoUtils.xmlEscape(modelUuid)}</model-uuid>
 193                                              <model-version>${MsoUtils.xmlEscape(modelVersion)}</model-version>
 194                                              <model-name>${MsoUtils.xmlEscape(modelName)}</model-name>
 195                                         </onap-model-information>
 196                                      </vnf-information>
 197                                      <vnf-request-input>
 198                                         <request-version></request-version>
 199                                         <vnf-name></vnf-name>
 200                                         <vnf-networks>
 201                                             <vnf-network>
 202                                                 <network-role></network-role>
 203                                                 <network-name></network-name>
 204                                                 <neutron-id></neutron-id>
 205                                                 <network-id></network-id>
 206                                                 <contrail-network-fqdn></contrail-network-fqdn>
 207                                                 <subnets-data>
 208                                                     <subnet-data>
 209                                                         <ip-version></ip-version>
 210                                                         <subnet-id></subnet-id>
 211                                                     </subnet-data>
 212                                                 </subnets-data>
 213                                             </vnf-network>
 214                                         </vnf-networks>
 215                                      </vnf-request-input>
 216                                      <vnf-input-parameters>
 217                                        <param></param>
 218                                      </vnf-input-parameters>
 219                                 </sdncadapterworkflow:SDNCRequestData>
 220                              </aetgt:SDNCAdapterWorkflowRequest>""".trim()
 221                     break
 222
 223                 case ~/^SOTNAttachment$/:
 224                     sndcTopologyDeleteRequest = """<aetgt:SDNCAdapterWorkflowRequest xmlns:aetgt="http://org.onap/so/workflow/schema/v1"
 225                                                               xmlns:sdncadapter="http://org.onap.so/workflow/sdnc/adapter/schema/v1"
 226                                                               xmlns:sdncadapterworkflow="http://org.onap/so/workflow/schema/v1">
 227                                  <sdncadapter:RequestHeader>
 228                                     <sdncadapter:RequestId>${MsoUtils.xmlEscape(hdrRequestId)}</sdncadapter:RequestId>
 229                                     <sdncadapter:SvcInstanceId>${MsoUtils.xmlEscape(serviceInstanceId)}</sdncadapter:SvcInstanceId>
 230                                     <sdncadapter:SvcAction>${MsoUtils.xmlEscape(sdnc_svcAction)}</sdncadapter:SvcAction>
 231                                     <sdncadapter:SvcOperation>network-topology-operation</sdncadapter:SvcOperation>
 232                                     <sdncadapter:CallbackUrl>sdncCallback</sdncadapter:CallbackUrl>
 233                                     <sdncadapter:MsoAction>generic-resource</sdncadapter:MsoAction>
 234                                  </sdncadapter:RequestHeader>
 235                                  <sdncadapterworkflow:SDNCRequestData>
 236                                      <request-information>
 237                                         <request-id>${MsoUtils.xmlEscape(hdrRequestId)}</request-id>
 238                                         <request-action>${MsoUtils.xmlEscape(sdnc_requestAction)}</request-action>
 239                                         <source>${MsoUtils.xmlEscape(source)}</source>
 240                                         <notification-url></notification-url>
 241                                         <order-number></order-number>
 242                                         <order-version></order-version>
 243                                      </request-information>
 244                                      <service-information>
 245                                         <service-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-id>
 246                                         <subscription-service-type>${MsoUtils.xmlEscape(serviceType)}</subscription-service-type>
 247                                         <onap-model-information>
 248                                              <model-invariant-uuid>${MsoUtils.xmlEscape(serviceModelInvariantUuid)}</model-invariant-uuid>
 249                                              <model-uuid>${MsoUtils.xmlEscape(serviceModelUuid)}</model-uuid>
 250                                              <model-version>${MsoUtils.xmlEscape(serviceModelVersion)}</model-version>
 251                                              <model-name>${MsoUtils.xmlEscape(serviceModelName)}</model-name>
 252                                         </onap-model-information>
 253                                         <service-instance-id>${MsoUtils.xmlEscape(serviceInstanceId)}</service-instance-id>
 254                                         <global-customer-id>${MsoUtils.xmlEscape(globalCustomerId)}</global-customer-id>
 255                                         <subscriber-name></subscriber-name>
 256                                      </service-information>
 257                                      <allotted-resource-information>
 258                                         <allotted-resource-id></allotted-resource-id>
 259                                         <allotted-resource-type></allotted-resource-type>
 260                                         <parent-service-instance-id></parent-service-instance-id>
 261                                         <onap-model-information>
 262                                              <model-invariant-uuid>${MsoUtils.xmlEscape(modelInvariantUuid)}</model-invariant-uuid>
 263                                              <model-customization-uuid>${MsoUtils.xmlEscape(modelCustomizationUuid)}</model-customization-uuid>
 264                                              <model-uuid>${MsoUtils.xmlEscape(modelUuid)}</model-uuid>
 265                                              <model-version>${MsoUtils.xmlEscape(modelVersion)}</model-version>
 266                                              <model-name>${MsoUtils.xmlEscape(modelName)}</model-name>
 267                                         </onap-model-information>
 268                                      </allotted-resource-information>
 269                                      <connection-attachment-request-input>
 270                                        <param></param>
 271                                      </connection-attachment-request-input>
 272                                 </sdncadapterworkflow:SDNCRequestData>
 273                              </aetgt:SDNCAdapterWorkflowRequest>""".trim()
 274                     break
 275
 276                 default:
 277                     sndcTopologyDeleteRequest = ""
 278             }
 279
 280             String sndcTopologyDeleteRequesAsString = utils.formatXml(sndcTopologyDeleteRequest)
 281             utils.logAudit(sndcTopologyDeleteRequesAsString)
 282             execution.setVariable("sdncAdapterWorkflowRequest", sndcTopologyDeleteRequesAsString)
 283             msoLogger.info("sdncAdapterWorkflowRequest - " + "\n" +  sndcTopologyDeleteRequesAsString)
 284
 285         } catch (Exception ex) {
 286             String exceptionMessage = " Bpmn error encountered in DeleteSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
 287             msoLogger.debug(exceptionMessage)
 288             exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
 289
 290         }
 291         msoLogger.info(" ***** Exit prepareSDNCRequest *****")
 292         }
 293
 294     private void setProgressUpdateVariables(DelegateExecution execution, String body) {
 295         def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
 296         execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
 297         execution.setVariable("CVFMI_updateResOperStatusRequest", body)
 298     }
 299
 300     public void prepareUpdateBeforeDeleteSDNCResource(DelegateExecution execution) {
 301         ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
 302         String operType = resourceInputObj.getOperationType()
 303         String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
 304         String serviceInstanceId = resourceInputObj.getServiceInstanceId()
 305         String operationId = resourceInputObj.getOperationId()
 306         String progress = "20"
 307         String status = "processing"
 308         String statusDescription = "SDCN resource delete invoked"
 309
 310         //String operationId = execution.getVariable("operationId")
 311
 312         String body = """
 313                 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 314                         xmlns:ns="http://org.onap.so/requestsdb">
 315                         <soapenv:Header/>
 316                 <soapenv:Body>
 317                     <ns:updateResourceOperationStatus>
 318                                <operType>${MsoUtils.xmlEscape(operType)}</operType>
 319                                <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
 320                                <progress>${MsoUtils.xmlEscape(progress)}</progress>
 321                                <resourceTemplateUUID>${MsoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
 322                                <serviceId>${MsoUtils.xmlEscape(serviceInstanceId)}</serviceId>
 323                                <status>${MsoUtils.xmlEscape(status)}</status>
 324                                <statusDescription>${MsoUtils.xmlEscape(statusDescription)}</statusDescription>
 325                     </ns:updateResourceOperationStatus>
 326                 </soapenv:Body>
 327                 </soapenv:Envelope>""";
 328
 329         setProgressUpdateVariables(execution, body)
 330
 331     }
 332
 333     public void prepareUpdateAfterDeleteSDNCResource(DelegateExecution execution) {
 334         ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
 335         String operType = resourceInputObj.getOperationType()
 336         String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
 337         String serviceInstanceId = resourceInputObj.getServiceInstanceId()
 338         String operationId = resourceInputObj.getOperationId()
 339         String progress = "100"
 340         String status = "finished"
 341         String statusDescription = "SDCN resource delete completed"
 342
 343         //String operationId = execution.getVariable("operationId")
 344
 345         String body = """
 346                 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 347                         xmlns:ns="http://org.onap.so/requestsdb">
 348                         <soapenv:Header/>
 349                 <soapenv:Body>
 350                     <ns:updateResourceOperationStatus>
 351                                <operType>${MsoUtils.xmlEscape(operType)}</operType>
 352                                <operationId>${MsoUtils.xmlEscape(operationId)}</operationId>
 353                                <progress>${MsoUtils.xmlEscape(progress)}</progress>
 354                                <resourceTemplateUUID>${MsoUtils.xmlEscape(resourceCustomizationUuid)}</resourceTemplateUUID>
 355                                <serviceId>${MsoUtils.xmlEscape(serviceInstanceId)}</serviceId>
 356                                <status>${MsoUtils.xmlEscape(status)}</status>
 357                                <statusDescription>${MsoUtils.xmlEscape(statusDescription)}</statusDescription>
 358                     </ns:updateResourceOperationStatus>
 359                 </soapenv:Body>
 360                 </soapenv:Envelope>""";
 361
 362         setProgressUpdateVariables(execution, body)
 363     }
 364
 365     public void postDeleteSDNCCall(DelegateExecution execution){
 366         msoLogger.info(" ***** Started prepareSDNCRequest *****")
 367         String responseCode = execution.getVariable(Prefix + "sdncDeleteReturnCode")
 368         String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
 369
 370         msoLogger.info("response from sdnc, response code :" + responseCode + "  response object :" + responseObj)
 371         msoLogger.info(" ***** Exit prepareSDNCRequest *****")
 372     }
 373
 374         public void sendSyncResponse (DelegateExecution execution) {
 375         msoLogger.info(" *** sendSyncResponse *** ")
 376
 377                 try {
 378                         String operationStatus = "finished"
 379                         // RESTResponse for main flow
 380                         String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
 381                         utils.log("DEBUG", " sendSyncResponse to APIH:" + "\n" + resourceOperationResp, isDebugEnabled)
 382                         sendWorkflowResponse(execution, 202, resourceOperationResp)
 383                         execution.setVariable("sentSyncResponse", true)
 384
 385                 } catch (Exception ex) {
 386                         String msg = "Exceptuion in sendSyncResponse:" + ex.getMessage()
 387             msoLogger.debug(msg)
 388                         exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
 389                 }
 390         msoLogger.info(" ***** Exit sendSyncResopnse *****")
 391         }
 392 }