gerrit.onap Code Review - sdc.git/blob

   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.openecomp.core.utilities.json.JsonUtil;
  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.common.utils.SdcCommon;
  25 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  26 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  27 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
  28 import org.openecomp.sdc.logging.api.Logger;
  29 import org.openecomp.sdc.logging.api.LoggerFactory;
  30 import org.openecomp.sdc.logging.types.LoggerConstants;
  31 import org.openecomp.sdc.logging.types.LoggerErrorCode;
  32 import org.openecomp.sdc.logging.types.LoggerErrorDescription;
  33 import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
  34 import org.openecomp.sdc.validation.Validator;
  35
  36 import java.io.InputStream;
  37 import java.util.ArrayList;
  38 import java.util.List;
  39 import java.util.Optional;
  40
  41
  42 public class ManifestValidator implements Validator {
  43   private static final Logger LOGGER = LoggerFactory.getLogger(YamlValidator.class);
  44   private static final ErrorMessageCode ERROR_CODE_MNF_1 = new ErrorMessageCode("MNF1");
  45   private static final ErrorMessageCode ERROR_CODE_MNF_2 = new ErrorMessageCode("MNF2");
  46   private static final ErrorMessageCode ERROR_CODE_MNF_3 = new ErrorMessageCode("MNF3");
  47   private static final ErrorMessageCode ERROR_CODE_MNF_4 = new ErrorMessageCode("MNF4");
  48   private static final ErrorMessageCode ERROR_CODE_MNF_5 = new ErrorMessageCode("MNF5");
  49   private static final ErrorMessageCode ERROR_CODE_MNF_6 = new ErrorMessageCode("MNF6");
  50   private static final ErrorMessageCode ERROR_CODE_MNF_7 = new ErrorMessageCode("MNF7");
  51   private static final ErrorMessageCode ERROR_CODE_MNF_8 = new ErrorMessageCode("MNF8");
  52
  53   @Override
  54   public void validate(GlobalValidationContext globalContext) {
  55     Optional<InputStream> content = globalContext.getFileContent(SdcCommon.MANIFEST_NAME);
  56     ManifestContent manifestContent;
  57
  58     try {
  59       if (content.isPresent()) {
  60         manifestContent = JsonUtil.json2Object(content.get(), ManifestContent.class);
  61       } else {
  62         throw new Exception("The manifest file '" + SdcCommon.MANIFEST_NAME + "' has no content");
  63       }
  64     } catch (Exception re) {
  65       LOGGER.debug("",re);
  66       globalContext.addMessage(SdcCommon.MANIFEST_NAME, ErrorLevel.ERROR,
  67               ErrorMessagesFormatBuilder
  68                       .getErrorWithParameters(ERROR_CODE_MNF_6,
  69                               Messages.INVALID_MANIFEST_FILE.getErrorMessage()),
  70           LoggerTragetServiceName.VALIDATE_MANIFEST_CONTENT,
  71           LoggerErrorDescription.INVALID_MANIFEST);
  72       return;
  73     }
  74
  75     List<String> manifestFiles = getManifestFileList(manifestContent, globalContext);
  76     manifestFiles.stream().filter(name ->
  77         !globalContext.getFileContextMap().containsKey(name)
  78     ).forEach(name -> globalContext
  79         .addMessage(name, ErrorLevel.ERROR,ErrorMessagesFormatBuilder
  80                 .getErrorWithParameters(ERROR_CODE_MNF_4,
  81                         Messages.MISSING_FILE_IN_ZIP.getErrorMessage()),
  82             LoggerTragetServiceName.VALIDATE_FILE_IN_ZIP, LoggerErrorDescription.MISSING_FILE));
  83
  84     globalContext.getFileContextMap().keySet().stream().filter(name ->
  85         isNotManifestFiles(manifestFiles, name) && isNotManifestName(name)
  86     ).forEach(name ->
  87         globalContext.addMessage(name, ErrorLevel.WARNING,
  88                 ErrorMessagesFormatBuilder
  89                         .getErrorWithParameters(ERROR_CODE_MNF_5,
  90                                 Messages.MISSING_FILE_IN_MANIFEST.getErrorMessage()),
  91             LoggerTragetServiceName.VALIDATE_FILE_IN_MANIFEST, LoggerErrorDescription.MISSING_FILE)
  92     );
  93   }
  94
  95   private boolean isNotManifestFiles(List<String> manifestFiles, String name) {
  96     return !manifestFiles.contains(name);
  97   }
  98
  99   private boolean isNotManifestName(String name) {
 100     return !SdcCommon.MANIFEST_NAME.equals(name);
 101   }
 102
 103
 104   private List<String> getManifestFileList(ManifestContent manifestContent,
 105                                            GlobalValidationContext context) {
 106     ManifestScanner manifestScanner = new ManifestScanner();
 107     manifestScanner.scan(null, manifestContent.getData(), context);
 108     return manifestScanner.getFileList();
 109   }
 110
 111
 112   private class ManifestScanner {
 113     private List<String> fileList = new ArrayList<>();
 114
 115     public void scan(FileData fileData, List<FileData> data,
 116                      GlobalValidationContext globalContext) {
 117       if (fileData == null) {
 118         for (FileData childFileData : data) {
 119           validateIfEnvIsAssociatedToHeat(globalContext, childFileData);
 120         }
 121       }
 122       if (fileData != null) {
 123         fileList.add(fileData.getFile());
 124         validateFileTypeVsFileName(globalContext,fileData);
 125       }
 126       if (data == null) {
 127         return;
 128       }
 129       data.forEach(chileFileData -> scan(chileFileData, chileFileData.getData(), globalContext));
 130     }
 131
 132     public List<String> getFileList() {
 133       return this.fileList;
 134     }
 135
 136     private void validateFileTypeVsFileName(GlobalValidationContext globalValidationContext,
 137                                             FileData fileData) {
 138       String fileName = fileData.getFile();
 139       validateIfFileExists(globalValidationContext,fileName);
 140       FileData.Type type = fileData.getType();
 141       if (type == null) {
 142         globalValidationContext.addMessage(fileName, ErrorLevel.ERROR,
 143                 ErrorMessagesFormatBuilder.getErrorWithParameters(ERROR_CODE_MNF_8,
 144                         Messages.INVALID_FILE_TYPE.getErrorMessage()),
 145                 LoggerTragetServiceName.VALIDATE_FILE_TYPE_AND_NAME, "Invalid file type");
 146       } else if (type.equals(FileData.Type.HEAT_NET) || type.equals(FileData.Type.HEAT_VOL)
 147               || type.equals(FileData.Type.HEAT)) {
 148         validateIfFileHasYamlExtenstion(globalValidationContext,fileName);
 149       } else if (type.equals(FileData.Type.HEAT_ENV)) {
 150         validateIfFileHasEnvExtension(globalValidationContext,fileName);
 151       }
 152     }
 153
 154     private void validateIfEnvIsAssociatedToHeat(GlobalValidationContext globalContext,
 155                                                  FileData childFileData) {
 156       if (childFileData.getType() != null
 157               && childFileData.getType().equals(FileData.Type.HEAT_ENV)) {
 158         globalContext.addMessage(childFileData.getFile(), ErrorLevel.ERROR,
 159                 ErrorMessagesFormatBuilder
 160                         .getErrorWithParameters(ERROR_CODE_MNF_1,
 161                                 Messages.ENV_NOT_ASSOCIATED_TO_HEAT.getErrorMessage()),
 162                 LoggerTragetServiceName.SCAN_MANIFEST_STRUCTURE,
 163                 "env file is not associated to HEAT file");
 164       }
 165     }
 166
 167     private void validateIfFileHasEnvExtension(GlobalValidationContext globalValidationContext,
 168                                                String fileName) {
 169       if (fileName != null && !fileName.endsWith(".env")) {
 170         globalValidationContext.addMessage(fileName, ErrorLevel.ERROR,
 171                 ErrorMessagesFormatBuilder
 172                         .getErrorWithParameters(ERROR_CODE_MNF_3,
 173                                 Messages.WRONG_ENV_FILE_EXTENSION.getErrorMessage(),
 174                                 fileName), LoggerTragetServiceName.VALIDATE_FILE_TYPE_AND_NAME,
 175                 "Wrong env file extention");
 176       }
 177     }
 178
 179     private void validateIfFileHasYamlExtenstion(GlobalValidationContext globalValidationContext,
 180                                                  String fileName) {
 181       if (fileName != null && !fileName.endsWith(".yml") && !fileName.endsWith(".yaml")) {
 182         globalValidationContext.addMessage(fileName, ErrorLevel.ERROR,
 183                 ErrorMessagesFormatBuilder
 184                         .getErrorWithParameters(ERROR_CODE_MNF_2,
 185                                 Messages.WRONG_HEAT_FILE_EXTENSION.getErrorMessage(),
 186                                 fileName), LoggerTragetServiceName.VALIDATE_FILE_TYPE_AND_NAME,
 187                 "Wrong HEAT file extention");
 188       }
 189     }
 190
 191     private void validateIfFileExists(GlobalValidationContext globalValidationContext,
 192                                       String fileName) {
 193       if (fileName == null) {
 194         globalValidationContext.addMessage(SdcCommon.MANIFEST_NAME, ErrorLevel.ERROR,
 195                 ErrorMessagesFormatBuilder
 196                         .getErrorWithParameters(ERROR_CODE_MNF_7,
 197                                 Messages.MISSING_FILE_NAME_IN_MANIFEST.getErrorMessage()),
 198                 LoggerTragetServiceName.VALIDATE_FILE_TYPE_AND_NAME,
 199                 "Missing file name in manifest");
 200
 201       }
 202     }
 203
 204   }
 205
 206 }