/*- * ============LICENSE_START======================================================= * ONAP - SO * ================================================================================ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. * ================================================================================ * Modifications Copyright (c) 2019 Samsung * ================================================================================ * 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.onap.so.bpmn.infrastructure.scripts import org.camunda.bpm.engine.delegate.BpmnError import org.camunda.bpm.engine.delegate.DelegateExecution import org.onap.aai.domain.yang.VolumeGroup import org.onap.so.bpmn.common.scripts.AaiUtil; import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor; import org.onap.so.bpmn.common.scripts.ExceptionUtil; import org.onap.so.bpmn.common.scripts.MsoUtils import org.onap.so.bpmn.common.scripts.VidUtils; import org.onap.so.bpmn.core.UrnPropertiesReader import org.onap.so.bpmn.core.WorkflowException import org.onap.so.client.aai.AAIObjectType import org.onap.so.client.aai.entities.AAIResultWrapper import org.onap.so.client.aai.entities.uri.AAIResourceUri import org.onap.so.client.aai.entities.uri.AAIUriFactory import org.onap.so.constants.Defaults import org.onap.so.logger.ErrorCode import org.onap.so.logger.MessageEnum import org.slf4j.Logger import org.slf4j.LoggerFactory import groovy.json.JsonSlurper import javax.ws.rs.NotFoundException /** * This groovy class supports the DeleteVfModuleVolume.bpmn process. */ public class DeleteVfModuleVolumeInfraV1 extends AbstractServiceTaskProcessor { private static final Logger logger = LoggerFactory.getLogger( DeleteVfModuleVolumeInfraV1.class); private XmlParser xmlParser = new XmlParser() /** * This method is executed during the preProcessRequest task of the DeleteVfModuleVolume.bpmn process. * @param execution */ public InitializeProcessVariables(DelegateExecution execution){ execution.setVariable('prefix', 'DELVfModVol_') execution.setVariable("DELVfModVol_volumeRequest", null) execution.setVariable('DELVfModVol_requestInfo', null) execution.setVariable('DELVfModVol_requestId', null) execution.setVariable('DELVfModVol_source', null) execution.setVariable('DELVfModVol_volumeInputs', null) execution.setVariable('DELVfModVol_volumeOutputs', null) execution.setVariable('DELVfModVol_volumeGroupId', null) execution.setVariable('DELVfModVol_vnfType', null) execution.setVariable('DELVfModVol_serviceId', null) execution.setVariable('DELVfModVol_cloudRegion', null) execution.setVariable('DELVfModVol_tenantId', null) execution.setVariable('DELVfModVol_volumeParams', null) execution.setVariable('DELVfModVol_volumeGroupHeatStackId', null) execution.setVariable('DELVfModVol_volumeGroupTenantId', null) execution.setVariable("DELVfModVol_queryAAIVolGrpResponse", null) execution.setVariable('DELVfModVol_messageId', null) execution.setVariable('DELVfModVol_deleteVnfARequest', null) execution.setVariable('DELVfModVol_updateInfraRequest', null) execution.setVariable('DELVfModVol_CompleteMsoProcessRequest', null) execution.setVariable('DELVfModVol_WorkflowException', null) execution.setVariable('DELVfModVol_TransactionSuccessIndicator', false) execution.setVariable("DELVfModVol_isErrorMessageException", false) execution.setVariable('DELVfModVol_syncResponseSent', false) } /** * Perform initial processing, such as request validation, initialization of variables, etc. * * @param execution */ public void preProcessRequest (DelegateExecution execution) { def isDebugEnabled=execution.getVariable("isDebugLogEnabled") preProcessRequest(execution, isDebugEnabled) } /** * This method is executed during the preProcessRequest task of the DeleteVfModuleVolume.bpmn process. * @param execution */ public void preProcessRequest (DelegateExecution execution, isDebugLogEnabled) { InitializeProcessVariables(execution) String createVolumeIncoming = validateRequest(execution) // check if request is xml or json try { def jsonSlurper = new JsonSlurper() Map reqMap = jsonSlurper.parseText(createVolumeIncoming) logger.debug(" Request is in JSON format.") def serviceInstanceId = execution.getVariable('serviceInstanceId') def volumeGroupId = execution.getVariable('volumeGroupId') def vidUtils = new VidUtils(this) createVolumeIncoming = vidUtils.createXmlVolumeRequest(reqMap, 'DELETE_VF_MODULE_VOL', serviceInstanceId, volumeGroupId) execution.setVariable("DELVfModVol_isVidRequest", true) } catch(groovy.json.JsonException je) { logger.debug(" Request is in XML format.") // assume request is in XML format - proceed as usual to process XML request } String request = utils.getNodeXml(createVolumeIncoming, "volume-request").drop(38).trim().replace("tag0:","").replace(":tag0","") execution.setVariable("DELVfModVol_volumeRequest", request) def requestInfo = getRequiredNodeXml(execution, request, 'request-info') execution.setVariable('DELVfModVol_requestInfo', requestInfo) String requestId = execution.getVariable("mso-request-id") if (requestId == null || requestId == "") { requestId = getRequiredNodeText(execution, requestInfo, 'request-id') } execution.setVariable('DELVfModVol_requestId', requestId) execution.setVariable('DELVfModVol_source', getNodeTextForce(requestInfo, 'source')) def volumeInputs = getRequiredNodeXml(execution, request, 'volume-inputs') execution.setVariable('DELVfModVol_volumeInputs', volumeInputs) execution.setVariable('DELVfModVol_volumeGroupId', getRequiredNodeText(execution, volumeInputs, 'volume-group-id')) execution.setVariable('DELVfModVol_vnfType', getRequiredNodeText(execution, volumeInputs, 'vnf-type')) execution.setVariable('DELVfModVol_serviceId', utils.getNodeText(volumeInputs, 'service-id')) execution.setVariable('DELVfModVol_tenantId', getRequiredNodeText(execution, volumeInputs, 'tenant-id')) execution.setVariable('DELVfModVol_messageId', UUID.randomUUID().toString()) execution.setVariable('DELVfModVol_volumeOutputs', utils.getNodeXml(request, 'volume-outputs', false)) execution.setVariable('DELVfModVol_volumeParams', utils.getNodeXml(request, 'volume-params')) execution.setVariable('DELVfModVol_cloudRegion', utils.getNodeText(request, 'aic-cloud-region')) setBasicDBAuthHeader(execution, isDebugLogEnabled) logger.debug('Request: ' + createVolumeIncoming) } public void sendSyncResponse (DelegateExecution execution, isDebugEnabled) { String volumeRequest = execution.getVariable("DELVfModVol_volumeRequest") logger.debug(" DELVfModVol_volumeRequest - " + "\n" + volumeRequest) // RESTResponse (for API Handler (APIH) Reply Task) String deleteVolumeRequest = """ ${volumeRequest} """.trim() def isVidRequest = execution.getVariable('DELVfModVol_isVidRequest') def syncResponse = '' if(isVidRequest) { def serviceInstanceId = execution.getVariable('serviceInstanceId') def volumeGroupId = execution.getVariable('volumeGroupId') def requestId = execution.getVariable('DELVfModVol_requestId') syncResponse = """{"requestReferences":{"instanceId":"${volumeGroupId}","requestId":"${requestId}"}}""".trim() } else { syncResponse = utils.formatXml(deleteVolumeRequest) } execution.setVariable('DELVfModVol_syncResponseSent', true) sendWorkflowResponse(execution, 200, syncResponse) } public void sendSyncError (DelegateExecution execution, isDebugEnabled) { WorkflowException we = execution.getVariable('WorkflowException') def errorCode = we?.getErrorCode() def errorMessage = we?.getErrorMessage() //default to 400 since only invalid request will trigger this method sendWorkflowResponse(execution, 400, errorMessage) } public void callRESTQueryAAICloudRegion (DelegateExecution execution, isDebugEnabled) { String cloudRegion = execution.getVariable('DELVfModVol_cloudRegion') AaiUtil aaiUtil = new AaiUtil(this) AAIResourceUri uri = AAIUriFactory.createResourceUri(AAIObjectType.CLOUD_REGION, Defaults.CLOUD_OWNER.toString(), cloudRegion) def queryCloudRegionRequest = aaiUtil.createAaiUri(uri) execution.setVariable("DELVfModVol_queryCloudRegionRequest", queryCloudRegionRequest) cloudRegion = aaiUtil.getAAICloudReqion(execution, queryCloudRegionRequest, "PO", cloudRegion) ExceptionUtil exceptionUtil = new ExceptionUtil() if ((cloudRegion != "ERROR")) { if(execution.getVariable("DELVfModVol_queryCloudRegionReturnCode") == "404"){ execution.setVariable("DELVfModVol_aicCloudRegion", "AAIAIC25") }else{ execution.setVariable("DELVfModVol_aicCloudRegion", cloudRegion) } execution.setVariable("DELVfModVol_cloudRegion", cloudRegion) execution.setVariable("DELVfModVol_isCloudRegionGood", true) } else { logger.debug("AAI Query Cloud Region Unsuccessful.") execution.setVariable("DELVfModVol_isCloudRegionGood", false) exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "AAI Query Cloud Region Unsuccessful. Return Code: " + execution.getVariable("DELVfModVol_queryCloudRegionReturnCode")) } logger.debug(" is Cloud Region Good: " + execution.getVariable("DELVfModVol_isCloudRegionGood")) } /** * Query volume group by id * @param execution */ public void queryAAIForVolumeGroup(DelegateExecution execution, isDebugLogEnabled) { ExceptionUtil exceptionUtil = new ExceptionUtil() def volumeGroupId = execution.getVariable('DELVfModVol_volumeGroupId') if(volumeGroupId == null) { exceptionUtil.buildAndThrowWorkflowException(execution, 2500, 'volume-group-id is not provided in the request') throw new Exception('volume-group-id is not provided in the request') } String cloudRegion = execution.getVariable('DELVfModVol_aicCloudRegion') try { AAIResourceUri uri = AAIUriFactory.createResourceUri(AAIObjectType.VOLUME_GROUP, Defaults.CLOUD_OWNER.toString(), cloudRegion, volumeGroupId) AAIResultWrapper volumeGroupWrapper = getAAIClient().get(uri) if (!volumeGroupWrapper.isEmpty()) { Optional volumeGroupOp = volumeGroupWrapper.asBean(VolumeGroup.class) execution.setVariable("DELVfModVol_queryAAIVolGrpResponse", volumeGroupOp.get()) def heatStackId = volumeGroupOp.get().getHeatStackId() ?: "" execution.setVariable('DELVfModVol_volumeGroupHeatStackId', heatStackId) if ( volumeGroupWrapper.getRelationships().isPresent() && !volumeGroupWrapper.getRelationships().get().getRelatedAAIUris(AAIObjectType.VF_MODULE).isEmpty()) { logger.debug('Volume Group ' + volumeGroupId + ' currently in use') exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Volume Group ${volumeGroupId} currently in use - found vf-module relationship.") } def volumeGroupTenantId = getTenantIdFromVolumeGroup(volumeGroupWrapper) if (volumeGroupTenantId == null) { logger.debug("Could not find Tenant Id element in Volume Group with Volume Group Id ${volumeGroupId}") exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Could not find Tenant Id element in Volume Group with Volume Group Id ${volumeGroupId}") } execution.setVariable('DELVfModVol_volumeGroupTenantId', volumeGroupTenantId) logger.debug('Received Tenant Id ' + volumeGroupTenantId + ' from AAI for Volume Group with Volume Group Id ' + volumeGroupId) } else { logger.debug("Volume Group ${volumeGroupId} not found in AAI") exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Volume Group ${volumeGroupId} not found in AAI. Response code: 404") } }catch (BpmnError e){ throw e }catch (Exception e){ WorkflowException aWorkflowException = exceptionUtil.MapAAIExceptionToWorkflowException(e.getMessage(), execution) throw new BpmnError("MSOWorkflowException") } } /** * 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(AAIResultWrapper wrapper) { if(wrapper.getRelationships().isPresent()) { List tenantURIList = wrapper.getRelationships().get().getRelatedAAIUris(AAIObjectType.TENANT) if(!tenantURIList.isEmpty()){ return tenantURIList.get(0).getURIKeys().get("tenant-id") } } return null } private boolean hasVnfRelationship(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('generic-vnf'))) { def Node relatedLink = utils.getChildNode(relationship, 'related-link') if (relatedLink !=null && relatedLink.text() != null){ return true } } } } return false } public void prepareVnfAdapterDeleteRequest(DelegateExecution execution, isDebugLogEnabled) { def cloudRegion = execution.getVariable('DELVfModVol_cloudRegion') def tenantId = execution.getVariable('DELVfModVol_tenantId') def volumeGroupId = execution.getVariable('DELVfModVol_volumeGroupId') def volumeGroupHeatStackId = execution.getVariable('DELVfModVol_volumeGroupHeatStackId') def requestId = execution.getVariable('DELVfModVol_requestId') def serviceId = execution.getVariable('DELVfModVol_serviceId') def messageId = execution.getVariable('DELVfModVol_messageId') def notificationUrl = createCallbackURL(execution, "VNFAResponse", messageId) def useQualifiedHostName = UrnPropertiesReader.getVariable("mso.use.qualified.host", execution) if ('true'.equals(useQualifiedHostName)) { notificationUrl = utils.getQualifiedHostNameForCallback(notificationUrl) } String vnfAdapterRestRequest = """ ${MsoUtils.xmlEscape(cloudRegion)} ${MsoUtils.xmlEscape(tenantId)} ${MsoUtils.xmlEscape(volumeGroupId)} ${MsoUtils.xmlEscape(volumeGroupHeatStackId)} true ${MsoUtils.xmlEscape(requestId)} ${MsoUtils.xmlEscape(serviceId)} ${MsoUtils.xmlEscape(messageId)} ${MsoUtils.xmlEscape(notificationUrl)} """ vnfAdapterRestRequest = utils.formatXml(vnfAdapterRestRequest) execution.setVariable('DELVfModVol_deleteVnfARequest', vnfAdapterRestRequest) logger.debug('Request for VNFAdapter Rest:\n' + vnfAdapterRestRequest) } public void deleteVolGrpId(DelegateExecution execution, isDebugEnabled) { // get variables VolumeGroup volumeGroup = execution.getVariable("DELVfModVol_queryAAIVolGrpResponse") String groupId = volumeGroup.getVolumeGroupId() String cloudRegion = execution.getVariable('DELVfModVol_aicCloudRegion') ExceptionUtil exceptionUtil = new ExceptionUtil() try { AAIResourceUri uri = AAIUriFactory.createResourceUri(AAIObjectType.VOLUME_GROUP, Defaults.CLOUD_OWNER.toString(), cloudRegion, groupId) getAAIClient().delete(uri) logger.debug("Volume group $groupId deleted.") }catch(NotFoundException e){ exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Volume group $groupId not found for delete in AAI Response code: 404") }catch(Exception e1){ WorkflowException aWorkflowException = exceptionUtil.MapAAIExceptionToWorkflowException(e1.getMessage(), execution) throw new BpmnError("MSOWorkflowException") } } public void prepareDBRequest (DelegateExecution execution, isDebugLogEnabled) { WorkflowException workflowExceptionObj = execution.getVariable("WorkflowException") ExceptionUtil exceptionUtil = new ExceptionUtil(); def requestId = execution.getVariable('DELVfModVol_requestId') def volOutputs = execution.getVariable('DELVfModVol_volumeOutputs') def statusMessage = "VolumeGroup successfully deleted" def progress = "100" def requestStatus = "COMPLETE" if (workflowExceptionObj != null) { statusMessage = (workflowExceptionObj.getErrorMessage()) execution.setVariable("DELVfModVol_WorkflowExceptionMessage", statusMessage) execution.setVariable("DELVfModVol_WorkflowExceptionCode", workflowExceptionObj.getErrorCode()) requestStatus = "FAILURE" progress = "" } String updateInfraRequest = """ ${MsoUtils.xmlEscape(requestId)} BPMN ${MsoUtils.xmlEscape(statusMessage)} ${MsoUtils.xmlEscape(requestStatus)} ${MsoUtils.xmlEscape(progress)} ${MsoUtils.xmlEscape(volOutputs)} """ updateInfraRequest = utils.formatXml(updateInfraRequest) execution.setVariable('DELVfModVol_updateInfraRequest', updateInfraRequest) logger.debug('Request for Update Infra Request:\n' + updateInfraRequest) } public void prepareCompletionHandlerRequest (DelegateExecution execution, isDebugLogEnabled) { def requestId = execution.getVariable("mso-request-id") def source = execution.getVariable("DELVfModVol_source") String msoCompletionRequest = """ ${MsoUtils.xmlEscape(requestId)} DELETE ${MsoUtils.xmlEscape(source)} Volume Group has been deleted successfully. BPMN VF Module Volume action: DELETE """ String xmlMsoCompletionRequest = utils.formatXml(msoCompletionRequest) execution.setVariable('DELVfModVol_CompleteMsoProcessRequest', xmlMsoCompletionRequest) logger.debug(" Overall SUCCESS Response going to CompleteMsoProcess - " + "\n" + xmlMsoCompletionRequest) } public void prepareFalloutHandler (DelegateExecution execution) { execution.setVariable("DELVfModVol_Success", false) String requestId = execution.getVariable("DELVfModVol_requestId") String source = execution.getVariable("DELVfModVol_source") WorkflowException workflowExceptionObj = execution.getVariable("WorkflowException") def errorMessage = workflowExceptionObj.getErrorMessage() def errorCode = workflowExceptionObj.getErrorCode() String falloutHandlerRequest = """ ${MsoUtils.xmlEscape(requestId)} DELETE ${MsoUtils.xmlEscape(source)} ${MsoUtils.xmlEscape(errorMessage)} ${MsoUtils.xmlEscape(errorCode)} """ // Format Response String xmlHandlerRequest = utils.formatXml(falloutHandlerRequest) logger.debug(xmlHandlerRequest) execution.setVariable("DELVfModVol_FalloutHandlerRequest", xmlHandlerRequest) logger.error("{} {} {} {} {}", MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(), "Overall Error Response going to FalloutHandler", "BPMN", ErrorCode.UnknownError.getValue(), "\n" + xmlHandlerRequest); } /** * Create a WorkflowException for the error case where the Tenant Id from * AAI did not match the Tenant Id in the incoming request. * * @param execution The flow's execution instance. */ public void handleTenantIdMismatch(DelegateExecution execution, isDebugLogEnabled) { def volumeGroupId = execution.getVariable('DELVfModVol_volumeGroupId') def aicCloudRegion = execution.getVariable('DELVfModVol_aicCloudRegion') def tenantId = execution.getVariable('DELVfModVol_tenantId') def volumeGroupTenantId = execution.getVariable('DELVfModVol_volumeGroupTenantId') def String errorMessage = 'TenantId ' + tenantId + ' in incoming request does not match Tenant Id ' + volumeGroupTenantId + ' retrieved from AAI for Volume Group Id ' + volumeGroupId logger.error("{} {} {} {}", MessageEnum.BPMN_GENERAL_EXCEPTION_ARG.toString(), "Error in DeleteVfModuleVolume: " + "\n" + errorMessage, "BPMN", ErrorCode.UnknownError.getValue()); ExceptionUtil exceptionUtil = new ExceptionUtil() exceptionUtil.buildWorkflowException(execution, 5000, errorMessage) } }