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
|
/*-
* ============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.infrastructure.scripts
import groovy.json.JsonSlurper
import groovy.util.XmlParser;
import java.util.concurrent.ExecutionException;
import org.springframework.web.util.UriUtils
import org.camunda.bpm.engine.delegate.BpmnError
import org.camunda.bpm.engine.runtime.Execution
import org.openecomp.mso.bpmn.common.scripts.AaiUtil
import org.openecomp.mso.bpmn.common.scripts.AbstractServiceTaskProcessor
import org.openecomp.mso.bpmn.common.scripts.ExceptionUtil
import org.openecomp.mso.bpmn.core.WorkflowException
import org.openecomp.mso.bpmn.core.json.JsonUtils
import org.openecomp.mso.rest.APIResponse
import org.apache.commons.lang3.*
class DoDeleteVfModuleVolumeV2 extends AbstractServiceTaskProcessor {
String prefix="DDVMV_"
ExceptionUtil exceptionUtil = new ExceptionUtil()
XmlParser xmlParser = new XmlParser()
JsonUtils jsonUtil = new JsonUtils()
@Override
public void preProcessRequest(Execution execution) {
def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
preProcessRequest(execution, isDebugEnabled)
}
/**
* Set default variable values
* @param execution
* @param isDebugLogEnabled
*/
public void preProcessRequest (Execution execution, isDebugEnabled) {
//Input:
// msoRequestId
// isDebugLogEnabled
// failIfNotFound (Optional)
// serviceInstanceId (Optional)
// vnfId (Optional)
// volumeGroupId
// vfModuleModelInfo (Optional)
// lcpCloudRegionId (Optional) @TODO: this is actually required
// tenantId (Optional) @TODO: this is actually required
// cloudConfiguration @TODO: temporary solution? this contains lcpCloudregion and tenantId
//
//Output:
// workflowException @TODO: actual variable name is WorkflowException
// rolledBack
// wasDeleted
execution.setVariable('prefix', prefix)
execution.setVariable('wasDeleted', 'false')
def tenantId = execution.getVariable("tenantId")
def cloudSiteId = execution.getVariable("lcpCloudRegionId")
// if tenantId or lcpCloudregionId is not passed, get it from cloudRegionConfiguration variable
if(!tenantId || !cloudSiteId) {
def cloudConfiguration = execution.getVariable("cloudConfiguration")
utils.log("DEBUG", "Using cloudConfiguration variable to get tenantId and lcpCloudRegionId - " + cloudConfiguration, isDebugEnabled)
tenantId = jsonUtil.getJsonValue(cloudConfiguration, "tenantId")
execution.setVariable("tenantId", tenantId)
cloudSiteId = jsonUtil.getJsonValue(cloudConfiguration, "lcpCloudRegionId")
execution.setVariable("lcpCloudRegionId", cloudSiteId)
}
}
/**
* Set out 'wasDeleted' variable to 'true'
* @param execution
* @param isDebugLogEnabled
*/
public void postProcess(Execution execution, isDebugLogEnabled) {
execution.setVariable('wasDeleted', 'true')
}
/**
* Query and set cloud region to use for AAI calls
* Output variables: prefix+'aicCloudRegion', prefix+'cloudRegion'
* @param execution
* @param isDebugEnabled
*/
public void callRESTQueryAAICloudRegion(Execution execution, isDebugEnabled) {
String cloudRegion = execution.getVariable('lcpCloudRegionId')
String aai_endpoint = execution.getVariable("URN_aai_endpoint")
AaiUtil aaiUtil = new AaiUtil(this)
String aai_uri = aaiUtil.getCloudInfrastructureCloudRegionUri(execution)
String queryCloudRegionRequest = "${aai_endpoint}${aai_uri}/" + cloudRegion
utils.logAudit(queryCloudRegionRequest)
utils.log("DEBUG", "AAI query cloud region URI - " + queryCloudRegionRequest, isDebugEnabled)
cloudRegion = aaiUtil.getAAICloudReqion(execution, queryCloudRegionRequest, "PO", cloudRegion)
if ((cloudRegion != "ERROR")) {
if(execution.getVariable(prefix+"queryCloudRegionReturnCode") == "404") {
execution.setVariable(prefix+"aicCloudRegion", "AAIAIC25")
}
else{
execution.setVariable(prefix+"aicCloudRegion", cloudRegion)
}
}
else {
utils.log("DEBUG", "AAI Query Cloud Region Unsuccessful.", isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "AAI Query Cloud Region Unsuccessful. Return Code: " + execution.getVariable(prefix+"queryCloudRegionReturnCode"))
}
}
/**
* Query AAI Volume Group
* Output variables: prefix+'queryAAIVolGrpResponse'; prefix+'volumeGroupHeatStackId'
* @param execution
* @param isDebugLogEnabled
*/
public void callRESTQueryAAIForVolumeGroup(Execution execution, isDebugLogEnabled) {
def tenantId = execution.getVariable('tenantId')
def volumeGroupId = execution.getVariable('volumeGroupId')
if(volumeGroupId == null) {
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, 'volumeGroupId is not provided in the request')
throw new Exception('volume-group-id is not provided in the request')
}
String cloudRegion = execution.getVariable(prefix+'aicCloudRegion')
AaiUtil aaiUtil = new AaiUtil(this)
String aaiEndpoint = aaiUtil.getCloudInfrastructureCloudRegionEndpoint(execution)
String queryAAIVolumeGroupRequest = aaiEndpoint + '/' + URLEncoder.encode(cloudRegion, "UTF-8") + "/volume-groups/volume-group/" + UriUtils.encode(volumeGroupId, "UTF-8")
utils.logAudit('Query AAI volume group by ID: ' + queryAAIVolumeGroupRequest)
logDebug('Query AAI volume group by ID: ' + queryAAIVolumeGroupRequest, isDebugLogEnabled)
APIResponse response = aaiUtil.executeAAIGetCall(execution, queryAAIVolumeGroupRequest)
String returnCode = response.getStatusCode()
String aaiResponseAsString = response.getResponseBodyAsString()
aaiResponseAsString = StringEscapeUtils.unescapeXml(aaiResponseAsString)
utils.logAudit("AAI query volume group by id return code: " + returnCode)
utils.logAudit("AAI query volume group by id response: " + aaiResponseAsString)
logDebug('AAI query volume group by id return code: ' + returnCode, isDebugLogEnabled)
logDebug('AAI query volume group by id response: ' + aaiResponseAsString, isDebugLogEnabled)
execution.setVariable(prefix+"queryAAIVolGrpResponse", aaiResponseAsString)
if (returnCode=='200' || returnCode == '204') {
def heatStackId = getNodeTextForce(aaiResponseAsString, 'heat-stack-id')
execution.setVariable(prefix+'volumeGroupHeatStackId', heatStackId)
logDebug('Heat stack id from AAI response: ' + heatStackId, isDebugLogEnabled)
if(hasVfModuleRelationship(aaiResponseAsString)){
utils.log("DEBUG", 'Volume Group ' + volumeGroupId + ' currently in use', isDebugLogEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Volume Group ${volumeGroupId} currently in use - found vf-module relationship.")
}
def volumeGroupTenantId = getTenantIdFromVolumeGroup(aaiResponseAsString)
logDebug('Tenant ID from AAI response: ' + volumeGroupTenantId, isDebugLogEnabled)
if (volumeGroupTenantId == null) {
utils.log("DEBUG", "Could not find Tenant Id element in Volume Group with Volume Group Id ${volumeGroupId}", isDebugLogEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Could not find Tenant Id element in Volume Group with Volume Group Id ${volumeGroupId}")
}
if (volumeGroupTenantId != tenantId) {
def String errorMessage = 'TenantId ' + tenantId + ' in incoming request does not match Tenant Id ' + volumeGroupTenantId + ' retrieved from AAI for Volume Group Id ' + volumeGroupId
utils.log("DEBUG", "Error in DeleteVfModuleVolume: " + errorMessage, isDebugLogEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 5000, errorMessage)
}
logDebug('Received Tenant Id ' + volumeGroupTenantId + ' from AAI for Volume Group with Volume Group Id ' + volumeGroupId , isDebugLogEnabled)
}
else {
if (returnCode=='404') {
utils.log("DEBUG", "Volume Group ${volumeGroupId} not found in AAI", isDebugLogEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Volume Group ${volumeGroupId} not found in AAI. Response code: 404")
}
else {
WorkflowException aWorkflowException = exceptionUtil.MapAAIExceptionToWorkflowException(aaiResponseAsString, execution)
throw new BpmnError("MSOWorkflowException")
}
}
}
/**
* Format VNF Adapter subflow request XML
* Variables: prefix+'deleteVnfARequest'
* @param execution
* @param isDebugLogEnabled
*/
public void prepareVnfAdapterDeleteRequest(Execution execution, isDebugLogEnabled) {
def cloudRegion = execution.getVariable(prefix+'aicCloudRegion')
def tenantId = execution.getVariable('tenantId') // input parameter (optional) - see preProcessRequest
def volumeGroupId = execution.getVariable('volumeGroupId') // input parameter (required)
def volumeGroupHeatStackId = execution.getVariable(prefix+'volumeGroupHeatStackId') // from AAI query volume group
def requestId = execution.getVariable('msoRequestId') // input parameter (required)
def serviceId = execution.getVariable('serviceInstanceId') // imput parameter (optional)
def messageId = UUID.randomUUID().toString()
def notificationUrl = createCallbackURL(execution, "VNFAResponse", messageId)
def useQualifiedHostName = execution.getVariable("URN_mso_use_qualified_host")
if ('true'.equals(useQualifiedHostName)) {
notificationUrl = utils.getQualifiedHostNameForCallback(notificationUrl)
}
String vnfAdapterRestRequest = """
<deleteVolumeGroupRequest>
<cloudSiteId>${cloudRegion}</cloudSiteId>
<tenantId>${tenantId}</tenantId>
<volumeGroupId>${volumeGroupId}</volumeGroupId>
<volumeGroupStackId>${volumeGroupHeatStackId}</volumeGroupStackId>
<skipAAI>true</skipAAI>
<msoRequest>
<requestId>${requestId}</requestId>
<serviceInstanceId>${serviceId}</serviceInstanceId>
</msoRequest>
<messageId>${messageId}</messageId>
<notificationUrl>${notificationUrl}</notificationUrl>
</deleteVolumeGroupRequest>
"""
vnfAdapterRestRequest = utils.formatXml(vnfAdapterRestRequest)
execution.setVariable(prefix+'deleteVnfARequest', vnfAdapterRestRequest)
logDebug('Request for VNFAdapter Rest:\n' + vnfAdapterRestRequest, isDebugLogEnabled)
}
/**
* Delete volume group in AAI
* @param execution
* @param isDebugEnabled
*/
public void callRESTDeleteAAIVolumeGroup(Execution execution, isDebugEnabled) {
// get variables
String queryAAIVolGrpIdResponse = execution.getVariable(prefix+"queryAAIVolGrpResponse")
String groupId = utils.getNodeText(queryAAIVolGrpIdResponse, "volume-group-id")
String resourceVersion = utils.getNodeText(queryAAIVolGrpIdResponse, "resource-version")
String messageId = UUID.randomUUID().toString()
String cloudRegion = execution.getVariable(prefix+'aicCloudRegion')
AaiUtil aaiUtil = new AaiUtil(this)
String aaiEndpoint = aaiUtil.getCloudInfrastructureCloudRegionEndpoint(execution)
String deleteAAIVolumeGrpIdRequest = aaiEndpoint + '/' + URLEncoder.encode(cloudRegion, "UTF-8") + "/volume-groups/volume-group/" + UriUtils.encode(groupId, "UTF-8")
if(resourceVersion !=null){
deleteAAIVolumeGrpIdRequest = deleteAAIVolumeGrpIdRequest +'?resource-version=' + UriUtils.encode(resourceVersion, 'UTF-8')
}
utils.logAudit('Delete AAI volume group : ' + deleteAAIVolumeGrpIdRequest)
utils.log("DEBUG", "Delete AAI volume group : " + deleteAAIVolumeGrpIdRequest, isDebugEnabled)
APIResponse response = aaiUtil.executeAAIDeleteCall(execution, deleteAAIVolumeGrpIdRequest)
String returnCode = response.getStatusCode()
String aaiResponseAsString = response.getResponseBodyAsString()
aaiResponseAsString = StringEscapeUtils.unescapeXml(aaiResponseAsString)
utils.logAudit("AAI delete volume group return code: " + returnCode)
utils.logAudit("AAI delete volume group response: " + aaiResponseAsString)
utils.log("DEBUG", "AAI delete volume group return code: " + returnCode, isDebugEnabled)
utils.log("DEBUG", "AAI delete volume group response: " + aaiResponseAsString, isDebugEnabled)
ExceptionUtil exceptionUtil = new ExceptionUtil()
if (returnCode=='200' || (returnCode == '204')) {
utils.log("DEBUG", "Volume group $groupId deleted.", isDebugEnabled)
} else {
if (returnCode=='404') {
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Volume group $groupId not found for delete in AAI Response code: 404")
} else {
WorkflowException aWorkflowException = exceptionUtil.MapAAIExceptionToWorkflowException(aaiResponseAsString, execution)
throw new BpmnError("MSOWorkflowException")
}
}
}
/**
* Check if volume group has a relationship to vf-module
* @param volumeGroupXml
* @return
*/
private boolean hasVfModuleRelationship(String volumeGroupXml) {
def Node volumeGroupNode = xmlParser.parseText(volumeGroupXml)
def Node relationshipList = utils.getChildNode(volumeGroupNode, 'relationship-list')
if (relationshipList != null) {
def NodeList relationships = utils.getIdenticalChildren(relationshipList, 'relationship')
for (Node relationship in relationships) {
def Node relatedTo = utils.getChildNode(relationship, 'related-to')
if ((relatedTo != null) && (relatedTo.text().equals('vf-module'))) {
def Node relatedLink = utils.getChildNode(relationship, 'related-link')
if (relatedLink !=null && relatedLink.text() != null){
return true
}
}
}
}
return false
}
/**
* Extract the Tenant Id from the Volume Group information returned by AAI.
* @param volumeGroupXml Volume Group XML returned by AAI.
* @return the Tenant Id extracted from the Volume Group information. 'null' is returned if
* the Tenant Id is missing or could not otherwise be extracted.
*/
private String getTenantIdFromVolumeGroup(String volumeGroupXml) {
def Node volumeGroupNode = xmlParser.parseText(volumeGroupXml)
def Node relationshipList = utils.getChildNode(volumeGroupNode, 'relationship-list')
if (relationshipList != null) {
def NodeList relationships = utils.getIdenticalChildren(relationshipList, 'relationship')
for (Node relationship in relationships) {
def Node relatedTo = utils.getChildNode(relationship, 'related-to')
if ((relatedTo != null) && (relatedTo.text().equals('tenant'))) {
def NodeList relationshipDataList = utils.getIdenticalChildren(relationship, 'relationship-data')
for (Node relationshipData in relationshipDataList) {
def Node relationshipKey = utils.getChildNode(relationshipData, 'relationship-key')
if ((relationshipKey != null) && (relationshipKey.text().equals('tenant.tenant-id'))) {
def Node relationshipValue = utils.getChildNode(relationshipData, 'relationship-value')
if (relationshipValue != null) {
return relationshipValue.text()
}
}
}
}
}
}
return null
}
}
|
