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.LicenseType;
103 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.NicEntity;
104 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.OnboardingMethod;
105 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.OrchestrationTemplateEntity;
106 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.PackageInfo;
107 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
108 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspQuestionnaireEntity;
109 import org.openecomp.sdc.vendorsoftwareproduct.errors.ComponentDependencyModelErrorBuilder;
110 import org.openecomp.sdc.vendorsoftwareproduct.errors.ComponentErrorBuilder;
111 import org.openecomp.sdc.vendorsoftwareproduct.errors.DeploymentFlavorErrorBuilder;
112 import org.openecomp.sdc.vendorsoftwareproduct.errors.FileCreationErrorBuilder;
113 import org.openecomp.sdc.vendorsoftwareproduct.errors.InformationArtifactCreationErrorBuilder;
114 import org.openecomp.sdc.vendorsoftwareproduct.errors.NicInternalNetworkErrorBuilder;
115 import org.openecomp.sdc.vendorsoftwareproduct.errors.PackageInvalidErrorBuilder;
116 import org.openecomp.sdc.vendorsoftwareproduct.errors.PackageNotFoundErrorBuilder;
117 import org.openecomp.sdc.vendorsoftwareproduct.errors.TranslationFileCreationErrorBuilder;
118 import org.openecomp.sdc.vendorsoftwareproduct.errors.VendorSoftwareProductInvalidErrorBuilder;
119 import org.openecomp.sdc.vendorsoftwareproduct.informationArtifact.InformationArtifactGenerator;
120 import org.openecomp.sdc.vendorsoftwareproduct.services.filedatastructuremodule.CandidateService;
121 import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIService;
122 import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIServiceImpl;
123 import org.openecomp.sdc.vendorsoftwareproduct.services.schemagenerator.SchemaGenerator;
124 import org.openecomp.sdc.vendorsoftwareproduct.types.QuestionnaireResponse;
125 import org.openecomp.sdc.vendorsoftwareproduct.types.QuestionnaireValidationResult;
126 import org.openecomp.sdc.vendorsoftwareproduct.types.ValidationResponse;
127 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.FilesDataStructure;
128 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.ComponentComputeAssociation;
129 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.CompositionEntityId;
130 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.CompositionEntityType;
131 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.CompositionEntityValidationData;
132 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.DeploymentFlavor;
133 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.NetworkType;
134 import org.openecomp.sdc.vendorsoftwareproduct.types.composition.Nic;
135 import org.openecomp.sdc.vendorsoftwareproduct.types.schemagenerator.ComponentQuestionnaireSchemaInput;
136 import org.openecomp.sdc.vendorsoftwareproduct.types.schemagenerator.SchemaTemplateContext;
137 import org.openecomp.sdc.vendorsoftwareproduct.types.schemagenerator.SchemaTemplateInput;
138 import org.openecomp.sdc.vendorsoftwareproduct.utils.ComponentDependencyTracker;
139 import org.openecomp.sdc.versioning.VersioningManager;
140 import org.openecomp.sdc.versioning.VersioningManagerFactory;
141 import org.openecomp.sdc.versioning.VersioningUtil;
142 import org.openecomp.sdc.versioning.dao.types.Version;
144 public class VendorSoftwareProductManagerImpl implements VendorSoftwareProductManager {
146 private static final Logger LOGGER = LoggerFactory.getLogger(VendorSoftwareProductManagerImpl.class);
147 private VspMergeDao vspMergeDao;
148 private OrchestrationTemplateDao orchestrationTemplateDao;
149 private OrchestrationTemplateCandidateManager orchestrationTemplateCandidateManager;
150 private VendorSoftwareProductInfoDao vspInfoDao;
151 private VendorLicenseFacade vendorLicenseFacade;
152 private ServiceModelDao<ToscaServiceModel> serviceModelDao;
153 private EnrichedServiceModelDao<ToscaServiceModel> enrichedServiceModelDao;
154 private VendorLicenseArtifactsService licenseArtifactsService;
155 private InformationArtifactGenerator informationArtifactGenerator;
156 private PackageInfoDao packageInfoDao;
157 private DeploymentFlavorDao deploymentFlavorDao;
158 private ComponentDao componentDao;
159 private ComponentDependencyModelDao componentDependencyModelDao;
160 private NicDao nicDao;
161 private ComputeDao computeDao;
162 private ImageDao imageDao;
163 private ManualVspToscaManager manualVspToscaManager;
164 private UniqueValueUtil uniqueValueUtil;
165 private CandidateService candidateService;
167 private static ErrorCode createMissingMandatoryFieldError(String fieldName) {
168 return new ValidationErrorBuilder("must be supplied", fieldName).build();
172 public ValidationResponse validate(VspDetails vspDetails) throws IOException {
173 List<ErrorCode> vspErrors = new ArrayList<>(validateVspFields(vspDetails));
174 ValidationResponse validationResponse = new ValidationResponse();
175 if (Objects.nonNull(vspDetails.getOnboardingMethod()) && OnboardingMethod.Manual.name().equals(vspDetails.getOnboardingMethod())) {
176 validateManualOnboardingMethod(vspDetails, validationResponse, vspErrors);
178 validateOrchestrationTemplateCandidate(validationResponse, vspErrors, vspDetails.getId(), vspDetails.getVersion());
179 if (!validationResponse.isValid()) {
180 return validationResponse;
182 validateLicense(vspDetails, vspErrors);
183 OrchestrationTemplateEntity orchestrationTemplate = orchestrationTemplateDao.get(vspDetails.getId(), vspDetails.getVersion());
184 ToscaServiceModel serviceModel = serviceModelDao.getServiceModel(vspDetails.getId(), vspDetails.getVersion());
185 if (isOrchestrationTemplateMissing(orchestrationTemplate) || isServiceModelMissing(serviceModel)) {
186 vspErrors.add(VendorSoftwareProductInvalidErrorBuilder
187 .vendorSoftwareProductMissingServiceModelErrorBuilder(vspDetails.getId(), vspDetails.getVersion()));
189 validationResponse.setUploadDataErrors(validateOrchestrationTemplate(orchestrationTemplate));
191 QuestionnaireValidationResult questionnaireValidationResult = validateQuestionnaire(vspDetails.getId(), vspDetails.getVersion(),
192 vspDetails.getOnboardingMethod());
193 if (Objects.nonNull(questionnaireValidationResult)) {
194 if (validationResponse.getQuestionnaireValidationResult() == null
195 || validationResponse.getQuestionnaireValidationResult().getValidationData() == null) {
196 validationResponse.setQuestionnaireValidationResult(questionnaireValidationResult);
198 validationResponse.getQuestionnaireValidationResult().getValidationData().addAll(questionnaireValidationResult.getValidationData());
201 Collection<ComponentDependencyModelEntity> componentDependencies = componentDependencyModelDao
202 .list(new ComponentDependencyModelEntity(vspDetails.getId(), vspDetails.getVersion(), null));
203 if (validateComponentDependencies(componentDependencies)) {
204 vspErrors.add(ComponentDependencyModelErrorBuilder.getCyclicDependencyComponentErrorBuilder());
206 validationResponse.setVspErrors(vspErrors);
207 validationResponse.setLicensingDataErrors(validateLicensingData(vspDetails));
208 return validationResponse;
211 private void validateLicense(VspDetails vspDetails, List<ErrorCode> vspErrors) {
212 if (vspDetails.getVlmVersion() != null || vspDetails.getLicenseAgreement() != null || vspDetails.getFeatureGroups() != null) {
213 vspErrors.addAll(validateMandatoryLicenseFields(vspDetails));
217 private void validateOrchestrationTemplateCandidate(ValidationResponse validationResponse, List<ErrorCode> vspErrors, String vspId,
219 orchestrationTemplateCandidateManager.getInfo(vspId, version).ifPresent(candidateInfo -> {
220 String fileName = candidateInfo.getFileName();
221 vspErrors.add(candidateInfo.getValidationData().isEmpty() ? candidateDataNotProcessedOrAbortedErrorBuilder(fileName)
222 : invalidProcessedCandidate(fileName));
223 validationResponse.setVspErrors(vspErrors);
227 private void validateManualOnboardingMethod(VspDetails vspDetails, ValidationResponse validationResponse, List<ErrorCode> vspErrors) {
228 vspErrors.addAll(validateMandatoryLicenseFields(vspDetails));
229 Collection<DeploymentFlavorEntity> deploymentFlavors = deploymentFlavorDao
230 .list(new DeploymentFlavorEntity(vspDetails.getId(), vspDetails.getVersion(), null));
231 if (CollectionUtils.isEmpty(deploymentFlavors)) {
232 vspErrors.add(vspMissingDeploymentFlavorErrorBuilder());
234 vspErrors.addAll(validateDeploymentFlavors(deploymentFlavors));
235 Set<CompositionEntityValidationData> componentValidationResult = componentValidation(vspDetails.getId(), vspDetails.getVersion());
236 if (!CollectionUtils.isEmpty(componentValidationResult)) {
237 if (validationResponse.getQuestionnaireValidationResult() == null
238 || validationResponse.getQuestionnaireValidationResult().getValidationData() == null) {
239 validationResponse.setQuestionnaireValidationResult(new QuestionnaireValidationResult(componentValidationResult));
241 validationResponse.getQuestionnaireValidationResult().getValidationData().addAll(componentValidationResult);
247 public Map<String, List<ErrorMessage>> compile(String vspId, Version version) {
248 ToscaServiceModel serviceModel = OnboardingMethod.Manual.name().equals(getValidatedVsp(vspId, version).getOnboardingMethod())
249 //Generate Tosca service model for Manual Onboarding flow
250 ? manualVspToscaManager.generateToscaModel(manualVspToscaManager.gatherVspInformation(vspId, version))
251 : serviceModelDao.getServiceModel(vspId, version);
252 return compile(vspId, version, serviceModel);
255 private boolean validateComponentDependencies(Collection<ComponentDependencyModelEntity> componentDependencies) {
256 ComponentDependencyTracker dependencyTracker = new ComponentDependencyTracker();
257 for (ComponentDependencyModelEntity componentDependency : componentDependencies) {
258 dependencyTracker.addDependency(componentDependency.getSourceComponentId(), componentDependency.getTargetComponentId());
260 return dependencyTracker.isCyclicDependencyPresent();
263 private Collection<ErrorCode> validateDeploymentFlavors(Collection<DeploymentFlavorEntity> deploymentFlavors) {
264 Collection<ErrorCode> errorCodeList = new ArrayList<>();
265 if (!CollectionUtils.isEmpty(deploymentFlavors)) {
266 deploymentFlavors.forEach(deploymentFlavor -> {
267 DeploymentFlavorEntity deployment = deploymentFlavorDao.get(deploymentFlavor);
268 DeploymentFlavor deploymentLocalFlavor = deployment.getDeploymentFlavorCompositionData();
269 if (deploymentLocalFlavor != null) {
270 if (deploymentLocalFlavor.getFeatureGroupId() == null) {
271 ErrorCode deploymentFlavorErrorBuilder = DeploymentFlavorErrorBuilder
272 .getFeatureGroupMandatoryErrorBuilder(deploymentLocalFlavor.getModel());
273 errorCodeList.add(deploymentFlavorErrorBuilder);
275 validateComponentComputeAssociations(errorCodeList, deploymentFlavor, deployment, deploymentLocalFlavor);
279 return errorCodeList;
282 private void validateComponentComputeAssociations(Collection<ErrorCode> errorCodeList, DeploymentFlavorEntity deploymentFlavor,
283 DeploymentFlavorEntity deployment, DeploymentFlavor deploymentlocalFlavor) {
284 List<ComponentComputeAssociation> componentComputeAssociations = deploymentlocalFlavor.getComponentComputeAssociations();
285 if (CollectionUtils.isEmpty(componentComputeAssociations)) {
286 validateCompositionEntity(errorCodeList, deploymentFlavor, deployment, deploymentlocalFlavor);
288 componentComputeAssociations.forEach(componentComputeAssociation -> {
289 if (componentComputeAssociation == null || !(componentComputeAssociation.getComponentId() != null
290 && componentComputeAssociation.getComputeFlavorId() != null)) {
291 validateCompositionEntity(errorCodeList, deploymentFlavor, deployment, deploymentlocalFlavor);
297 private void validateCompositionEntity(Collection<ErrorCode> errorCodeList, DeploymentFlavorEntity deploymentFlavor,
298 DeploymentFlavorEntity deployment, DeploymentFlavor deploymentlocalFlavor) {
299 CompositionEntityValidationData compositionEntityValidationData = new CompositionEntityValidationData(CompositionEntityType.deployment,
300 deploymentFlavor.getId());
301 compositionEntityValidationData.setEntityName(deployment.getDeploymentFlavorCompositionData().getModel());
302 ErrorCode deploymentFlavorErrorBuilder = DeploymentFlavorErrorBuilder
303 .getInvalidComponentComputeAssociationErrorBuilder(deploymentlocalFlavor.getModel());
304 errorCodeList.add(deploymentFlavorErrorBuilder);
307 private Set<CompositionEntityValidationData> componentValidation(String vspId, Version version) {
308 Set<CompositionEntityValidationData> validationData = new HashSet<>();
309 Collection<ComponentEntity> components = componentDao.list(new ComponentEntity(vspId, version, null));
310 if (!CollectionUtils.isEmpty(components)) {
311 components.forEach(component -> {
312 validateImage(vspId, version, validationData, component);
313 validateNic(vspId, version, validationData, component);
316 return validationData;
319 private void validateNic(String vspId, Version version, Set<CompositionEntityValidationData> validationData, ComponentEntity component) {
320 Collection<NicEntity> nics = nicDao.list(new NicEntity(vspId, version, component.getId(), null));
321 if (CollectionUtils.isNotEmpty(nics)) {
322 nics.forEach(nicEntity -> {
323 NicEntity nic = nicDao.get(new NicEntity(vspId, version, component.getId(), nicEntity.getId()));
324 NetworkType networkType = nic.getNicCompositionData().getNetworkType();
325 String networkId = nic.getNicCompositionData().getNetworkId();
326 if (networkType.equals(NetworkType.Internal) && networkId == null) {
327 CompositionEntityValidationData compositionEntityValidationData = new CompositionEntityValidationData(CompositionEntityType.nic,
329 compositionEntityValidationData.setEntityName(nic.getNicCompositionData().getName());
330 ErrorCode nicInternalNetworkErrorBuilder = NicInternalNetworkErrorBuilder.getNicNullNetworkIdInternalNetworkIdErrorBuilder();
331 List<String> errors = new ArrayList<>();
332 errors.add(nicInternalNetworkErrorBuilder.message());
333 compositionEntityValidationData.setErrors(errors);
334 validationData.add(compositionEntityValidationData);
340 private void validateImage(String vspId, Version version, Set<CompositionEntityValidationData> validationData, ComponentEntity component) {
341 Collection<ImageEntity> images = imageDao.list(new ImageEntity(vspId, version, component.getId(), null));
342 if (CollectionUtils.isEmpty(images)) {
343 CompositionEntityValidationData compositionEntityValidationData = new CompositionEntityValidationData(component.getType(),
345 compositionEntityValidationData.setEntityName(component.getComponentCompositionData().getDisplayName());
346 ErrorCode vfcMissingImageErrorBuilder = ComponentErrorBuilder.vfcMissingImageErrorBuilder();
347 List<String> errors = new ArrayList<>();
348 errors.add(vfcMissingImageErrorBuilder.message());
349 compositionEntityValidationData.setErrors(errors);
350 validationData.add(compositionEntityValidationData);
354 private List<ErrorCode> validateVspFields(VspDetails vspDetails) {
355 List<ErrorCode> errors = new ArrayList<>();
356 if (vspDetails.getName() == null) {
357 errors.add(createMissingMandatoryFieldError("name"));
359 if (vspDetails.getDescription() == null) {
360 errors.add(createMissingMandatoryFieldError("description"));
362 if (vspDetails.getVendorId() == null) {
363 errors.add(createMissingMandatoryFieldError("vendor Id"));
365 if (vspDetails.getCategory() == null) {
366 errors.add(createMissingMandatoryFieldError("category"));
368 if (vspDetails.getSubCategory() == null) {
369 errors.add(createMissingMandatoryFieldError("sub category"));
374 private List<ErrorCode> validateMandatoryLicenseFields(VspDetails vspDetails) {
375 List<ErrorCode> errors = new ArrayList<>();
376 if (vspDetails.getVlmVersion() == null) {
377 errors.add(createMissingMandatoryFieldError("licensing version"));
379 if (vspDetails.getLicenseAgreement() == null) {
380 errors.add(createMissingMandatoryFieldError("license agreement"));
382 if (CollectionUtils.isEmpty(vspDetails.getFeatureGroups())) {
383 errors.add(createMissingMandatoryFieldError("feature groups"));
388 private Map<String, List<ErrorMessage>> compile(String vendorSoftwareProductId, Version version, ToscaServiceModel serviceModel) {
389 if (isServiceModelMissing(serviceModel)) {
390 return Collections.emptyMap();
392 enrichedServiceModelDao.deleteAll(vendorSoftwareProductId, version);
393 if (CollectionUtils.isNotEmpty(serviceModel.getModelList())) {
394 enrichedServiceModelDao.storeServiceModel(vendorSoftwareProductId, version, serviceModel);
395 return Collections.emptyMap();
397 final EnrichmentManager<ToscaServiceModel> enrichmentManager = EnrichmentManagerFactory.getInstance().createInterface();
398 enrichmentManager.init(vendorSoftwareProductId, version);
399 enrichmentManager.setModel(serviceModel);
400 final Map<String, List<ErrorMessage>> enrichErrors = enrichmentManager.enrich();
401 enrichedServiceModelDao.storeServiceModel(vendorSoftwareProductId, version, enrichmentManager.getModel());
405 private Collection<ErrorCode> validateLicensingData(VspDetails vspDetails) {
406 if (vspDetails.getVendorId() != null) {
407 Optional<ErrorCode> errorCode = vendorLicenseFacade.validateVendorForUsage(vspDetails.getVendorId(), vspDetails.getVlmVersion());
408 if (errorCode.isPresent()) {
409 return Collections.singleton(errorCode.get());
412 if (vspDetails.getVendorId() == null || vspDetails.getVlmVersion() == null || vspDetails.getLicenseAgreement() == null || CollectionUtils
413 .isEmpty(vspDetails.getFeatureGroups())) {
414 return Collections.emptyList();
416 return vendorLicenseFacade.validateLicensingData(vspDetails.getVendorId(), vspDetails.getVlmVersion(), vspDetails.getLicenseAgreement(),
417 vspDetails.getFeatureGroups());
421 public VspDetails createVsp(VspDetails vspDetails) {
422 vspInfoDao.create(vspDetails);
423 vspInfoDao.updateQuestionnaireData(vspDetails.getId(), vspDetails.getVersion(),
424 new JsonSchemaDataGenerator(getVspQuestionnaireSchema(null)).generateData());
429 public void updateVsp(VspDetails vspDetails) {
430 VspDetails retrieved = vspInfoDao.get(vspDetails);
431 if (retrieved == null) {
432 throw new CoreException((new ErrorCode.ErrorCodeBuilder()
433 .withMessage(String.format("Vsp with id %s and version %s does not exist.", vspDetails.getId(), vspDetails.getVersion().getId())))
436 vspDetails.setOnboardingMethod(retrieved.getOnboardingMethod());
437 //If any existing feature group is removed from VSP which is also associated in DF then
439 //update DF to remove feature group associations.
440 updateDeploymentFlavor(vspDetails);
441 updateUniqueName(retrieved.getName(), vspDetails.getName());
442 vspInfoDao.update(vspDetails);
445 private void updateDeploymentFlavor(VspDetails vspDetails) {
446 final List<String> featureGroups = vspDetails.getFeatureGroups();
447 if (featureGroups != null) {
448 final Collection<DeploymentFlavorEntity> deploymentFlavorEntities = deploymentFlavorDao
449 .list(new DeploymentFlavorEntity(vspDetails.getId(), vspDetails.getVersion(), null));
450 if (Objects.nonNull(deploymentFlavorEntities)) {
451 for (DeploymentFlavorEntity deploymentFlavorEntity : deploymentFlavorEntities) {
452 updateDeploymentFlavourEntity(featureGroups, deploymentFlavorEntity);
458 private void updateDeploymentFlavourEntity(List<String> featureGroups, DeploymentFlavorEntity deploymentFlavorEntity) {
459 final String featureGroupId = deploymentFlavorEntity.getDeploymentFlavorCompositionData().getFeatureGroupId();
460 if (!featureGroups.contains(featureGroupId)) {
461 DeploymentFlavor deploymentFlavorCompositionData = deploymentFlavorEntity.getDeploymentFlavorCompositionData();
462 deploymentFlavorCompositionData.setFeatureGroupId(null);
463 deploymentFlavorEntity.setDeploymentFlavorCompositionData(deploymentFlavorCompositionData);
464 deploymentFlavorDao.update(deploymentFlavorEntity);
469 public VspDetails getVsp(String vspId, Version version) {
470 return getValidatedVsp(vspId, version);
473 private VspDetails getValidatedVsp(String vspId, Version version) {
474 VspDetails vsp = vspInfoDao.get(new VspDetails(vspId, version));
476 throw new CoreException(new VendorSoftwareProductNotFoundErrorBuilder(vspId).build());
482 public void deleteVsp(String vspId, Version version) {
483 vspMergeDao.deleteHint(vspId, version);
487 public List<PackageInfo> listPackages(String category, String subCategory) {
488 return packageInfoDao.listByCategory(category, subCategory);
492 public File getTranslatedFile(String vspId, Version version) {
493 PackageInfo packageInfo = packageInfoDao.get(new PackageInfo(vspId, version));
494 if (packageInfo == null) {
495 throw new CoreException(new PackageNotFoundErrorBuilder(vspId, version).build());
497 ByteBuffer translatedFileBuffer = packageInfo.getTranslatedFile();
498 if (translatedFileBuffer == null) {
499 throw new CoreException(new PackageInvalidErrorBuilder(vspId, version).build());
501 File translatedFile = new File(VendorSoftwareProductConstants.VSP_PACKAGE_ZIP);
502 try (FileOutputStream fos = new FileOutputStream(translatedFile)) {
503 fos.write(translatedFileBuffer.array());
504 } catch (IOException exception) {
505 throw new CoreException(new TranslationFileCreationErrorBuilder(vspId, version).build(), exception);
507 return translatedFile;
511 public byte[] getOrchestrationTemplateFile(String vspId, Version version) {
512 OrchestrationTemplateEntity uploadData = orchestrationTemplateDao.get(vspId, version);
513 ByteBuffer contentData = uploadData.getContentData();
514 if (contentData == null) {
517 ByteArrayOutputStream baos = new ByteArrayOutputStream();
518 try (final ZipOutputStream zos = new ZipOutputStream(baos); ZipInputStream ignored = new ZipInputStream(
519 new ByteArrayInputStream(contentData.array()))) {
520 zos.write(contentData.array());
521 } catch (IOException exception) {
522 throw new CoreException(new FileCreationErrorBuilder(vspId).build(), exception);
524 return baos.toByteArray();
528 public OrchestrationTemplateEntity getOrchestrationTemplateInfo(String vspId, Version version) {
529 return orchestrationTemplateDao.getInfo(vspId, version);
533 public Optional<FilesDataStructure> getOrchestrationTemplateStructure(String vspId, Version version) {
534 Optional<String> jsonFileDataStructure = orchestrationTemplateDao.getOrchestrationTemplateStructure(vspId, version);
535 if (jsonFileDataStructure.isPresent() && JsonUtil.isValidJson(jsonFileDataStructure.get())) {
536 return Optional.of(JsonUtil.json2Object(jsonFileDataStructure.get(), FilesDataStructure.class));
538 return Optional.empty();
543 public void updatePackage(PackageInfo packageInfo) {
544 packageInfoDao.update(packageInfo);
548 public PackageInfo createPackage(final String vspId, final Version version) throws IOException {
549 final ToscaServiceModel toscaServiceModel = enrichedServiceModelDao.getServiceModel(vspId, version);
550 final VspDetails vspDetails = vspInfoDao.get(new VspDetails(vspId, version));
551 final Version vlmVersion = vspDetails.getVlmVersion();
552 if (vlmVersion != null) {
553 populateVersionsForVlm(vspDetails.getVendorId(), vlmVersion);
555 final PackageInfo packageInfo = createPackageInfo(vspDetails);
556 final ToscaFileOutputServiceCsarImpl toscaServiceTemplateServiceCsar = new ToscaFileOutputServiceCsarImpl(
557 new AsdPackageHelper(new ManifestUtils()));
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 FileContentHandler licenseArtifacts = null;
570 if (!LicenseType.EXTERNAL.name().equals(vspDetails.getLicenseType())) {
571 licenseArtifacts = licenseArtifactsService
572 .createLicenseArtifacts(vspDetails.getId(), vspDetails.getVendorId(), vlmVersion, vspDetails.getFeatureGroups());
574 packageInfo.setTranslatedFile(ByteBuffer.wrap(toscaServiceTemplateServiceCsar.createOutputFile(toscaServiceModel, licenseArtifacts)));
575 packageInfoDao.create(packageInfo);
579 void populateVersionsForVlm(String vlmId, Version vlmVersion) {
580 VersioningManager versioningManager = VersioningManagerFactory.getInstance().createInterface();
581 versioningManager.list(vlmId).stream().filter(version -> version.getId().equalsIgnoreCase(vlmVersion.getId())).findAny()
582 .ifPresent(version -> {
583 vlmVersion.setMinor(version.getMinor());
584 vlmVersion.setMajor(version.getMajor());
588 private PackageInfo createPackageInfo(final VspDetails vspDetails) {
589 final var packageInfo = new PackageInfo(vspDetails.getId(), vspDetails.getVersion());
590 packageInfo.setVspName(vspDetails.getName());
591 packageInfo.setVspDescription(vspDetails.getDescription());
592 packageInfo.setCategory(vspDetails.getCategory());
593 packageInfo.setSubCategory(vspDetails.getSubCategory());
594 packageInfo.setVendorName(vspDetails.getVendorName());
595 packageInfo.setPackageType(VendorSoftwareProductConstants.CSAR);
596 packageInfo.setVendorRelease("1.0"); //todo TBD
597 if (CollectionUtils.isNotEmpty(vspDetails.getModelIdList())) {
598 packageInfo.setModels(new HashSet<>(vspDetails.getModelIdList()));
604 public QuestionnaireResponse getVspQuestionnaire(String vspId, Version version) {
605 VspQuestionnaireEntity retrieved = vspInfoDao.getQuestionnaire(vspId, version);
606 VersioningUtil.validateEntityExistence(retrieved, new VspQuestionnaireEntity(vspId, version), VspDetails.ENTITY_TYPE);
607 String questionnaireData = retrieved.getQuestionnaireData();
608 QuestionnaireResponse questionnaireResponse = new QuestionnaireResponse();
609 questionnaireResponse.setData(questionnaireData);
610 questionnaireResponse.setSchema(getVspQuestionnaireSchema(null));
611 return questionnaireResponse;
615 public void updateVspQuestionnaire(String vspId, Version version, String questionnaireData) {
616 vspInfoDao.updateQuestionnaireData(vspId, version, questionnaireData);
619 private Map<String, List<ErrorMessage>> validateOrchestrationTemplate(OrchestrationTemplateEntity orchestrationTemplate) throws IOException {
620 if (isOrchestrationTemplateMissing(orchestrationTemplate)) {
621 return Collections.emptyMap();
623 Map<String, List<ErrorMessage>> validationErrors = new HashMap<>();
624 FileContentHandler fileContentMap = CommonUtil
625 .validateAndUploadFileContent(OnboardingTypesEnum.getOnboardingTypesEnum(orchestrationTemplate.getFileSuffix()),
626 orchestrationTemplate.getContentData().array());
627 try (InputStream zipFileManifest = fileContentMap.getFileContentAsStream(SdcCommon.MANIFEST_NAME)) {
628 addDummyHeatBase(zipFileManifest, fileContentMap);
629 } catch (Exception e) {
630 LOGGER.error("Invalid package content", e);
632 if (CommonUtil.isFileOriginFromZip(orchestrationTemplate.getFileSuffix())) {
633 ValidationManager validationManager = ValidationManagerUtil.initValidationManager(fileContentMap);
634 validationErrors.putAll(validationManager.validate());
636 return MapUtils.isEmpty(MessageContainerUtil.getMessageByLevel(ErrorLevel.ERROR, validationErrors)) ? null : validationErrors;
639 private FileContentHandler addDummyHeatBase(InputStream zipFileManifest, FileContentHandler fileContentMap) {
640 ManifestContent manifestContent = JsonUtil.json2Object(zipFileManifest, ManifestContent.class);
641 for (FileData fileData : manifestContent.getData()) {
642 if ((fileData.getFile()).contains("dummy_ignore.yaml")) {
643 String filePath = new File("").getAbsolutePath() + "/resources";
644 File envFilePath = new File(filePath + "/base_template.env");
645 File baseFilePath = new File(filePath + "/base_template.yaml");
646 try (InputStream envStream = new FileInputStream(envFilePath); InputStream baseStream = new FileInputStream(baseFilePath);) {
647 fileContentMap.addFile("base_template_dummy_ignore.env", envStream);
648 fileContentMap.addFile("base_template_dummy_ignore.yaml", baseStream);
649 } catch (Exception e) {
650 LOGGER.error("File not found error {}", e);
654 return fileContentMap;
657 private QuestionnaireValidationResult validateQuestionnaire(String vspId, Version version, String onboardingMethod) {
658 // The apis of CompositionEntityDataManager used here are stateful!
660 // so, it must be re-created from scratch when it is used!
661 CompositionEntityDataManager compositionEntityDataManager = CompositionEntityDataManagerFactory.getInstance().createInterface();
662 compositionEntityDataManager.addEntity(vspInfoDao.getQuestionnaire(vspId, version), null);
663 Collection<NicEntity> nics = nicDao.listByVsp(vspId, version);
664 Map<String, List<String>> nicNamesByComponent = new HashMap<>();
665 for (NicEntity nicEntity : nics) {
666 compositionEntityDataManager.addEntity(nicEntity, null);
667 Nic nic = nicEntity.getNicCompositionData();
668 if (nic != null && nic.getName() != null) {
669 List<String> nicNames = nicNamesByComponent.computeIfAbsent(nicEntity.getComponentId(), k -> new ArrayList<>());
670 nicNames.add(nic.getName());
673 Collection<ComponentEntity> components = componentDao.listCompositionAndQuestionnaire(vspId, version);
674 components.forEach(component -> compositionEntityDataManager.addEntity(component,
675 new ComponentQuestionnaireSchemaInput(nicNamesByComponent.get(component.getId()),
676 JsonUtil.json2Object(component.getQuestionnaireData(), Map.class), null, OnboardingMethod.Manual.name().equals(onboardingMethod))));
677 Collection<ComputeEntity> computes = computeDao.listByVsp(vspId, version);
678 computes.forEach(compute -> compositionEntityDataManager.addEntity(compute, null));
679 if (OnboardingMethod.Manual.name().equals(onboardingMethod)) {
680 Collection<ImageEntity> images = imageDao.listByVsp(vspId, version);
681 images.forEach(image -> compositionEntityDataManager.addEntity(image, null));
683 Map<CompositionEntityId, Collection<String>> errorsByEntityId = compositionEntityDataManager.validateEntitiesQuestionnaire();
684 if (MapUtils.isNotEmpty(errorsByEntityId)) {
685 compositionEntityDataManager.buildTrees();
686 compositionEntityDataManager.addErrorsToTrees(errorsByEntityId);
687 return new QuestionnaireValidationResult(compositionEntityDataManager.getAllErrorsByVsp(vspId));
693 public File getInformationArtifact(String vspId, Version version) {
694 VspDetails vspDetails = vspInfoDao.get(new VspDetails(vspId, version));
695 if (vspDetails == null) {
698 String vspName = vspDetails.getName();
699 ByteBuffer infoArtifactAsByteBuffer;
700 File infoArtifactFile;
702 infoArtifactAsByteBuffer = ByteBuffer.wrap(informationArtifactGenerator.generate(vspId, version).getBytes());
703 infoArtifactFile = new File(String.format(VendorSoftwareProductConstants.INFORMATION_ARTIFACT_NAME, vspName));
704 try (OutputStream out = new BufferedOutputStream(new FileOutputStream(infoArtifactFile))) {
705 out.write(infoArtifactAsByteBuffer.array());
707 } catch (IOException ex) {
708 throw new CoreException(new InformationArtifactCreationErrorBuilder(vspId).build(), ex);
710 return infoArtifactFile;
713 String getVspQuestionnaireSchema(SchemaTemplateInput schemaInput) {
714 return SchemaGenerator.generate(SchemaTemplateContext.questionnaire, CompositionEntityType.vsp, schemaInput);
718 public Optional<Pair<String, byte[]>> get(String vspId, Version version) throws IOException {
719 OrchestrationTemplateEntity orchestrationTemplateEntity = orchestrationTemplateDao.get(vspId, version);
720 if (isOrchestrationTemplateMissing(orchestrationTemplateEntity)) {
721 return Optional.empty();
723 if (CommonUtil.isFileOriginFromZip(orchestrationTemplateEntity.getFileSuffix())) {
724 return Optional.of(new ImmutablePair<>(OnboardingTypesEnum.ZIP.toString(),
725 candidateService.getZipData(orchestrationTemplateEntity.getContentData())));
727 return Optional.of(new ImmutablePair<>(orchestrationTemplateEntity.getFileSuffix(), orchestrationTemplateEntity.getContentData().array()));
730 void updateUniqueName(String oldVspName, String newVspName) {
731 uniqueValueUtil.updateUniqueValue(VendorSoftwareProductConstants.UniqueValues.VENDOR_SOFTWARE_PRODUCT_NAME, oldVspName, newVspName);
735 public Collection<ComputeEntity> getComputeByVsp(String vspId, Version version) {
736 return computeDao.listByVsp(vspId, version);
739 private boolean isOrchestrationTemplateMissing(OrchestrationTemplateEntity orchestrationTemplate) {
740 return orchestrationTemplate == null || orchestrationTemplate.getContentData() == null || orchestrationTemplate.getFileSuffix() == null
741 || orchestrationTemplate.getFileName() == null;
744 private boolean isServiceModelMissing(ToscaServiceModel serviceModel) {
745 return serviceModel == null || serviceModel.getEntryDefinitionServiceTemplate() == null;
748 public static class Builder {
750 private VspMergeDao vspMergeDao;
751 private OrchestrationTemplateDao orchestrationTemplateDao;
752 private OrchestrationTemplateCandidateManager orchestrationTemplateCandidateManager;
753 private VendorSoftwareProductInfoDao vspInfoDao;
754 private VendorLicenseFacade vendorLicenseFacade;
755 private ServiceModelDao<ToscaServiceModel> serviceModelDao;
756 private EnrichedServiceModelDao<ToscaServiceModel> enrichedServiceModelDao;
757 private VendorLicenseArtifactsService licenseArtifactsService;
758 private InformationArtifactGenerator informationArtifactGenerator;
759 private PackageInfoDao packageInfoDao;
760 private DeploymentFlavorDao deploymentFlavorDao;
761 private ComponentDao componentDao;
762 private ComponentDependencyModelDao componentDependencyModelDao;
763 private NicDao nicDao;
764 private ComputeDao computeDao;
765 private ImageDao imageDao;
766 private ManualVspToscaManager manualVspToscaManager;
767 private UniqueValueDao uniqueValueDao;
768 private CandidateService candidateService;
770 public Builder vspMerge(VspMergeDao vspMergeDao) {
771 this.vspMergeDao = vspMergeDao;
775 public Builder orchestrationTemplate(OrchestrationTemplateDao orchestrationTemplateDao) {
776 this.orchestrationTemplateDao = orchestrationTemplateDao;
780 public Builder orchestrationTemplateCandidateManager(OrchestrationTemplateCandidateManager orchestrationTemplateCandidateManager) {
781 this.orchestrationTemplateCandidateManager = orchestrationTemplateCandidateManager;
785 public Builder vspInfo(VendorSoftwareProductInfoDao vspInfoDao) {
786 this.vspInfoDao = vspInfoDao;
790 public Builder vendorLicenseFacade(VendorLicenseFacade vendorLicenseFacade) {
791 this.vendorLicenseFacade = vendorLicenseFacade;
795 public Builder serviceModel(ServiceModelDao<ToscaServiceModel> serviceModelDao) {
796 this.serviceModelDao = serviceModelDao;
800 public Builder enrichedServiceModel(EnrichedServiceModelDao<ToscaServiceModel> enrichedServiceModelDao) {
801 this.enrichedServiceModelDao = enrichedServiceModelDao;
805 public Builder licenseArtifactsService(VendorLicenseArtifactsService licenseArtifactsService) {
806 this.licenseArtifactsService = licenseArtifactsService;
810 public Builder informationArtifactGenerator(InformationArtifactGenerator informationArtifactGenerator) {
811 this.informationArtifactGenerator = informationArtifactGenerator;
815 public Builder packageInfo(PackageInfoDao packageInfoDao) {
816 this.packageInfoDao = packageInfoDao;
820 public Builder deploymentFlavor(DeploymentFlavorDao deploymentFlavorDao) {
821 this.deploymentFlavorDao = deploymentFlavorDao;
825 public Builder component(ComponentDao componentDao) {
826 this.componentDao = componentDao;
830 public Builder componentDependencyModel(ComponentDependencyModelDao componentDependencyModelDao) {
831 this.componentDependencyModelDao = componentDependencyModelDao;
835 public Builder nic(NicDao nicDao) {
836 this.nicDao = nicDao;
840 public Builder compute(ComputeDao computeDao) {
841 this.computeDao = computeDao;
845 public Builder image(ImageDao imageDao) {
846 this.imageDao = imageDao;
850 public Builder manualVspToscaManager(ManualVspToscaManager manualVspToscaManager) {
851 this.manualVspToscaManager = manualVspToscaManager;
855 public Builder uniqueValue(UniqueValueDao uniqueValueDao) {
856 this.uniqueValueDao = uniqueValueDao;
860 public Builder candidateService(CandidateService candidateService) {
861 this.candidateService = candidateService;
865 private void registerToVersioning() {
866 if (serviceModelDao != null) {
867 serviceModelDao.registerVersioning(VendorSoftwareProductConstants.VENDOR_SOFTWARE_PRODUCT_VERSIONABLE_TYPE);
869 if (enrichedServiceModelDao != null) {
870 enrichedServiceModelDao.registerVersioning(VendorSoftwareProductConstants.VENDOR_SOFTWARE_PRODUCT_VERSIONABLE_TYPE);
874 public VendorSoftwareProductManager build() {
875 VendorSoftwareProductManagerImpl vendorSoftwareProductManager = new VendorSoftwareProductManagerImpl();
876 vendorSoftwareProductManager.vspMergeDao = this.vspMergeDao;
877 vendorSoftwareProductManager.orchestrationTemplateDao = this.orchestrationTemplateDao;
878 vendorSoftwareProductManager.orchestrationTemplateCandidateManager = this.orchestrationTemplateCandidateManager;
879 vendorSoftwareProductManager.vspInfoDao = this.vspInfoDao;
880 vendorSoftwareProductManager.vendorLicenseFacade = this.vendorLicenseFacade;
881 vendorSoftwareProductManager.serviceModelDao = this.serviceModelDao;
882 vendorSoftwareProductManager.enrichedServiceModelDao = this.enrichedServiceModelDao;
883 vendorSoftwareProductManager.licenseArtifactsService = this.licenseArtifactsService;
884 vendorSoftwareProductManager.informationArtifactGenerator = this.informationArtifactGenerator;
885 vendorSoftwareProductManager.packageInfoDao = this.packageInfoDao;
886 vendorSoftwareProductManager.deploymentFlavorDao = this.deploymentFlavorDao;
887 vendorSoftwareProductManager.componentDao = this.componentDao;
888 vendorSoftwareProductManager.componentDependencyModelDao = this.componentDependencyModelDao;
889 vendorSoftwareProductManager.nicDao = this.nicDao;
890 vendorSoftwareProductManager.computeDao = this.computeDao;
891 vendorSoftwareProductManager.imageDao = this.imageDao;
892 vendorSoftwareProductManager.manualVspToscaManager = this.manualVspToscaManager;
893 vendorSoftwareProductManager.uniqueValueUtil = new UniqueValueUtil(this.uniqueValueDao);
894 vendorSoftwareProductManager.candidateService = candidateService;
895 this.registerToVersioning();
896 return vendorSoftwareProductManager;