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