gerrit.onap Code Review - sdc.git/blob

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