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

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