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