5e9a7c8245b1e51f17cecf438c3f65a0911e916f
[so.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  * OPENECOMP - SO
4  * ================================================================================
5  * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.so.bpmn.infrastructure.scripts
22
23 import org.apache.commons.lang3.StringUtils
24 import org.camunda.bpm.engine.delegate.BpmnError
25 import org.json.JSONObject
26 import org.json.XML
27 import org.onap.so.logger.MsoLogger
28 import org.onap.so.bpmn.common.recipe.ResourceInput
29 import org.onap.so.bpmn.common.resource.ResourceRequestBuilder
30 import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
31 import org.camunda.bpm.engine.delegate.DelegateExecution
32 import org.onap.so.bpmn.core.json.JsonUtils
33 import org.onap.so.bpmn.common.scripts.ExceptionUtil
34 import org.onap.so.bpmn.common.scripts.SDNCAdapterUtils
35 import org.onap.so.logger.MsoLogger
36
37 /**
38  * This groovy class supports the <class>ActivateSDNCCNetworkResource.bpmn</class> process.
39  * flow for SDNC Network Resource Activate
40  */
41 public class DeActivateSDNCNetworkResource extends AbstractServiceTaskProcessor {
42     private static final MsoLogger msoLogger = MsoLogger.getMsoLogger(MsoLogger.Catalog.BPEL, DeActivateSDNCNetworkResource.class);
43     String Prefix = "DEACTSDNCRES_"
44
45     ExceptionUtil exceptionUtil = new ExceptionUtil()
46
47     JsonUtils jsonUtil = new JsonUtils()
48
49     SDNCAdapterUtils sdncAdapterUtils = new SDNCAdapterUtils()
50
51     public void preProcessRequest(DelegateExecution execution) {
52
53         def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
54         msoLogger.info(" ***** Started preProcessRequest *****")
55
56         try {
57
58             //get bpmn inputs from resource request.
59             String requestId = execution.getVariable("mso-request-id")
60             String requestAction = execution.getVariable("requestAction")
61             String recipeParamsFromRequest = execution.getVariable("recipeParams")
62             String resourceInput = execution.getVariable("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 resourceModelName = resourceInputObj.getResourceModelInfo().getModelName()
70             //For sdnc requestAction default is "NetworkInstance"
71             String operationType = "Network"
72             if(!StringUtils.isBlank(recipeParamsFromRequest) && "null" != 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
82             // TODO: based on the resource type decide action and operation type
83             String sdnc_svcAction = "deactivate"
84             switch (resourceInputObj.getResourceModelInfo().getModelName()) {
85                 case ~/[\w\s\W]*SOTNConnectivity[\w\s\W]*/ :
86                     operationType = "SOTNConnectivity"
87                     break
88
89                 case ~/[\w\s\W]*sotnvpnattachment[\w\s\W]*/ :
90                     operationType = "SOTNAttachment"
91                     break
92
93                 case ~/[\w\s\W]*SiteVF[\w\s\W]*/ :
94                     operationType = "Site"
95                     break
96
97                 case ~/[\w\s\W]*deviceVF[\w\s\W]*/ :
98                     operationType = "SDWANDevice"
99                     execution.setVariable("isActivateRequired", "true")
100                     break
101
102                 case ~/[\w\s\W]*SDWANConnectivity[\w\s\W]*/ :
103                     operationType = "SDWANConnectivity"
104                     break
105
106                 case ~/[\w\s\W]*sdwanvpnattachment[\w\s\W]*/ :
107                     operationType = "SDWANAttachment"
108                     break
109
110                 case ~/[\w\s\W]*SiteWANVF[\w\s\W]*/ :
111                     operationType = "SDWANPort"
112                     execution.setVariable("isActivateRequired", "true")
113                     break
114
115                 default:
116                     break
117             }
118
119             String sdnc_requestAction = StringUtils.capitalize(sdnc_svcAction) + operationType +"Instance"
120             execution.setVariable(Prefix + "svcAction", sdnc_svcAction)
121             execution.setVariable(Prefix + "requestAction", sdnc_requestAction)
122             execution.setVariable(Prefix + "serviceInstanceId", resourceInputObj.getServiceInstanceId())
123             execution.setVariable("mso-request-id", requestId)
124             execution.setVariable("mso-service-instance-id", resourceInputObj.getServiceInstanceId())
125             //TODO Here build networkrequest
126
127         } catch (BpmnError e) {
128             throw e;
129         } catch (Exception ex){
130             msg = "Exception in preProcessRequest " + ex.getMessage()
131             msoLogger.debug(msg)
132             exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
133         }
134     }
135
136     public void prepareSDNCRequest(DelegateExecution execution) {
137         def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
138         msoLogger.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 = execution.getVariable(Prefix + "resourceInput")
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.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
176                                     <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
177                                     <sdncadapter:SvcAction>${msoUtils.xmlEncode(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.xmlEncode(hdrRequestId)}</request-id>
185                                         <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
186                                         <source>${msoUtils.xmlEncode(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.xmlEncode(serviceInstanceId)}</service-id>
193                                         <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
194                                         <onap-model-information>
195                                              <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
196                                              <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
197                                              <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
198                                              <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
199                                         </onap-model-information>
200                                         <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
201                                         <global-customer-id>${msoUtils.xmlEncode(globalCustomerId)}</global-customer-id>
202                                         <subscriber-name>${msoUtils.xmlEncode(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.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
209                                              <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
210                                              <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
211                                              <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
212                                              <model-name>${msoUtils.xmlEncode(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.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
234                                     <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
235                                     <sdncadapter:SvcAction>${msoUtils.xmlEncode(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.xmlEncode(hdrRequestId)}</request-id>
243                                         <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
244                                         <source>${msoUtils.xmlEncode(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.xmlEncode(serviceInstanceId)}</service-id>
251                                         <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
252                                         <onap-model-information>
253                                              <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
254                                              <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
255                                              <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
256                                              <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
257                                         </onap-model-information>
258                                         <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
259                                         <global-customer-id>${msoUtils.xmlEncode(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.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
268                                              <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
269                                              <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
270                                              <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
271                                              <model-name>${msoUtils.xmlEncode(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.xmlEncode(hdrRequestId)}</sdncadapter:RequestId>
286                                     <sdncadapter:SvcInstanceId>${msoUtils.xmlEncode(serviceInstanceId)}</sdncadapter:SvcInstanceId>
287                                     <sdncadapter:SvcAction>${msoUtils.xmlEncode(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.xmlEncode(hdrRequestId)}</request-id>
295                                         <request-action>${msoUtils.xmlEncode(sdnc_requestAction)}</request-action>
296                                         <source>${msoUtils.xmlEncode(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.xmlEncode(serviceInstanceId)}</service-id>
303                                         <subscription-service-type>${msoUtils.xmlEncode(serviceType)}</subscription-service-type>
304                                         <onap-model-information>
305                                              <model-invariant-uuid>${msoUtils.xmlEncode(serviceModelInvariantUuid)}</model-invariant-uuid>
306                                              <model-uuid>${msoUtils.xmlEncode(serviceModelUuid)}</model-uuid>
307                                              <model-version>${msoUtils.xmlEncode(serviceModelVersion)}</model-version>
308                                              <model-name>${msoUtils.xmlEncode(serviceModelName)}</model-name>
309                                         </onap-model-information>
310                                         <service-instance-id>${msoUtils.xmlEncode(serviceInstanceId)}</service-instance-id>
311                                         <global-customer-id>${msoUtils.xmlEncode(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.xmlEncode(modelInvariantUuid)}</model-invariant-uuid>
317                                              <model-customization-uuid>${msoUtils.xmlEncode(modelCustomizationUuid)}</model-customization-uuid>
318                                              <model-uuid>${msoUtils.xmlEncode(modelUuid)}</model-uuid>
319                                              <model-version>${msoUtils.xmlEncode(modelVersion)}</model-version>
320                                              <model-name>${msoUtils.xmlEncode(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             utils.logAudit(sdncTopologyDeleteRequesAsString)
332             execution.setVariable("sdncAdapterWorkflowRequest", sdncTopologyDeleteRequesAsString)
333             msoLogger.info("sdncAdapterWorkflowRequest - " + "\n" +  sdncTopologyDeleteRequesAsString)
334
335         } catch (Exception ex) {
336             String exceptionMessage = " Bpmn error encountered in DeleteSDNCCNetworkResource flow. prepareSDNCRequest() - " + ex.getMessage()
337             msoLogger.debug(exceptionMessage)
338             exceptionUtil.buildAndThrowWorkflowException(execution, 7000, exceptionMessage)
339
340         }
341         msoLogger.info(" ***** Exit prepareSDNCRequest *****")
342     }
343
344     public void prepareUpdateAfterDeActivateSDNCResource(DelegateExecution execution) {
345         ResourceInput resourceInputObj = execution.getVariable(Prefix + "resourceInput")
346         String operType = resourceInputObj.getOperationType()
347         String resourceCustomizationUuid = resourceInputObj.getResourceModelInfo().getModelCustomizationUuid()
348         String serviceInstanceId = resourceInputObj.getServiceInstanceId()
349         String operationId = resourceInputObj.getOperationId()
350         String progress = "50"
351         String status = "deactivated"
352         String statusDescription = "SDCN resource deactivation completed"
353
354         //String operationId = execution.getVariable("operationId")
355
356         String body = """
357                 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
358                         xmlns:ns="http://org.openecomp.mso/requestsdb">
359                         <soapenv:Header/>
360                 <soapenv:Body>
361                     <ns:updateResourceOperationStatus>
362                                <operType>${msoUtils.xmlEncode(operType)}</operType>
363                                <operationId>${msoUtils.xmlEncode(operationId)}</operationId>
364                                <progress>${msoUtils.xmlEncode(progress)}</progress>
365                                <resourceTemplateUUID>${msoUtils.xmlEncode(resourceCustomizationUuid)}</resourceTemplateUUID>
366                                <serviceId>${msoUtils.xmlEncode(serviceInstanceId)}</serviceId>
367                                <status>${msoUtils.xmlEncode(status)}</status>
368                                <statusDescription>${msoUtils.xmlEncode(statusDescription)}</statusDescription>
369                     </ns:updateResourceOperationStatus>
370                 </soapenv:Body>
371                 </soapenv:Envelope>""";
372
373         setProgressUpdateVariables(execution, body)
374     }
375
376     private void setProgressUpdateVariables(DelegateExecution execution, String body) {
377         def dbAdapterEndpoint = execution.getVariable("URN_mso_adapters_openecomp_db_endpoint")
378         execution.setVariable("CVFMI_dbAdapterEndpoint", dbAdapterEndpoint)
379         execution.setVariable("CVFMI_updateResOperStatusRequest", body)
380     }
381
382     public void postDeactivateSDNCCall(DelegateExecution execution) {
383         def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
384         msoLogger.info(" ***** Started prepareSDNCRequest *****")        String responseCode = execution.getVariable(Prefix + "sdncDeleteReturnCode")
385         String responseObj = execution.getVariable(Prefix + "SuccessIndicator")
386
387         msoLogger.info("response from sdnc, response code :" + responseCode + "  response object :" + responseObj)
388         msoLogger.info(" ***** Exit prepareSDNCRequest *****")
389     }
390
391     public void sendSyncResponse(DelegateExecution execution) {
392         def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
393         msoLogger.debug(" *** sendSyncResponse *** ")
394
395         try {
396             String operationStatus = "finished"
397             // RESTResponse for main flow
398             String resourceOperationResp = """{"operationStatus":"${operationStatus}"}""".trim()
399             msoLogger.debug(" sendSyncResponse to APIH:" + "\n" + resourceOperationResp)
400             sendWorkflowResponse(execution, 202, resourceOperationResp)
401             execution.setVariable("sentSyncResponse", true)
402
403         } catch (Exception ex) {
404             String msg = "Exceptuion in sendSyncResponse:" + ex.getMessage()
405             msoLogger.debug(msg)
406             exceptionUtil.buildAndThrowWorkflowException(execution, 7000, msg)
407         }
408         msoLogger("DEBUG"," ***** Exit sendSyncResopnse *****")
409     }
410
411 }