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