vid-app-common/src/main/java/org/onap/vid/services/AuditServiceImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.vid.services;
  22
  23 import static org.apache.commons.lang3.ObjectUtils.notEqual;
  24
  25 import org.jetbrains.annotations.NotNull;
  26 import org.onap.vid.dal.AsyncInstantiationRepository;
  27 import org.onap.vid.job.Job;
  28 import org.onap.vid.model.JobAuditStatus;
  29 import org.onap.vid.mso.*;
  30 import org.onap.vid.mso.rest.AsyncRequestStatus;
  31 import org.onap.vid.mso.rest.AsyncRequestStatus.Request;
  32 import org.onap.vid.mso.rest.AsyncRequestStatusList;
  33 import org.springframework.stereotype.Service;
  34 import java.text.MessageFormat;
  35 import org.apache.commons.lang3.StringUtils;
  36 import javax.inject.Inject;
  37 import java.util.List;
  38 import java.util.Objects;
  39 import java.util.UUID;
  40 import java.util.stream.Collectors;
  41
  42
  43 @Service
  44 public class AuditServiceImpl implements AuditService{
  45
  46     private final RestMsoImplementation restMso;
  47     private final AsyncInstantiationRepository asyncInstantiationRepository;
  48
  49     @Inject
  50     public AuditServiceImpl(RestMsoImplementation restMso, AsyncInstantiationRepository asyncInstantiationRepository) {
  51         this.restMso = restMso;
  52         this.asyncInstantiationRepository = asyncInstantiationRepository;
  53     }
  54
  55     @Override
  56     public void setFailedAuditStatusFromMso(UUID jobUuid, String requestId, int statusCode, String msoResponse){
  57         final String failedMsoRequestStatus = "FAILED";
  58         String additionalInfo = MsoUtil.formatExceptionAdditionalInfo(statusCode, msoResponse);
  59         auditMsoStatus(jobUuid, failedMsoRequestStatus, requestId, additionalInfo);
  60     }
  61
  62     @Override
  63     public List<JobAuditStatus> getAuditStatusFromMsoByRequestId(UUID jobId, UUID requestId) {
  64         String filter = "requestId:EQUALS:" + requestId + "&format=statusDetail";
  65         return getAuditStatusFromMso(jobId, filter, null);
  66     }
  67
  68     @Override
  69     public List<JobAuditStatus> getAuditStatusFromMsoByInstanceId(JobAuditStatus.ResourceTypeFilter resourceTypeFilter, UUID instanceId, UUID jobId) {
  70         String filter = resourceTypeFilter.getFilterBy() + ":EQUALS:" + instanceId + "&format=statusDetail";
  71         return getAuditStatusFromMso(jobId, filter, instanceId);
  72     }
  73
  74     @Override
  75     public List<JobAuditStatus> getAuditStatusFromMsoByJobId(UUID jobId) {
  76         List<JobAuditStatus> auditStatuses = getAuditStatuses(jobId, JobAuditStatus.SourceStatus.MSO);
  77         String instanceName = getInstanceNameFromServiceInfo(jobId);
  78         auditStatuses.stream().forEach(status ->
  79                 status.setInstanceName(instanceName)
  80         );
  81         return auditStatuses;
  82     }
  83
  84     @Override
  85     public void auditVidStatus(UUID jobUUID, Job.JobStatus jobStatus){
  86         JobAuditStatus vidStatus = new JobAuditStatus(jobUUID, jobStatus.toString(), JobAuditStatus.SourceStatus.VID);
  87         auditStatus(vidStatus);
  88     }
  89
  90     @Override
  91     public void auditMsoStatus(UUID jobUUID, AsyncRequestStatus.Request msoRequestStatus){
  92         auditMsoStatus(jobUUID, msoRequestStatus.requestStatus.getRequestState(), msoRequestStatus.requestId, msoRequestStatus.requestStatus.getStatusMessage());
  93     }
  94
  95     @Override
  96     public void auditMsoStatus(UUID jobUUID, String jobStatus, String requestId, String additionalInfo){
  97         JobAuditStatus msoStatus = new JobAuditStatus(jobUUID, jobStatus, JobAuditStatus.SourceStatus.MSO,
  98                 requestId != null ? UUID.fromString(requestId) : null,
  99                 additionalInfo);
 100         auditStatus(msoStatus);
 101     }
 102
 103     private void auditStatus(JobAuditStatus jobAuditStatus){
 104         JobAuditStatus latestStatus = getLatestAuditStatus(jobAuditStatus.getJobId(), jobAuditStatus.getSource());
 105
 106         if (notEqual(jobAuditStatus, latestStatus)) {
 107             jobAuditStatus.setOrdinal(nextOrdinalAfter(latestStatus));
 108             asyncInstantiationRepository.addJobAudiStatus(jobAuditStatus);
 109         }
 110     }
 111
 112     protected int nextOrdinalAfter(JobAuditStatus jobAuditStatus) {
 113         return jobAuditStatus == null ? 0 : (jobAuditStatus.getOrdinal() + 1);
 114     }
 115
 116     private JobAuditStatus getLatestAuditStatus(UUID jobUUID, JobAuditStatus.SourceStatus source){
 117         List<JobAuditStatus> list = getAuditStatuses(jobUUID, source);
 118         return !list.isEmpty() ? list.get(list.size()-1) : null;
 119     }
 120
 121     public List<JobAuditStatus> getAuditStatuses(UUID jobUUID, JobAuditStatus.SourceStatus source) {
 122         return asyncInstantiationRepository.getAuditStatuses(jobUUID, source);
 123     }
 124
 125     @Override
 126     //modelType is requestScope in MSO response
 127     public List<AsyncRequestStatus.Request> retrieveRequestsFromMsoByServiceIdAndRequestTypeAndScope(String instanceId, String requestType, String modelType) {
 128         String filter = JobAuditStatus.ResourceTypeFilter.SERVICE.getFilterBy() + ":EQUALS:" + instanceId;
 129         List<AsyncRequestStatus> msoStatuses = getAsyncRequestStatusListFromMso(filter);
 130         return msoStatuses.stream()
 131                 .filter(x -> Objects.equals(x.request.requestType, requestType) && Objects.equals(x.request.requestScope, modelType))
 132                 .map(x -> x.request)
 133                 .collect(Collectors.toList());
 134     }
 135
 136     private List<JobAuditStatus> getAuditStatusFromMso(UUID jobId, String filter, UUID instanceId) {
 137
 138         List<AsyncRequestStatus> msoStatuses = getAsyncRequestStatusListFromMso(filter);
 139
 140         //add service name from service info for each audit status (in case that serviceInstanceId is null all statuses belong to service)
 141         String userInstanceName = (instanceId == null && jobId != null) ? getInstanceNameFromServiceInfo(jobId) : null;
 142         return convertMsoResponseStatusToJobAuditStatus(msoStatuses, userInstanceName);
 143     }
 144
 145     @NotNull
 146     private List<AsyncRequestStatus> getAsyncRequestStatusListFromMso(String filter) {
 147         String path = MsoBusinessLogicImpl.validateEndpointPath(MsoProperties.MSO_REST_API_GET_ORC_REQS) + "filter=" + filter;
 148         RestObject<AsyncRequestStatusList> msoResponse = restMso.GetForObject(path , AsyncRequestStatusList.class);
 149         if (msoResponse.getStatusCode() >= 400 || msoResponse.get() == null) {
 150             throw new BadResponseFromMso(msoResponse);
 151         }
 152         return msoResponse.get().getRequestList();
 153     }
 154
 155     private String getInstanceNameFromServiceInfo(UUID jobId) {
 156         return asyncInstantiationRepository.getServiceInfoByJobId(jobId).getServiceInstanceName();
 157     }
 158
 159     protected List<JobAuditStatus> convertMsoResponseStatusToJobAuditStatus(List<AsyncRequestStatus> msoStatuses, String defaultName){
 160         return msoStatuses.stream().map(status ->
 161                 convertAsyncRequestStatusToJobAuditStatusAdditionalInfo(status, defaultName)
 162         ).collect(Collectors.toList());
 163     }
 164     private JobAuditStatus convertAsyncRequestStatusToJobAuditStatusAdditionalInfo(AsyncRequestStatus status, String defaultName) {
 165         if (status == null) {
 166             return null;
 167         }
 168         UUID requestId = null;
 169         String instanceName = defaultName;
 170         String jobStatus = null;
 171         String additionalInfo = null;
 172         String finishTime = null;
 173         String instanceType = null;
 174         String modelType = "";
 175         String startTime = null;
 176                 String instanceId = "";
 177         AsyncRequestStatus.Request request = status.request;
 178         if (request != null) {
 179             if (request.requestId != null) {
 180                 requestId = UUID.fromString(request.requestId);
 181             }
 182             instanceName = extractInstanceName(instanceName, request);
 183             instanceType = request.requestType;
 184             if (request.requestDetails != null && request.requestDetails.modelInfo != null) {
 185                 modelType = request.requestDetails.modelInfo.modelType;
 186             }
 187
 188                         instanceId = extractInstanceId(modelType,request);
 189
 190             startTime = request.startTime;
 191
 192             if (request.requestStatus != null) {
 193                 jobStatus = request.requestStatus.getRequestState();
 194                 additionalInfo = buildAdditionalInfo(request);
 195
 196                 if (!request.requestStatus.getAdditionalProperties().isEmpty() &&
 197                     request.requestStatus.getAdditionalProperties().get("finishTime") != null) {
 198                     finishTime = request.requestStatus.getAdditionalProperties().get("finishTime").toString();
 199                 } else {
 200                     finishTime = request.requestStatus.getTimestamp();
 201                 }
 202             }
 203         }
 204         return new JobAuditStatus(requestId, instanceName, modelType, instanceType, startTime, finishTime,
 205            jobStatus, instanceId, additionalInfo);
 206     }
 207
 208         private String extractInstanceId(String modelType, Request request) {
 209         if(null != request.instanceReferences) {
 210             if("service".equalsIgnoreCase(modelType)) {
 211                 return request.instanceReferences.serviceInstanceId;
 212             } else if("vfModule".equalsIgnoreCase(modelType)){
 213                 return request.instanceReferences.vfModuleInstanceId;
 214             } else if("vnf".equalsIgnoreCase(modelType)) {
 215                 return request.instanceReferences.vnfInstanceId;
 216             } else if("volumeGroup".equalsIgnoreCase(modelType)){
 217                 return request.instanceReferences.volumeGroupInstanceId;
 218             } else {
 219                 return "";
 220             }
 221         }
 222         return "";
 223     }
 224
 225     private String buildAdditionalInfo(AsyncRequestStatus.Request request) {
 226         String source = "";
 227         String statusMessage = "";
 228         String flowStatus = "";
 229         String subscriptionServiceType = "";
 230         String alacarte = "";
 231         String testApi = "";
 232         String projectName = "";
 233         String owningEntityId = "";
 234         String owningEntityName = "";
 235         String requestScope = "";
 236         String tenantId = "";
 237         String tenantName = "";
 238         String cloudOwner = "";
 239         String platformName = "";
 240         String lineOfBusiness = "";
 241         MessageFormat mfBasedOnService = null;
 242         String otherInfo = "";
 243         MessageFormat mf = new MessageFormat("{0}" +
 244             "{1}" +
 245             "{2}" +
 246             "{3}" +
 247             "{4}" +
 248             "{5}"+
 249             "{6}");
 250         requestScope = request.requestScope;
 251         statusMessage = request.requestStatus != null ? "<b>StatusMessage:</b>"+request.requestStatus.getStatusMessage()+ "</br>": "";
 252         if(request.requestDetails != null && request.requestDetails.requestInfo != null) {
 253             source = "<b>Source:</b> "+request.requestDetails.requestInfo.source + "</br>";
 254         }
 255         if(request.requestStatus != null && request.requestStatus.getFlowStatus() != null) {
 256             flowStatus = "<b>FlowStatus:</b> "+request.requestStatus.getFlowStatus()+ "</br>";
 257         }
 258         if(request.requestDetails != null && request.requestDetails.requestParameters != null &&
 259             request.requestDetails.requestParameters.subscriptionServiceType != null) {
 260             subscriptionServiceType = "<b>SubscriptionServiceType:</b> "+request.requestDetails.requestParameters.subscriptionServiceType+ "</br>";
 261         }
 262         if(request.requestDetails != null && request.requestDetails.requestParameters != null &&
 263             request.requestDetails.requestParameters.aLaCarte != null) {
 264             alacarte = "<b>Alacarte:</b> "+request.requestDetails.requestParameters.aLaCarte+ "</br>";
 265         }
 266         if(request.requestDetails != null && request.requestDetails.requestParameters != null &&
 267             request.requestDetails.requestParameters.testApi != null) {
 268             testApi = "<b>TestAPI:</b> "+request.requestDetails.requestParameters.testApi+ "</br>";
 269         }
 270
 271         if(request.requestDetails != null) {
 272             if("service".equals(requestScope)) {
 273                 mfBasedOnService = new MessageFormat("<b>ProjectName: {0}</br>" +
 274                     "<b>OwningEntityId:</b> {1}</br>" +
 275                     "<b>OwningEntityName:</b> {2}</br>");
 276                 projectName = request.requestDetails.project != null ? request.requestDetails.project.projectName : "";
 277                 owningEntityId = request.requestDetails.owningEntity != null ? request.requestDetails.owningEntity.owningEntityId : "";
 278                 owningEntityName = request.requestDetails.owningEntity != null ? request.requestDetails.owningEntity.owningEntityName : "";
 279                 Object[] arr1 = new Object[]{projectName, owningEntityId, owningEntityName};
 280                 otherInfo = mfBasedOnService.format(arr1);
 281             } else if("vnf".equals(requestScope)) {
 282                 mfBasedOnService = new MessageFormat("<b>TenantId:</b> {0}</br>" +
 283                     "<b>TenantName:</b> {1}</br>" +
 284                     "<b>CloudOwner:</b> {2}</br>" +
 285                     "<b>PlatformName:</b> {3}</br>" +
 286                     "<b>LineOfBusiness:</b> {4}</br>");
 287                 tenantId = request.requestDetails.cloudConfiguration != null ? request.requestDetails.cloudConfiguration.tenantId : "";
 288                 tenantName= request.requestDetails.cloudConfiguration != null ? request.requestDetails.cloudConfiguration.tenantName : "";
 289                 cloudOwner= request.requestDetails.cloudConfiguration != null ? request.requestDetails.cloudConfiguration.cloudOwner : "";
 290                 platformName= request.requestDetails.platform != null ? request.requestDetails.platform.platformName : "";
 291                 lineOfBusiness= request.requestDetails.lineOfBusiness != null ? request.requestDetails.lineOfBusiness.lineOfBusinessName : "";
 292                 Object[] arr2 = new Object[]{tenantId, tenantName, cloudOwner,platformName,lineOfBusiness};
 293                 otherInfo = mfBasedOnService.format(arr2);
 294             } else if("vfModule".equals(requestScope)) {
 295                 mfBasedOnService = new MessageFormat("<b>TenantId:</b> {0}</br>" +
 296                     "<b>TenantName:</b> {1}</br>" +
 297                     "<b>CloudOwner:</b> {2}</br>");
 298                 tenantId = request.requestDetails.cloudConfiguration != null ? request.requestDetails.cloudConfiguration.tenantId : "";
 299                 tenantName= request.requestDetails.cloudConfiguration != null ? request.requestDetails.cloudConfiguration.tenantName : "";
 300                 cloudOwner= request.requestDetails.cloudConfiguration != null ? request.requestDetails.cloudConfiguration.cloudOwner : "";
 301                 Object[] arr2 = new Object[]{tenantId, tenantName, cloudOwner};
 302                 otherInfo = mfBasedOnService.format(arr2);
 303             }
 304         }
 305         Object[] objArray = {source, statusMessage, flowStatus, subscriptionServiceType, alacarte, testApi, otherInfo};
 306         return StringUtils.chomp(mf.format(objArray));
 307     }
 308     private JobAuditStatus convertAsyncRequestStatusToJobAuditStatus(AsyncRequestStatus status, String defaultName){
 309         if (status == null) {
 310             return null;
 311         }
 312
 313         UUID requestId = null;
 314         String instanceName = defaultName;
 315         String jobStatus = null;
 316         String additionalInfo = null;
 317         String created = null;
 318         String instanceType = null;
 319
 320         AsyncRequestStatus.Request request = status.request;
 321         if(request != null) {
 322             if (request.requestId != null) {
 323                 requestId = UUID.fromString(request.requestId);
 324             }
 325             instanceName = extractInstanceName(instanceName, request);
 326             instanceType = request.requestScope;
 327             if(request.requestStatus != null) {
 328                 jobStatus = request.requestStatus.getRequestState();
 329                 additionalInfo = request.requestStatus.getStatusMessage();
 330                 if(!request.requestStatus.getAdditionalProperties().isEmpty() &&
 331                         request.requestStatus.getAdditionalProperties().get("finishTime") != null) {
 332                     created = request.requestStatus.getAdditionalProperties().get("finishTime").toString();
 333                 } else {
 334                     created = request.requestStatus.getTimestamp();
 335                 }
 336             }
 337         }
 338         return new JobAuditStatus(instanceName, jobStatus, requestId, additionalInfo, created, instanceType);
 339     }
 340
 341     private String extractInstanceName(String instanceName, AsyncRequestStatus.Request request) {
 342         if(request.requestDetails != null && request.requestDetails.requestInfo != null && request.requestDetails.requestInfo.instanceName != null) {
 343             instanceName = request.requestDetails.requestInfo.instanceName;
 344         }
 345         return instanceName;
 346     }
 347
 348     @Override
 349     public JobAuditStatus getResourceAuditStatus(String trackById) {
 350         AsyncRequestStatus asyncRequestStatus = asyncInstantiationRepository.getResourceInfoByTrackId(trackById).getErrorMessage();
 351         return convertAsyncRequestStatusToJobAuditStatus(asyncRequestStatus, null);
 352     }
 353
 354
 355     public static class BadResponseFromMso extends RuntimeException {
 356         private final RestObject<AsyncRequestStatusList> msoResponse;
 357
 358         public BadResponseFromMso(RestObject<AsyncRequestStatusList> msoResponse) {
 359             this.msoResponse = msoResponse;
 360         }
 361
 362         public RestObject<AsyncRequestStatusList> getMsoResponse() {
 363             return msoResponse;
 364         }
 365     }
 366 }