gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2016-2017 European Support Limited
   3  * Copyright © 2020-2021 Nokia
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 package org.openecomp.sdc.validation.impl.validators;
  18
  19 import java.io.InputStream;
  20 import java.util.Collection;
  21 import java.util.Map;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import org.onap.sdc.tosca.services.MyPropertyUtils;
  25 import org.onap.sdc.tosca.services.StrictMapAppenderConstructor;
  26 import org.openecomp.core.validation.ErrorMessageCode;
  27 import org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder;
  28 import org.openecomp.core.validation.types.GlobalValidationContext;
  29 import org.openecomp.sdc.common.errors.Messages;
  30 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  31 import org.openecomp.sdc.validation.Validator;
  32 import org.openecomp.sdc.validation.impl.util.YamlValidatorUtil;
  33 import org.yaml.snakeyaml.DumperOptions;
  34 import org.yaml.snakeyaml.LoaderOptions;
  35 import org.yaml.snakeyaml.TypeDescription;
  36 import org.yaml.snakeyaml.Yaml;
  37 import org.yaml.snakeyaml.constructor.Constructor;
  38 import org.yaml.snakeyaml.representer.Representer;
  39
  40 public class YamlValidator implements Validator {
  41
  42     private static final ErrorMessageCode ERROR_CODE_YML_1 = new ErrorMessageCode("YML1");
  43     private static final ErrorMessageCode ERROR_CODE_YML_2 = new ErrorMessageCode("YML2");
  44
  45     @Override
  46     public void validate(GlobalValidationContext globalContext) {
  47         Set<String> pmDictionaryFiles = GlobalContextUtil.findPmDictionaryFiles(globalContext);
  48         Collection<String> files = globalContext
  49             .files((fileName, globalValidationContext) -> FileExtensionUtils.isYaml(fileName) && !pmDictionaryFiles.contains(fileName));
  50         files.forEach(fileName -> validate(fileName, globalContext));
  51     }
  52
  53     private void validate(String fileName, GlobalValidationContext globalContext) {
  54         Optional<InputStream> rowContent = globalContext.getFileContent(fileName);
  55         if (rowContent.isEmpty()) {
  56             globalContext.addMessage(fileName, ErrorLevel.ERROR, ErrorMessagesFormatBuilder
  57                 .getErrorWithParameters(ERROR_CODE_YML_1, Messages.INVALID_YAML_FORMAT_REASON.getErrorMessage(),
  58                     Messages.EMPTY_YAML_FILE.getErrorMessage()));
  59             return; /* no need to continue validation */
  60         }
  61
  62         try (var yamlContent = rowContent.get()) {
  63             Constructor constructor = new StrictMapAppenderConstructor(Map.class);
  64             constructor.setAllowDuplicateKeys(false);
  65             constructor.setPropertyUtils(new MyPropertyUtils());
  66             TypeDescription yamlFileDescription = new TypeDescription(Map.class);
  67             constructor.addTypeDescription(yamlFileDescription);
  68             LoaderOptions options = new LoaderOptions();
  69             options.setAllowDuplicateKeys(false);
  70             //No Yaml Constructor takes only Constructor and LoaderOptions, that is why I had to pass anonymous Representer and DumperOptions objects
  71             Object yamlObj = new Yaml(constructor, new Representer(), new DumperOptions(), options).load(yamlContent);
  72
  73             if (yamlObj == null) {
  74                 throw new Exception();
  75             }
  76         } catch (Exception exception) {
  77             globalContext.addMessage(fileName, ErrorLevel.ERROR, ErrorMessagesFormatBuilder
  78                 .getErrorWithParameters(ERROR_CODE_YML_2, Messages
  79                         .INVALID_YAML_FORMAT_REASON.getErrorMessage(),
  80                     YamlValidatorUtil.getParserExceptionReason(exception)));
  81         }
  82     }
  83
  84 }
  85