openecomp-be/backend/openecomp-sdc-vendor-software-product-manager/src/main/java/org/openecomp/sdc/vendorsoftwareproduct/impl/orchestration/process/OrchestrationTemplateProcessCsarHandler.java

   1 /*
   2  * Copyright © 2016-2018 European Support Limited
   3  *
   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
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16 package org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.process;
  17
  18 import java.io.ByteArrayInputStream;
  19 import java.io.IOException;
  20 import java.util.ArrayList;
  21 import java.util.HashMap;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.Optional;
  25 import org.apache.commons.collections4.CollectionUtils;
  26 import org.apache.commons.collections4.MapUtils;
  27 import org.openecomp.core.impl.AbstractToscaSolConverter;
  28 import org.openecomp.core.impl.ToscaConverterImpl;
  29 import org.openecomp.core.impl.ToscaModelConverter;
  30 import org.openecomp.core.impl.ToscaSolConverterVnf;
  31 import org.openecomp.core.impl.ToscaSolModelDrivenConverterPnf;
  32 import org.openecomp.core.utilities.file.FileContentHandler;
  33 import org.openecomp.core.utilities.orchestration.OnboardingTypesEnum;
  34 import org.openecomp.core.validation.util.MessageContainerUtil;
  35 import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
  36 import org.openecomp.sdc.common.api.ArtifactTypeEnum;
  37 import org.openecomp.sdc.common.errors.CoreException;
  38 import org.openecomp.sdc.common.utils.SdcCommon;
  39 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  40 import org.openecomp.sdc.datatypes.error.ErrorMessage;
  41 import org.openecomp.sdc.heat.datatypes.structure.HeatStructureTree;
  42 import org.openecomp.sdc.heat.datatypes.structure.ValidationStructureList;
  43 import org.openecomp.sdc.heat.services.tree.ToscaTreeManager;
  44 import org.openecomp.sdc.logging.api.Logger;
  45 import org.openecomp.sdc.logging.api.LoggerFactory;
  46 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
  47 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.OrchestrationTemplateCandidateData;
  48 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
  49 import org.openecomp.sdc.vendorsoftwareproduct.factory.CandidateServiceFactory;
  50 import org.openecomp.sdc.vendorsoftwareproduct.impl.orchestration.OrchestrationUtil;
  51 import org.openecomp.sdc.vendorsoftwareproduct.services.filedatastructuremodule.CandidateService;
  52 import org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi.ETSIServiceImpl;
  53 import org.openecomp.sdc.vendorsoftwareproduct.types.OrchestrationTemplateActionResponse;
  54 import org.openecomp.sdc.vendorsoftwareproduct.types.UploadFileResponse;
  55
  56 public class OrchestrationTemplateProcessCsarHandler implements OrchestrationTemplateProcessHandler {
  57
  58     private static final Logger LOGGER = LoggerFactory.getLogger(OrchestrationTemplateProcessCsarHandler.class);
  59     private static final String SDC_ONBOARDED_PACKAGE_DIR = "Deployment/" + ArtifactTypeEnum.ETSI_PACKAGE.getType() + "/";
  60     private static final String EXT_SEPARATOR = ".";
  61     private final CandidateService candidateService = CandidateServiceFactory.getInstance().createInterface();
  62     private final ToscaTreeManager toscaTreeManager = new ToscaTreeManager();
  63
  64     @Override
  65     public OrchestrationTemplateActionResponse process(VspDetails vspDetails, OrchestrationTemplateCandidateData candidateData) {
  66         UploadFileResponse uploadFileResponse = new UploadFileResponse();
  67         Optional<FileContentHandler> fileContent = OrchestrationUtil
  68             .getFileContentMap(OnboardingTypesEnum.CSAR, uploadFileResponse, candidateData.getContentData().array());
  69         OrchestrationTemplateActionResponse response = new OrchestrationTemplateActionResponse();
  70         if (fileContent.isPresent()) {
  71             try {
  72                 FileContentHandler fileContentHandler = fileContent.get();
  73                 processCsar(vspDetails, fileContentHandler, candidateData, response);
  74             } catch (CoreException e) {
  75                 LOGGER.error(e.getMessage(), e);
  76                 response.addErrorMessageToMap(e.code().id(), e.code().message(), ErrorLevel.ERROR);
  77             } catch (IOException e) {
  78                 LOGGER.error(e.getMessage(), e);
  79                 response.addErrorMessageToMap(SdcCommon.PROCESS_FILE, e.getMessage(), ErrorLevel.ERROR);
  80             }
  81         } else {
  82             if (!uploadFileResponse.getErrors().isEmpty()) {
  83                 response.addStructureErrors(uploadFileResponse.getErrors());
  84             }
  85         }
  86         return response;
  87     }
  88
  89     private void processCsar(VspDetails vspDetails, FileContentHandler fileContentHandler, OrchestrationTemplateCandidateData candidateData,
  90                              OrchestrationTemplateActionResponse response) throws IOException {
  91         response.setFileNames(new ArrayList<>(fileContentHandler.getFileList()));
  92         Map<String, List<ErrorMessage>> errors = validateCsar(fileContentHandler);
  93         toscaTreeManager.createTree();
  94         if (!isValid(errors)) {
  95             response.addStructureErrors(errors);
  96             toscaTreeManager.addErrors(errors);
  97             candidateService
  98                 .updateValidationData(vspDetails.getId(), vspDetails.getVersion(), new ValidationStructureList(toscaTreeManager.getTree()));
  99             return;
 100         }
 101         HeatStructureTree tree = toscaTreeManager.getTree();
 102         final var orchestrationUtil = new OrchestrationUtil();
 103         orchestrationUtil.backupComponentsQuestionnaireBeforeDelete(vspDetails.getId(), vspDetails.getVersion(),
 104             new HashMap<>(), new HashMap<>(), new HashMap<>(), new HashMap<>(), new HashMap<>());
 105         Optional<ByteArrayInputStream> zipByteArrayInputStream = candidateService
 106             .fetchZipFileByteArrayInputStream(vspDetails.getId(), candidateData, null, OnboardingTypesEnum.CSAR, errors);
 107         orchestrationUtil.deleteUploadDataAndContent(vspDetails.getId(), vspDetails.getVersion());
 108         zipByteArrayInputStream.ifPresent(
 109             byteArrayInputStream -> orchestrationUtil.saveUploadData(vspDetails, candidateData, byteArrayInputStream, fileContentHandler, tree));
 110         final var toscaServiceModel = convertToToscaServiceModel(vspDetails.getModelIdList(), fileContentHandler, candidateData);
 111         orchestrationUtil
 112             .saveServiceModel(vspDetails.getId(), vspDetails.getVersion(), toscaServiceModel, toscaServiceModel);
 113         candidateService.deleteOrchestrationTemplateCandidate(vspDetails.getId(), vspDetails.getVersion());
 114     }
 115
 116     private ToscaServiceModel convertToToscaServiceModel(final List<String> modelList, final FileContentHandler fileContentHandler,
 117                                                          final OrchestrationTemplateCandidateData candidateData) throws IOException {
 118         if (CollectionUtils.isNotEmpty(modelList)) {
 119             return handleToscaModelConversion(modelList, fileContentHandler, candidateData);
 120         }
 121         if (new ETSIServiceImpl().isSol004WithToscaMetaDirectory(fileContentHandler)) {
 122             return getToscaServiceModelSol004(fileContentHandler, candidateData);
 123         }
 124         return new ToscaConverterImpl().convert(fileContentHandler);
 125     }
 126
 127     private ToscaServiceModel handleToscaModelConversion(final List<String> modelList, final FileContentHandler fileContentHandler,
 128                                                          final OrchestrationTemplateCandidateData candidateData) throws IOException {
 129         addOriginalOnboardedPackage(fileContentHandler, candidateData);
 130         final var toscaServiceModel = new ToscaModelConverter().convert(fileContentHandler);
 131         toscaServiceModel.setModelList(modelList);
 132         return toscaServiceModel;
 133     }
 134
 135     private ToscaServiceModel getToscaServiceModelSol004(final FileContentHandler fileContentHandler,
 136                                                          final OrchestrationTemplateCandidateData candidateData) throws IOException {
 137         addOriginalOnboardedPackage(fileContentHandler, candidateData);
 138         final ResourceTypeEnum resourceType = new ETSIServiceImpl().getResourceType(fileContentHandler);
 139         return instantiateToscaConverterFor(resourceType).convert(fileContentHandler);
 140     }
 141
 142     private void addOriginalOnboardedPackage(final FileContentHandler fileContentHandler, final OrchestrationTemplateCandidateData candidateData) {
 143         if (OnboardingTypesEnum.CSAR.getType().equalsIgnoreCase(candidateData.getFileSuffix())) {
 144             fileContentHandler
 145                 .addFile(SDC_ONBOARDED_PACKAGE_DIR + candidateData.getOriginalFileName() + EXT_SEPARATOR + candidateData.getOriginalFileSuffix(),
 146                     candidateData.getOriginalFileContentData().array());
 147         } else {
 148             fileContentHandler.addFile(SDC_ONBOARDED_PACKAGE_DIR + candidateData.getFileName() + EXT_SEPARATOR + candidateData.getFileSuffix(),
 149                 candidateData.getContentData().array());
 150         }
 151     }
 152
 153     private AbstractToscaSolConverter instantiateToscaConverterFor(ResourceTypeEnum resourceType) {
 154         if (resourceType == ResourceTypeEnum.PNF) {
 155             return new ToscaSolModelDrivenConverterPnf();
 156         }
 157         // default is VF
 158         return new ToscaSolConverterVnf();
 159     }
 160
 161     private void addFiles(FileContentHandler fileContentHandler) {
 162         for (Map.Entry<String, byte[]> fileEntry : fileContentHandler.getFiles().entrySet()) {
 163             toscaTreeManager.addFile(fileEntry.getKey(), fileEntry.getValue());
 164         }
 165     }
 166
 167     private Map<String, List<ErrorMessage>> validateCsar(FileContentHandler fileContentHandler) {
 168         Map<String, List<ErrorMessage>> errors = new HashMap<>();
 169         addFiles(fileContentHandler);
 170         toscaTreeManager.createTree();
 171         toscaTreeManager.addErrors(errors);
 172         //todo - add tosca validation here to the existing validation framework
 173         return errors;
 174     }
 175
 176     private boolean isValid(Map<String, List<ErrorMessage>> errors) {
 177         return MapUtils.isEmpty(MessageContainerUtil.getMessageByLevel(ErrorLevel.ERROR, errors));
 178     }
 179 }