openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/services/VendorSoftwareProductsImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 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.openecomp.sdcrests.vsp.rest.services;
  22
  23 import org.openecomp.sdc.activityLog.ActivityLogManager;
  24 import org.openecomp.sdc.activityLog.ActivityLogManagerFactory;
  25 import org.openecomp.sdc.common.errors.CoreException;
  26 import org.openecomp.sdc.common.errors.ErrorCode;
  27 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  28 import org.openecomp.sdc.datatypes.error.ErrorMessage;
  29 import org.openecomp.sdc.logging.api.Logger;
  30 import org.openecomp.sdc.logging.api.LoggerFactory;
  31 import org.openecomp.sdc.logging.context.MdcUtil;
  32 import org.openecomp.sdc.logging.context.impl.MdcDataErrorMessage;
  33 import org.openecomp.sdc.logging.messages.AuditMessages;
  34 import org.openecomp.sdc.logging.types.LoggerConstants;
  35 import org.openecomp.sdc.logging.types.LoggerErrorCode;
  36 import org.openecomp.sdc.logging.types.LoggerServiceName;
  37 import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
  38 import org.openecomp.sdc.vendorsoftwareproduct.VendorSoftwareProductManager;
  39 import org.openecomp.sdc.vendorsoftwareproduct.VspManagerFactory;
  40 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.ComputeEntity;
  41 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.PackageInfo;
  42 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
  43 import org.openecomp.sdc.vendorsoftwareproduct.errors.OnboardingMethodErrorBuilder;
  44 import org.openecomp.sdc.vendorsoftwareproduct.types.QuestionnaireResponse;
  45 import org.openecomp.sdc.vendorsoftwareproduct.types.ValidationResponse;
  46 import org.openecomp.sdc.vendorsoftwareproduct.types.VersionedVendorSoftwareProductInfo;
  47 import org.openecomp.sdc.versioning.dao.types.Version;
  48 import org.openecomp.sdc.versioning.types.VersionInfo;
  49 import org.openecomp.sdc.versioning.types.VersionableEntityAction;
  50 import org.openecomp.sdcrests.vendorsoftwareproducts.types.*;
  51 import org.openecomp.sdcrests.vsp.rest.VendorSoftwareProducts;
  52 import org.openecomp.sdcrests.vsp.rest.mapping.MapComputeEntityToVspComputeDto;
  53 import org.openecomp.sdcrests.vsp.rest.mapping.MapPackageInfoToPackageInfoDto;
  54 import org.openecomp.sdcrests.vsp.rest.mapping.MapQuestionnaireResponseToQuestionnaireResponseDto;
  55 import org.openecomp.sdcrests.vsp.rest.mapping.MapValidationResponseToDto;
  56 import org.openecomp.sdcrests.vsp.rest.mapping.MapVersionedVendorSoftwareProductInfoToVspDetailsDto;
  57 import org.openecomp.sdcrests.vsp.rest.mapping.MapVspDescriptionDtoToVspDetails;
  58 import org.openecomp.sdcrests.vsp.rest.mapping.MapVspDetailsToVspCreationDto;
  59 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
  60 import org.openecomp.sdcrests.wrappers.StringWrapperResponse;
  61 import org.slf4j.MDC;
  62 import org.springframework.context.annotation.Scope;
  63 import org.springframework.stereotype.Service;
  64
  65 import javax.inject.Named;
  66 import javax.ws.rs.core.Response;
  67 import java.io.File;
  68 import java.io.IOException;
  69 import java.util.Collection;
  70 import java.util.List;
  71
  72 import static org.openecomp.sdc.logging.messages.AuditMessages.SUBMIT_VSP_ERROR;
  73
  74
  75 @Named
  76 @Service("vendorSoftwareProducts")
  77 @Scope(value = "prototype")
  78 public class VendorSoftwareProductsImpl implements VendorSoftwareProducts {
  79
  80   private VendorSoftwareProductManager vendorSoftwareProductManager =
  81       VspManagerFactory.getInstance().createInterface();
  82
  83   private static final Logger logger =
  84       LoggerFactory.getLogger(VendorSoftwareProductsImpl.class);
  85
  86   private ActivityLogManager activityLogManager =
  87       ActivityLogManagerFactory.getInstance().createInterface();
  88
  89     @Override
  90     public Response createVsp(VspDescriptionDto vspDescriptionDto, String user) {
  91         MdcUtil.initMdc(LoggerServiceName.Create_VSP.toString());
  92         logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CREATE_VSP
  93             + vspDescriptionDto.getName());
  94
  95       VspCreationDto vspCreationDto = null;
  96       OnboardingMethod onboardingMethod = OnboardingMethod.valueOf(vspDescriptionDto.getOnboardingMethod());
  97       if (onboardingMethod == null){
  98         return handleUnkownOnboardingMethod();
  99       }
 100       switch (onboardingMethod) {
 101         case NetworkPackage:
 102         case Manual:
 103           VspDetails vspDetails = new MapVspDescriptionDtoToVspDetails().
 104               applyMapping(vspDescriptionDto, VspDetails.class);
 105
 106           vspDetails = vendorSoftwareProductManager.createVsp(vspDetails, user);
 107
 108           MapVspDetailsToVspCreationDto mapping = new MapVspDetailsToVspCreationDto();
 109           vspCreationDto = mapping.applyMapping(vspDetails, VspCreationDto.class);
 110           break;
 111         default:
 112           return handleUnkownOnboardingMethod();
 113       }
 114
 115       return Response.ok(vspCreationDto).build();
 116     }
 117
 118   private Response handleUnkownOnboardingMethod() {
 119     ErrorCode onboardingMethodUpdateErrorCode = OnboardingMethodErrorBuilder
 120         .getInvalidOnboardingMethodErrorBuilder();
 121     MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_API,
 122         LoggerTragetServiceName.ADD_VSP, ErrorLevel.ERROR.name(),
 123         LoggerErrorCode.DATA_ERROR.getErrorCode(), onboardingMethodUpdateErrorCode.message());
 124     throw new CoreException(onboardingMethodUpdateErrorCode);
 125   }
 126
 127   @Override
 128   public Response listVsps(String versionFilter, String user) {
 129     MdcUtil.initMdc(LoggerServiceName.List_VSP.toString());
 130     List<VersionedVendorSoftwareProductInfo> vspList =
 131         vendorSoftwareProductManager.listVsps(versionFilter, user);
 132
 133     GenericCollectionWrapper<VspDetailsDto> results = new GenericCollectionWrapper<>();
 134     if (!vspList.isEmpty()) {
 135       MapVersionedVendorSoftwareProductInfoToVspDetailsDto mapper =
 136           new MapVersionedVendorSoftwareProductInfoToVspDetailsDto();
 137       for (VersionedVendorSoftwareProductInfo versionedVsp : vspList) {
 138         results.add(mapper.applyMapping(versionedVsp, VspDetailsDto.class));
 139       }
 140     }
 141
 142     return Response.ok(results).build();
 143   }
 144
 145   @Override
 146   public Response getVsp(String vspId, String versionId, String user) {
 147     MdcUtil.initMdc(LoggerServiceName.Get_VSP.toString());
 148
 149
 150     VspDetails vspDetails =
 151         vendorSoftwareProductManager
 152             .getVsp(vspId, resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read),
 153                 user);
 154
 155     VersionInfo versionInfo = getVersionInfo(vspId, VersionableEntityAction.Read, user);
 156
 157     //
 158     if (vspDetails.getOldVersion() != null && !"".equals(vspDetails.getOldVersion())) {
 159       if (Version.valueOf(versionId).equals(versionInfo.getActiveVersion())) {
 160         try {
 161           Version healedVersion = vendorSoftwareProductManager.callAutoHeal(vspId, versionInfo,
 162               vspDetails, user);
 163           vspDetails =
 164               vendorSoftwareProductManager
 165                   .getVsp(vspId, resolveVspVersion(vspId, healedVersion.toString(), user,
 166                       VersionableEntityAction.Read), user);
 167           versionInfo = getVersionInfo(vspId, VersionableEntityAction.Read, user);
 168         } catch (Exception e) {
 169           logger.error(e.getMessage(), e);
 170         }
 171       }
 172     }
 173
 174     VspDetailsDto vspDetailsDto = vspDetails == null
 175         ? null
 176         : new MapVersionedVendorSoftwareProductInfoToVspDetailsDto()
 177             .applyMapping(new VersionedVendorSoftwareProductInfo(vspDetails, versionInfo),
 178                 VspDetailsDto.class);
 179
 180     return Response.ok(vspDetailsDto).build();
 181   }
 182
 183   @Override
 184   public Response updateVsp(String vspId, String versionId, VspDescriptionDto vspDescriptionDto,
 185                             String user) {
 186     MdcUtil.initMdc(LoggerServiceName.Update_VSP.toString());
 187     VspDetails vspDetails =
 188         new MapVspDescriptionDtoToVspDetails().applyMapping(vspDescriptionDto, VspDetails.class);
 189     vspDetails.setId(vspId);
 190     vspDetails.setVersion(resolveVspVersion(vspId, null, user, VersionableEntityAction.Write));
 191
 192     vendorSoftwareProductManager.updateVsp(vspDetails, user);
 193
 194     return Response.ok().build();
 195   }
 196
 197   @Override
 198   public Response deleteVsp(String vspId, String user) {
 199     MdcUtil.initMdc(LoggerServiceName.Delete_VSP.toString());
 200     vendorSoftwareProductManager.deleteVsp(vspId, user);
 201
 202     return Response.ok().build();
 203   }
 204
 205   @Override
 206   public Response actOnVendorSoftwareProduct(String vspId, String versionId,
 207                                              VersionSoftwareProductActionRequestDto request,
 208                                              String user) throws IOException {
 209
 210     switch (request.getAction()) {
 211       case Checkout:
 212         MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Checkout_VSP.toString());
 213         vendorSoftwareProductManager.checkout(vspId, user);
 214         logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CHECK_OUT_VSP + vspId);
 215         break;
 216       case Undo_Checkout:
 217         MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Undo_Checkout_VSP.toString());
 218         vendorSoftwareProductManager.undoCheckout(vspId, user);
 219         break;
 220       case Checkin:
 221         MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Checkin_VSP.toString());
 222         vendorSoftwareProductManager.checkin(vspId, user);
 223         logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CHECK_IN_VSP + vspId);
 224         break;
 225       case Submit:
 226         MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Submit_VSP.toString());
 227         ValidationResponse validationResponse = vendorSoftwareProductManager.submit(vspId, user);
 228         if (!validationResponse.isValid()) {
 229           logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VSP_FAIL + vspId);
 230           if (validationResponse.getVspErrors() != null) {
 231             validationResponse.getVspErrors().forEach(errorCode -> logger.audit(AuditMessages
 232                 .AUDIT_MSG + String.format(SUBMIT_VSP_ERROR, errorCode.message(), vspId)));
 233           }
 234           if (validationResponse.getUploadDataErrors() != null) {
 235             validationResponse.getUploadDataErrors().values().forEach(errorMessages
 236                 -> printAuditForErrors(errorMessages, vspId, SUBMIT_VSP_ERROR));
 237           }
 238
 239           return Response.status(Response.Status.EXPECTATION_FAILED).entity(
 240               new MapValidationResponseToDto()
 241                   .applyMapping(validationResponse, ValidationResponseDto.class)).build();
 242         }
 243         logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VSP + vspId);
 244         break;
 245       case Create_Package:
 246         MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Create_Package.toString());
 247
 248         PackageInfo packageInfo = vendorSoftwareProductManager.createPackage(vspId,
 249             resolveVspVersion(vspId, null, user, VersionableEntityAction.Read), user);
 250         return Response.ok(packageInfo == null
 251             ? null
 252             : new MapPackageInfoToPackageInfoDto().applyMapping(packageInfo, PackageInfoDto.class))
 253             .build();
 254       default:
 255     }
 256
 257     return Response.ok().build();
 258   }
 259
 260   @Override
 261   public Response getValidationVsp(String user)
 262       throws Exception {
 263     String validationVspId = vendorSoftwareProductManager.fetchValidationVsp(user);
 264     StringWrapperResponse response = new StringWrapperResponse(validationVspId);
 265     return Response.ok(response).build();
 266   }
 267
 268
 269   @Override
 270   public Response getOrchestrationTemplate(String vspId, String versionId, String user) {
 271     MdcUtil.initMdc(LoggerServiceName.Get_Uploaded_File.toString());
 272     byte[] orchestrationTemplateFile =
 273         vendorSoftwareProductManager
 274             .getOrchestrationTemplateFile(vspId,
 275                 resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read), user);
 276
 277     if (orchestrationTemplateFile == null) {
 278       return Response.status(Response.Status.NOT_FOUND).build();
 279     }
 280     Response.ResponseBuilder response = Response.ok(orchestrationTemplateFile);
 281     response.header("Content-Disposition", "attachment; filename=LatestHeatPackage.zip");
 282     return response.build();
 283   }
 284
 285   @Override
 286   public Response listPackages(String category, String subCategory, String user) {
 287     MdcUtil.initMdc(LoggerServiceName.List_Packages.toString());
 288     List<PackageInfo> packageInfoList =
 289         vendorSoftwareProductManager.listPackages(category, subCategory);
 290
 291     GenericCollectionWrapper<PackageInfoDto> results = new GenericCollectionWrapper<>();
 292     MapPackageInfoToPackageInfoDto mapper = new MapPackageInfoToPackageInfoDto();
 293
 294     if (packageInfoList != null) {
 295       for (PackageInfo packageInfo : packageInfoList) {
 296         results.add(mapper.applyMapping(packageInfo, PackageInfoDto.class));
 297       }
 298     }
 299     return Response.ok(results).build();
 300   }
 301
 302   @Override
 303   public Response getTranslatedFile(String vspId, String versionId, String user) {
 304     MdcUtil.initMdc(LoggerServiceName.Get_Translated_File.toString());
 305
 306     Version version = Version.valueOf(versionId);
 307     Version resolvedVersion = version == null
 308         ? getVersionInfo(vspId, VersionableEntityAction.Read, user).getLatestFinalVersion()
 309         : version;
 310
 311     File zipFile = vendorSoftwareProductManager.getTranslatedFile(vspId, resolvedVersion, user);
 312
 313     Response.ResponseBuilder response = Response.ok(zipFile);
 314     if (zipFile == null) {
 315       logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.IMPORT_FAIL + vspId);
 316       return Response.status(Response.Status.NOT_FOUND).build();
 317     }
 318     response.header("Content-Disposition", "attachment; filename=" + zipFile.getName());
 319
 320     logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.IMPORT_SUCCESS + vspId);
 321     return response.build();
 322   }
 323
 324   @Override
 325   public Response getQuestionnaire(String vspId, String versionId, String user) {
 326     MdcUtil.initMdc(LoggerServiceName.Get_Questionnaire_VSP.toString());
 327     QuestionnaireResponse questionnaireResponse =
 328         vendorSoftwareProductManager.getVspQuestionnaire(vspId,
 329             resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read), user);
 330
 331     if (questionnaireResponse.getErrorMessage() != null) {
 332       return Response.status(Response.Status.EXPECTATION_FAILED).entity(
 333           new MapQuestionnaireResponseToQuestionnaireResponseDto()
 334               .applyMapping(questionnaireResponse, QuestionnaireResponseDto.class)).build();
 335     }
 336
 337     QuestionnaireResponseDto result = new MapQuestionnaireResponseToQuestionnaireResponseDto()
 338         .applyMapping(questionnaireResponse, QuestionnaireResponseDto.class);
 339     return Response.ok(result).build();
 340   }
 341
 342   @Override
 343   public Response updateQuestionnaire(String questionnaireData, String vspId, String
 344       versionId, String user) {
 345     MdcUtil.initMdc(LoggerServiceName.Update_Questionnaire_VSP.toString());
 346     vendorSoftwareProductManager.updateVspQuestionnaire(vspId,
 347         resolveVspVersion(vspId, null, user, VersionableEntityAction.Write),
 348         questionnaireData, user);
 349     return Response.ok().build();
 350   }
 351
 352   @Override
 353   public Response heal(String vspId, String versionId, String user) {
 354     vendorSoftwareProductManager.heal(vspId, Version.valueOf(versionId), user);
 355
 356     return Response.ok().build();
 357   }
 358
 359   @Override
 360   public Response getVspInformationArtifact(String vspId, String versionId, String user) {
 361     MdcUtil.initMdc(LoggerServiceName.Get_Information_Artifact.toString());
 362     File textInformationArtifact =
 363         vendorSoftwareProductManager.getInformationArtifact(vspId,
 364             resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read), user);
 365
 366         Response.ResponseBuilder response = Response.ok(textInformationArtifact);
 367         if (textInformationArtifact == null) {
 368             return Response.status(Response.Status.NOT_FOUND).build();
 369         }
 370         response
 371                 .header("Content-Disposition", "attachment; filename=" + textInformationArtifact.getName());
 372         return response.build();
 373     }
 374
 375   public Response listCompute(String vspId, String version, String user) {
 376
 377     Collection<ComputeEntity> computes = vendorSoftwareProductManager.getComputeByVsp(vspId,
 378         resolveVspVersion(vspId, version, user, VersionableEntityAction.Read), user);
 379
 380     MapComputeEntityToVspComputeDto mapper = new MapComputeEntityToVspComputeDto();
 381     GenericCollectionWrapper<VspComputeDto> results = new GenericCollectionWrapper<>();
 382     for (ComputeEntity compute : computes) {
 383       results.add(mapper.applyMapping(compute, VspComputeDto.class));
 384     }
 385
 386     return Response.ok(results).build();
 387   }
 388
 389   private void printAuditForErrors(List<ErrorMessage> errorList, String vspId, String auditType) {
 390
 391     errorList.forEach(errorMessage -> {
 392       if (errorMessage.getLevel().equals(ErrorLevel.ERROR)) {
 393         logger.audit(AuditMessages.AUDIT_MSG + String.format(auditType, errorMessage.getMessage(),
 394             vspId));
 395       }
 396     });
 397   }
 398 }