2 * Copyright © 2016-2018 European Support Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org.openecomp.sdc.vendorsoftwareproduct.impl;
18 import static org.openecomp.sdc.vendorsoftwareproduct.errors.VendorSoftwareProductInvalidErrorBuilder.candidateDataNotProcessedOrAbortedErrorBuilder;
19 import static org.openecomp.sdc.vendorsoftwareproduct.errors.VendorSoftwareProductInvalidErrorBuilder.invalidProcessedCandidate;
20 import static org.openecomp.sdc.vendorsoftwareproduct.errors.VendorSoftwareProductInvalidErrorBuilder.vspMissingDeploymentFlavorErrorBuilder;
22 import java.io.BufferedOutputStream;
23 import java.io.ByteArrayInputStream;
24 import java.io.ByteArrayOutputStream;
26 import java.io.FileInputStream;
27 import java.io.FileOutputStream;
28 import java.io.IOException;
29 import java.io.InputStream;
30 import java.io.OutputStream;
31 import java.nio.ByteBuffer;
32 import java.nio.file.Path;
33 import java.util.ArrayList;
34 import java.util.Collection;
35 import java.util.Collections;
36 import java.util.HashMap;
37 import java.util.HashSet;
38 import java.util.List;
40 import java.util.Objects;
41 import java.util.Optional;
43 import java.util.zip.ZipInputStream;
44 import java.util.zip.ZipOutputStream;
45 import org.apache.commons.collections4.CollectionUtils;
46 import org.apache.commons.collections4.MapUtils;
47 import org.apache.commons.lang3.tuple.ImmutablePair;
48 import org.apache.commons.lang3.tuple.Pair;
49 import org.openecomp.core.dao.UniqueValueDao;
50 import org.openecomp.core.enrichment.api.EnrichmentManager;
51 import org.openecomp.core.enrichment.factory.EnrichmentManagerFactory;
52 import org.openecomp.core.model.dao.EnrichedServiceModelDao;
53 import org.openecomp.core.model.dao.ServiceModelDao;
54 import org.openecomp.core.util.UniqueValueUtil;
55 import org.openecomp.core.utilities.file.FileContentHandler;
56 import org.openecomp.core.utilities.json.JsonSchemaDataGenerator;
57 import org.openecomp.core.utilities.json.JsonUtil;
58 import org.openecomp.core.utilities.orchestration.OnboardingTypesEnum;
59 import org.openecomp.core.validation.api.ValidationManager;
60 import org.openecomp.core.validation.util.MessageContainerUtil;
61 import org.openecomp.sdc.common.errors.CoreException;
62 import org.openecomp.sdc.common.errors.ErrorCode;
63 import org.openecomp.sdc.common.errors.ValidationErrorBuilder;
64 import org.openecomp.sdc.common.utils.CommonUtil;
65 import org.openecomp.sdc.common.utils.SdcCommon;
66 import org.openecomp.sdc.datatypes.error.ErrorLevel;
67 import org.openecomp.sdc.datatypes.error.ErrorMessage;
68 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
69 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
70 import org.openecomp.sdc.logging.api.Logger;
71 import org.openecomp.sdc.logging.api.LoggerFactory;
72 import org.openecomp.sdc.tosca.csar.AsdPackageHelper;
73 import org.openecomp.sdc.tosca.csar.Manifest;
74 import org.openecomp.sdc.tosca.csar.ManifestUtils;
75 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
76 import org.openecomp.sdc.tosca.services.impl.ToscaFileOutputServiceCsarImpl;
77 import org.openecomp.sdc.validation.util.ValidationManagerUtil;
78 import org.openecomp.sdc.vendorlicense.facade.VendorLicenseFacade;
79 import org.openecomp.sdc.vendorlicense.licenseartifacts.VendorLicenseArtifactsService;
80 import org.openecomp.sdc.vendorsoftwareproduct.CompositionEntityDataManager;
81 import org.openecomp.sdc.vendorsoftwareproduct.CompositionEntityDataManagerFactory;
82 import org.openecomp.sdc.vendorsoftwareproduct.ManualVspToscaManager;
83 import org.openecomp.sdc.vendorsoftwareproduct.OrchestrationTemplateCandidateManager;
84 import org.openecomp.sdc.vendorsoftwareproduct.VendorSoftwareProductConstants;
85 import org.openecomp.sdc.vendorsoftwareproduct.VendorSoftwareProductManager;
86 import org.openecomp.sdc.vendorsoftwareproduct.dao.ComponentDao;
87 import org.openecomp.sdc.vendorsoftwareproduct.dao.ComponentDependencyModelDao;
88 import org.openecomp.sdc.vendorsoftwareproduct.dao.ComputeDao;
89 import org.openecomp.sdc.vendorsoftwareproduct.dao.DeploymentFlavorDao;
90 import org.openecomp.sdc.vendorsoftwareproduct.dao.ImageDao;
91 import org.openecomp.sdc.vendorsoftwareproduct.dao.NicDao;
92 import org.openecomp.sdc.vendorsoftwareproduct.dao.OrchestrationTemplateDao;
93 import org.openecomp.sdc.vendorsoftwareproduct.dao.PackageInfoDao;
94 import org.openecomp.sdc.vendorsoftwareproduct.dao.VendorSoftwareProductInfoDao;
95 import org.openecomp.sdc.vendorsoftwareproduct.dao.VspMergeDao;
96 import org.openecomp.sdc.vendorsoftwareproduct.dao.errors.VendorSoftwareProductNotFoundErrorBuilder;
97 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.ComponentDependencyModelEntity;
98 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.ComponentEntity;
99 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.ComputeEntity;
100 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.DeploymentFlavorEntity;
101 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.ImageEntity;
102 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.NicEntity;
103 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.OnboardingMethod;
104 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.OrchestrationTemplateEntity;
105 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.PackageInfo;
106 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
107 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspQuestionnaireEntity;
108 import org.openecomp.sdc.vendorsoftwareproduct.errors.ComponentDependencyModelErrorBuilder;
109 import org.openecomp.sdc.vendorsoftwareproduct.errors.ComponentErrorBuilder;
110 import org.openecomp.sdc.vendorsoftwareproduct.errors.DeploymentFlavorErrorBuilder;
111 import org.openecomp.sdc.vendorsoftwareproduct.errors.FileCreationErrorBuilder;
112 import org.openecomp.sdc.vendorsoftwareproduct.errors.InformationArtifactCreationErrorBuilder;
113 import org.openecomp.sdc.vendorsoftwareproduct.errors.NicInternalNetworkErrorBuilder;
114 import org.openecomp.sdc.vendorsoftwareproduct.errors.PackageInvalidErrorBuilder;
115 import org.openecomp.sdc.vendorsoftwareproduct.errors.PackageNotFoundErrorBuilder;
116 import org.openecomp.sdc.vendorsoftwareproduct.errors.TranslationFileCreationErrorBuilder;
117 import org.openecomp.sdc.vendorsoftwareproduct.errors.VendorSoftwareProductInvalidErrorBuilder;
118 import org.openecomp.sdc.vendorsoftwareproduct.informationArtifact.InformationArtifactGenerator;
119 import org.openecomp.sdc.vendorsoftwareproduct.services.filedatastructuremodule.CandidateService;
120 import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIService;
121 import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIServiceImpl;
122 import org.openecomp.sdc.vendorsoftwareproduct.services.schemagenerator.SchemaGenerator;
123 import org.openecomp.sdc.vendorsoftwareproduct.types.QuestionnaireResponse;
124 import org.openecomp.sdc.vendorsoftwareproduct.types.QuestionnaireValidationResult;
125 import org.openecomp.sdc.vendorsoftwareproduct.types.ValidationResponse;
126 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.FilesDataStructure;
127 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.ComponentComputeAssociation;
128 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.CompositionEntityId;
129 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.CompositionEntityType;
130 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.CompositionEntityValidationData;
131 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.DeploymentFlavor;
132 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.NetworkType;
133 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.Nic;
134 import org.openecomp.sdc.vendorsoftwareproduct.types.schemagenerator.ComponentQuestionnaireSchemaInput;
135 import org.openecomp.sdc.vendorsoftwareproduct.types.schemagenerator.SchemaTemplateContext;
136 import org.openecomp.sdc.vendorsoftwareproduct.types.schemagenerator.SchemaTemplateInput;
137 import org.openecomp.sdc.vendorsoftwareproduct.utils.ComponentDependencyTracker;
138 import org.openecomp.sdc.versioning.VersioningManager;
139 import org.openecomp.sdc.versioning.VersioningManagerFactory;
140 import org.openecomp.sdc.versioning.VersioningUtil;
141 import org.openecomp.sdc.versioning.dao.types.Version;
143 public class VendorSoftwareProductManagerImpl implements VendorSoftwareProductManager {
145 private static final Logger LOGGER = LoggerFactory.getLogger(VendorSoftwareProductManager.class);
146 private VspMergeDao vspMergeDao;
147 private OrchestrationTemplateDao orchestrationTemplateDao;
148 private OrchestrationTemplateCandidateManager orchestrationTemplateCandidateManager;
149 private VendorSoftwareProductInfoDao vspInfoDao;
150 private VendorLicenseFacade vendorLicenseFacade;
151 private ServiceModelDao<ToscaServiceModel> serviceModelDao;
152 private EnrichedServiceModelDao<ToscaServiceModel> enrichedServiceModelDao;
153 private VendorLicenseArtifactsService licenseArtifactsService;
154 private InformationArtifactGenerator informationArtifactGenerator;
155 private PackageInfoDao packageInfoDao;
156 private DeploymentFlavorDao deploymentFlavorDao;
157 private ComponentDao componentDao;
158 private ComponentDependencyModelDao componentDependencyModelDao;
159 private NicDao nicDao;
160 private ComputeDao computeDao;
161 private ImageDao imageDao;
162 private ManualVspToscaManager manualVspToscaManager;
163 private UniqueValueUtil uniqueValueUtil;
164 private CandidateService candidateService;
166 private static ErrorCode createMissingMandatoryFieldError(String fieldName) {
167 return new ValidationErrorBuilder("must be supplied", fieldName).build();
171 public ValidationResponse validate(VspDetails vspDetails) throws IOException {
172 List<ErrorCode> vspErrors = new ArrayList<>(validateVspFields(vspDetails));
173 ValidationResponse validationResponse = new ValidationResponse();
174 if (Objects.nonNull(vspDetails.getOnboardingMethod()) && OnboardingMethod.Manual.name().equals(vspDetails.getOnboardingMethod())) {
175 validateManualOnboardingMethod(vspDetails, validationResponse, vspErrors);
177 validateOrchestrationTemplateCandidate(validationResponse, vspErrors, vspDetails.getId(), vspDetails.getVersion());
178 if (!validationResponse.isValid()) {
179 return validationResponse;
181 validateLicense(vspDetails, vspErrors);
182 OrchestrationTemplateEntity orchestrationTemplate = orchestrationTemplateDao.get(vspDetails.getId(), vspDetails.getVersion());
183 ToscaServiceModel serviceModel = serviceModelDao.getServiceModel(vspDetails.getId(), vspDetails.getVersion());
184 if (isOrchestrationTemplateMissing(orchestrationTemplate) || isServiceModelMissing(serviceModel)) {
185 vspErrors.add(VendorSoftwareProductInvalidErrorBuilder
186 .vendorSoftwareProductMissingServiceModelErrorBuilder(vspDetails.getId(), vspDetails.getVersion()));
188 validationResponse.setUploadDataErrors(validateOrchestrationTemplate(orchestrationTemplate));
190 QuestionnaireValidationResult questionnaireValidationResult = validateQuestionnaire(vspDetails.getId(), vspDetails.getVersion(),
191 vspDetails.getOnboardingMethod());
192 if (Objects.nonNull(questionnaireValidationResult)) {
193 if (validationResponse.getQuestionnaireValidationResult() == null
194 || validationResponse.getQuestionnaireValidationResult().getValidationData() == null) {
195 validationResponse.setQuestionnaireValidationResult(questionnaireValidationResult);
197 validationResponse.getQuestionnaireValidationResult().getValidationData().addAll(questionnaireValidationResult.getValidationData());
200 Collection<ComponentDependencyModelEntity> componentDependencies = componentDependencyModelDao
201 .list(new ComponentDependencyModelEntity(vspDetails.getId(), vspDetails.getVersion(), null));
202 if (validateComponentDependencies(componentDependencies)) {
203 vspErrors.add(ComponentDependencyModelErrorBuilder.getCyclicDependencyComponentErrorBuilder());
205 validationResponse.setVspErrors(vspErrors);
206 validationResponse.setLicensingDataErrors(validateLicensingData(vspDetails));
207 return validationResponse;
210 private void validateLicense(VspDetails vspDetails, List<ErrorCode> vspErrors) {
211 if (vspDetails.getVlmVersion() != null || vspDetails.getLicenseAgreement() != null || vspDetails.getFeatureGroups() != null) {
212 vspErrors.addAll(validateMandatoryLicenseFields(vspDetails));
216 private void validateOrchestrationTemplateCandidate(ValidationResponse validationResponse, List<ErrorCode> vspErrors, String vspId,
218 orchestrationTemplateCandidateManager.getInfo(vspId, version).ifPresent(candidateInfo -> {
219 String fileName = candidateInfo.getFileName();
220 vspErrors.add(candidateInfo.getValidationData().isEmpty() ? candidateDataNotProcessedOrAbortedErrorBuilder(fileName)
221 : invalidProcessedCandidate(fileName));
222 validationResponse.setVspErrors(vspErrors);
226 private void validateManualOnboardingMethod(VspDetails vspDetails, ValidationResponse validationResponse, List<ErrorCode> vspErrors) {
227 vspErrors.addAll(validateMandatoryLicenseFields(vspDetails));
228 Collection<DeploymentFlavorEntity> deploymentFlavors = deploymentFlavorDao
229 .list(new DeploymentFlavorEntity(vspDetails.getId(), vspDetails.getVersion(), null));
230 if (CollectionUtils.isEmpty(deploymentFlavors)) {
231 vspErrors.add(vspMissingDeploymentFlavorErrorBuilder());
233 vspErrors.addAll(validateDeploymentFlavors(deploymentFlavors));
234 Set<CompositionEntityValidationData> componentValidationResult = componentValidation(vspDetails.getId(), vspDetails.getVersion());
235 if (!CollectionUtils.isEmpty(componentValidationResult)) {
236 if (validationResponse.getQuestionnaireValidationResult() == null
237 || validationResponse.getQuestionnaireValidationResult().getValidationData() == null) {
238 validationResponse.setQuestionnaireValidationResult(new QuestionnaireValidationResult(componentValidationResult));
240 validationResponse.getQuestionnaireValidationResult().getValidationData().addAll(componentValidationResult);
246 public Map<String, List<ErrorMessage>> compile(String vspId, Version version) {
247 ToscaServiceModel serviceModel = OnboardingMethod.Manual.name().equals(getValidatedVsp(vspId, version).getOnboardingMethod())
248 //Generate Tosca service model for Manual Onboarding flow
249 ? manualVspToscaManager.generateToscaModel(manualVspToscaManager.gatherVspInformation(vspId, version))
250 : serviceModelDao.getServiceModel(vspId, version);
251 return compile(vspId, version, serviceModel);
254 private boolean validateComponentDependencies(Collection<ComponentDependencyModelEntity> componentDependencies) {
255 ComponentDependencyTracker dependencyTracker = new ComponentDependencyTracker();
256 for (ComponentDependencyModelEntity componentDependency : componentDependencies) {
257 dependencyTracker.addDependency(componentDependency.getSourceComponentId(), componentDependency.getTargetComponentId());
259 return dependencyTracker.isCyclicDependencyPresent();
262 private Collection<ErrorCode> validateDeploymentFlavors(Collection<DeploymentFlavorEntity> deploymentFlavors) {
263 Collection<ErrorCode> errorCodeList = new ArrayList<>();
264 if (!CollectionUtils.isEmpty(deploymentFlavors)) {
265 deploymentFlavors.forEach(deploymentFlavor -> {
266 DeploymentFlavorEntity deployment = deploymentFlavorDao.get(deploymentFlavor);
267 DeploymentFlavor deploymentLocalFlavor = deployment.getDeploymentFlavorCompositionData();
268 if (deploymentLocalFlavor != null) {
269 if (deploymentLocalFlavor.getFeatureGroupId() == null) {
270 ErrorCode deploymentFlavorErrorBuilder = DeploymentFlavorErrorBuilder
271 .getFeatureGroupMandatoryErrorBuilder(deploymentLocalFlavor.getModel());
272 errorCodeList.add(deploymentFlavorErrorBuilder);
274 validateComponentComputeAssociations(errorCodeList, deploymentFlavor, deployment, deploymentLocalFlavor);
278 return errorCodeList;
281 private void validateComponentComputeAssociations(Collection<ErrorCode> errorCodeList, DeploymentFlavorEntity deploymentFlavor,
282 DeploymentFlavorEntity deployment, DeploymentFlavor deploymentlocalFlavor) {
283 List<ComponentComputeAssociation> componentComputeAssociations = deploymentlocalFlavor.getComponentComputeAssociations();
284 if (CollectionUtils.isEmpty(componentComputeAssociations)) {
285 validateCompositionEntity(errorCodeList, deploymentFlavor, deployment, deploymentlocalFlavor);
287 componentComputeAssociations.forEach(componentComputeAssociation -> {
288 if (componentComputeAssociation == null || !(componentComputeAssociation.getComponentId() != null
289 && componentComputeAssociation.getComputeFlavorId() != null)) {
290 validateCompositionEntity(errorCodeList, deploymentFlavor, deployment, deploymentlocalFlavor);
296 private void validateCompositionEntity(Collection<ErrorCode> errorCodeList, DeploymentFlavorEntity deploymentFlavor,
297 DeploymentFlavorEntity deployment, DeploymentFlavor deploymentlocalFlavor) {
298 CompositionEntityValidationData compositionEntityValidationData = new CompositionEntityValidationData(CompositionEntityType.deployment,
299 deploymentFlavor.getId());
300 compositionEntityValidationData.setEntityName(deployment.getDeploymentFlavorCompositionData().getModel());
301 ErrorCode deploymentFlavorErrorBuilder = DeploymentFlavorErrorBuilder
302 .getInvalidComponentComputeAssociationErrorBuilder(deploymentlocalFlavor.getModel());
303 errorCodeList.add(deploymentFlavorErrorBuilder);
306 private Set<CompositionEntityValidationData> componentValidation(String vspId, Version version) {
307 Set<CompositionEntityValidationData> validationData = new HashSet<>();
308 Collection<ComponentEntity> components = componentDao.list(new ComponentEntity(vspId, version, null));
309 if (!CollectionUtils.isEmpty(components)) {
310 components.forEach(component -> {
311 validateImage(vspId, version, validationData, component);
312 validateNic(vspId, version, validationData, component);
315 return validationData;
318 private void validateNic(String vspId, Version version, Set<CompositionEntityValidationData> validationData, ComponentEntity component) {
319 Collection<NicEntity> nics = nicDao.list(new NicEntity(vspId, version, component.getId(), null));
320 if (CollectionUtils.isNotEmpty(nics)) {
321 nics.forEach(nicEntity -> {
322 NicEntity nic = nicDao.get(new NicEntity(vspId, version, component.getId(), nicEntity.getId()));
323 NetworkType networkType = nic.getNicCompositionData().getNetworkType();
324 String networkId = nic.getNicCompositionData().getNetworkId();
325 if (networkType.equals(NetworkType.Internal) && networkId == null) {
326 CompositionEntityValidationData compositionEntityValidationData = new CompositionEntityValidationData(CompositionEntityType.nic,
328 compositionEntityValidationData.setEntityName(nic.getNicCompositionData().getName());
329 ErrorCode nicInternalNetworkErrorBuilder = NicInternalNetworkErrorBuilder.getNicNullNetworkIdInternalNetworkIdErrorBuilder();
330 List<String> errors = new ArrayList<>();
331 errors.add(nicInternalNetworkErrorBuilder.message());
332 compositionEntityValidationData.setErrors(errors);
333 validationData.add(compositionEntityValidationData);
339 private void validateImage(String vspId, Version version, Set<CompositionEntityValidationData> validationData, ComponentEntity component) {
340 Collection<ImageEntity> images = imageDao.list(new ImageEntity(vspId, version, component.getId(), null));
341 if (CollectionUtils.isEmpty(images)) {
342 CompositionEntityValidationData compositionEntityValidationData = new CompositionEntityValidationData(component.getType(),
344 compositionEntityValidationData.setEntityName(component.getComponentCompositionData().getDisplayName());
345 ErrorCode vfcMissingImageErrorBuilder = ComponentErrorBuilder.vfcMissingImageErrorBuilder();
346 List<String> errors = new ArrayList<>();
347 errors.add(vfcMissingImageErrorBuilder.message());
348 compositionEntityValidationData.setErrors(errors);
349 validationData.add(compositionEntityValidationData);
353 private List<ErrorCode> validateVspFields(VspDetails vspDetails) {
354 List<ErrorCode> errors = new ArrayList<>();
355 if (vspDetails.getName() == null) {
356 errors.add(createMissingMandatoryFieldError("name"));
358 if (vspDetails.getDescription() == null) {
359 errors.add(createMissingMandatoryFieldError("description"));
361 if (vspDetails.getVendorId() == null) {
362 errors.add(createMissingMandatoryFieldError("vendor Id"));
364 if (vspDetails.getCategory() == null) {
365 errors.add(createMissingMandatoryFieldError("category"));
367 if (vspDetails.getSubCategory() == null) {
368 errors.add(createMissingMandatoryFieldError("sub category"));
373 private List<ErrorCode> validateMandatoryLicenseFields(VspDetails vspDetails) {
374 List<ErrorCode> errors = new ArrayList<>();
375 if (vspDetails.getVlmVersion() == null) {
376 errors.add(createMissingMandatoryFieldError("licensing version"));
378 if (vspDetails.getLicenseAgreement() == null) {
379 errors.add(createMissingMandatoryFieldError("license agreement"));
381 if (CollectionUtils.isEmpty(vspDetails.getFeatureGroups())) {
382 errors.add(createMissingMandatoryFieldError("feature groups"));
387 private Map<String, List<ErrorMessage>> compile(String vendorSoftwareProductId, Version version, ToscaServiceModel serviceModel) {
388 if (isServiceModelMissing(serviceModel)) {
391 enrichedServiceModelDao.deleteAll(vendorSoftwareProductId, version);
392 if (CollectionUtils.isNotEmpty(serviceModel.getModelList())) {
393 enrichedServiceModelDao.storeServiceModel(vendorSoftwareProductId, version, serviceModel);
394 return Collections.emptyMap();
396 final EnrichmentManager<ToscaServiceModel> enrichmentManager = EnrichmentManagerFactory.getInstance().createInterface();
397 enrichmentManager.init(vendorSoftwareProductId, version);
398 enrichmentManager.setModel(serviceModel);
399 final Map<String, List<ErrorMessage>> enrichErrors = enrichmentManager.enrich();
400 enrichedServiceModelDao.storeServiceModel(vendorSoftwareProductId, version, enrichmentManager.getModel());
404 private Collection<ErrorCode> validateLicensingData(VspDetails vspDetails) {
405 if (vspDetails.getVendorId() != null) {
406 Optional<ErrorCode> errorCode = vendorLicenseFacade.validateVendorForUsage(vspDetails.getVendorId(), vspDetails.getVlmVersion());
407 if (errorCode.isPresent()) {
408 return Collections.singleton(errorCode.get());
411 if (vspDetails.getVendorId() == null || vspDetails.getVlmVersion() == null || vspDetails.getLicenseAgreement() == null || CollectionUtils
412 .isEmpty(vspDetails.getFeatureGroups())) {
413 return Collections.emptyList();
415 return vendorLicenseFacade.validateLicensingData(vspDetails.getVendorId(), vspDetails.getVlmVersion(), vspDetails.getLicenseAgreement(),
416 vspDetails.getFeatureGroups());
420 public VspDetails createVsp(VspDetails vspDetails) {
421 vspInfoDao.create(vspDetails);
422 vspInfoDao.updateQuestionnaireData(vspDetails.getId(), vspDetails.getVersion(),
423 new JsonSchemaDataGenerator(getVspQuestionnaireSchema(null)).generateData());
428 public void updateVsp(VspDetails vspDetails) {
429 VspDetails retrieved = vspInfoDao.get(vspDetails);
430 if (retrieved == null) {
431 throw new CoreException((new ErrorCode.ErrorCodeBuilder()
432 .withMessage(String.format("Vsp with id %s and version %s does not exist.", vspDetails.getId(), vspDetails.getVersion().getId())))
435 vspDetails.setOnboardingMethod(retrieved.getOnboardingMethod());
436 //If any existing feature group is removed from VSP which is also associated in DF then
438 //update DF to remove feature group associations.
439 updateDeploymentFlavor(vspDetails);
440 updateUniqueName(retrieved.getName(), vspDetails.getName());
441 vspInfoDao.update(vspDetails);
444 private void updateDeploymentFlavor(VspDetails vspDetails) {
445 final List<String> featureGroups = vspDetails.getFeatureGroups();
446 if (featureGroups != null) {
447 final Collection<DeploymentFlavorEntity> deploymentFlavorEntities = deploymentFlavorDao
448 .list(new DeploymentFlavorEntity(vspDetails.getId(), vspDetails.getVersion(), null));
449 if (Objects.nonNull(deploymentFlavorEntities)) {
450 for (DeploymentFlavorEntity deploymentFlavorEntity : deploymentFlavorEntities) {
451 updateDeploymentFlavourEntity(featureGroups, deploymentFlavorEntity);
457 private void updateDeploymentFlavourEntity(List<String> featureGroups, DeploymentFlavorEntity deploymentFlavorEntity) {
458 final String featureGroupId = deploymentFlavorEntity.getDeploymentFlavorCompositionData().getFeatureGroupId();
459 if (!featureGroups.contains(featureGroupId)) {
460 DeploymentFlavor deploymentFlavorCompositionData = deploymentFlavorEntity.getDeploymentFlavorCompositionData();
461 deploymentFlavorCompositionData.setFeatureGroupId(null);
462 deploymentFlavorEntity.setDeploymentFlavorCompositionData(deploymentFlavorCompositionData);
463 deploymentFlavorDao.update(deploymentFlavorEntity);
468 public VspDetails getVsp(String vspId, Version version) {
469 return getValidatedVsp(vspId, version);
472 private VspDetails getValidatedVsp(String vspId, Version version) {
473 VspDetails vsp = vspInfoDao.get(new VspDetails(vspId, version));
475 throw new CoreException(new VendorSoftwareProductNotFoundErrorBuilder(vspId).build());
481 public void deleteVsp(String vspId, Version version) {
482 vspMergeDao.deleteHint(vspId, version);
486 public List<PackageInfo> listPackages(String category, String subCategory) {
487 return packageInfoDao.listByCategory(category, subCategory);
491 public File getTranslatedFile(String vspId, Version version) {
492 PackageInfo packageInfo = packageInfoDao.get(new PackageInfo(vspId, version));
493 if (packageInfo == null) {
494 throw new CoreException(new PackageNotFoundErrorBuilder(vspId, version).build());
496 ByteBuffer translatedFileBuffer = packageInfo.getTranslatedFile();
497 if (translatedFileBuffer == null) {
498 throw new CoreException(new PackageInvalidErrorBuilder(vspId, version).build());
500 File translatedFile = new File(VendorSoftwareProductConstants.VSP_PACKAGE_ZIP);
501 try (FileOutputStream fos = new FileOutputStream(translatedFile)) {
502 fos.write(translatedFileBuffer.array());
503 } catch (IOException exception) {
504 throw new CoreException(new TranslationFileCreationErrorBuilder(vspId, version).build(), exception);
506 return translatedFile;
510 public byte[] getOrchestrationTemplateFile(String vspId, Version version) {
511 OrchestrationTemplateEntity uploadData = orchestrationTemplateDao.get(vspId, version);
512 ByteBuffer contentData = uploadData.getContentData();
513 if (contentData == null) {
516 ByteArrayOutputStream baos = new ByteArrayOutputStream();
517 try (final ZipOutputStream zos = new ZipOutputStream(baos); ZipInputStream ignored = new ZipInputStream(
518 new ByteArrayInputStream(contentData.array()))) {
519 zos.write(contentData.array());
520 } catch (IOException exception) {
521 throw new CoreException(new FileCreationErrorBuilder(vspId).build(), exception);
523 return baos.toByteArray();
527 public OrchestrationTemplateEntity getOrchestrationTemplateInfo(String vspId, Version version) {
528 return orchestrationTemplateDao.getInfo(vspId, version);
532 public Optional<FilesDataStructure> getOrchestrationTemplateStructure(String vspId, Version version) {
533 Optional<String> jsonFileDataStructure = orchestrationTemplateDao.getOrchestrationTemplateStructure(vspId, version);
534 if (jsonFileDataStructure.isPresent() && JsonUtil.isValidJson(jsonFileDataStructure.get())) {
535 return Optional.of(JsonUtil.json2Object(jsonFileDataStructure.get(), FilesDataStructure.class));
537 return Optional.empty();
542 public void updatePackage(PackageInfo packageInfo) {
543 packageInfoDao.update(packageInfo);
547 public PackageInfo createPackage(final String vspId, final Version version) throws IOException {
548 final ToscaServiceModel toscaServiceModel = enrichedServiceModelDao.getServiceModel(vspId, version);
549 final VspDetails vspDetails = vspInfoDao.get(new VspDetails(vspId, version));
550 final Version vlmVersion = vspDetails.getVlmVersion();
551 if (vlmVersion != null) {
552 populateVersionsForVlm(vspDetails.getVendorId(), vlmVersion);
554 final PackageInfo packageInfo = createPackageInfo(vspDetails);
555 final ToscaFileOutputServiceCsarImpl toscaServiceTemplateServiceCsar = new ToscaFileOutputServiceCsarImpl(new AsdPackageHelper(new ManifestUtils()));
556 final FileContentHandler licenseArtifacts = licenseArtifactsService
557 .createLicenseArtifacts(vspDetails.getId(), vspDetails.getVendorId(), vlmVersion, vspDetails.getFeatureGroups());
558 final ETSIService etsiService = new ETSIServiceImpl();
559 if (etsiService.hasEtsiSol261Metadata(toscaServiceModel.getArtifactFiles())) {
560 final FileContentHandler handler = toscaServiceModel.getArtifactFiles();
561 final Manifest manifest = etsiService.getManifest(handler);
562 final Optional<Map<String, Path>> fromToMovedPaths = etsiService.moveNonManoFileToArtifactFolder(handler);
563 fromToMovedPaths.ifPresent(it -> etsiService.updateMainDescriptorPaths(toscaServiceModel, it));
564 packageInfo.setResourceType(etsiService.getResourceType(manifest).name());
565 if (CollectionUtils.isEmpty(vspDetails.getModelIdList())) {
566 packageInfo.setVendorRelease(etsiService.getHighestCompatibleSpecificationVersion(handler).getOriginalValue());
569 packageInfo.setTranslatedFile(ByteBuffer.wrap(toscaServiceTemplateServiceCsar.createOutputFile(toscaServiceModel, licenseArtifacts)));
570 packageInfoDao.create(packageInfo);
574 void populateVersionsForVlm(String vlmId, Version vlmVersion) {
575 VersioningManager versioningManager = VersioningManagerFactory.getInstance().createInterface();
576 versioningManager.list(vlmId).stream().filter(version -> version.getId().equalsIgnoreCase(vlmVersion.getId())).findAny()
577 .ifPresent(version -> {
578 vlmVersion.setMinor(version.getMinor());
579 vlmVersion.setMajor(version.getMajor());
583 private PackageInfo createPackageInfo(final VspDetails vspDetails) {
584 final var packageInfo = new PackageInfo(vspDetails.getId(), vspDetails.getVersion());
585 packageInfo.setVspName(vspDetails.getName());
586 packageInfo.setVspDescription(vspDetails.getDescription());
587 packageInfo.setCategory(vspDetails.getCategory());
588 packageInfo.setSubCategory(vspDetails.getSubCategory());
589 packageInfo.setVendorName(vspDetails.getVendorName());
590 packageInfo.setPackageType(VendorSoftwareProductConstants.CSAR);
591 packageInfo.setVendorRelease("1.0"); //todo TBD
592 if (CollectionUtils.isNotEmpty(vspDetails.getModelIdList())) {
593 packageInfo.setModels(new HashSet<>(vspDetails.getModelIdList()));
599 public QuestionnaireResponse getVspQuestionnaire(String vspId, Version version) {
600 VspQuestionnaireEntity retrieved = vspInfoDao.getQuestionnaire(vspId, version);
601 VersioningUtil.validateEntityExistence(retrieved, new VspQuestionnaireEntity(vspId, version), VspDetails.ENTITY_TYPE);
602 String questionnaireData = retrieved.getQuestionnaireData();
603 QuestionnaireResponse questionnaireResponse = new QuestionnaireResponse();
604 questionnaireResponse.setData(questionnaireData);
605 questionnaireResponse.setSchema(getVspQuestionnaireSchema(null));
606 return questionnaireResponse;
610 public void updateVspQuestionnaire(String vspId, Version version, String questionnaireData) {
611 vspInfoDao.updateQuestionnaireData(vspId, version, questionnaireData);
614 private Map<String, List<ErrorMessage>> validateOrchestrationTemplate(OrchestrationTemplateEntity orchestrationTemplate) throws IOException {
615 if (isOrchestrationTemplateMissing(orchestrationTemplate)) {
618 Map<String, List<ErrorMessage>> validationErrors = new HashMap<>();
619 FileContentHandler fileContentMap = CommonUtil
620 .validateAndUploadFileContent(OnboardingTypesEnum.getOnboardingTypesEnum(orchestrationTemplate.getFileSuffix()),
621 orchestrationTemplate.getContentData().array());
622 try (InputStream zipFileManifest = fileContentMap.getFileContentAsStream(SdcCommon.MANIFEST_NAME)) {
623 addDummyHeatBase(zipFileManifest, fileContentMap);
624 } catch (Exception e) {
625 LOGGER.error("Invalid package content", e);
627 if (CommonUtil.isFileOriginFromZip(orchestrationTemplate.getFileSuffix())) {
628 ValidationManager validationManager = ValidationManagerUtil.initValidationManager(fileContentMap);
629 validationErrors.putAll(validationManager.validate());
631 return MapUtils.isEmpty(MessageContainerUtil.getMessageByLevel(ErrorLevel.ERROR, validationErrors)) ? null : validationErrors;
634 private FileContentHandler addDummyHeatBase(InputStream zipFileManifest, FileContentHandler fileContentMap) {
635 ManifestContent manifestContent = JsonUtil.json2Object(zipFileManifest, ManifestContent.class);
636 for (FileData fileData : manifestContent.getData()) {
637 if ((fileData.getFile()).contains("dummy_ignore.yaml")) {
638 String filePath = new File("").getAbsolutePath() + "/resources";
639 File envFilePath = new File(filePath + "/base_template.env");
640 File baseFilePath = new File(filePath + "/base_template.yaml");
641 try (InputStream envStream = new FileInputStream(envFilePath); InputStream baseStream = new FileInputStream(baseFilePath);) {
642 fileContentMap.addFile("base_template_dummy_ignore.env", envStream);
643 fileContentMap.addFile("base_template_dummy_ignore.yaml", baseStream);
644 } catch (Exception e) {
645 LOGGER.error("File not found error {}", e);
649 return fileContentMap;
652 private QuestionnaireValidationResult validateQuestionnaire(String vspId, Version version, String onboardingMethod) {
653 // The apis of CompositionEntityDataManager used here are stateful!
655 // so, it must be re-created from scratch when it is used!
656 CompositionEntityDataManager compositionEntityDataManager = CompositionEntityDataManagerFactory.getInstance().createInterface();
657 compositionEntityDataManager.addEntity(vspInfoDao.getQuestionnaire(vspId, version), null);
658 Collection<NicEntity> nics = nicDao.listByVsp(vspId, version);
659 Map<String, List<String>> nicNamesByComponent = new HashMap<>();
660 for (NicEntity nicEntity : nics) {
661 compositionEntityDataManager.addEntity(nicEntity, null);
662 Nic nic = nicEntity.getNicCompositionData();
663 if (nic != null && nic.getName() != null) {
664 List<String> nicNames = nicNamesByComponent.computeIfAbsent(nicEntity.getComponentId(), k -> new ArrayList<>());
665 nicNames.add(nic.getName());
668 Collection<ComponentEntity> components = componentDao.listCompositionAndQuestionnaire(vspId, version);
669 components.forEach(component -> compositionEntityDataManager.addEntity(component,
670 new ComponentQuestionnaireSchemaInput(nicNamesByComponent.get(component.getId()),
671 JsonUtil.json2Object(component.getQuestionnaireData(), Map.class), null, OnboardingMethod.Manual.name().equals(onboardingMethod))));
672 Collection<ComputeEntity> computes = computeDao.listByVsp(vspId, version);
673 computes.forEach(compute -> compositionEntityDataManager.addEntity(compute, null));
674 if (OnboardingMethod.Manual.name().equals(onboardingMethod)) {
675 Collection<ImageEntity> images = imageDao.listByVsp(vspId, version);
676 images.forEach(image -> compositionEntityDataManager.addEntity(image, null));
678 Map<CompositionEntityId, Collection<String>> errorsByEntityId = compositionEntityDataManager.validateEntitiesQuestionnaire();
679 if (MapUtils.isNotEmpty(errorsByEntityId)) {
680 compositionEntityDataManager.buildTrees();
681 compositionEntityDataManager.addErrorsToTrees(errorsByEntityId);
682 return new QuestionnaireValidationResult(compositionEntityDataManager.getAllErrorsByVsp(vspId));
688 public File getInformationArtifact(String vspId, Version version) {
689 VspDetails vspDetails = vspInfoDao.get(new VspDetails(vspId, version));
690 if (vspDetails == null) {
693 String vspName = vspDetails.getName();
694 ByteBuffer infoArtifactAsByteBuffer;
695 File infoArtifactFile;
697 infoArtifactAsByteBuffer = ByteBuffer.wrap(informationArtifactGenerator.generate(vspId, version).getBytes());
698 infoArtifactFile = new File(String.format(VendorSoftwareProductConstants.INFORMATION_ARTIFACT_NAME, vspName));
699 try (OutputStream out = new BufferedOutputStream(new FileOutputStream(infoArtifactFile))) {
700 out.write(infoArtifactAsByteBuffer.array());
702 } catch (IOException ex) {
703 throw new CoreException(new InformationArtifactCreationErrorBuilder(vspId).build(), ex);
705 return infoArtifactFile;
708 String getVspQuestionnaireSchema(SchemaTemplateInput schemaInput) {
709 return SchemaGenerator.generate(SchemaTemplateContext.questionnaire, CompositionEntityType.vsp, schemaInput);
713 public Optional<Pair<String, byte[]>> get(String vspId, Version version) throws IOException {
714 OrchestrationTemplateEntity orchestrationTemplateEntity = orchestrationTemplateDao.get(vspId, version);
715 if (isOrchestrationTemplateMissing(orchestrationTemplateEntity)) {
716 return Optional.empty();
718 if (CommonUtil.isFileOriginFromZip(orchestrationTemplateEntity.getFileSuffix())) {
719 return Optional.of(new ImmutablePair<>(OnboardingTypesEnum.ZIP.toString(),
720 candidateService.getZipData(orchestrationTemplateEntity.getContentData())));
722 return Optional.of(new ImmutablePair<>(orchestrationTemplateEntity.getFileSuffix(), orchestrationTemplateEntity.getContentData().array()));
725 void updateUniqueName(String oldVspName, String newVspName) {
726 uniqueValueUtil.updateUniqueValue(VendorSoftwareProductConstants.UniqueValues.VENDOR_SOFTWARE_PRODUCT_NAME, oldVspName, newVspName);
730 public Collection<ComputeEntity> getComputeByVsp(String vspId, Version version) {
731 return computeDao.listByVsp(vspId, version);
734 private boolean isOrchestrationTemplateMissing(OrchestrationTemplateEntity orchestrationTemplate) {
735 return orchestrationTemplate == null || orchestrationTemplate.getContentData() == null || orchestrationTemplate.getFileSuffix() == null
736 || orchestrationTemplate.getFileName() == null;
739 private boolean isServiceModelMissing(ToscaServiceModel serviceModel) {
740 return serviceModel == null || serviceModel.getEntryDefinitionServiceTemplate() == null;
743 public static class Builder {
745 private VspMergeDao vspMergeDao;
746 private OrchestrationTemplateDao orchestrationTemplateDao;
747 private OrchestrationTemplateCandidateManager orchestrationTemplateCandidateManager;
748 private VendorSoftwareProductInfoDao vspInfoDao;
749 private VendorLicenseFacade vendorLicenseFacade;
750 private ServiceModelDao<ToscaServiceModel> serviceModelDao;
751 private EnrichedServiceModelDao<ToscaServiceModel> enrichedServiceModelDao;
752 private VendorLicenseArtifactsService licenseArtifactsService;
753 private InformationArtifactGenerator informationArtifactGenerator;
754 private PackageInfoDao packageInfoDao;
755 private DeploymentFlavorDao deploymentFlavorDao;
756 private ComponentDao componentDao;
757 private ComponentDependencyModelDao componentDependencyModelDao;
758 private NicDao nicDao;
759 private ComputeDao computeDao;
760 private ImageDao imageDao;
761 private ManualVspToscaManager manualVspToscaManager;
762 private UniqueValueDao uniqueValueDao;
763 private CandidateService candidateService;
765 public Builder vspMerge(VspMergeDao vspMergeDao) {
766 this.vspMergeDao = vspMergeDao;
770 public Builder orchestrationTemplate(OrchestrationTemplateDao orchestrationTemplateDao) {
771 this.orchestrationTemplateDao = orchestrationTemplateDao;
775 public Builder orchestrationTemplateCandidateManager(OrchestrationTemplateCandidateManager orchestrationTemplateCandidateManager) {
776 this.orchestrationTemplateCandidateManager = orchestrationTemplateCandidateManager;
780 public Builder vspInfo(VendorSoftwareProductInfoDao vspInfoDao) {
781 this.vspInfoDao = vspInfoDao;
785 public Builder vendorLicenseFacade(VendorLicenseFacade vendorLicenseFacade) {
786 this.vendorLicenseFacade = vendorLicenseFacade;
790 public Builder serviceModel(ServiceModelDao<ToscaServiceModel> serviceModelDao) {
791 this.serviceModelDao = serviceModelDao;
795 public Builder enrichedServiceModel(EnrichedServiceModelDao<ToscaServiceModel> enrichedServiceModelDao) {
796 this.enrichedServiceModelDao = enrichedServiceModelDao;
800 public Builder licenseArtifactsService(VendorLicenseArtifactsService licenseArtifactsService) {
801 this.licenseArtifactsService = licenseArtifactsService;
805 public Builder informationArtifactGenerator(InformationArtifactGenerator informationArtifactGenerator) {
806 this.informationArtifactGenerator = informationArtifactGenerator;
810 public Builder packageInfo(PackageInfoDao packageInfoDao) {
811 this.packageInfoDao = packageInfoDao;
815 public Builder deploymentFlavor(DeploymentFlavorDao deploymentFlavorDao) {
816 this.deploymentFlavorDao = deploymentFlavorDao;
820 public Builder component(ComponentDao componentDao) {
821 this.componentDao = componentDao;
825 public Builder componentDependencyModel(ComponentDependencyModelDao componentDependencyModelDao) {
826 this.componentDependencyModelDao = componentDependencyModelDao;
830 public Builder nic(NicDao nicDao) {
831 this.nicDao = nicDao;
835 public Builder compute(ComputeDao computeDao) {
836 this.computeDao = computeDao;
840 public Builder image(ImageDao imageDao) {
841 this.imageDao = imageDao;
845 public Builder manualVspToscaManager(ManualVspToscaManager manualVspToscaManager) {
846 this.manualVspToscaManager = manualVspToscaManager;
850 public Builder uniqueValue(UniqueValueDao uniqueValueDao) {
851 this.uniqueValueDao = uniqueValueDao;
855 public Builder candidateService(CandidateService candidateService) {
856 this.candidateService = candidateService;
860 private void registerToVersioning() {
861 if (serviceModelDao != null) {
862 serviceModelDao.registerVersioning(VendorSoftwareProductConstants.VENDOR_SOFTWARE_PRODUCT_VERSIONABLE_TYPE);
864 if (enrichedServiceModelDao != null) {
865 enrichedServiceModelDao.registerVersioning(VendorSoftwareProductConstants.VENDOR_SOFTWARE_PRODUCT_VERSIONABLE_TYPE);
869 public VendorSoftwareProductManager build() {
870 VendorSoftwareProductManagerImpl vendorSoftwareProductManager = new VendorSoftwareProductManagerImpl();
871 vendorSoftwareProductManager.vspMergeDao = this.vspMergeDao;
872 vendorSoftwareProductManager.orchestrationTemplateDao = this.orchestrationTemplateDao;
873 vendorSoftwareProductManager.orchestrationTemplateCandidateManager = this.orchestrationTemplateCandidateManager;
874 vendorSoftwareProductManager.vspInfoDao = this.vspInfoDao;
875 vendorSoftwareProductManager.vendorLicenseFacade = this.vendorLicenseFacade;
876 vendorSoftwareProductManager.serviceModelDao = this.serviceModelDao;
877 vendorSoftwareProductManager.enrichedServiceModelDao = this.enrichedServiceModelDao;
878 vendorSoftwareProductManager.licenseArtifactsService = this.licenseArtifactsService;
879 vendorSoftwareProductManager.informationArtifactGenerator = this.informationArtifactGenerator;
880 vendorSoftwareProductManager.packageInfoDao = this.packageInfoDao;
881 vendorSoftwareProductManager.deploymentFlavorDao = this.deploymentFlavorDao;
882 vendorSoftwareProductManager.componentDao = this.componentDao;
883 vendorSoftwareProductManager.componentDependencyModelDao = this.componentDependencyModelDao;
884 vendorSoftwareProductManager.nicDao = this.nicDao;
885 vendorSoftwareProductManager.computeDao = this.computeDao;
886 vendorSoftwareProductManager.imageDao = this.imageDao;
887 vendorSoftwareProductManager.manualVspToscaManager = this.manualVspToscaManager;
888 vendorSoftwareProductManager.uniqueValueUtil = new UniqueValueUtil(this.uniqueValueDao);
889 vendorSoftwareProductManager.candidateService = candidateService;
890 this.registerToVersioning();
891 return vendorSoftwareProductManager;