aboutsummaryrefslogtreecommitdiffstats
path: root/bpmn/MSOCommonBPMN/src/main/groovy/org/openecomp/mso/bpmn/common/scripts/CompleteMsoProcess.groovy
blob: e7277b602bc37690c46ba17a709fc68532fb1bbb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
/*-
 * ============LICENSE_START=======================================================
 * OPENECOMP - MSO
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.mso.bpmn.common.scripts

import org.apache.commons.lang3.*
import org.camunda.bpm.engine.delegate.BpmnError
import org.camunda.bpm.engine.runtime.Execution


public class CompleteMsoProcess extends AbstractServiceTaskProcessor {

	String Prefix="CMSO_"
	ExceptionUtil exceptionUtil = new ExceptionUtil()

	// Complete MSO Request processing
	public initializeProcessVariables(Execution execution){

		def method = getClass().getSimpleName() + '.initializeProcessVariables(' +'execution=' + execution.getId() +')'
		def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
		logDebug('Entered ' + method, isDebugLogEnabled)
		try {

			/* Initialize all the process request variables in this block */
			execution.setVariable("prefix",Prefix)
			execution.setVariable("CMSO_request_id","")
			execution.setVariable("CMSO_notification-url","")
			execution.setVariable("CMSO_mso-bpel-name","")
			execution.setVariable("CMSO_request_action","")
			execution.setVariable("CMSO_notification-url-Ok", false)
			execution.setVariable("CMSO_request_id-Ok", false)

			//updateRequest Adapter process variables
			execution.setVariable("CMSO_updateRequestResponse", "")
			execution.setVariable("CMSO_updateRequestResponseCode", "")
			execution.setVariable("CMSO_updateFinalNotifyAckStatusFailedPayload", "")

			//Set DB adapter variables here
			execution.setVariable("CMSO_updateDBStatusToSuccessPayload", "")
			execution.setVariable("CMSO_updateInfraRequestDBPayload", "")
			execution.setVariable("CMSO_setUpdateDBstatustoSuccessPayload", "")

			//Auth variables
			execution.setVariable("BasicAuthHeaderValue","")

			//Response variables
			execution.setVariable("CompletionHandlerResponse","")
			execution.setVariable("CMSO_ErrorResponse", null)
			execution.setVariable("CMSO_ResponseCode", "")

			setSuccessIndicator(execution, false)

		} catch (BpmnError e) {
			throw e;
		} catch (Exception e) {
			logError('Caught exception in ' + method, e)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2000, "Internal Error - Occured in" + method)
		}

	}

	public void preProcessRequest (Execution execution) {

		initializeProcessVariables(execution)
		def method = getClass().getSimpleName() + '.preProcessRequest(' +'execution=' + execution.getId() +')'
		def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
//		utils.log("DEBUG", "*** Started CompleteMsoProcess preProcessRequest Method ***", isDebugLogEnabled);
		logDebug('Entered ' + method, isDebugLogEnabled)
		try {
			def xml = execution.getVariable("CompleteMsoProcessRequest")

			utils.logAudit("CompleteMsoProcess Request: " + xml)
			utils.log("DEBUG", "Incoming Request is: "+ xml, isDebugLogEnabled)

			//mso-bpel-name from the incoming request
			def msoBpelName = utils.getNodeText1(xml,"mso-bpel-name")
			execution.setVariable("CMSO_mso-bpel-name",msoBpelName)

			//Check the incoming request type
			//Incoming request can be ACTIVE_REQUESTS (request-information node) or  INFRA_ACTIVE_REQUESTS (request-info node)
			if (utils.nodeExists(xml, "request-information")) {
				execution.setVariable("CMSO_request_id-Ok", true) // Incoming request is for ACTIVE_REQUESTS
			}

			//Check notification-url for the incoming request type
			//ACTIVE_REQUESTS may have notificationurl node
			//INFRA_ACTIVE_REQUESTS notificationurl node does not exist
			def notificationurl = ""
			if (utils.nodeExists(xml, "notification-url")) {
				notificationurl = utils.getNodeText(xml,"notification-url")
				if(notificationurl != null && !notificationurl.isEmpty()) {
					execution.setVariable("CMSO_notification-url-Ok", true)
					execution.setVariable("CMSO_notification-url",notificationurl)
				}
			}

			//Check request_id for the incoming request type
			//For INFRA_ACTIVE_REQUESTS payload request-id IS optional (Not sure why this is option since req id is primary key ... also tried exe through SOAP UI to check if MSO code handles null like auto generated seq not it does not)
			//For ACTIVE_REQUESTS payload request-id is NOT optional
			def request_id = ""
			if (utils.nodeExists(xml, "request-id")) {
				execution.setVariable("CMSO_request_id",utils.getNodeText(xml,"request-id"))
			}


			// INFRA_ACTIVE_REQUESTS	 have "action" element ... mandatory
			// ACTIVE_REQUEST have "request-action" ... mandatory
			if (utils.nodeExists(xml, "request-action")) {
				execution.setVariable("CMSO_request_action",utils.getNodeText(xml,"request-action"))
			} else if (utils.nodeExists(xml, "action")) {
				execution.setVariable("CMSO_request_action",utils.getNodeText(xml,"action"))
			}

			//Check source for the incoming request type
			//For INFRA_ACTIVE_REQUESTS payload source IS optional
			//For ACTIVE_REQUESTS payload source is NOT optional
			def source = ""
			if (utils.nodeExists(xml, "source")) {
				execution.setVariable("CMSO_source",utils.getNodeText(xml,"source"))
			}

			utils.log("DEBUG", "CMSO_notification-url-Ok --> " + execution.getVariable("CMSO_notification-url-Ok"), isDebugLogEnabled)
			utils.log("DEBUG", "CMSO_request_id-Ok --> " + execution.getVariable("CMSO_request_id-Ok"), isDebugLogEnabled)

			// set the DHV/Service Instantiation values if specified in the request
			execution.setVariable("CMSO_is_srv_inst_req", String.valueOf("true".equals(utils.getNodeText1(xml, "is-srv-inst-req"))))
			utils.log("DEBUG", "CMSO_is_srv_inst_req --> " + execution.getVariable("CMSO_is_srv_inst_req"), isDebugLogEnabled)
			execution.setVariable("CMSO_is_json_content", String.valueOf("JSON".equals(utils.getNodeText1(xml, "resp-content-type"))))
			utils.log("DEBUG", "CMSO_is_json_content --> " + execution.getVariable("CMSO_is_json_content"), isDebugLogEnabled)
			execution.setVariable("CMSO_service_inst_id", utils.getNodeText1(xml, "service-instance-id"))
			utils.log("DEBUG", "CMSO_service_inst_id --> " + execution.getVariable("CMSO_service_inst_id"), isDebugLogEnabled)
			execution.setVariable("CMSO_start_time", utils.getNodeText1(xml, "start-time"))
			utils.log("DEBUG", "CMSO_start_time --> " + execution.getVariable("CMSO_start_time"), isDebugLogEnabled)
			// this variable is used by the camunda flow to set the Content-Type for the async response
			if (execution.getVariable("CMSO_is_srv_inst_req").equals("true") &&
				execution.getVariable("CMSO_is_json_content").equals("true")) {
				execution.setVariable("CMSO_content_type", "application/json")
			} else {
				execution.setVariable("CMSO_content_type", "text/xml")
			}
			
			logDebug('Exited ' + method, isDebugLogEnabled)
		} catch (BpmnError e) {
			throw e;
		} catch (Exception e) {
			utils.log("DEBUG", "Exception Occured During PreProcessRequest: " + e, isDebugLogEnabled);
			exceptionUtil.buildAndThrowWorkflowException(execution, 2000, "Internal Error - Occured in " + method)
		}

//		utils.log("DEBUG", "*** Completed CompleteMsoProcess preProcessRequest Method ***", isDebugLogEnabled);
	}

	public void postProcessResponse (Execution execution) {

		def method = getClass().getSimpleName() + '.postProcessResponse(' +'execution=' + execution.getId() +')'
		def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
		logDebug('Entered ' + method, isDebugLogEnabled)
//		utils.log("DEBUG", "*** Started CompleteMsoProcess PostProcessRequest Method ***", isDebugLogEnabled);
		try {

			def msoCompletionResponse = """
			<sdncadapterworkflow:MsoCompletionResponse xmlns:sdncadapterworkflow="http://org.openecomp/mso/workflow/schema/v1">
			   <sdncadapterworkflow:out>BPEL ${execution.getVariable("CMSO_mso-bpel-name")} completed</sdncadapterworkflow:out>
			</sdncadapterworkflow:MsoCompletionResponse>
			""".trim()

			// Format Response
			def xmlMsoCompletionResponse = utils.formatXML(msoCompletionResponse)
			String buildMsoCompletionResponseAsString = xmlMsoCompletionResponse.drop(38).trim()
			// TODO: Should deprecate use of processKey+Response variable for the response. Will use "WorkflowResponse" instead
			execution.setVariable("WorkflowResponse", buildMsoCompletionResponseAsString)
			utils.logAudit("CompleteMsoProcess Response: " + buildMsoCompletionResponseAsString)
			execution.setVariable("CompleteMsoProcessResponse", buildMsoCompletionResponseAsString)
			execution.setVariable("CMSO_ResponseCode", "200")

			setSuccessIndicator(execution, true)

			utils.log("DEBUG", "@@ CompleteMsoProcess Response @@ " + "\n" + execution.getVariable("CompleteMsoProcessResponse"), isDebugLogEnabled)

			logDebug('Exited ' + method, isDebugLogEnabled)
		} catch (BpmnError e) {
			throw e;
		} catch (Exception e) {
			logError('Caught exception in ' + method, e)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2000, "Internal Error - Occured in" + method)
		}
