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

   1 /*
   2  * Copyright © 2016-2017 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.validation.impl.validators;
  18
  19 import org.apache.commons.collections4.MapUtils;
  20 import org.openecomp.core.validation.ErrorMessageCode;
  21 import org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder;
  22 import org.openecomp.core.validation.types.GlobalValidationContext;
  23 import org.openecomp.sdc.common.errors.Messages;
  24 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  25 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  26 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
  27 import org.openecomp.sdc.heat.datatypes.model.HeatOrchestrationTemplate;
  28 import org.openecomp.sdc.heat.datatypes.model.Resource;
  29 import org.openecomp.sdc.heat.services.HeatConstants;
  30 import org.openecomp.sdc.heat.services.manifest.ManifestUtil;
  31 import org.openecomp.sdc.logging.api.Logger;
  32 import org.openecomp.sdc.logging.api.LoggerFactory;
  33 import org.openecomp.sdc.logging.context.impl.MdcDataDebugMessage;
  34 import org.openecomp.sdc.logging.types.LoggerErrorDescription;
  35 import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
  36 import org.openecomp.sdc.tosca.services.YamlUtil;
  37 import org.openecomp.sdc.validation.Validator;
  38 import org.openecomp.sdc.validation.tos.ContrailResourcesMappingTo;
  39 import org.openecomp.sdc.validation.util.ValidationUtil;
  40
  41 import java.io.InputStream;
  42 import java.util.Map;
  43 import java.util.Objects;
  44 import java.util.Optional;
  45
  46
  47 public class ContrailValidator implements Validator {
  48   private static final MdcDataDebugMessage MDC_DATA_DEBUG_MESSAGE = new MdcDataDebugMessage();
  49   private static final Logger LOGGER = LoggerFactory.getLogger(ContrailValidator.class);
  50   private static final ErrorMessageCode ERROR_CODE_CTL_1 = new ErrorMessageCode("CTL1");
  51   private static final ErrorMessageCode ERROR_CODE_CTL_2 = new ErrorMessageCode("CTL2");
  52   private static final ErrorMessageCode ERROR_CODE_CTL_3 = new ErrorMessageCode("CTL3");
  53   private static final ErrorMessageCode ERROR_CODE_CTL_4 = new ErrorMessageCode("CTL4");
  54
  55   @Override
  56   public void validate(GlobalValidationContext globalContext) {
  57     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(null, null);
  58
  59     ManifestContent manifestContent;
  60     try {
  61       manifestContent = ValidationUtil.validateManifest(globalContext);
  62     } catch (Exception exception) {
  63       LOGGER.debug("",exception);
  64       return;
  65     }
  66     Map<String, FileData.Type> fileTypeMap = ManifestUtil.getFileTypeMap(manifestContent);
  67     ContrailResourcesMappingTo contrailResourcesMappingTo = new ContrailResourcesMappingTo();
  68
  69     globalContext.getFiles().stream()
  70         .filter(fileName -> FileData.isHeatFile(fileTypeMap.get(fileName)))
  71         .forEach(fileName -> validate(fileName,
  72             contrailResourcesMappingTo, globalContext));
  73
  74     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(null, null);
  75   }
  76
  77
  78   private void validate(String fileName,
  79                         ContrailResourcesMappingTo contrailResourcesMappingTo,
  80                         GlobalValidationContext globalContext) {
  81     handleContrailV1AndContrailV2ResourceMerging(fileName, contrailResourcesMappingTo,
  82         globalContext);
  83     validateNoContrailResourceTypeIsInUse(fileName, globalContext);
  84   }
  85
  86
  87   private void handleContrailV1AndContrailV2ResourceMerging(String fileName,
  88                ContrailResourcesMappingTo contrailResourcesMappingTo,
  89                GlobalValidationContext globalContext) {
  90
  91
  92     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage("file", fileName);
  93
  94     Optional<ContrailResourcesMappingTo> fileContrailResourcesMappingTo =
  95         collectHeatFileContrailResources(globalContext, fileName);
  96     fileContrailResourcesMappingTo.ifPresent(contrailResourcesMappingTo::addAll);
  97     addContrailMergeValidationMessageToGlobalContext(globalContext, contrailResourcesMappingTo);
  98
  99     MDC_DATA_DEBUG_MESSAGE.debugExitMessage("file", fileName);
 100   }
 101
 102   private void addContrailMergeValidationMessageToGlobalContext(
 103       GlobalValidationContext globalContext,
 104       ContrailResourcesMappingTo contrailResourcesMappingTo) {
 105
 106
 107     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage(null, null);
 108
 109     if (!MapUtils.isEmpty(contrailResourcesMappingTo.getContrailV1Resources())
 110         && !MapUtils.isEmpty(contrailResourcesMappingTo.getContrailV2Resources())) {
 111       globalContext.addMessage(
 112           contrailResourcesMappingTo.getContrailV1Resources().keySet().iterator().next(),
 113           ErrorLevel.WARNING, ErrorMessagesFormatBuilder.getErrorWithParameters(
 114                   ERROR_CODE_CTL_2, Messages.MERGE_OF_CONTRAIL2_AND_CONTRAIL3_RESOURCES.getErrorMessage(),
 115               contrailResourcesMappingTo.fetchContrailV1Resources(),
 116               contrailResourcesMappingTo.fetchContrailV2Resources()),
 117           LoggerTragetServiceName.MERGE_OF_CONTRAIL_2_AND_3,
 118           LoggerErrorDescription.MERGE_CONTRAIL_2_AND_3);
 119     }
 120
 121     MDC_DATA_DEBUG_MESSAGE.debugExitMessage(null, null);
 122   }
 123
 124   private Optional<ContrailResourcesMappingTo> collectHeatFileContrailResources(
 125       GlobalValidationContext globalContext, String fileName) {
 126     Optional<InputStream> fileContent = globalContext.getFileContent(fileName);
 127     if (!fileContent.isPresent()) {
 128       globalContext.addMessage(fileName, ErrorLevel.ERROR, ErrorMessagesFormatBuilder
 129           .getErrorWithParameters(ERROR_CODE_CTL_1, Messages.INVALID_HEAT_FORMAT_REASON
 130                   .getErrorMessage(),
 131           "The file '" + fileName + "' has no content"),
 132           LoggerTragetServiceName.VALIDATE_HEAT_FORMAT, LoggerErrorDescription.INVALID_HEAT_FORMAT);
 133       return Optional.empty();
 134     }
 135     return fetchContrailResourcesMapping(fileName, fileContent.get());
 136   }
 137
 138   private Optional<ContrailResourcesMappingTo> fetchContrailResourcesMapping(String fileName,
 139           InputStream fileContent ) {
 140
 141
 142     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage("file", fileName);
 143
 144     ContrailResourcesMappingTo contrailResourcesMappingTo = new ContrailResourcesMappingTo();
 145     HeatOrchestrationTemplate heatOrchestrationTemplate;
 146     try {
 147       heatOrchestrationTemplate =
 148           new YamlUtil().yamlToObject(fileContent, HeatOrchestrationTemplate.class);
 149     } catch (Exception ignored) {
 150       LOGGER.debug("",ignored);
 151       // the HeatValidator should handle file that is failing to parse
 152       MDC_DATA_DEBUG_MESSAGE.debugExitMessage("file", fileName);
 153       return Optional.empty();
 154     }
 155     if( !MapUtils.isEmpty(heatOrchestrationTemplate.getResources())) {
 156       heatOrchestrationTemplate.getResources().entrySet()
 157           .forEach(entry -> {
 158             if (entry.getValue().getType().startsWith(HeatConstants.CONTRAIL_RESOURCE_PREFIX)) {
 159               contrailResourcesMappingTo.addContrailV1Resource(fileName, entry.getKey());
 160             } else if (entry.getValue().getType()
 161                 .startsWith(HeatConstants.CONTRAIL_V2_RESOURCE_PREFIX)) {
 162               contrailResourcesMappingTo.addContrailV2Resource(fileName, entry.getKey());
 163             }
 164           });
 165     }
 166
 167     MDC_DATA_DEBUG_MESSAGE.debugExitMessage("file", fileName);
 168     return Optional.of(contrailResourcesMappingTo);
 169   }
 170
 171
 172   private void validateNoContrailResourceTypeIsInUse(String fileName,
 173                                                      GlobalValidationContext globalContext) {
 174
 175     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage("file", fileName);
 176     globalContext.setMessageCode(ERROR_CODE_CTL_4);
 177     HeatOrchestrationTemplate heatOrchestrationTemplate =
 178         ValidationUtil.checkHeatOrchestrationPreCondition(fileName, globalContext);
 179
 180     if (heatOrchestrationTemplate == null) {
 181       return;
 182     }
 183     validateResourcePrefix(fileName, globalContext, heatOrchestrationTemplate);
 184     MDC_DATA_DEBUG_MESSAGE.debugExitMessage("file", fileName);
 185   }
 186
 187   private void validateResourcePrefix(String fileName, GlobalValidationContext globalContext,
 188                                       HeatOrchestrationTemplate heatOrchestrationTemplate) {
 189
 190     MDC_DATA_DEBUG_MESSAGE.debugEntryMessage("file", fileName);
 191     Map<String, Resource> resourcesMap = heatOrchestrationTemplate.getResources();
 192     if(!MapUtils.isEmpty(resourcesMap)) {
 193       for (Map.Entry<String, Resource> resourceEntry : resourcesMap.entrySet()) {
 194         String type = resourceEntry.getValue().getType();
 195         if (Objects.nonNull(type) && type.startsWith(HeatConstants.CONTRAIL_RESOURCE_PREFIX)) {
 196           globalContext.addMessage(fileName, ErrorLevel.WARNING, ErrorMessagesFormatBuilder
 197               .getErrorWithParameters(ERROR_CODE_CTL_3, Messages.CONTRAIL_2_IN_USE.getErrorMessage(),
 198               resourceEntry.getKey()), LoggerTragetServiceName.CONTRAIL_2_IN_USE,
 199               LoggerErrorDescription.CONTRAIL_2_IN_USE);
 200         }
 201       }
 202     }
 203     MDC_DATA_DEBUG_MESSAGE.debugExitMessage("file", fileName);
 204   }
 205
 206 }