bpmn/MSOInfrastructureBPMN/src/main/groovy/org/openecomp/mso/bpmn/infrastructure/scripts/DeleteNetworkInstance.groovy

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. 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.openecomp.mso.bpmn.infrastructure.scripts;
  22
  23 import org.openecomp.mso.bpmn.common.scripts.AbstractServiceTaskProcessor
  24 import org.openecomp.mso.bpmn.common.scripts.ExceptionUtil
  25 import org.openecomp.mso.bpmn.common.scripts.NetworkUtils
  26 import org.openecomp.mso.bpmn.common.scripts.VidUtils
  27 import org.openecomp.mso.bpmn.core.WorkflowException
  28 import org.openecomp.mso.bpmn.core.json.JsonUtils;
  29 import org.openecomp.mso.rest.APIResponse
  30 import java.util.UUID;
  31 import org.camunda.bpm.engine.delegate.BpmnError
  32 import org.camunda.bpm.engine.delegate.DelegateExecution
  33 import org.apache.commons.lang3.*
  34 import org.apache.commons.codec.binary.Base64;
  35 import org.springframework.web.util.UriUtils
  36 import groovy.xml.XmlUtil
  37 import groovy.json.*
  38
  39 public class DeleteNetworkInstance extends AbstractServiceTaskProcessor {
  40         String Prefix="DELNI_"
  41         String groovyClassName = "DeleteNetworkInstance"
  42         ExceptionUtil exceptionUtil = new ExceptionUtil()
  43         JsonUtils jsonUtil = new JsonUtils()
  44         VidUtils vidUtils = new VidUtils(this)
  45         NetworkUtils networkUtils = new NetworkUtils()
  46
  47
  48         public InitializeProcessVariables(DelegateExecution execution){
  49
  50                 execution.setVariable(Prefix + "Success", false)
  51
  52                 execution.setVariable(Prefix + "CompleteMsoProcessRequest", "")
  53                 execution.setVariable(Prefix + "FalloutHandlerRequest", "")
  54                 execution.setVariable(Prefix + "isSilentSuccess", false)
  55
  56         }
  57
  58         // **************************************************
  59         //     Pre or Prepare Request Section
  60         // **************************************************
  61
  62         public void preProcessRequest (DelegateExecution execution) {
  63                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
  64                 execution.setVariable("prefix",Prefix)
  65
  66                 utils.log("DEBUG", " ***** Inside preProcessRequest() of " + groovyClassName + " ***** ", isDebugEnabled)
  67
  68                 try {
  69                         // initialize flow variables
  70                         InitializeProcessVariables(execution)
  71
  72                         String sdncVersion = execution.getVariable("sdncVersion")
  73                         if (sdncVersion == null || sdncVersion == '1610') {
  74                                 // 'a-la-cart' default, sdncVersion = '1610'
  75                                 execution.setVariable("sdncVersion", "1610")
  76                                 String bpmnRequest = execution.getVariable("bpmnRequest")
  77                                 // set 'disableRollback'
  78                                 if (bpmnRequest != null) {
  79                                         String disableRollback = jsonUtil.getJsonValue(bpmnRequest, "requestDetails.requestInfo.suppressRollback")
  80                                         if (disableRollback != null) {
  81                                                 execution.setVariable("disableRollback", disableRollback)
  82                                                 utils.log("DEBUG", "Received 'suppressRollback': " + disableRollback , isDebugEnabled)
  83                                         } else {
  84                                             execution.setVariable("disableRollback", false)
  85                                         }
  86                                         utils.log("DEBUG", " Set 'disableRollback' : " + execution.getVariable("disableRollback") , isDebugEnabled)
  87                                 } else {
  88                                         String dataErrorMessage = " Invalid 'bpmnRequest' request."
  89                                         utils.log("DEBUG", dataErrorMessage, isDebugEnabled)
  90                                         exceptionUtil.buildAndThrowWorkflowException(execution, 2500, dataErrorMessage)
  91                                 }
  92
  93                         } else {
  94                             // 'macro' test ONLY, sdncVersion = '1702'
  95                             utils.log("DEBUG", " 'disableRollback' : " + execution.getVariable("disableRollback") , isDebugEnabled)
  96                         }
  97
  98                         // get/set 'msoRequestId' and 'mso-request-id'
  99                         String requestId = execution.getVariable("msoRequestId")
 100                         if (requestId != null) {
 101                                 execution.setVariable("mso-request-id", requestId)
 102                         } else {
 103                                 requestId = execution.getVariable("mso-request-id")
 104                         }
 105                         execution.setVariable(Prefix + "requestId", requestId)
 106
 107                         // get/set 'requestId'
 108                     if (execution.getVariable("requestId") == null) {
 109                                 execution.setVariable("requestId", requestId)
 110                         }
 111
 112                         // set action to "DELETE"
 113                         execution.setVariable("action", "DELETE")
 114
 115                         //Place holder for additional code.
 116
 117                         // TODO ???
 118                         // userParams???  1) pre-loads indicator, 2) 'auto-activation'
 119                         // Tag/Value parameters
 120                         //
 121                         // Map: 'networkInputParams': 'auto-activation''
 122                         // Sample format?
 123                         // "requestParameters": {
 124                         //     "userParams": [
 125             //          {
 126                         //               "name": "someUserParam1",
 127                         //               "value": "someValue1"
 128                         //          }
 129             //     ]
 130                     //   }
 131                         //
 132                         // String userParams = //use json util to extract "userParams"//
 133                 // execution.setVariable("networkInputParams", userParams)
 134                         // else: execution.setVariable("networkInputParams", null)
 135                         //
 136
 137
 138                 } catch (Exception ex){
 139                         sendSyncError(execution)
 140                         String exceptionMessage = "Exception Encountered in " + groovyClassName + ", PreProcessRequest() - " + ex.getMessage()
 141                         utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 142                         exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
 143
 144                 }
 145
 146         }
 147
 148         public void getNetworkModelInfo (DelegateExecution execution) {
 149                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 150                 execution.setVariable("prefix", Prefix)
 151
 152                 utils.log("DEBUG", " ***** Inside getNetworkModelInfo() of DeleteNetworkInstance ***** ", isDebugEnabled)
 153
 154                 try {
 155
 156                         // For Ala-Carte (sdnc = 1610):
 157                         // 1. the Network ModelInfo is expected to be sent
 158                         //     via requestDetails.modelInfo (modelType = network), ex: modelCustomizationId.
 159                         // 2. the Service ModelInfo is expected to be sent but will be IGNORE
 160                         //     via requestDetails.relatedInstanceList.relatedInstance.modelInfo (modelType = service)
 161
 162                 } catch (Exception ex) {
 163                         sendSyncError(execution)
 164                    String exceptionMessage = "Bpmn error encountered in DeleteNetworkInstance flow. getNetworkModelInfo() - " + ex.getMessage()
 165                    utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 166                    exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
 167
 168                 }
 169
 170         }
 171
 172         public void sendSyncResponse (DelegateExecution execution) {
 173                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 174                 execution.setVariable("prefix",Prefix)
 175
 176                 utils.log("DEBUG", " ***** Inside sendSyncResponse() of DeleteNetworkInstance ***** ", isDebugEnabled)
 177
 178                 try {
 179                         String requestId = execution.getVariable("mso-request-id")
 180                         String serviceInstanceId = execution.getVariable("serviceInstanceId")
 181
 182                         // RESTResponse (for API Handler (APIH) Reply Task)
 183                         String deleteNetworkRestRequest = """{"requestReferences":{"instanceId":"${serviceInstanceId}","requestId":"${requestId}"}}""".trim()
 184
 185                         utils.log("DEBUG", " sendSyncResponse to APIH - " + "\n" + deleteNetworkRestRequest, isDebugEnabled)
 186
 187                         sendWorkflowResponse(execution, 202, deleteNetworkRestRequest)
 188
 189                 } catch (Exception ex) {
 190                          // caught exception
 191                         String exceptionMessage = "Exception Encountered in  DeleteNetworkInstance, sendSyncResponse() - " + ex.getMessage()
 192                         utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 193                         exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
 194
 195                 }
 196
 197         }
 198
 199         public void prepareCompletion (DelegateExecution execution) {
 200                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 201                 execution.setVariable("prefix",Prefix)
 202
 203                 utils.log("DEBUG", " ***** Inside prepareCompletion() of CreateNetworkInstance ***** ", isDebugEnabled)
 204
 205                 try {
 206
 207                         String requestId = execution.getVariable("mso-request-id")
 208                         String source = execution.getVariable(Prefix + "source")
 209
 210                         String msoCompletionRequest =
 211                                 """<aetgt:MsoCompletionRequest xmlns:aetgt="http://org.openecomp/mso/workflow/schema/v1"
 212                                                                 xmlns:ns="http://org.openecomp/mso/request/types/v1">
 213                                                 <request-info xmlns="http://org.openecomp/mso/infra/vnf-request/v1">
 214                                                         <request-id>${requestId}</request-id>
 215                                                         <action>DELETE</action>
 216                                                         <source>VID</source>
 217                                                 </request-info>
 218                                                 <aetgt:status-message>Network has been deleted successfully.</aetgt:status-message>
 219                                                 <aetgt:mso-bpel-name>BPMN Network action: DELETE</aetgt:mso-bpel-name>
 220                                         </aetgt:MsoCompletionRequest>"""
 221
 222                                 // Format Response
 223                         String xmlMsoCompletionRequest = utils.formatXml(msoCompletionRequest)
 224
 225                         // normal path
 226                         execution.setVariable(Prefix + "CompleteMsoProcessRequest", xmlMsoCompletionRequest)
 227                         utils.log("DEBUG", " Overall SUCCESS Response going to CompleteMsoProcess - " + "\n" + xmlMsoCompletionRequest, isDebugEnabled)
 228
 229                 } catch (Exception ex) {
 230                         String exceptionMessage = " Bpmn error encountered in CreateNetworkInstance flow. prepareCompletion() - " + ex.getMessage()
 231                         utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 232                         exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
 233
 234                 }
 235
 236
 237         }
 238
 239         public void prepareDBRequestError (DelegateExecution execution) {
 240                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 241                 execution.setVariable("prefix", Prefix)
 242
 243                 try {
 244                         utils.log("DEBUG", " ***** Inside prepareDBRequestError of DeleteNetworkInstance ***** ", isDebugEnabled)
 245
 246                         // set DB Header Authorization
 247                         setBasicDBAuthHeader(execution, isDebugEnabled)
 248
 249                         WorkflowException wfe = execution.getVariable("WorkflowException")
 250                         String statusMessage = wfe.getErrorMessage()
 251                         String requestId = execution.getVariable(Prefix +"requestId")
 252
 253                         String dbRequest =
 254                                         """<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 255                                                 <soapenv:Header/>
 256                                                 <soapenv:Body>
 257                                                         <ns:updateInfraRequest xmlns:ns="http://org.openecomp.mso/requestsdb">
 258                                                                 <requestId>${requestId}</requestId>
 259                                                                 <lastModifiedBy>BPMN</lastModifiedBy>
 260                                                                 <statusMessage>${statusMessage}</statusMessage>
 261                                                                 <responseBody></responseBody>
 262                                                                 <requestStatus>FAILED</requestStatus>
 263                                                                 <progress></progress>
 264                                                                 <vnfOutputs>&lt;network-outputs xmlns="http://org.openecomp/mso/infra/vnf-request/v1" xmlns:aetgt="http://org.openecomp/mso/infra/vnf-request/v1" xmlns:rest="http://schemas.activebpel.org/REST/2007/12/01/aeREST.xsd"/&gt;</vnfOutputs>
 265                                                         </ns:updateInfraRequest>
 266                                                 </soapenv:Body>
 267                                            </soapenv:Envelope>"""
 268
 269                    execution.setVariable(Prefix + "deleteDBRequest", dbRequest)
 270                    utils.log("DEBUG", " DB Adapter Request - " + "\n" + dbRequest, isDebugEnabled)
 271
 272                 } catch (Exception ex) {
 273                         // caught exception
 274                         String exceptionMessage = "Bpmn error encountered in  DeleteNetworkInstance, prepareDBRequestError() - " + ex.getMessage()
 275                         logError(exceptionMessage)
 276                         utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 277                         exceptionUtil.buildWorkflowException(execution, 7000, exceptionMessage)
 278
 279                 }
 280
 281          }
 282
 283         // **************************************************
 284         //     Post or Validate Response Section
 285         // **************************************************
 286
 287         public void postProcessResponse (DelegateExecution execution) {
 288                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 289                 execution.setVariable("prefix", Prefix)
 290
 291                 utils.log("DEBUG", " ***** Inside postProcessResponse() of DeleteNetworkInstance ***** ", isDebugEnabled)
 292
 293                 try {
 294                         if (execution.getVariable("CMSO_ResponseCode") == "200") {
 295                            execution.setVariable(Prefix + "Success", true)
 296                            utils.log("DEBUG", " ***** DeleteNetworkInstance Success ***** ", isDebugEnabled)
 297                            //   Place holder for additional code.
 298
 299                         } else {
 300                            execution.setVariable(Prefix + "Success", false)
 301                            utils.log("DEBUG", " ***** DeleteNetworkInstance Failed in CompletionMsoProces flow!. ***** ", isDebugEnabled)
 302
 303                         }
 304
 305
 306                 } catch (Exception ex) {
 307                         String exceptionMessage = " Bpmn error encountered in DeleteNetworkInstance flow. postProcessResponse() - " + ex.getMessage()
 308                         utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 309                         exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
 310
 311             }
 312
 313         }
 314
 315
 316         // *******************************
 317         //     Build Error Section
 318         // *******************************
 319
 320         // Prepare for FalloutHandler
 321         public void buildErrorResponse (DelegateExecution execution) {
 322                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 323                 execution.setVariable("prefix", Prefix)
 324
 325                 utils.log("DEBUG", " ***** Prepare for FalloutHandler. FAILURE - prepare request for sub-process FalloutHandler. *****", isDebugEnabled)
 326
 327                 String dbReturnCode = execution.getVariable(Prefix + "dbReturnCode")
 328                 utils.log("DEBUG", " ***** DB Update Response Code  : " + dbReturnCode, isDebugEnabled)
 329                 utils.log("DEBUG", " ***** DB Update Response String: " + '\n' + execution.getVariable(Prefix + "deleteDBResponse"), isDebugEnabled)
 330
 331                 String falloutHandlerRequest = ""
 332                 String requestId = execution.getVariable("mso-request-id")
 333                 String source = execution.getVariable(Prefix + "source")
 334                 execution.setVariable(Prefix + "Success", false)
 335                 try {
 336                         WorkflowException wfe = execution.getVariable("WorkflowException")
 337                         String errorCode = String.valueOf(wfe.getErrorCode())
 338                         String errorMessage = wfe.getErrorMessage()
 339
 340                         falloutHandlerRequest =
 341                             """<aetgt:FalloutHandlerRequest xmlns:aetgt="http://org.openecomp/mso/workflow/schema/v1"
 342                                                                      xmlns:ns="http://org.openecomp/mso/request/types/v1"
 343                                                                      xmlns:wfsch="http://org.openecomp/mso/workflow/schema/v1">
 344                                            <request-info xmlns="http://org.openecomp/mso/infra/vnf-request/v1">
 345                                               <request-id>${requestId}</request-id>
 346                                               <action>DELETE</action>
 347                                               <source>${source}</source>
 348                                            </request-info>
 349                                                 <aetgt:WorkflowException xmlns:aetgt="http://org.openecomp/mso/workflow/schema/v1">
 350                                                         <aetgt:ErrorMessage>${errorMessage}</aetgt:ErrorMessage>
 351                                                         <aetgt:ErrorCode>${errorCode}</aetgt:ErrorCode>
 352                                                 </aetgt:WorkflowException>
 353                                         </aetgt:FalloutHandlerRequest>"""
 354
 355                         utils.logAudit(falloutHandlerRequest)
 356                         execution.setVariable(Prefix + "FalloutHandlerRequest", falloutHandlerRequest)
 357                         utils.log("ERROR", "  Overall Error Response going to FalloutHandler: " + "\n" + falloutHandlerRequest, isDebugEnabled)
 358
 359                 } catch (Exception ex) {
 360                         // caught exception
 361                         String exceptionMessage = "Bpmn error encountered in DeleteNetworkInstance, buildErrorResponse() - " + ex.getMessage()
 362                         utils.log("DEBUG", exceptionMessage, isDebugEnabled)
 363                         falloutHandlerRequest =
 364                         """<aetgt:FalloutHandlerRequest xmlns:aetgt="http://org.openecomp/mso/workflow/schema/v1"
 365                                                                      xmlns:ns="http://org.openecomp/mso/request/types/v1"
 366                                                                      xmlns:wfsch="http://org.openecomp/mso/workflow/schema/v1">
 367                                            <request-info xmlns="http://org.openecomp/mso/infra/vnf-request/v1">
 368                                               <request-id>${requestId}</request-id>
 369                                               <action>DELEtE</action>
 370                                               <source>${source}</source>
 371                                            </request-info>
 372                                                 <aetgt:WorkflowException xmlns:aetgt="http://org.openecomp/mso/workflow/schema/v1">
 373                                                         <aetgt:ErrorMessage>${exceptionMessage}</aetgt:ErrorMessage>
 374                                                         <aetgt:ErrorCode>9999</aetgt:ErrorCode>
 375                                                 </aetgt:WorkflowException>
 376                                         </aetgt:FalloutHandlerRequest>"""
 377                         execution.setVariable(Prefix + "FalloutHandlerRequest", falloutHandlerRequest)
 378                         utils.log("DEBUG", "  Overall Error Response going to FalloutHandler: " + "\n" + falloutHandlerRequest, isDebugEnabled)
 379                 }
 380         }
 381
 382
 383         public void sendSyncError (DelegateExecution execution) {
 384                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 385                 execution.setVariable("prefix", Prefix)
 386
 387                 try {
 388                         String requestId = execution.getVariable("mso-request-id")
 389                         String serviceInstanceId = execution.getVariable("serviceInstanceId")
 390
 391                         // RESTResponse (for API Handler (APIH) Reply Task)
 392                         String deleteNetworkRestError = """{"requestReferences":{"instanceId":"${serviceInstanceId}","requestId":"${requestId}"}}""".trim()
 393
 394                         utils.log("DEBUG", " sendSyncResponse to APIH - " + "\n" + deleteNetworkRestError, isDebugEnabled)
 395
 396                         sendWorkflowResponse(execution, 500, deleteNetworkRestError)
 397
 398                 } catch (Exception ex) {
 399                         utils.log("DEBUG", " Sending Sync Error Activity Failed -  DeleteNetworkInstance, sendSyncError(): " + "\n" + ex.getMessage(), isDebugEnabled)
 400                 }
 401         }
 402
 403         public void processJavaException(DelegateExecution execution){
 404                 def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
 405                 execution.setVariable("prefix",Prefix)
 406                 try{
 407                         utils.log("DEBUG", "Caught a Java Exception", isDebugEnabled)
 408                         utils.log("DEBUG", "Started processJavaException Method", isDebugEnabled)
 409                         utils.log("DEBUG", "Variables List: " + execution.getVariables(), isDebugEnabled)
 410                         execution.setVariable("UnexpectedError", "Caught a Java Lang Exception")  // Adding this line temporarily until this flows error handling gets updated
 411                         exceptionUtil.buildWorkflowException(execution, 500, "Caught a Java Lang Exception")
 412
 413                 }catch(Exception e){
 414                         utils.log("DEBUG", "Caught Exception during processJavaException Method: " + e, isDebugEnabled)
 415                         execution.setVariable("UnexpectedError", "Exception in processJavaException method")  // Adding this line temporarily until this flows error handling gets updated
 416                         exceptionUtil.buildWorkflowException(execution, 500, "Exception in processJavaException method")
 417                 }
 418                 utils.log("DEBUG", "Completed processJavaException Method of " + Prefix, isDebugEnabled)
 419         }
 420
 421 }