2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.openecomp.sdcrests.vsp.rest.services;
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.OnboardingMethod;
52 import org.openecomp.sdcrests.vendorsoftwareproducts.types.PackageInfoDto;
53 import org.openecomp.sdcrests.vendorsoftwareproducts.types.QuestionnaireResponseDto;
54 import org.openecomp.sdcrests.vendorsoftwareproducts.types.ValidationResponseDto;
55 import org.openecomp.sdcrests.vendorsoftwareproducts.types.VersionSoftwareProductActionRequestDto;
56 import org.openecomp.sdcrests.vendorsoftwareproducts.types.VspComputeDto;
57 import org.openecomp.sdcrests.vendorsoftwareproducts.types.VspCreationDto;
58 import org.openecomp.sdcrests.vendorsoftwareproducts.types.VspDescriptionDto;
59 import org.openecomp.sdcrests.vendorsoftwareproducts.types.VspDetailsDto;
60 import org.openecomp.sdcrests.vsp.rest.VendorSoftwareProducts;
61 import org.openecomp.sdcrests.vsp.rest.mapping.MapComputeEntityToVspComputeDto;
62 import org.openecomp.sdcrests.vsp.rest.mapping.MapPackageInfoToPackageInfoDto;
63 import org.openecomp.sdcrests.vsp.rest.mapping.MapQuestionnaireResponseToQuestionnaireResponseDto;
64 import org.openecomp.sdcrests.vsp.rest.mapping.MapValidationResponseToDto;
65 import org.openecomp.sdcrests.vsp.rest.mapping.MapVersionedVendorSoftwareProductInfoToVspDetailsDto;
66 import org.openecomp.sdcrests.vsp.rest.mapping.MapVspDescriptionDtoToVspDetails;
67 import org.openecomp.sdcrests.vsp.rest.mapping.MapVspDetailsToVspCreationDto;
68 import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
69 import org.openecomp.sdcrests.wrappers.StringWrapperResponse;
71 import org.springframework.context.annotation.Scope;
72 import org.springframework.stereotype.Service;
74 import javax.inject.Named;
75 import javax.ws.rs.core.Response;
77 import java.io.IOException;
78 import java.util.Collection;
79 import java.util.List;
80 import java.util.Objects;
82 import static org.openecomp.sdc.logging.messages.AuditMessages.SUBMIT_VSP_ERROR;
86 @Service("vendorSoftwareProducts")
87 @Scope(value = "prototype")
88 public class VendorSoftwareProductsImpl implements VendorSoftwareProducts {
90 private VendorSoftwareProductManager vendorSoftwareProductManager =
91 VspManagerFactory.getInstance().createInterface();
93 private static final Logger logger =
94 LoggerFactory.getLogger(VendorSoftwareProductsImpl.class);
96 private ActivityLogManager activityLogManager =
97 ActivityLogManagerFactory.getInstance().createInterface();
100 public Response createVsp(VspDescriptionDto vspDescriptionDto, String user) {
101 MdcUtil.initMdc(LoggerServiceName.Create_VSP.toString());
102 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CREATE_VSP
103 + vspDescriptionDto.getName());
105 VspCreationDto vspCreationDto = null;
106 OnboardingMethod onboardingMethod =
107 OnboardingMethod.valueOf(vspDescriptionDto.getOnboardingMethod());
108 if (onboardingMethod == null) {
109 return handleUnkownOnboardingMethod();
111 switch (onboardingMethod) {
114 VspDetails vspDetails = new MapVspDescriptionDtoToVspDetails().
115 applyMapping(vspDescriptionDto, VspDetails.class);
117 vspDetails = vendorSoftwareProductManager.createVsp(vspDetails, user);
119 MapVspDetailsToVspCreationDto mapping = new MapVspDetailsToVspCreationDto();
120 vspCreationDto = mapping.applyMapping(vspDetails, VspCreationDto.class);
123 return handleUnkownOnboardingMethod();
126 return Response.ok(vspCreationDto).build();
129 private Response handleUnkownOnboardingMethod() {
130 ErrorCode onboardingMethodUpdateErrorCode = OnboardingMethodErrorBuilder
131 .getInvalidOnboardingMethodErrorBuilder();
132 MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_API,
133 LoggerTragetServiceName.ADD_VSP, ErrorLevel.ERROR.name(),
134 LoggerErrorCode.DATA_ERROR.getErrorCode(), onboardingMethodUpdateErrorCode.message());
135 throw new CoreException(onboardingMethodUpdateErrorCode);
139 public Response listVsps(String versionFilter, String user) {
140 MdcUtil.initMdc(LoggerServiceName.List_VSP.toString());
141 List<VersionedVendorSoftwareProductInfo> vspList =
142 vendorSoftwareProductManager.listVsps(versionFilter, user);
144 GenericCollectionWrapper<VspDetailsDto> results = new GenericCollectionWrapper<>();
145 if (!vspList.isEmpty()) {
146 MapVersionedVendorSoftwareProductInfoToVspDetailsDto mapper =
147 new MapVersionedVendorSoftwareProductInfoToVspDetailsDto();
148 for (VersionedVendorSoftwareProductInfo versionedVsp : vspList) {
149 results.add(mapper.applyMapping(versionedVsp, VspDetailsDto.class));
153 return Response.ok(results).build();
157 public Response getVsp(String vspId, String versionId, String user) {
158 MdcUtil.initMdc(LoggerServiceName.Get_VSP.toString());
161 VspDetails vspDetails =
162 vendorSoftwareProductManager
163 .getVsp(vspId, resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read),
166 VersionInfo versionInfo = getVersionInfo(vspId, VersionableEntityAction.Read, user);
169 if (vspDetails.getOldVersion() != null && !"".equals(vspDetails.getOldVersion())) {
170 if (Version.valueOf(versionId).equals(versionInfo.getActiveVersion())) {
172 Version healedVersion = vendorSoftwareProductManager.callAutoHeal(vspId, versionInfo,
175 vendorSoftwareProductManager
176 .getVsp(vspId, resolveVspVersion(vspId, healedVersion.toString(), user,
177 VersionableEntityAction.Read), user);
178 versionInfo = getVersionInfo(vspId, VersionableEntityAction.Read, user);
179 } catch (Exception e) {
180 logger.error(e.getMessage(), e);
185 VspDetailsDto vspDetailsDto = vspDetails == null
187 : new MapVersionedVendorSoftwareProductInfoToVspDetailsDto()
188 .applyMapping(new VersionedVendorSoftwareProductInfo(vspDetails, versionInfo),
189 VspDetailsDto.class);
191 return Response.ok(vspDetailsDto).build();
195 public Response updateVsp(String vspId, String versionId, VspDescriptionDto vspDescriptionDto,
197 MdcUtil.initMdc(LoggerServiceName.Update_VSP.toString());
198 VspDetails vspDetails =
199 new MapVspDescriptionDtoToVspDetails().applyMapping(vspDescriptionDto, VspDetails.class);
200 vspDetails.setId(vspId);
201 vspDetails.setVersion(resolveVspVersion(vspId, null, user, VersionableEntityAction.Write));
203 vendorSoftwareProductManager.updateVsp(vspDetails, user);
205 return Response.ok().build();
209 public Response deleteVsp(String vspId, String user) {
210 MdcUtil.initMdc(LoggerServiceName.Delete_VSP.toString());
211 vendorSoftwareProductManager.deleteVsp(vspId, user);
213 return Response.ok().build();
217 public Response actOnVendorSoftwareProduct(String vspId, String versionId,
218 VersionSoftwareProductActionRequestDto request,
219 String user) throws IOException {
221 switch (request.getAction()) {
223 MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Checkout_VSP.toString());
224 vendorSoftwareProductManager.checkout(vspId, user);
225 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CHECK_OUT_VSP + vspId);
228 MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Undo_Checkout_VSP.toString());
229 vendorSoftwareProductManager.undoCheckout(vspId, user);
232 MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Checkin_VSP.toString());
233 vendorSoftwareProductManager.checkin(vspId, user);
234 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.CHECK_IN_VSP + vspId);
237 MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Submit_VSP.toString());
238 ValidationResponse validationResponse = vendorSoftwareProductManager.submit(vspId, user);
239 if (!validationResponse.isValid()) {
240 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VSP_FAIL + vspId);
241 if (validationResponse.getVspErrors() != null) {
242 validationResponse.getVspErrors().forEach(errorCode -> logger.audit(AuditMessages
243 .AUDIT_MSG + String.format(SUBMIT_VSP_ERROR, errorCode.message(), vspId)));
245 if (validationResponse.getUploadDataErrors() != null) {
246 validationResponse.getUploadDataErrors().values().forEach(errorMessages
247 -> printAuditForErrors(errorMessages, vspId, SUBMIT_VSP_ERROR));
250 return Response.status(Response.Status.EXPECTATION_FAILED).entity(
251 new MapValidationResponseToDto()
252 .applyMapping(validationResponse, ValidationResponseDto.class)).build();
254 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.SUBMIT_VSP + vspId);
257 MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Create_Package.toString());
259 PackageInfo packageInfo = vendorSoftwareProductManager.createPackage(vspId,
260 resolveVspVersion(vspId, null, user, VersionableEntityAction.Read), user);
261 return Response.ok(packageInfo == null
263 : new MapPackageInfoToPackageInfoDto().applyMapping(packageInfo, PackageInfoDto.class))
268 return Response.ok().build();
272 public Response getValidationVsp(String user)
274 String validationVspId = vendorSoftwareProductManager.fetchValidationVsp(user);
275 StringWrapperResponse response = new StringWrapperResponse(validationVspId);
276 return Response.ok(response).build();
281 public Response getOrchestrationTemplate(String vspId, String versionId, String user) {
282 MdcUtil.initMdc(LoggerServiceName.Get_Uploaded_File.toString());
283 byte[] orchestrationTemplateFile =
284 vendorSoftwareProductManager
285 .getOrchestrationTemplateFile(vspId,
286 resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read), user);
288 if (orchestrationTemplateFile == null) {
289 return Response.status(Response.Status.NOT_FOUND).build();
291 Response.ResponseBuilder response = Response.ok(orchestrationTemplateFile);
292 response.header("Content-Disposition", "attachment; filename=LatestHeatPackage.zip");
293 return response.build();
297 public Response listPackages(String category, String subCategory, String user) {
298 MdcUtil.initMdc(LoggerServiceName.List_Packages.toString());
299 List<PackageInfo> packageInfoList =
300 vendorSoftwareProductManager.listPackages(category, subCategory);
302 GenericCollectionWrapper<PackageInfoDto> results = new GenericCollectionWrapper<>();
303 MapPackageInfoToPackageInfoDto mapper = new MapPackageInfoToPackageInfoDto();
305 if (packageInfoList != null) {
306 for (PackageInfo packageInfo : packageInfoList) {
307 results.add(mapper.applyMapping(packageInfo, PackageInfoDto.class));
310 return Response.ok(results).build();
314 public Response getTranslatedFile(String vspId, String versionId, String user) {
315 MdcUtil.initMdc(LoggerServiceName.Get_Translated_File.toString());
317 Version version = Version.valueOf(versionId);
318 Version resolvedVersion = version == null
319 ? getVersionInfo(vspId, VersionableEntityAction.Read, user).getLatestFinalVersion()
322 File zipFile = vendorSoftwareProductManager.getTranslatedFile(vspId, resolvedVersion, user);
324 Response.ResponseBuilder response = Response.ok(zipFile);
325 if (zipFile == null) {
326 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.IMPORT_FAIL + vspId);
327 return Response.status(Response.Status.NOT_FOUND).build();
329 response.header("Content-Disposition", "attachment; filename=" + zipFile.getName());
331 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.IMPORT_SUCCESS + vspId);
332 return response.build();
336 public Response getQuestionnaire(String vspId, String versionId, String user) {
337 MdcUtil.initMdc(LoggerServiceName.Get_Questionnaire_VSP.toString());
338 QuestionnaireResponse questionnaireResponse =
339 vendorSoftwareProductManager.getVspQuestionnaire(vspId,
340 resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read), user);
342 if (questionnaireResponse.getErrorMessage() != null) {
343 return Response.status(Response.Status.EXPECTATION_FAILED).entity(
344 new MapQuestionnaireResponseToQuestionnaireResponseDto()
345 .applyMapping(questionnaireResponse, QuestionnaireResponseDto.class)).build();
348 QuestionnaireResponseDto result = new MapQuestionnaireResponseToQuestionnaireResponseDto()
349 .applyMapping(questionnaireResponse, QuestionnaireResponseDto.class);
350 return Response.ok(result).build();
354 public Response updateQuestionnaire(String questionnaireData, String vspId, String
355 versionId, String user) {
356 MdcUtil.initMdc(LoggerServiceName.Update_Questionnaire_VSP.toString());
357 vendorSoftwareProductManager.updateVspQuestionnaire(vspId,
358 resolveVspVersion(vspId, null, user, VersionableEntityAction.Write),
359 questionnaireData, user);
360 return Response.ok().build();
364 public Response heal(String vspId, String versionId, String user) {
365 vendorSoftwareProductManager.heal(vspId, Version.valueOf(versionId), user);
367 return Response.ok().build();
371 public Response getVspInformationArtifact(String vspId, String versionId, String user) {
372 MdcUtil.initMdc(LoggerServiceName.Get_Information_Artifact.toString());
373 File textInformationArtifact =
374 vendorSoftwareProductManager.getInformationArtifact(vspId,
375 resolveVspVersion(vspId, versionId, user, VersionableEntityAction.Read), user);
377 Response.ResponseBuilder response = Response.ok(textInformationArtifact);
378 if (textInformationArtifact == null) {
379 return Response.status(Response.Status.NOT_FOUND).build();
382 .header("Content-Disposition", "attachment; filename=" + textInformationArtifact.getName());
383 return response.build();
386 public Response listCompute(String vspId, String version, String user) {
388 Collection<ComputeEntity> computes = vendorSoftwareProductManager.getComputeByVsp(vspId,
389 resolveVspVersion(vspId, version, user, VersionableEntityAction.Read), user);
391 MapComputeEntityToVspComputeDto mapper = new MapComputeEntityToVspComputeDto();
392 GenericCollectionWrapper<VspComputeDto> results = new GenericCollectionWrapper<>();
393 for (ComputeEntity compute : computes) {
394 results.add(mapper.applyMapping(compute, VspComputeDto.class));
397 return Response.ok(results).build();
401 public Response reSubmitAll(String user) throws IOException {
403 MDC.put(LoggerConstants.SERVICE_NAME, LoggerServiceName.Re_Submit_ALL_Final_VSPs.toString());
404 logger.audit(AuditMessages.AUDIT_MSG + AuditMessages.RESUBMIT_ALL_FINAL_VSPS);
406 List<VersionedVendorSoftwareProductInfo> vspList = Objects.requireNonNull(
407 vendorSoftwareProductManager.listVsps(VersionStatus.Final.name(), user));
408 int skippedCounter = 0;
409 final int vspListSizeBefore = vspList.size();
411 for (VersionedVendorSoftwareProductInfo versionVspInfo : vspList) {
412 final VspDetails vspDetails = versionVspInfo.getVspDetails();
413 final String vspId = vspDetails.getId();
414 final Version latestFinalVersion =
415 getVersionInfo(vspId, VersionableEntityAction.Read, user).getLatestFinalVersion();
417 if (latestFinalVersion.getStatus().equals(VersionStatus.Locked)) {
418 logger.info("Skipping processing VSP name [{}]/id [{}] due to status LOCKED", vspDetails
422 vspList.remove(versionVspInfo);
426 logger.info("Removed {} VSPs out of {} from processing due to status LOCKED", skippedCounter,
429 int healingCounter = 0;
430 int failedCounter = 0;
431 int totalCounter = 0;
434 final int vspListSize = vspList.size();
435 logger.info("Total number of VSPs: {}. Performing healing and " +
436 "resubmit for all non-Manual VSPs in submitted status.\n No need to pre-set oldVersion " +
437 "field", vspListSize);
439 for (VersionedVendorSoftwareProductInfo versionVspInfo : vspList) {
442 final Version activeVersion = versionVspInfo.getVersionInfo().getActiveVersion();
443 final VspDetails vspDetails = versionVspInfo.getVspDetails();
444 final String vspId = vspDetails.getId();
445 final Version latestFinalVersion =
446 getVersionInfo(vspId, VersionableEntityAction.Read, user).getLatestFinalVersion();
448 final String vspName = vspDetails.getName();
449 logger.info("VSP Name {}, VSP id [{}], Active Version {} , Active Version Status {}," +
450 "Latest Final Version {} , " +
451 "Latest Final Version Status {}", vspName, vspId, activeVersion
453 activeVersion.getStatus(), latestFinalVersion.toString(),
454 latestFinalVersion.getStatus());
456 if (Objects.nonNull(latestFinalVersion) &&
457 (!OnboardingMethod.Manual.name().equals(vspDetails.getOnboardingMethod()))) {
458 reSubmit(vspDetails, user, totalCounter, vspListSize);
461 } catch (Exception e) {
466 logger.info("Total VSPs processed {}. Completed running healing and resubmit for {} VSPs out" +
468 "of total # of {} submitted VSPs. Failures count during resubmitAll: {}",
469 totalCounter, healingCounter, vspListSize, failedCounter);
472 return Response.ok().build();
476 private void reSubmit(VspDetails vspDetails, String user, int currentCount, int total) throws
479 final String vspId = vspDetails.getId();
480 final String vspName = vspDetails.getName();
481 final Version versionBefore = vspDetails.getVersion();
482 Version finalVersion;
484 logger.info("Starting on healing and resubmit for VSP [{}], #{} out of total {}", vspName,
485 currentCount, total);
486 vspDetails.setOldVersion("true");
490 vendorSoftwareProductManager.healAndAdvanceFinalVersion(vspId, vspDetails, user);
492 } catch (Exception e) {
494 logger.error("Failed during resubmit, VSP [{}] , version before:{}, version after:{}, " +
495 "status after:{}, with exception:{}",
496 vspName, versionBefore.toString(), vspDetails.getVersion().toString(), vspDetails
497 .getVersion().getStatus().name(), e.getMessage());
501 logger.info("Completed healing and resubmit for VSP [{}], version before:{}, version after:" +
502 " {}", vspName, versionBefore.toString(), finalVersion);
505 private static void printAuditForErrors(List<ErrorMessage> errorList, String vspId,
507 errorList.forEach(errorMessage -> {
508 if (errorMessage.getLevel().equals(ErrorLevel.ERROR)) {
509 logger.audit(AuditMessages.AUDIT_MSG + String.format(auditType, errorMessage.getMessage(),