gerrit.onap Code Review - sdc.git/blob

   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
  17 package org.openecomp.sdc.translator.services.heattotosca;
  18
  19 import org.apache.commons.collections4.CollectionUtils;
  20 import org.apache.commons.collections4.MapUtils;
  21 import org.openecomp.core.translator.datatypes.TranslatorOutput;
  22 import org.openecomp.core.utilities.file.FileUtils;
  23 import org.openecomp.sdc.common.errors.CoreException;
  24 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  25 import org.openecomp.sdc.heat.datatypes.model.Environment;
  26 import org.openecomp.sdc.heat.datatypes.model.HeatOrchestrationTemplate;
  27 import org.openecomp.sdc.heat.datatypes.model.Output;
  28 import org.openecomp.sdc.heat.datatypes.model.Resource;
  29 import org.openecomp.sdc.logging.api.Logger;
  30 import org.openecomp.sdc.logging.api.LoggerFactory;
  31 import org.openecomp.sdc.tosca.datatypes.ToscaGroupType;
  32 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
  33 import org.onap.sdc.tosca.datatypes.model.GroupDefinition;
  34 import org.onap.sdc.tosca.datatypes.model.ParameterDefinition;
  35 import org.onap.sdc.tosca.datatypes.model.PropertyType;
  36 import org.onap.sdc.tosca.datatypes.model.ServiceTemplate;
  37 import org.onap.sdc.tosca.datatypes.model.TopologyTemplate;
  38 import org.onap.sdc.tosca.datatypes.model.heatextend.ParameterDefinitionExt;
  39 import org.openecomp.sdc.tosca.services.DataModelUtil;
  40 import org.openecomp.sdc.tosca.services.ToscaConstants;
  41 import org.openecomp.sdc.tosca.services.ToscaFileOutputService;
  42 import org.openecomp.sdc.tosca.services.ToscaUtil;
  43 import org.onap.sdc.tosca.services.YamlUtil;
  44 import org.openecomp.sdc.tosca.services.impl.ToscaFileOutputServiceCsarImpl;
  45 import org.openecomp.sdc.translator.datatypes.heattotosca.AttachedResourceId;
  46 import org.openecomp.sdc.translator.datatypes.heattotosca.TranslationContext;
  47 import org.openecomp.sdc.translator.datatypes.heattotosca.to.FileDataCollection;
  48 import org.openecomp.sdc.translator.services.heattotosca.errors.ResourceNotFoundInHeatFileErrorBuilder;
  49 import org.openecomp.sdc.translator.services.heattotosca.globaltypes.GlobalTypesGenerator;
  50 import org.openecomp.sdc.translator.services.heattotosca.mapping.TranslatorHeatToToscaParameterConverter;
  51
  52 import java.util.ArrayList;
  53 import java.util.HashMap;
  54 import java.util.HashSet;
  55 import java.util.List;
  56 import java.util.Map;
  57 import java.util.Objects;
  58 import java.util.Optional;
  59 import java.util.Set;
  60
  61 public class TranslationService {
  62
  63     protected static Logger logger = LoggerFactory.getLogger(TranslationService.class);
  64
  65     /**
  66      * Gets types to process by translator.
  67      *
  68      * @return the types to process by translator
  69      */
  70     public static Set<FileData.Type> getTypesToProcessByTranslator() {
  71         Set<FileData.Type> types = new HashSet<>();
  72         types.add(FileData.Type.HEAT);
  73         types.add(FileData.Type.HEAT_VOL);
  74         return types;
  75     }
  76
  77     /**
  78      * Translate heat files translator output.
  79      *
  80      * @param translationContext the translation context
  81      * @return the translator output
  82      */
  83     public TranslatorOutput translateHeatFiles(TranslationContext translationContext) {
  84         ServiceTemplate mainServiceTemplate = createMainServiceTemplate(translationContext);
  85         List<FileData> fileDataList = translationContext.getManifest().getContent().getData();
  86         FileDataCollection fileDataCollection = HeatToToscaUtil.getFileCollectionsByFilter(fileDataList,
  87                 TranslationService.getTypesToProcessByTranslator(), translationContext);
  88
  89         if (fileDataCollection.getBaseFile() != null) {
  90             for (FileData fileData : fileDataCollection.getBaseFile()) {
  91                 translateHeatFile(mainServiceTemplate, fileData,  translationContext);
  92             }
  93         }
  94         if (fileDataCollection.getAddOnFiles() != null) {
  95             for (FileData fileData : fileDataCollection.getAddOnFiles()) {
  96                 translateHeatFile(mainServiceTemplate, fileData, translationContext);
  97             }
  98         }
  99
 100         ToscaServiceModel toscaServiceModel =
 101                 HeatToToscaUtil.createToscaServiceModel(mainServiceTemplate, translationContext);
 102
 103         TranslatorOutput translatorOutput = new TranslatorOutput();
 104         //Keeping a copy of tosca service model after first stage of translation for extraction of
 105         // composition data
 106         translatorOutput.setNonUnifiedToscaServiceModel(
 107                 ToscaServiceModel.getClonedServiceModel(toscaServiceModel));
 108         translatorOutput.setToscaServiceModel(toscaServiceModel);
 109         return translatorOutput;
 110     }
 111
 112     private ServiceTemplate createMainServiceTemplate(TranslationContext translationContext) {
 113         ServiceTemplate mainServiceTemplate = new ServiceTemplate();
 114         translationContext.getTranslatedServiceTemplates()
 115                 .put(Constants.MAIN_TEMPLATE_NAME, mainServiceTemplate);
 116         Map<String, String> templateMetadata = new HashMap<>();
 117         templateMetadata.put(ToscaConstants.ST_METADATA_TEMPLATE_NAME, Constants.MAIN_TEMPLATE_NAME);
 118         mainServiceTemplate.setTosca_definitions_version(ToscaConstants.TOSCA_DEFINITIONS_VERSION);
 119         mainServiceTemplate.setMetadata(templateMetadata);
 120         mainServiceTemplate.setTopology_template(new TopologyTemplate());
 121         mainServiceTemplate.setImports(GlobalTypesGenerator.getGlobalTypesImportList());
 122         return mainServiceTemplate;
 123     }
 124
 125     /**
 126      * Translate heat file.
 127      *
 128      * @param serviceTemplate the service template
 129      * @param heatFileData    the heat file data
 130      * @param context         the context
 131      */
 132     public void translateHeatFile(ServiceTemplate serviceTemplate, FileData heatFileData,
 133                                   TranslationContext context) {
 134         String heatFileName = heatFileData.getFile();
 135         HeatOrchestrationTemplate heatOrchestrationTemplate = new YamlUtil()
 136                 .yamlToObject(context.getFileContent(heatFileName), HeatOrchestrationTemplate.class);
 137
 138         translateInputParameters(serviceTemplate, heatOrchestrationTemplate, heatFileData, context,
 139                 heatFileName);
 140
 141         translateResources(heatFileName, serviceTemplate, heatOrchestrationTemplate, context);
 142         translateOutputParameters(serviceTemplate, heatOrchestrationTemplate, heatFileData,
 143                 heatFileName, context);
 144         createHeatStackGroup(serviceTemplate, heatFileData, heatOrchestrationTemplate, context);
 145         handleHeatPseudoParam(heatFileName, serviceTemplate, context);
 146         if (Objects.nonNull(heatFileData.getData())) {
 147             heatFileData.getData().stream().filter(data -> FileData.Type.canBeAssociated(data.getType()))
 148                     .forEach(data -> translateHeatFile(serviceTemplate, data, context));
 149         }
 150     }
 151
 152     private void handleHeatPseudoParam(String heatFileName, ServiceTemplate serviceTemplate,
 153                                        TranslationContext context) {
 154         Map<String, String> translatedHeatPseudoParam =
 155                 context.getUsedHeatPseudoParams().get(heatFileName);
 156         if (Objects.nonNull(translatedHeatPseudoParam)) {
 157             for (String heatPseudoParam : translatedHeatPseudoParam.keySet()) {
 158                 if (!serviceTemplate.getTopology_template().getInputs().containsKey(heatPseudoParam)) {
 159                     ParameterDefinition parameterDefinition = new ParameterDefinition();
 160                     parameterDefinition.setType(PropertyType.STRING.getDisplayName());
 161                     parameterDefinition.setRequired(false);
 162                     String parameterDefinitionId = translatedHeatPseudoParam.get(heatPseudoParam);
 163                     DataModelUtil.addInputParameterToTopologyTemplate(serviceTemplate, parameterDefinitionId,
 164                             parameterDefinition);
 165                 }
 166             }
 167         }
 168     }
 169
 170     private void createHeatStackGroup(ServiceTemplate serviceTemplate, FileData heatFileData,
 171                                       HeatOrchestrationTemplate heatOrchestrationTemplate,
 172                                       TranslationContext context) {
 173         ToscaFileOutputService toscaFileOutputService = new ToscaFileOutputServiceCsarImpl();
 174         final String fileName = heatFileData.getFile();
 175         final String heatStackGroupId = FileUtils.getFileWithoutExtention(fileName) + "_group";
 176
 177         GroupDefinition groupDefinition = new GroupDefinition();
 178         groupDefinition.setType(ToscaGroupType.HEAT_STACK);
 179         groupDefinition.setProperties(new HashMap<>());
 180         groupDefinition.getProperties()
 181                 .put("heat_file", "../" + toscaFileOutputService.getArtifactsFolderName() + "/" + fileName);
 182         String hotDescription = heatOrchestrationTemplate.getDescription();
 183         if (hotDescription != null && !hotDescription.isEmpty()) {
 184             groupDefinition.getProperties().put(Constants.DESCRIPTION_PROPERTY_NAME, hotDescription);
 185         }
 186         groupDefinition.setMembers(new ArrayList<>());
 187         Set<String> heatStackGroupMembersIds = getHeatStackGroupMembers(fileName,
 188                 serviceTemplate, context);
 189         if (CollectionUtils.isEmpty(heatStackGroupMembersIds)) {
 190             return; //not creating a group when no resources are present in the heat input
 191         }
 192         groupDefinition.getMembers().addAll(heatStackGroupMembersIds);
 193         DataModelUtil
 194                 .addGroupDefinitionToTopologyTemplate(serviceTemplate, heatStackGroupId, groupDefinition);
 195     }
 196
 197     private Set<String> getHeatStackGroupMembers(String heatFileName,
 198                                                  ServiceTemplate serviceTemplate,
 199                                                  TranslationContext context) {
 200
 201         Map<String, Set<String>> heatStackGroupMembers = context.getHeatStackGroupMembers();
 202         Set<String> groupMembers = MapUtils.isEmpty(heatStackGroupMembers) ? new HashSet<>()
 203                 : heatStackGroupMembers.get(heatFileName);
 204
 205         if (CollectionUtils.isEmpty(groupMembers)) {
 206             return new HashSet<>();
 207         }
 208
 209         Set<String> updatedMembersIds = new HashSet<>();
 210
 211         groupMembers.forEach(member -> {
 212             if (Objects.nonNull(DataModelUtil.getNodeTemplate(serviceTemplate, member))) {
 213                 updatedMembersIds.add(member);
 214             } else {
 215                 updateSubstitutableGroupMemberId(heatFileName, serviceTemplate, updatedMembersIds);
 216             }
 217         });
 218
 219         return updatedMembersIds;
 220     }
 221
 222     private void updateSubstitutableGroupMemberId(String heatFileName,
 223                                                   ServiceTemplate serviceTemplate,
 224                                                   Set<String> updatedMembersIds) {
 225         Optional<String> substitutableGroupMemberId =
 226                 ToscaUtil.getSubstitutableGroupMemberId(heatFileName, serviceTemplate);
 227
 228         substitutableGroupMemberId.ifPresent(updatedMembersIds::add);
 229     }
 230
 231     private void translateInputParameters(ServiceTemplate serviceTemplate,
 232                                           HeatOrchestrationTemplate heatOrchestrationTemplate,
 233                                           FileData heatFileData, TranslationContext context,
 234                                           String heatFileName) {
 235         if (heatOrchestrationTemplate.getParameters() == null) {
 236             return;
 237         }
 238
 239         Map<String, ParameterDefinition> parameterDefinitionMap =
 240                 TranslatorHeatToToscaParameterConverter
 241                         .parameterConverter(serviceTemplate, heatOrchestrationTemplate.getParameters(),
 242                                 heatOrchestrationTemplate, heatFileName, heatFileData.getParentFile(), context);
 243         Environment heatEnvFile = getHeatEnvFile(heatFileData, context);
 244         Map<String, Object> parameters = heatEnvFile.getParameters();
 245         Object parameterValue;
 246         if (parameters != null) {
 247             for (Map.Entry<String, ParameterDefinition> entry : parameterDefinitionMap.entrySet()) {
 248                 String paramName = entry.getKey();
 249                 parameterValue = parameters.get(paramName);
 250                 if (parameterValue != null) {
 251                     entry.getValue().set_default(TranslatorHeatToToscaParameterConverter
 252                             .getToscaParameterDefaultValue(null, null, parameterValue, entry.getValue().getType(),
 253                                     heatFileName, heatOrchestrationTemplate, context));
 254                 }
 255             }
 256         }
 257
 258
 259         Map<String, ParameterDefinition> inputs = serviceTemplate.getTopology_template().getInputs();
 260         if (Objects.isNull(inputs)) {
 261             serviceTemplate.getTopology_template().setInputs(parameterDefinitionMap);
 262         } else {
 263             setInputs(inputs, parameterDefinitionMap);
 264
 265         }
 266
 267     }
 268
 269     private void setInputs(Map<String, ParameterDefinition> inputs, Map<String, ParameterDefinition> newParameters) {
 270
 271         updateAnnotations(inputs, newParameters);
 272         inputs.putAll(newParameters);
 273
 274     }
 275
 276     private void updateAnnotations(Map<String, ParameterDefinition> inputParameters, Map<String,
 277             ParameterDefinition> newParameters) {
 278             newParameters.entrySet().stream().filter(stringParameterDefinitionEntry ->
 279                     inputParameters.containsKey(stringParameterDefinitionEntry.getKey())
 280                          && isHasAnnotation(inputParameters, stringParameterDefinitionEntry))
 281                             .forEach(stringParameterDefinitionEntry -> {
 282                                 List inputParamVFModuleList = getVFModulesList(
 283                                         inputParameters.get(stringParameterDefinitionEntry.getKey()));
 284                                 List newParamVFModuleList = getVFModulesList(stringParameterDefinitionEntry.getValue());
 285                                 if (inputParamVFModuleList.contains(newParamVFModuleList.get(0))) {
 286                                     newParamVFModuleList.remove(0);
 287                                 }
 288                                 newParamVFModuleList.addAll(inputParamVFModuleList);
 289                             });
 290
 291     }
 292
 293     private boolean isHasAnnotation(Map<String, ParameterDefinition> inputParameters, Map.Entry<String, ParameterDefinition> newParameterSet) {
 294         ParameterDefinitionExt inputParameter = (ParameterDefinitionExt) inputParameters.get(newParameterSet.getKey());
 295         ParameterDefinitionExt newParameter = (ParameterDefinitionExt) newParameterSet.getValue();
 296         return inputParameter.getAnnotations() != null && newParameter.getAnnotations() != null;
 297     }
 298
 299     private List getVFModulesList(ParameterDefinition param) {
 300         ParameterDefinitionExt parameterDefinitionExt = (ParameterDefinitionExt) param;
 301         return (List) parameterDefinitionExt.getAnnotations().get(ToscaConstants.SOURCE_ANNOTATION_ID).getProperties().
 302                 get(ToscaConstants.VF_MODULE_LABEL_PROPERTY_NAME);
 303     }
 304
 305     private void translateOutputParameters(ServiceTemplate serviceTemplate,
 306                                            HeatOrchestrationTemplate heatOrchestrationTemplate,
 307                                            FileData heatFileData, String heatFileName,
 308                                            TranslationContext context) {
 309         if (heatOrchestrationTemplate.getOutputs() == null) {
 310             return;
 311         }
 312         Map<String, ParameterDefinition> parameterDefinitionMap =
 313                 TranslatorHeatToToscaParameterConverter
 314                         .parameterOutputConverter(serviceTemplate, heatOrchestrationTemplate.getOutputs(),
 315                                 heatOrchestrationTemplate, heatFileName, context);
 316         if (serviceTemplate.getTopology_template().getOutputs() != null) {
 317             serviceTemplate.getTopology_template().getOutputs().putAll(parameterDefinitionMap);
 318         } else {
 319             serviceTemplate.getTopology_template().setOutputs(parameterDefinitionMap);
 320         }
 321
 322         if (heatFileData.getBase() != null && heatFileData.getBase().equals(true)) {
 323             updateSharedResources(serviceTemplate, heatFileName, heatOrchestrationTemplate,
 324                     heatOrchestrationTemplate.getOutputs(), context);
 325         }
 326     }
 327
 328     private void updateSharedResources(ServiceTemplate serviceTemplate, String heatFileName,
 329                                        HeatOrchestrationTemplate heatOrchestrationTemplate,
 330                                        Map<String, Output> outputs, TranslationContext context) {
 331         for (Map.Entry<String, Output> parameter : outputs.entrySet()) {
 332             Optional<AttachedResourceId> attachedSharedResourceId = HeatToToscaUtil
 333                     .extractAttachedResourceId(heatFileName, heatOrchestrationTemplate, context,
 334                             parameter.getValue().getValue());
 335             if (attachedSharedResourceId.isPresent() && attachedSharedResourceId.get().isGetResource()
 336                     && attachedSharedResourceId.get().getTranslatedId() != null) {
 337                 String sharedTranslatedResourceId =
 338                         attachedSharedResourceId.get().getTranslatedId().toString();
 339                 updateSharedResource(serviceTemplate, context, parameter, sharedTranslatedResourceId,
 340                         heatOrchestrationTemplate.getResources()
 341                                 .get(attachedSharedResourceId.get().getEntityId()));
 342             } else {
 343                 Optional<String> contrailSharedResourceId = HeatToToscaUtil
 344                         .extractContrailGetResourceAttachedHeatResourceId(parameter.getValue().getValue());
 345                 if (contrailSharedResourceId.isPresent()
 346                         && context.getTranslatedIds().get(heatFileName).get(contrailSharedResourceId.get())
 347                         != null) {
 348                     String sharedTranslatedResourceId = context.getTranslatedIds().get(heatFileName).get
 349                             (contrailSharedResourceId.get());
 350                     ConsolidationDataUtil.removeSharedResource(serviceTemplate, heatOrchestrationTemplate,
 351                             context, parameter.getKey(), contrailSharedResourceId.get(), sharedTranslatedResourceId);
 352                     updateSharedResource(serviceTemplate, context, parameter, sharedTranslatedResourceId,
 353                             heatOrchestrationTemplate.getResources().get(contrailSharedResourceId.get()));
 354                 }
 355             }
 356         }
 357         if (serviceTemplate.getTopology_template().getOutputs() != null
 358                 && serviceTemplate.getTopology_template().getOutputs().size() == 0) {
 359             serviceTemplate.getTopology_template().setOutputs(null);
 360         }
 361     }
 362
 363     private void updateSharedResource(ServiceTemplate serviceTemplate, TranslationContext context,
 364                                       Map.Entry<String, Output> paramName,
 365                                       String sharedTranslatedResourceId, Resource resource) {
 366         context.addHeatSharedResourcesByParam(paramName.getKey(), sharedTranslatedResourceId, resource);
 367         serviceTemplate.getTopology_template().getOutputs().remove(paramName.getKey());
 368     }
 369
 370     private void translateResources(String heatFileName, ServiceTemplate serviceTemplate,
 371                                     HeatOrchestrationTemplate heatOrchestrationTemplate,
 372                                     TranslationContext context) {
 373         if (MapUtils.isEmpty(heatOrchestrationTemplate.getResources())) {
 374             return;
 375         }
 376
 377         for (String resourceId : heatOrchestrationTemplate.getResources().keySet()) {
 378             Resource resource = heatOrchestrationTemplate.getResources().get(resourceId);
 379             if (resource == null) {
 380                 throw new CoreException(
 381                         new ResourceNotFoundInHeatFileErrorBuilder(resourceId, heatFileName).build());
 382             }
 383             ResourceTranslationFactory.getInstance(resource)
 384                     .translateResource(heatFileName, serviceTemplate, heatOrchestrationTemplate, resource,
 385                             resourceId, context);
 386         }
 387     }
 388
 389     private Environment getHeatEnvFile(FileData heatFileData, TranslationContext context) {
 390         List<FileData> fileRelatedDataList = heatFileData.getData();
 391         if (fileRelatedDataList == null) {
 392             return new Environment();
 393         }
 394         for (FileData fileRelatedData : fileRelatedDataList) {
 395             if (fileRelatedData.getType().equals(FileData.Type.HEAT_ENV)) {
 396                 return new YamlUtil().yamlToObject(context.getFileContent(fileRelatedData.getFile()),
 397                         Environment.class);
 398             }
 399         }
 400         return new Environment();
 401     }
 402
 403
 404 }