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