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