openecomp-be/lib/openecomp-sdc-validation-lib/openecomp-sdc-validation-impl/src/main/java/org/openecomp/sdc/validation/impl/validators/ContrailValidator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.validation.impl.validators;
  22
  23 import org.apache.commons.collections4.MapUtils;
  24 import org.openecomp.core.validation.ErrorMessageCode;
  25 import org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder;
  26 import org.openecomp.core.validation.types.GlobalValidationContext;
  27 import org.openecomp.sdc.common.errors.Messages;
  28 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  29 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  30 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
  31 import org.openecomp.sdc.heat.datatypes.model.HeatOrchestrationTemplate;
  32 import org.openecomp.sdc.heat.datatypes.model.Resource;
  33 import org.openecomp.sdc.heat.services.HeatConstants;
  34 import org.openecomp.sdc.heat.services.manifest.ManifestUtil;
  35 import org.openecomp.sdc.logging.api.Logger;
  36 import org.openecomp.sdc.logging.api.LoggerFactory;
  37 import org.openecomp.sdc.logging.context.impl.MdcDataDebugMessage;
  38 import org.openecomp.sdc.logging.types.LoggerErrorDescription;
  39 import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
  40 import org.openecomp.sdc.tosca.services.YamlUtil;
  41 import org.openecomp.sdc.validation.Validator;
  42 import org.openecomp.sdc.validation.tos.ContrailResourcesMappingTo;
  43 import org.openecomp.sdc.validation.util.ValidationUtil;
  44
  45 import java.io.InputStream;
  46 import java.util.Map;
  47 import java.util.Objects;
  48 import java.util.Optional;
  49
  50
  51 public class ContrailValidator implements Validator {
  52   public static final MdcDataDebugMessage mdcDataDebugMessage = new MdcDataDebugMessage();
  53   protected static Logger logger = (Logger) LoggerFactory.getLogger(ContrailValidator.class);
  54   private static final ErrorMessageCode ERROR_CODE_CTL_1 = new ErrorMessageCode("CTL1");
  55   private static final ErrorMessageCode ERROR_CODE_CTL_2 = new ErrorMessageCode("CTL2");
  56   private static final ErrorMessageCode ERROR_CODE_CTL_3 = new ErrorMessageCode("CTL3");
  57   private static final ErrorMessageCode ERROR_CODE_CTL_4 = new ErrorMessageCode("CTL4");
  58
  59   @Override
  60   public void validate(GlobalValidationContext globalContext) {
  61     mdcDataDebugMessage.debugEntryMessage(null, null);
  62
  63     ManifestContent manifestContent;
  64     try {
  65       manifestContent = ValidationUtil.validateManifest(globalContext);
  66     } catch (Exception exception) {
  67       logger.debug("",exception);
  68       return;
  69     }
  70     Map<String, FileData.Type> fileTypeMap = ManifestUtil.getFileTypeMap(manifestContent);
  71     ContrailResourcesMappingTo contrailResourcesMappingTo = new ContrailResourcesMappingTo();
  72
  73     globalContext.getFiles().stream()
  74         .filter(fileName -> FileData.isHeatFile(fileTypeMap.get(fileName)))
  75         .forEach(fileName -> validate(fileName, fileTypeMap,
  76             contrailResourcesMappingTo, globalContext));
  77
  78     mdcDataDebugMessage.debugExitMessage(null, null);
  79   }
  80
  81
  82   private void validate(String fileName, Map<String, FileData.Type> fileTypeMap,
  83                         ContrailResourcesMappingTo contrailResourcesMappingTo,
  84                         GlobalValidationContext globalContext) {
  85     handleContrailV1AndContrailV2ResourceMerging(fileName, fileTypeMap, contrailResourcesMappingTo,
  86         globalContext);
  87     validateNoContrailResourceTypeIsInUse(fileName, globalContext);
  88   }
  89
  90
  91   private void handleContrailV1AndContrailV2ResourceMerging(String fileName,
  92                Map<String, FileData.Type> fileTypeMap,
  93                ContrailResourcesMappingTo contrailResourcesMappingTo,
  94                GlobalValidationContext globalContext) {
  95
  96
  97     mdcDataDebugMessage.debugEntryMessage("file", fileName);
  98
  99     Optional<ContrailResourcesMappingTo> fileContrailResourcesMappingTo =
 100         collectHeatFileContrailResources(globalContext, fileName);
 101     if (fileContrailResourcesMappingTo.isPresent()) {
 102       contrailResourcesMappingTo.addAll(fileContrailResourcesMappingTo.get());
 103     }
 104     addContrailMergeValidationMessageToGlobalContext(globalContext, contrailResourcesMappingTo);
 105
 106     mdcDataDebugMessage.debugExitMessage("file", fileName);
 107   }
 108
 109   private void addContrailMergeValidationMessageToGlobalContext(
 110       GlobalValidationContext globalContext,
 111       ContrailResourcesMappingTo contrailResourcesMappingTo) {
 112
 113
 114     mdcDataDebugMessage.debugEntryMessage(null, null);
 115
 116     if (!MapUtils.isEmpty(contrailResourcesMappingTo.getContrailV1Resources())
 117         && !MapUtils.isEmpty(contrailResourcesMappingTo.getContrailV2Resources())) {
 118       globalContext.addMessage(
 119           contrailResourcesMappingTo.getContrailV1Resources().keySet().iterator().next(),
 120           ErrorLevel.WARNING, ErrorMessagesFormatBuilder.getErrorWithParameters(
 121                   ERROR_CODE_CTL_2, Messages.MERGE_OF_CONTRAIL2_AND_CONTRAIL3_RESOURCES.getErrorMessage(),
 122               contrailResourcesMappingTo.fetchContrailV1Resources(),
 123               contrailResourcesMappingTo.fetchContrailV2Resources()),
 124           LoggerTragetServiceName.MERGE_OF_CONTRAIL_2_AND_3,
 125           LoggerErrorDescription.MERGE_CONTRAIL_2_AND_3);
 126     }
 127
 128     mdcDataDebugMessage.debugExitMessage(null, null);
 129   }
 130
 131   private Optional<ContrailResourcesMappingTo> collectHeatFileContrailResources(
 132       GlobalValidationContext globalContext, String fileName) {
 133     Optional<InputStream> fileContent = globalContext.getFileContent(fileName);
 134     if (!fileContent.isPresent()) {
 135       globalContext.addMessage(fileName, ErrorLevel.ERROR, ErrorMessagesFormatBuilder
 136           .getErrorWithParameters(ERROR_CODE_CTL_1, Messages.INVALID_HEAT_FORMAT_REASON
 137                   .getErrorMessage(),
 138           "The file '" + fileName + "' has no content"),
 139           LoggerTragetServiceName.VALIDATE_HEAT_FORMAT, LoggerErrorDescription.INVALID_HEAT_FORMAT);
 140       return Optional.empty();
 141     }
 142     return fetchContrailResourcesMapping(fileName, fileContent.get(), globalContext);
 143   }
 144
 145   private Optional<ContrailResourcesMappingTo> fetchContrailResourcesMapping(String fileName,
 146           InputStream fileContent,
 147           GlobalValidationContext globalContext) {
 148
 149
 150     mdcDataDebugMessage.debugEntryMessage("file", fileName);
 151
 152     ContrailResourcesMappingTo contrailResourcesMappingTo = new ContrailResourcesMappingTo();
 153     HeatOrchestrationTemplate heatOrchestrationTemplate;
 154     try {
 155       heatOrchestrationTemplate =
 156           new YamlUtil().yamlToObject(fileContent, HeatOrchestrationTemplate.class);
 157     } catch (Exception ignored) {
 158       logger.debug("",ignored);
 159       // the HeatValidator should handle file that is failing to parse
 160       mdcDataDebugMessage.debugExitMessage("file", fileName);
 161       return Optional.empty();
 162     }
 163     if( !MapUtils.isEmpty(heatOrchestrationTemplate.getResources())) {
 164       heatOrchestrationTemplate.getResources().entrySet()
 165           .forEach(entry -> {
 166             if (entry.getValue().getType().startsWith(HeatConstants.CONTRAIL_RESOURCE_PREFIX)) {
 167               contrailResourcesMappingTo.addContrailV1Resource(fileName, entry.getKey());
 168             } else if (entry.getValue().getType()
 169                 .startsWith(HeatConstants.CONTRAIL_V2_RESOURCE_PREFIX)) {
 170               contrailResourcesMappingTo.addContrailV2Resource(fileName, entry.getKey());
 171             }
 172           });
 173     }
 174
 175     mdcDataDebugMessage.debugExitMessage("file", fileName);
 176     return Optional.of(contrailResourcesMappingTo);
 177   }
 178
 179
 180   private void validateNoContrailResourceTypeIsInUse(String fileName,
 181                                                      GlobalValidationContext globalContext) {
 182
 183     mdcDataDebugMessage.debugEntryMessage("file", fileName);
 184     globalContext.setMessageCode(ERROR_CODE_CTL_4);
 185     HeatOrchestrationTemplate heatOrchestrationTemplate =
 186         ValidationUtil.checkHeatOrchestrationPreCondition(fileName, globalContext);
 187
 188     if (heatOrchestrationTemplate == null) {
 189       return;
 190     }
 191     validateResourcePrefix(fileName, globalContext, heatOrchestrationTemplate);
 192     mdcDataDebugMessage.debugExitMessage("file", fileName);
 193   }
 194
 195   private void validateResourcePrefix(String fileName, GlobalValidationContext globalContext,
 196                                       HeatOrchestrationTemplate heatOrchestrationTemplate) {
 197
 198     mdcDataDebugMessage.debugEntryMessage("file", fileName);
 199     Map<String, Resource> resourcesMap = heatOrchestrationTemplate.getResources();
 200     if(!MapUtils.isEmpty(resourcesMap)) {
 201       for (Map.Entry<String, Resource> resourceEntry : resourcesMap.entrySet()) {
 202         String type = resourceEntry.getValue().getType();
 203         if (Objects.nonNull(type) && type.startsWith(HeatConstants.CONTRAIL_RESOURCE_PREFIX)) {
 204           globalContext.addMessage(fileName, ErrorLevel.WARNING, ErrorMessagesFormatBuilder
 205               .getErrorWithParameters(ERROR_CODE_CTL_3, Messages.CONTRAIL_2_IN_USE.getErrorMessage(),
 206               resourceEntry.getKey()), LoggerTragetServiceName.CONTRAIL_2_IN_USE,
 207               LoggerErrorDescription.CONTRAIL_2_IN_USE);
 208         }
 209       }
 210     }
 211     mdcDataDebugMessage.debugExitMessage("file", fileName);
 212   }
 213
 214 }