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