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  * ================================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.so.apihandlerinfra;
  24
  25 import java.io.IOException;
  26 import java.text.SimpleDateFormat;
  27 import java.util.ArrayList;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import javax.transaction.Transactional;
  32 import javax.ws.rs.Consumes;
  33 import javax.ws.rs.GET;
  34 import javax.ws.rs.POST;
  35 import javax.ws.rs.Path;
  36 import javax.ws.rs.PathParam;
  37 import javax.ws.rs.Produces;
  38 import javax.ws.rs.QueryParam;
  39 import javax.ws.rs.core.Context;
  40 import javax.ws.rs.core.MediaType;
  41 import javax.ws.rs.core.MultivaluedMap;
  42 import javax.ws.rs.core.Response;
  43 import javax.ws.rs.core.UriInfo;
  44 import org.apache.commons.lang.StringUtils;
  45 import org.apache.http.HttpStatus;
  46 import org.onap.so.apihandler.common.ErrorNumbers;
  47 import org.onap.so.apihandler.common.ResponseBuilder;
  48 import org.onap.so.apihandlerinfra.exceptions.ApiException;
  49 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
  50 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
  51 import org.onap.so.db.request.beans.InfraActiveRequests;
  52 import org.onap.so.db.request.beans.RequestProcessingData;
  53 import org.onap.so.db.request.client.RequestsDbClient;
  54 import org.onap.so.exceptions.ValidationException;
  55 import org.onap.so.logger.ErrorCode;
  56 import org.onap.so.logger.MessageEnum;
  57 import org.onap.so.serviceinstancebeans.CloudRequestData;
  58 import org.onap.so.serviceinstancebeans.GetOrchestrationListResponse;
  59 import org.onap.so.serviceinstancebeans.GetOrchestrationResponse;
  60 import org.onap.so.serviceinstancebeans.InstanceReferences;
  61 import org.onap.so.serviceinstancebeans.Request;
  62 import org.onap.so.serviceinstancebeans.RequestDetails;
  63 import org.onap.so.serviceinstancebeans.RequestList;
  64 import org.onap.so.serviceinstancebeans.RequestStatus;
  65 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68 import org.springframework.beans.factory.annotation.Autowired;
  69 import org.springframework.stereotype.Component;
  70 import com.fasterxml.jackson.databind.ObjectMapper;
  71 import io.swagger.annotations.Api;
  72 import io.swagger.annotations.ApiOperation;
  73
  74 @Path("onap/so/infra/orchestrationRequests")
  75 @Api(value = "onap/so/infra/orchestrationRequests", description = "API Requests for Orchestration requests")
  76 @Component
  77 public class OrchestrationRequests {
  78
  79     private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
  80
  81     @Autowired
  82     private RequestsDbClient requestsDbClient;
  83
  84     @Autowired
  85     private MsoRequest msoRequest;
  86
  87     @Autowired
  88     private ResponseBuilder builder;
  89
  90     @GET
  91     @Path("/{version:[vV][4-7]}/{requestId}")
  92     @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
  93     @Produces(MediaType.APPLICATION_JSON)
  94     @Transactional
  95     public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
  96             @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest)
  97             throws ApiException {
  98
  99         String apiVersion = version.substring(1);
 100         GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
 101
 102         InfraActiveRequests infraActiveRequest = null;
 103         List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
 104         try {
 105             infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
 106             requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
 107
 108         } catch (Exception e) {
 109             logger.error("Exception occurred", e);
 110             ErrorLoggerInfo errorLoggerInfo =
 111                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
 112
 113             ValidateException validateException =
 114                     new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
 115                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
 116                                     .errorInfo(errorLoggerInfo).build();
 117
 118             throw validateException;
 119
 120         }
 121
 122         if (infraActiveRequest == null) {
 123
 124             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
 125                     ErrorCode.BusinessProcesssError).build();
 126
 127             ValidateException validateException =
 128                     new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
 129                             HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
 130                                     .errorInfo(errorLoggerInfo).build();
 131
 132             throw validateException;
 133         }
 134
 135         Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest);
 136         if (!requestProcessingData.isEmpty()) {
 137             request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
 138         }
 139         request.setRequestId(requestId);
 140         orchestrationResponse.setRequest(request);
 141
 142         return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
 143     }
 144
 145     @GET
 146     @Path("/{version:[vV][4-7]}")
 147     @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
 148     @Produces(MediaType.APPLICATION_JSON)
 149     @Transactional
 150     public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
 151             @QueryParam("includeCloudRequest") boolean includeCloudRequest) throws ApiException {
 152
 153         long startTime = System.currentTimeMillis();
 154
 155         MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
 156
 157         List<InfraActiveRequests> activeRequests = null;
 158
 159         GetOrchestrationListResponse orchestrationList = null;
 160         Map<String, List<String>> orchestrationMap;
 161         String apiVersion = version.substring(1);
 162
 163         try {
 164             orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
 165             if (orchestrationMap.isEmpty()) {
 166                 throw new ValidationException("At least one filter query param must be specified");
 167             }
 168         } catch (ValidationException ex) {
 169             logger.error("Exception occurred", ex);
 170             ErrorLoggerInfo errorLoggerInfo =
 171                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
 172             ValidateException validateException =
 173                     new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
 174                             ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
 175             throw validateException;
 176
 177         }
 178
 179         activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
 180
 181         orchestrationList = new GetOrchestrationListResponse();
 182         List<RequestList> requestLists = new ArrayList<>();
 183
 184         for (InfraActiveRequests infraActive : activeRequests) {
 185             List<RequestProcessingData> requestProcessingData =
 186                     requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
 187             RequestList requestList = new RequestList();
 188             Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest);
 189             if (!requestProcessingData.isEmpty()) {
 190                 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
 191             }
 192             requestList.setRequest(request);
 193             requestLists.add(requestList);
 194         }
 195
 196         orchestrationList.setRequestList(requestLists);
 197         return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
 198     }
 199
 200     @POST
 201     @Path("/{version: [vV][4-7]}/{requestId}/unlock")
 202     @Consumes(MediaType.APPLICATION_JSON)
 203     @Produces(MediaType.APPLICATION_JSON)
 204     @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
 205     @Transactional
 206     public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
 207             @PathParam("version") String version) throws ApiException {
 208
 209         long startTime = System.currentTimeMillis();
 210         logger.debug("requestId is: {}", requestId);
 211         ServiceInstancesRequest sir = null;
 212
 213         InfraActiveRequests infraActiveRequest = null;
 214         Request request = null;
 215
 216         try {
 217             ObjectMapper mapper = new ObjectMapper();
 218             sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
 219         } catch (IOException e) {
 220             logger.error("Exception occurred", e);
 221             ErrorLoggerInfo errorLoggerInfo =
 222                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 223                             .build();
 224             ValidateException validateException =
 225                     new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
 226                             HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
 227                                     .errorInfo(errorLoggerInfo).build();
 228
 229             throw validateException;
 230
 231         }
 232         try {
 233             msoRequest.parseOrchestration(sir);
 234         } catch (Exception e) {
 235             logger.error("Exception occurred", e);
 236             ErrorLoggerInfo errorLoggerInfo =
 237                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 238                             .build();
 239             ValidateException validateException =
 240                     new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 241                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 242             throw validateException;
 243         }
 244
 245         infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
 246         if (infraActiveRequest == null) {
 247             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
 248                     ErrorCode.BusinessProcesssError).build();
 249
 250             ValidateException validateException =
 251                     new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
 252                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
 253                                     .build();
 254
 255             throw validateException;
 256
 257         } else {
 258             String status = infraActiveRequest.getRequestStatus();
 259             if (status.equalsIgnoreCase("IN_PROGRESS") || status.equalsIgnoreCase("PENDING")
 260                     || status.equalsIgnoreCase("PENDING_MANUAL_TASK")) {
 261                 infraActiveRequest.setRequestStatus("UNLOCKED");
 262                 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
 263                 infraActiveRequest.setRequestId(requestId);
 264                 requestsDbClient.save(infraActiveRequest);
 265             } else {
 266
 267                 ErrorLoggerInfo errorLoggerInfo =
 268                         new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
 269                                 .build();
 270
 271                 ValidateException validateException = new ValidateException.Builder(
 272                         "Orchestration RequestId " + requestId + " has a status of " + status
 273                                 + " and can not be unlocked",
 274                         HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
 275                                 .build();
 276
 277                 throw validateException;
 278             }
 279         }
 280         return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
 281     }
 282
 283     private Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest)
 284             throws ApiException {
 285         String requestBody = iar.getRequestBody();
 286         Request request = new Request();
 287
 288         ObjectMapper mapper = new ObjectMapper();
 289
 290         request.setRequestId(iar.getRequestId());
 291         request.setRequestScope(iar.getRequestScope());
 292         request.setRequestType(iar.getRequestAction());
 293         String rollbackStatusMessage = iar.getRollbackStatusMessage();
 294         String flowStatusMessage = iar.getFlowStatus();
 295         String retryStatusMessage = iar.getRetryStatusMessage();
 296
 297         InstanceReferences ir = new InstanceReferences();
 298         if (iar.getNetworkId() != null)
 299             ir.setNetworkInstanceId(iar.getNetworkId());
 300         if (iar.getNetworkName() != null)
 301             ir.setNetworkInstanceName(iar.getNetworkName());
 302         if (iar.getServiceInstanceId() != null)
 303             ir.setServiceInstanceId(iar.getServiceInstanceId());
 304         if (iar.getServiceInstanceName() != null)
 305             ir.setServiceInstanceName(iar.getServiceInstanceName());
 306         if (iar.getVfModuleId() != null)
 307             ir.setVfModuleInstanceId(iar.getVfModuleId());
 308         if (iar.getVfModuleName() != null)
 309             ir.setVfModuleInstanceName(iar.getVfModuleName());
 310         if (iar.getVnfId() != null)
 311             ir.setVnfInstanceId(iar.getVnfId());
 312         if (iar.getVnfName() != null)
 313             ir.setVnfInstanceName(iar.getVnfName());
 314         if (iar.getVolumeGroupId() != null)
 315             ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
 316         if (iar.getVolumeGroupName() != null)
 317             ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
 318         if (iar.getRequestorId() != null)
 319             ir.setRequestorId(iar.getRequestorId());
 320         if (iar.getInstanceGroupId() != null)
 321             ir.setInstanceGroupId(iar.getInstanceGroupId());
 322         if (iar.getInstanceGroupName() != null)
 323             ir.setInstanceGroupName(iar.getInstanceGroupName());
 324
 325         request.setInstanceReferences(ir);
 326
 327         RequestDetails requestDetails = null;
 328
 329         if (StringUtils.isNotBlank(requestBody)) {
 330             try {
 331                 if (requestBody.contains("\"requestDetails\":")) {
 332                     ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
 333                     requestDetails = sir.getRequestDetails();
 334                 } else {
 335                     requestDetails = mapper.readValue(requestBody, RequestDetails.class);
 336                 }
 337             } catch (IOException e) {
 338                 logger.error("Exception occurred", e);
 339                 ErrorLoggerInfo errorLoggerInfo =
 340                         new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 341                                 .build();
 342                 ValidateException validateException =
 343                         new ValidateException.Builder("Mapping of request to JSON object failed : ",
 344                                 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
 345                                         .errorInfo(errorLoggerInfo).build();
 346
 347                 throw validateException;
 348             }
 349         }
 350         request.setRequestDetails(requestDetails);
 351
 352         if (iar.getStartTime() != null) {
 353             String startTimeStamp =
 354                     new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
 355             request.setStartTime(startTimeStamp);
 356         }
 357         if (iar.getEndTime() != null) {
 358             String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
 359             request.setFinishTime(endTimeStamp);
 360         }
 361         String statusMessages = null;
 362         RequestStatus status = new RequestStatus();
 363         if (iar.getStatusMessage() != null) {
 364             statusMessages = "STATUS: " + iar.getStatusMessage();
 365         }
 366         if (flowStatusMessage != null) {
 367             if (statusMessages != null) {
 368                 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
 369             } else {
 370                 statusMessages = "FLOW STATUS: " + flowStatusMessage;
 371             }
 372         }
 373         if (retryStatusMessage != null) {
 374             if (statusMessages != null) {
 375                 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
 376             } else {
 377                 statusMessages = "RETRY STATUS: " + retryStatusMessage;
 378             }
 379         }
 380         if (rollbackStatusMessage != null) {
 381             if (statusMessages != null) {
 382                 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
 383             } else {
 384                 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
 385             }
 386         }
 387         if (statusMessages != null) {
 388             status.setStatusMessage(statusMessages);
 389         }
 390         if (iar.getModifyTime() != null) {
 391             String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
 392             status.setTimeStamp(timeStamp);
 393         }
 394
 395         if (iar.getRequestStatus() != null) {
 396             status.setRequestState(iar.getRequestStatus());
 397         }
 398
 399         if (iar.getProgress() != null) {
 400             status.setPercentProgress(iar.getProgress().intValue());
 401         }
 402
 403         if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
 404             iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
 405                 try {
 406                     request.getCloudRequestData()
 407                             .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
 408                                     cloudRequest.getCloudIdentifier()));
 409                 } catch (Exception e) {
 410                     logger.error("Error reading Cloud Request", e);
 411                 }
 412             });
 413         }
 414
 415         request.setRequestStatus(status);
 416         return request;
 417     }
 418
 419     public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
 420             List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
 421         List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
 422         org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
 423                 new org.onap.so.serviceinstancebeans.RequestProcessingData();
 424         String currentGroupingId = null;
 425         HashMap<String, String> tempMap = new HashMap<>();
 426         List<HashMap<String, String>> tempList = new ArrayList<>();
 427         for (RequestProcessingData data : processingData) {
 428             String groupingId = data.getGroupingId();
 429             String tag = data.getTag();
 430             if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
 431                 if (!tempMap.isEmpty()) {
 432                     tempList.add(tempMap);
 433                     finalProcessingData.setDataPairs(tempList);
 434                     addedRequestProcessingData.add(finalProcessingData);
 435                 }
 436                 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
 437                 if (groupingId != null) {
 438                     finalProcessingData.setGroupingId(groupingId);
 439                 }
 440                 if (tag != null) {
 441                     finalProcessingData.setTag(tag);
 442                 }
 443                 currentGroupingId = groupingId;
 444                 tempMap = new HashMap<>();
 445                 tempList = new ArrayList<>();
 446                 if (data.getName() != null && data.getValue() != null) {
 447                     tempMap.put(data.getName(), data.getValue());
 448                 }
 449             } else {
 450                 if (data.getName() != null && data.getValue() != null) {
 451                     tempMap.put(data.getName(), data.getValue());
 452                 }
 453             }
 454         }
 455         if (tempMap.size() > 0) {
 456             tempList.add(tempMap);
 457             finalProcessingData.setDataPairs(tempList);
 458         }
 459         addedRequestProcessingData.add(finalProcessingData);
 460         return addedRequestProcessingData;
 461     }
 462 }