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