gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
   7  * ================================================================================
   8  * Modifications Copyright (c) 2019 Samsung
   9  * ================================================================================
  10  * Licensed under the Apache License, Version 2.0 (the "License");
  11  * you may not use this file except in compliance with the License.
  12  * You may obtain a copy of the License at
  13  *
  14  *      http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.so.apihandlerinfra;
  25
  26 import org.apache.http.HttpStatus;
  27 import org.onap.so.apihandler.common.ErrorNumbers;
  28 import org.onap.so.apihandler.common.RequestClientParameter;
  29 import org.onap.so.apihandlerinfra.exceptions.ApiException;
  30 import org.onap.so.apihandlerinfra.exceptions.RecipeNotFoundException;
  31 import org.onap.so.apihandlerinfra.exceptions.RequestDbFailureException;
  32 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
  33 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
  34 import org.onap.so.constants.Status;
  35 import org.onap.so.db.catalog.beans.Workflow;
  36 import org.onap.so.db.catalog.client.CatalogDbClient;
  37 import org.onap.so.db.request.beans.InfraActiveRequests;
  38 import org.onap.so.db.request.client.RequestsDbClient;
  39 import org.onap.so.exceptions.ValidationException;
  40 import org.onap.so.logger.ErrorCode;
  41 import org.onap.so.logger.MessageEnum;
  42 import org.onap.so.serviceinstancebeans.ModelType;
  43 import org.onap.so.serviceinstancebeans.RequestReferences;
  44 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
  45 import org.onap.so.serviceinstancebeans.ServiceInstancesResponse;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48 import org.springframework.beans.factory.annotation.Autowired;
  49 import org.springframework.stereotype.Component;
  50 import javax.transaction.Transactional;
  51 import javax.ws.rs.Consumes;
  52 import javax.ws.rs.POST;
  53 import javax.ws.rs.Path;
  54 import javax.ws.rs.PathParam;
  55 import javax.ws.rs.Produces;
  56 import javax.ws.rs.container.ContainerRequestContext;
  57 import javax.ws.rs.core.Context;
  58 import javax.ws.rs.core.MediaType;
  59 import javax.ws.rs.core.Response;
  60 import java.io.IOException;
  61 import java.util.HashMap;
  62 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
  63 import io.swagger.v3.oas.annotations.Operation;
  64 import io.swagger.v3.oas.annotations.info.Info;
  65 import io.swagger.v3.oas.annotations.media.ArraySchema;
  66 import io.swagger.v3.oas.annotations.media.Content;
  67 import io.swagger.v3.oas.annotations.media.Schema;
  68 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  69
  70 @Component
  71 @Path("/onap/so/infra/instanceManagement")
  72 @OpenAPIDefinition(info = @Info(title = "/onap/so/infra/instanceManagement",
  73         description = "Infrastructure API Requests for Instance Management"))
  74 public class InstanceManagement {
  75
  76     private static Logger logger = LoggerFactory.getLogger(InstanceManagement.class);
  77     private static String uriPrefix = "/instanceManagement/";
  78     private static final String SAVE_TO_DB = "save instance to db";
  79
  80     @Autowired
  81     private RequestsDbClient infraActiveRequestsClient;
  82
  83     @Autowired
  84     private CatalogDbClient catalogDbClient;
  85
  86     @Autowired
  87     private MsoRequest msoRequest;
  88
  89     @Autowired
  90     private RequestHandlerUtils requestHandlerUtils;
  91
  92     @POST
  93     @Path("/{version:[vV][1]}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/workflows/{workflowUuid}")
  94     @Consumes(MediaType.APPLICATION_JSON)
  95     @Produces(MediaType.APPLICATION_JSON)
  96     @Operation(description = "Execute custom workflow", responses = @ApiResponse(
  97             content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
  98     @Transactional
  99     public Response executeVNFCustomWorkflow(String request, @PathParam("version") String version,
 100             @PathParam("serviceInstanceId") String serviceInstanceId, @PathParam("vnfInstanceId") String vnfInstanceId,
 101             @PathParam("workflowUuid") String workflowUuid, @Context ContainerRequestContext requestContext)
 102             throws ApiException {
 103         String requestId = requestHandlerUtils.getRequestId(requestContext);
 104         HashMap<String, String> instanceIdMap = new HashMap<>();
 105         instanceIdMap.put("serviceInstanceId", serviceInstanceId);
 106         instanceIdMap.put("vnfInstanceId", vnfInstanceId);
 107         instanceIdMap.put("workflowUuid", workflowUuid);
 108         return processCustomWorkflowRequest(request, Action.inPlaceSoftwareUpdate, instanceIdMap, version, requestId,
 109                 requestContext);
 110     }
 111
 112     @POST
 113     @Path("/{version:[vV][1]}/serviceInstances/{serviceInstanceId}/pnfs/{pnfId}/workflows/{workflowUuid}")
 114     @Consumes(MediaType.APPLICATION_JSON)
 115     @Produces(MediaType.APPLICATION_JSON)
 116     @Operation(description = "Execute custom workflow", responses = @ApiResponse(
 117             content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
 118     @Transactional
 119     public Response executePNFCustomWorkflow(String request, @PathParam("version") String version,
 120             @PathParam("serviceInstanceId") String serviceInstanceId, @PathParam("pnfId") String pnfId,
 121             @PathParam("workflowUuid") String workflowUuid, @Context ContainerRequestContext requestContext)
 122             throws ApiException {
 123         String requestId = requestHandlerUtils.getRequestId(requestContext);
 124         HashMap<String, String> instanceIdMap = new HashMap<>();
 125         instanceIdMap.put("serviceInstanceId", serviceInstanceId);
 126         instanceIdMap.put("pnfId", pnfId);
 127         instanceIdMap.put("workflowUuid", workflowUuid);
 128         return processPNFCustomWorkflowRequest(request, Action.forCustomWorkflow, instanceIdMap, version, requestId,
 129                 requestContext);
 130     }
 131
 132     private Response processCustomWorkflowRequest(String requestJSON, Actions action,
 133             HashMap<String, String> instanceIdMap, String version, String requestId,
 134             ContainerRequestContext requestContext) throws ApiException {
 135         String serviceInstanceId;
 136         Boolean aLaCarte = true;
 137         ServiceInstancesRequest sir;
 138         String apiVersion = version.substring(1);
 139
 140         String requestUri = requestHandlerUtils.getRequestUri(requestContext, uriPrefix);
 141
 142         sir = requestHandlerUtils.convertJsonToServiceInstanceRequest(requestJSON, action, requestId, requestUri);
 143         String requestScope = requestHandlerUtils.deriveRequestScope(action, sir, requestUri);
 144         InfraActiveRequests currentActiveReq =
 145                 msoRequest.createRequestObject(sir, action, requestId, Status.IN_PROGRESS, requestJSON, requestScope);
 146
 147         try {
 148             requestHandlerUtils.validateHeaders(requestContext);
 149         } catch (ValidationException e) {
 150             logger.error("Exception occurred", e);
 151             ErrorLoggerInfo errorLoggerInfo =
 152                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
 153                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 154             ValidateException validateException =
 155                     new ValidateException.Builder(e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 156                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 157             requestHandlerUtils.updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
 158             throw validateException;
 159         }
 160
 161         requestHandlerUtils.parseRequest(sir, instanceIdMap, action, version, requestJSON, aLaCarte, requestId,
 162                 currentActiveReq);
 163         requestHandlerUtils.setInstanceId(currentActiveReq, requestScope, null, instanceIdMap);
 164
 165         int requestVersion = Integer.parseInt(version.substring(1));
 166         String vnfType = msoRequest.getVnfType(sir, requestScope, action, requestVersion);
 167
 168         if (requestScope.equalsIgnoreCase(ModelType.vnf.name()) && vnfType != null) {
 169             currentActiveReq.setVnfType(vnfType);
 170         }
 171
 172         InfraActiveRequests dup = null;
 173         boolean inProgress = false;
 174
 175         dup = requestHandlerUtils.duplicateCheck(action, instanceIdMap, null, requestScope, currentActiveReq);
 176
 177         if (dup != null) {
 178             inProgress = requestHandlerUtils.camundaHistoryCheck(dup, currentActiveReq);
 179         }
 180
 181         if (dup != null && inProgress) {
 182             requestHandlerUtils.buildErrorOnDuplicateRecord(currentActiveReq, action, instanceIdMap, null, requestScope,
 183                     dup);
 184         }
 185         ServiceInstancesResponse serviceResponse = new ServiceInstancesResponse();
 186
 187         RequestReferences referencesResponse = new RequestReferences();
 188
 189         referencesResponse.setRequestId(requestId);
 190
 191         serviceResponse.setRequestReferences(referencesResponse);
 192         Boolean isBaseVfModule = false;
 193
 194         String workflowUuid = null;
 195         if (instanceIdMap != null) {
 196             workflowUuid = instanceIdMap.get("workflowUuid");
 197         }
 198
 199         RecipeLookupResult recipeLookupResult = getInstanceManagementWorkflowRecipe(currentActiveReq, workflowUuid);
 200
 201         String serviceInstanceType = requestHandlerUtils.getServiceType(requestScope, sir, true);
 202
 203         serviceInstanceId = requestHandlerUtils.setServiceInstanceId(requestScope, sir);
 204         String vnfId = "";
 205
 206         if (sir.getVnfInstanceId() != null) {
 207             vnfId = sir.getVnfInstanceId();
 208         }
 209
 210         try {
 211             infraActiveRequestsClient.save(currentActiveReq);
 212         } catch (Exception e) {
 213             ErrorLoggerInfo errorLoggerInfo =
 214                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.DataError)
 215                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 216             throw new RequestDbFailureException.Builder(SAVE_TO_DB, e.toString(), HttpStatus.SC_INTERNAL_SERVER_ERROR,
 217                     ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e).errorInfo(errorLoggerInfo).build();
 218         }
 219
 220         RequestClientParameter requestClientParameter = null;
 221         try {
 222             requestClientParameter = new RequestClientParameter.Builder().setRequestId(requestId)
 223                     .setBaseVfModule(isBaseVfModule).setRecipeTimeout(recipeLookupResult.getRecipeTimeout())
 224                     .setRequestAction(action.toString()).setServiceInstanceId(serviceInstanceId).setVnfId(vnfId)
 225                     .setServiceType(serviceInstanceType).setVnfType(vnfType)
 226                     .setRequestDetails(requestHandlerUtils.mapJSONtoMSOStyle(requestJSON, null, aLaCarte, action))
 227                     .setApiVersion(apiVersion).setALaCarte(aLaCarte).setRequestUri(requestUri).build();
 228         } catch (IOException e) {
 229             ErrorLoggerInfo errorLoggerInfo =
 230                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
 231                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 232             throw new ValidateException.Builder("Unable to generate RequestClientParamter object" + e.getMessage(),
 233                     HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo)
 234                             .build();
 235         }
 236         return requestHandlerUtils.postBPELRequest(currentActiveReq, requestClientParameter,
 237                 recipeLookupResult.getOrchestrationURI(), requestScope);
 238     }
 239
 240     private Response processPNFCustomWorkflowRequest(String requestJSON, Actions action,
 241             HashMap<String, String> instanceIdMap, String version, String requestId,
 242             ContainerRequestContext requestContext) throws ApiException {
 243         Boolean aLaCarte = false;
 244         ServiceInstancesRequest sir;
 245         String apiVersion = version.substring(1);
 246
 247         String serviceInstanceId = "";
 248         String pnfId = "";
 249         String workflowUuid = "";
 250         if (instanceIdMap != null) {
 251             serviceInstanceId = instanceIdMap.get("serviceInstanceId");
 252             pnfId = instanceIdMap.get("pnfId");
 253             workflowUuid = instanceIdMap.get("workflowUuid");
 254         }
 255
 256         String requestUri = requestHandlerUtils.getRequestUri(requestContext, uriPrefix);
 257         sir = requestHandlerUtils.convertJsonToServiceInstanceRequest(requestJSON, action, requestId, requestUri);
 258         sir.setServiceInstanceId(serviceInstanceId);
 259         sir.setPnfId(pnfId);
 260         String requestScope = ModelType.pnf.name();
 261         InfraActiveRequests currentActiveReq =
 262                 msoRequest.createRequestObject(sir, action, requestId, Status.IN_PROGRESS, requestJSON, requestScope);
 263
 264         try {
 265             requestHandlerUtils.validateHeaders(requestContext);
 266         } catch (ValidationException e) {
 267             logger.error("Exception occurred", e);
 268             ErrorLoggerInfo errorLoggerInfo =
 269                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
 270                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 271             ValidateException validateException =
 272                     new ValidateException.Builder(e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 273                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 274             requestHandlerUtils.updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
 275             throw validateException;
 276         }
 277
 278         requestHandlerUtils.parseRequest(sir, instanceIdMap, action, version, requestJSON, aLaCarte, requestId,
 279                 currentActiveReq);
 280         requestHandlerUtils.setInstanceId(currentActiveReq, requestScope, null, instanceIdMap);
 281
 282         InfraActiveRequests dup = null;
 283         boolean inProgress = false;
 284
 285         dup = requestHandlerUtils.duplicateCheck(action, instanceIdMap, null, requestScope, currentActiveReq);
 286
 287         if (dup != null) {
 288             inProgress = requestHandlerUtils.camundaHistoryCheck(dup, currentActiveReq);
 289         }
 290
 291         if (dup != null && inProgress) {
 292             requestHandlerUtils.buildErrorOnDuplicateRecord(currentActiveReq, action, instanceIdMap, null, requestScope,
 293                     dup);
 294         }
 295
 296         RecipeLookupResult recipeLookupResult = getInstanceManagementWorkflowRecipe(currentActiveReq, workflowUuid);
 297
 298         try {
 299             infraActiveRequestsClient.save(currentActiveReq);
 300         } catch (Exception e) {
 301             ErrorLoggerInfo errorLoggerInfo =
 302                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.DataError)
 303                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 304             throw new RequestDbFailureException.Builder(SAVE_TO_DB, e.toString(), HttpStatus.SC_INTERNAL_SERVER_ERROR,
 305                     ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e).errorInfo(errorLoggerInfo).build();
 306         }
 307
 308         RequestClientParameter requestClientParameter = null;
 309         try {
 310             requestClientParameter = new RequestClientParameter.Builder().setRequestId(requestId)
 311                     .setRecipeTimeout(recipeLookupResult.getRecipeTimeout()).setRequestAction(action.toString())
 312                     .setServiceInstanceId(serviceInstanceId).setPnfCorrelationId(pnfId)
 313                     .setRequestDetails(requestHandlerUtils.mapJSONtoMSOStyle(requestJSON, null, aLaCarte, action))
 314                     .setApiVersion(apiVersion).setRequestUri(requestUri).build();
 315         } catch (IOException e) {
 316             ErrorLoggerInfo errorLoggerInfo =
 317                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
 318                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 319             throw new ValidateException.Builder("Unable to generate RequestClientParamter object" + e.getMessage(),
 320                     HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo)
 321                             .build();
 322         }
 323         return requestHandlerUtils.postBPELRequest(currentActiveReq, requestClientParameter,
 324                 recipeLookupResult.getOrchestrationURI(), requestScope);
 325     }
 326
 327     private RecipeLookupResult getInstanceManagementWorkflowRecipe(InfraActiveRequests currentActiveReq,
 328             String workflowUuid) throws ApiException {
 329         RecipeLookupResult recipeLookupResult = null;
 330
 331         try {
 332             recipeLookupResult = getCustomWorkflowUri(workflowUuid);
 333         } catch (Exception e) {
 334             ErrorLoggerInfo errorLoggerInfo =
 335                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 336                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 337             ValidateException validateException =
 338                     new ValidateException.Builder(e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 339                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 340             requestHandlerUtils.updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
 341             throw validateException;
 342         }
 343
 344         if (recipeLookupResult == null) {
 345             ErrorLoggerInfo errorLoggerInfo =
 346                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.DataError)
 347                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 348             RecipeNotFoundException recipeNotFoundExceptionException =
 349                     new RecipeNotFoundException.Builder("Recipe could not be retrieved from catalog DB.",
 350                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).errorInfo(errorLoggerInfo)
 351                                     .build();
 352             requestHandlerUtils.updateStatus(currentActiveReq, Status.FAILED,
 353                     recipeNotFoundExceptionException.getMessage());
 354             throw recipeNotFoundExceptionException;
 355         }
 356
 357         return recipeLookupResult;
 358     }
 359
 360     private RecipeLookupResult getCustomWorkflowUri(String workflowUuid) {
 361
 362         String recipeUri = null;
 363         Workflow workflow = catalogDbClient.findWorkflowByArtifactUUID(workflowUuid);
 364         if (workflow == null) {
 365             return null;
 366         } else {
 367             String workflowName = workflow.getName();
 368             recipeUri = "/mso/async/services/" + workflowName;
 369         }
 370         return new RecipeLookupResult(recipeUri, 180);
 371     }
 372 }