//		utils.log("DEBUG", "*** Completed CompleteMsoProcess PostProcessRequest Method ***", isDebugLogEnabled);

	}

	public void updateDBStatusToSuccessPayload (Execution execution){
		def method = getClass().getSimpleName() + '.updateDBStatusToSuccessPayload(' +'execution=' + execution.getId() +')'
		def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
		logDebug('Entered ' + method, isDebugLogEnabled)
		
		try {
			// Catalog DB headers Authorization
			String basicAuthValueDB = execution.getVariable("URN_mso_adapters_db_auth")
			utils.log("DEBUG", " Obtained BasicAuth userid password for Catalog DB adapter: " + basicAuthValueDB, isDebugLogEnabled)
			
			def encodedString = utils.getBasicAuth(basicAuthValueDB, execution.getVariable("URN_mso_msoKey"))
			execution.setVariable("BasicAuthHeaderValueDB",encodedString)
		} catch (IOException ex) {
			String dataErrorMessage = " Unable to encode Catalog DB user/password string - " + ex.getMessage()
			utils.log("DEBUG", dataErrorMessage, isDebugLogEnabled)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2500, dataErrorMessage)
		}
		
		try {

			String payload = """
			<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:req="http://org.openecomp.mso/requestsdb">
			<soapenv:Header/>
			<soapenv:Body>
			   <req:updateStatus>
				  <requestId>${execution.getVariable("CMSO_request_id")}</requestId>
				  <lastModifiedBy>BPEL</lastModifiedBy>
				  <status>COMPLETED</status>
			   </req:updateStatus>
			</soapenv:Body>
		 </soapenv:Envelope>
		"""
			execution.setVariable("CMSO_updateDBStatusToSuccessPayload", payload)
			utils.logAudit("updateDBStatusToSuccessPayload: " + payload)
			logDebug('Exited ' + method, isDebugLogEnabled)
			//println("CMSO_updateDBStatusToSuccessPayload --> " + execution.getVariable("CMSO_updateDBStatusToSuccessPayload"))

		} catch (BpmnError e) {
			throw e;
		} catch (Exception e) {
			logError('Caught exception in ' + method, e)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2000, "Internal Error - Occured in" + method)
		}
	}

	public void setUpdateDBstatustoSuccessPayload (Execution execution){

		def method = getClass().getSimpleName() + '.setUpdateDBstatustoSuccessPayload(' +'execution=' + execution.getId() +')'
		def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
		logDebug('Entered ' + method, isDebugLogEnabled)
		
		try {
			String basicAuthValueDB = execution.getVariable("URN_mso_adapters_db_auth")
			utils.log("DEBUG", " Obtained BasicAuth userid password for Catalog DB adapter: " + basicAuthValueDB, isDebugLogEnabled)
			
			def encodedString = utils.getBasicAuth(basicAuthValueDB, execution.getVariable("URN_mso_msoKey"))
			execution.setVariable("BasicAuthHeaderValueDB",encodedString)
		} catch (IOException ex) {
			String dataErrorMessage = " Unable to encode Catalog DB user/password string - " + ex.getMessage()
			utils.log("DEBUG", dataErrorMessage, isDebugLogEnabled)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2500, dataErrorMessage)
		} 
		
		try {

			def xml = execution.getVariable("CompleteMsoProcessRequest")

			//Get statusMessage if exists
			def statusMessage
			if(utils.nodeExists(xml, "status-message")){
				statusMessage = utils.getNodeText1(xml, "status-message")
			}else{
				statusMessage = "Resource Completed Successfully"
			}

			//Get instance Id if exist
			String idXml = ""
			if(utils.nodeExists(xml, "vnfId")){
				idXml = utils.getNodeXml(xml, "vnfId")
			}else if(utils.nodeExists(xml, "networkId")){
				idXml = utils.getNodeXml(xml, "networkId")
			}else if(utils.nodeExists(xml, "serviceInstanceId")){
				idXml = utils.getNodeXml(xml, "serviceInstanceId")
			}else if(utils.nodeExists(xml, "vfModuleId")){
				idXml = utils.getNodeXml(xml, "vfModuleId")
			}else if(utils.nodeExists(xml, "volumeGroupId")){
				idXml = utils.getNodeXml(xml, "volumeGroupId")
			}else{
				idXml = ""
			}
			idXml = utils.removeXmlPreamble(idXml)
			utils.log("DEBUG", "Incoming Instance Id Xml: " + idXml, isDebugLogEnabled)

			String payload = """
						<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:req="http://org.openecomp.mso/requestsdb">
						   <soapenv:Header/>
						   <soapenv:Body>
						      <req:updateInfraRequest>
						         <requestId>${execution.getVariable("CMSO_request_id")}</requestId>
						         <lastModifiedBy>${execution.getVariable("CMSO_mso-bpel-name")}</lastModifiedBy>
						         <statusMessage>${statusMessage}</statusMessage>
						         <requestStatus>COMPLETE</requestStatus>
								 <progress>100</progress>
								 ${idXml}
						      </req:updateInfraRequest>
						   </soapenv:Body>
						</soapenv:Envelope>"""

			execution.setVariable("CMSO_setUpdateDBstatustoSuccessPayload", payload)
			utils.log("DEBUG", "Outgoing Update Mso Request Payload is: " + payload, isDebugLogEnabled)
			utils.logAudit("setUpdateDBstatustoSuccessPayload: " + payload)

		} catch (BpmnError e) {
			throw e;
		} catch (Exception e) {
			logError('Caught exception in ' + method, e)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2000, "Internal Error - Occured in" + method)
		}
		logDebug('Exited ' + method, isDebugLogEnabled)
	}

	public void buildDataError (Execution execution, String message) {

		def method = getClass().getSimpleName() + '.buildDataError(' +'execution=' + execution.getId() +')'
		def isDebugLogEnabled = execution.getVariable('isDebugLogEnabled')
		logDebug('Entered ' + method, isDebugLogEnabled)
		try {

			def msoCompletionResponse = """
			<sdncadapterworkflow:MsoCompletionResponse xmlns:sdncadapterworkflow="http://org.openecomp/mso/workflow/schema/v1">
			   <sdncadapterworkflow:out>BPEL ${execution.getVariable("CMSO_mso-bpel-name")} FAILED</sdncadapterworkflow:out>
			</sdncadapterworkflow:MsoCompletionResponse>
			""".trim()

			// Format Response
			def xmlMsoCompletionResponse = utils.formatXml(msoCompletionResponse)
			String buildMsoCompletionResponseAsString = xmlMsoCompletionResponse.drop(38).trim()
			utils.logAudit("CompleteMsoProcess Response: " + buildMsoCompletionResponseAsString)
			execution.setVariable("CompleteMsoProcessResponse", buildMsoCompletionResponseAsString)
			utils.log("DEBUG", "@@ CompleteMsoProcess Response @@ " + "\n" + execution.getVariable("CompletionHandlerResponse"), isDebugLogEnabled)

			exceptionUtil.buildAndThrowWorkflowException(execution, 500, message)

		} catch (BpmnError e) {
			utils.log("DEBUG", "Rethrowing MSOWorkflowException", isDebugLogEnabled)
			throw e;
		} catch (Exception e) {
			logError('Caught exception in ' + method, e)
			exceptionUtil.buildAndThrowWorkflowException(execution, 2000, "Internal Error - Occured in" + method)
		}

	}

}