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/OrchestrationTemplateCandidateUploadManagerImpl.java

   1 /*
   2  * -
   3  *  ============LICENSE_START=======================================================
   4  *  Copyright (C) 2022 Nordix Foundation.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *       http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.openecomp.sdcrests.vsp.rest.services;
  23
  24 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.alreadyInStatusBeingUpdated;
  25 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.couldNotCreateLock;
  26 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.couldNotFindLock;
  27 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.couldNotFindStatus;
  28 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.couldNotUpdateLock;
  29 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.couldNotUpdateStatus;
  30 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.invalidCompletionStatus;
  31 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.uploadAlreadyFinished;
  32 import static org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier.vspUploadAlreadyInProgress;
  33
  34 import java.util.Date;
  35 import java.util.List;
  36 import java.util.Optional;
  37 import java.util.UUID;
  38 import java.util.concurrent.locks.Lock;
  39 import java.util.concurrent.locks.ReentrantLock;
  40 import org.openecomp.sdc.common.errors.CoreException;
  41 import org.openecomp.sdc.vendorsoftwareproduct.VendorSoftwareProductManager;
  42 import org.openecomp.sdc.vendorsoftwareproduct.VspManagerFactory;
  43 import org.openecomp.sdc.vendorsoftwareproduct.dao.VspUploadStatusRecordDao;
  44 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
  45 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspUploadStatus;
  46 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspUploadStatusRecord;
  47 import org.openecomp.sdc.versioning.dao.types.Version;
  48 import org.openecomp.sdcrests.vendorsoftwareproducts.types.VspUploadStatusDto;
  49 import org.openecomp.sdcrests.vsp.rest.exception.OrchestrationTemplateCandidateUploadManagerExceptionSupplier;
  50 import org.openecomp.sdcrests.vsp.rest.mapping.VspUploadStatusRecordMapper;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53 import org.springframework.beans.factory.annotation.Autowired;
  54 import org.springframework.beans.factory.annotation.Qualifier;
  55 import org.springframework.stereotype.Service;
  56
  57 /**
  58  * Manages the package upload process status.
  59  */
  60 @Service
  61 public class OrchestrationTemplateCandidateUploadManagerImpl implements OrchestrationTemplateCandidateUploadManager {
  62
  63     private static final Logger LOGGER = LoggerFactory.getLogger(OrchestrationTemplateCandidateUploadManagerImpl.class);
  64
  65     private final VspUploadStatusRecordDao vspUploadStatusRecordDao;
  66     private final VspUploadStatusRecordMapper vspUploadStatusRecordMapper;
  67     private final VendorSoftwareProductManager vendorSoftwareProductManager;
  68     private final Lock startUploadLock;
  69     private final Lock updateStatusLock;
  70
  71     @Autowired
  72     public OrchestrationTemplateCandidateUploadManagerImpl(
  73         @Qualifier("vsp-upload-status-record-dao-impl") final VspUploadStatusRecordDao vspUploadStatusRecordDao) {
  74
  75         this.vspUploadStatusRecordDao = vspUploadStatusRecordDao;
  76         this.vendorSoftwareProductManager = VspManagerFactory.getInstance().createInterface();
  77         this.vspUploadStatusRecordMapper = new VspUploadStatusRecordMapper();
  78         startUploadLock = new ReentrantLock();
  79         updateStatusLock = new ReentrantLock();
  80     }
  81
  82     //for tests purpose
  83     OrchestrationTemplateCandidateUploadManagerImpl(final VspUploadStatusRecordDao vspUploadStatusRecordDao,
  84                                                     final VendorSoftwareProductManager vendorSoftwareProductManager) {
  85         this.vspUploadStatusRecordDao = vspUploadStatusRecordDao;
  86         this.vendorSoftwareProductManager = vendorSoftwareProductManager;
  87         this.vspUploadStatusRecordMapper = new VspUploadStatusRecordMapper();
  88         startUploadLock = new ReentrantLock();
  89         updateStatusLock = new ReentrantLock();
  90     }
  91
  92     @Override
  93     public VspUploadStatusDto putUploadInProgress(final String vspId, final String vspVersionId, final String user) {
  94         checkVspExists(vspId, vspVersionId);
  95         LOGGER.debug("Start uploading for VSP id '{}', version '{}', triggered by user '{}'", vspId, vspVersionId, user);
  96
  97         final VspUploadStatusRecord vspUploadStatusRecord;
  98         startUploadLock.lock();
  99         try {
 100             final List<VspUploadStatusRecord> uploadInProgressList = vspUploadStatusRecordDao.findAllInProgress(vspId, vspVersionId);
 101             if (!uploadInProgressList.isEmpty()) {
 102                 throw vspUploadAlreadyInProgress(vspId, vspVersionId).get();
 103             }
 104
 105             vspUploadStatusRecord = new VspUploadStatusRecord();
 106             vspUploadStatusRecord.setStatus(VspUploadStatus.UPLOADING);
 107             vspUploadStatusRecord.setVspId(vspId);
 108             vspUploadStatusRecord.setVspVersionId(vspVersionId);
 109             vspUploadStatusRecord.setLockId(UUID.randomUUID());
 110             vspUploadStatusRecord.setCreated(new Date());
 111
 112             vspUploadStatusRecordDao.create(vspUploadStatusRecord);
 113             LOGGER.debug("Upload lock '{}' created for VSP id '{}', version '{}'", vspUploadStatusRecord.getLockId(), vspId, vspVersionId);
 114         } catch (final CoreException e) {
 115             throw e;
 116         } catch (final Exception e) {
 117             throw couldNotCreateLock(vspId, vspVersionId, e).get();
 118         } finally {
 119             startUploadLock.unlock();
 120         }
 121
 122         return vspUploadStatusRecordMapper.applyMapping(vspUploadStatusRecord, VspUploadStatusDto.class);
 123     }
 124
 125     @Override
 126     public VspUploadStatusDto putUploadInValidation(final String vspId, final String vspVersionId, final String user) {
 127         return updateToNotFinalStatus(vspId, vspVersionId, VspUploadStatus.VALIDATING, user);
 128     }
 129
 130     @Override
 131     public VspUploadStatusDto putUploadInProcessing(final String vspId, final String vspVersionId, final String user) {
 132         return updateToNotFinalStatus(vspId, vspVersionId, VspUploadStatus.PROCESSING, user);
 133     }
 134
 135     private VspUploadStatusDto updateToNotFinalStatus(final String vspId, final String vspVersionId, final VspUploadStatus status, final String user) {
 136         LOGGER.debug("Updating upload status to '{}' for VSP id '{}', version '{}', triggered by user '{}'", status, vspId, vspVersionId, user);
 137         if (status.isCompleteStatus()) {
 138             throw invalidCompletionStatus(status).get();
 139         }
 140         updateStatusLock.lock();
 141         try {
 142             final Optional<VspUploadStatusRecord> vspUploadStatusRecordOptional = vspUploadStatusRecordDao.findLatest(vspId, vspVersionId);
 143             if (vspUploadStatusRecordOptional.isEmpty()) {
 144                 throw couldNotFindStatus(vspId, vspVersionId).get();
 145             }
 146
 147             final VspUploadStatusRecord vspUploadStatusRecord = vspUploadStatusRecordOptional.get();
 148             final VspUploadStatus currentStatus = vspUploadStatusRecord.getStatus();
 149             if (currentStatus == status) {
 150                 throw alreadyInStatusBeingUpdated(vspId, vspVersionId, status).get();
 151             }
 152             return updateStatus(vspUploadStatusRecord, status);
 153         } finally {
 154             updateStatusLock.unlock();
 155         }
 156     }
 157
 158     private VspUploadStatusDto updateStatus(final VspUploadStatusRecord vspUploadStatusRecord, final VspUploadStatus status) {
 159         final VspUploadStatus currentStatus = vspUploadStatusRecord.getStatus();
 160         vspUploadStatusRecord.setStatus(status);
 161         vspUploadStatusRecord.setUpdated(new Date());
 162
 163         final String vspId = vspUploadStatusRecord.getVspId();
 164         final String vspVersionId = vspUploadStatusRecord.getVspVersionId();
 165         try {
 166             vspUploadStatusRecordDao.update(vspUploadStatusRecord);
 167             LOGGER.debug("Upload lock '{}' status updated from '{}' to '{}' for VSP id '{}', version '{}'",
 168                 vspUploadStatusRecord.getLockId(), currentStatus, status, vspId, vspVersionId);
 169         } catch (final Exception e) {
 170             throw couldNotUpdateStatus(vspId, vspVersionId, status, e).get();
 171         }
 172
 173         return vspUploadStatusRecordMapper.applyMapping(vspUploadStatusRecord, VspUploadStatusDto.class);
 174     }
 175
 176     @Override
 177     public VspUploadStatusDto putUploadAsFinished(final String vspId, final String vspVersionId, final UUID lockId, final VspUploadStatus completionStatus,
 178                                                   final String user) {
 179
 180         if (!completionStatus.isCompleteStatus()) {
 181             throw OrchestrationTemplateCandidateUploadManagerExceptionSupplier.invalidCompleteStatus(completionStatus).get();
 182         }
 183         final Optional<VspUploadStatusRecord> vspUploadStatusOptional =
 184             vspUploadStatusRecordDao.findByVspIdAndVersionIdAndLockId(vspId, vspVersionId, lockId);
 185         if (vspUploadStatusOptional.isEmpty()) {
 186             throw couldNotFindLock(lockId, vspId, vspVersionId).get();
 187         }
 188         final VspUploadStatusRecord vspUploadStatusRecord = vspUploadStatusOptional.get();
 189         if (vspUploadStatusRecord.getIsComplete()) {
 190             throw uploadAlreadyFinished(lockId, vspId, vspVersionId).get();
 191         }
 192         LOGGER.debug("Finishing the upload for VSP id '{}', version '{}', lock '{}', triggered by user '{}'",
 193             vspUploadStatusRecord.getVspId(), vspUploadStatusRecord.getVspVersionId(), vspUploadStatusRecord.getLockId(), user);
 194         vspUploadStatusRecord.setStatus(completionStatus);
 195         vspUploadStatusRecord.setUpdated(new Date());
 196         vspUploadStatusRecord.setIsComplete(true);
 197
 198         try {
 199             vspUploadStatusRecordDao.update(vspUploadStatusRecord);
 200             LOGGER.debug("Upload complete for VSP '{}', version '{}', lock '{}'",
 201                 vspUploadStatusRecord.getLockId(), vspUploadStatusRecord.getVspId(), vspUploadStatusRecord.getVspVersionId());
 202         } catch (final Exception e) {
 203             throw couldNotUpdateLock(vspUploadStatusRecord.getLockId(), vspUploadStatusRecord.getVspId(), vspUploadStatusRecord.getVspVersionId(), e)
 204                 .get();
 205         }
 206
 207         return vspUploadStatusRecordMapper.applyMapping(vspUploadStatusRecord, VspUploadStatusDto.class);
 208     }
 209
 210     private void checkVspExists(final String vspId, final String vspVersionId) {
 211         final VspDetails vspDetails = vendorSoftwareProductManager.getVsp(vspId, new Version(vspVersionId));
 212         if (vspDetails == null) {
 213             throw OrchestrationTemplateCandidateUploadManagerExceptionSupplier.vspNotFound(vspId, vspVersionId).get();
 214         }
 215     }
 216
 217     @Override
 218     public Optional<VspUploadStatusDto> findLatestStatus(final String vspId, final String vspVersionId, final String user) {
 219         checkVspExists(vspId, vspVersionId);
 220
 221         final Optional<VspUploadStatusRecord> vspUploadStatus = vspUploadStatusRecordDao.findLatest(vspId, vspVersionId);
 222         if (vspUploadStatus.isEmpty()) {
 223             return Optional.empty();
 224         }
 225
 226         return Optional.of(vspUploadStatusRecordMapper.applyMapping(vspUploadStatus.get(), VspUploadStatusDto.class));
 227     }
 228
 229 }