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.vendorsoftwareproduct.services.impl.filedatastructuremodule;
  18
  19 import org.apache.commons.collections4.CollectionUtils;
  20 import org.openecomp.core.utilities.file.FileContentHandler;
  21 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  22 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
  23 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
  24 import org.openecomp.sdc.vendorsoftwareproduct.services.HeatFileAnalyzer;
  25 import org.openecomp.sdc.vendorsoftwareproduct.services.filedatastructuremodule.ManifestCreator;
  26 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.AnalyzedZipHeatFiles;
  27 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.Constants;
  28 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.FilesDataStructure;
  29 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.Module;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 import java.util.*;
  34 import java.util.regex.Pattern;
  35
  36 public class ManifestCreatorNamingConventionImpl implements ManifestCreator {
  37   protected static final Logger logger =
  38       LoggerFactory.getLogger(ManifestCreatorNamingConventionImpl.class);
  39
  40   private static final String CLOUD_SPECIFIC_FIXED_KEY_WORD = "cloudtech";
  41   private static final String[][] CLOUD_SPECIFIC_KEY_WORDS = {{"k8s", "azure", "aws"}, /* cloud specific technology */
  42                                                               {"charts", "day0", "configtemplate"} /*cloud specific sub type*/};
  43   private static final String CONTROLLER_BLUEPRINT_ARCHIVE_FIXED_KEY_WORD = "CBA";
  44   private static final String HELM_KEY_WORD = "HELM";
  45
  46   @Override
  47   public Optional<ManifestContent> createManifest(
  48       VspDetails vspDetails, FilesDataStructure filesDataStructure) {
  49     if (Objects.isNull(filesDataStructure)) {
  50       return Optional.empty();
  51     }
  52
  53     List<FileData> fileDataList = new ArrayList<>();
  54     addModulesToManifestFileDataList(filesDataStructure, fileDataList);
  55     addNestedToManifest(filesDataStructure, fileDataList);
  56     addArtifactsToManifestFileDataList(filesDataStructure, fileDataList);
  57     ManifestContent manifestContent = createManifest(vspDetails, fileDataList);
  58     return Optional.of(manifestContent);
  59   }
  60
  61   private void addNestedToManifest(
  62       FilesDataStructure filesDataStructure, List<FileData> fileDataList) {
  63     if (CollectionUtils.isNotEmpty(filesDataStructure.getNested())) {
  64       for (String nested : filesDataStructure.getNested()) {
  65         fileDataList.add(createBaseFileData(FileData.Type.HEAT, nested));
  66       }
  67     }
  68   }
  69
  70   @Override
  71   public Optional<ManifestContent> createManifest(VspDetails vspDetails,
  72                                                   FileContentHandler fileContentHandler,
  73                                                   AnalyzedZipHeatFiles analyzedZipHeatFiles) {
  74     logger.info("Trying to generate manifest");
  75     if (Objects.isNull(fileContentHandler)
  76         || CollectionUtils.isEmpty(fileContentHandler.getFileList())) {
  77       logger.info("fileContentHandler or filesList is empty. ManifestContent will not be created");
  78       return Optional.empty();
  79     }
  80
  81     Map<String, byte[]> files = fileContentHandler.getFiles();
  82
  83     List<FileData> fileDataList =
  84         createFileDataListFromZipFiles(fileContentHandler, files,
  85             analyzedZipHeatFiles.getFilesNotEligbleForModules());
  86     ManifestContent manifestContent = createManifest(vspDetails, fileDataList);
  87
  88     return Optional.of(manifestContent);
  89   }
  90
  91   private ManifestContent createManifest(VspDetails vspDetails, List<FileData> fileDataList) {
  92     ManifestContent manifestContent = new ManifestContent();
  93     manifestContent.setName(vspDetails.getName());
  94     manifestContent.setDescription(vspDetails.getDescription());
  95     manifestContent
  96         .setVersion(vspDetails.getVersion() == null ? null : vspDetails.getVersion().toString());
  97     // vsp version, need to check in confluence
  98     manifestContent.setData(fileDataList);
  99     return manifestContent;
 100   }
 101
 102   private List<FileData> createFileDataListFromZipFiles(FileContentHandler fileContentHandler,
 103                                                         Map<String, byte[]> files,
 104                                                         Collection<String> filesNotEligibleForModules) {
 105
 106     Set<String> processedFiles = new HashSet<>();
 107     List<FileData> fileDataList = new ArrayList<>();
 108     for (String fileName : files.keySet()) {
 109       if (processedFiles.contains(fileName)) {
 110         continue;
 111       }
 112       if (isFileBaseFile(fileName)) {
 113         fileDataList
 114             .add(createModuleFileData(
 115                 fileName, true, processedFiles, fileContentHandler.getFileList(), fileDataList));
 116       } else if (isFileModuleFile(fileName, filesNotEligibleForModules)) {
 117         fileDataList
 118             .add(createModuleFileData(
 119                 fileName, false, processedFiles, fileContentHandler.getFileList(), fileDataList));
 120       } else {
 121         if (HeatFileAnalyzer.isYamlFile(fileName)) {
 122           fileDataList.add(createBasicFileData(fileName, FileData.Type.HEAT, null));
 123         } else if (HeatFileAnalyzer.isEnvFile(fileName)) {
 124           fileDataList.add(createBasicFileData(fileName, FileData.Type.HEAT_ENV, null));
 125         } else {
 126           fileDataList.add(createBasicFileData(fileName, FileData.Type.OTHER, null));
 127         }
 128       }
 129     }
 130     return fileDataList;
 131   }
 132
 133   private boolean isFileModuleFile(String fileName, Collection<String> filesCannotBeModule) {
 134     return !filesCannotBeModule.contains(fileName);
 135   }
 136
 137   @Override
 138   public boolean isFileBaseFile(String fileName) {
 139     return Pattern.matches(Constants.BASE_HEAT_REGEX, fileName) && !isVolFile(fileName);
 140   }
 141
 142   protected boolean isCloudSpecificArtifact(String artifact) {
 143       if (artifact.contains(CLOUD_SPECIFIC_FIXED_KEY_WORD)) {
 144           for (int i = 0; i < CLOUD_SPECIFIC_KEY_WORDS.length; i++) {
 145               if (Arrays.stream(CLOUD_SPECIFIC_KEY_WORDS[i]).noneMatch(str -> artifact.contains(str))) {
 146                   return false;
 147               }
 148           }
 149           return true;
 150       } else {
 151           return false;
 152       }
 153   }
 154
 155   private boolean isControllerBlueprintArchive(String artifact) {
 156     return artifact.toUpperCase().contains(CONTROLLER_BLUEPRINT_ARCHIVE_FIXED_KEY_WORD);
 157   }
 158
 159   private boolean isHelm(String artifact) {
 160     return artifact.toUpperCase().contains(HELM_KEY_WORD);
 161   }
 162
 163   private void addArtifactsToManifestFileDataList(
 164       FilesDataStructure filesDataStructure, List<FileData> fileDataList) {
 165     Collection<String> forArtifacts = CollectionUtils
 166         .union(filesDataStructure.getArtifacts(), filesDataStructure.getUnassigned());
 167     if (CollectionUtils.isNotEmpty(forArtifacts)) {
 168       for (String artifact : forArtifacts) {
 169         if (isCloudSpecificArtifact(artifact)) {
 170             fileDataList.add(createBaseFileData(FileData.Type.CLOUD_TECHNOLOGY_SPECIFIC_ARTIFACT, artifact));
 171         } else if (isControllerBlueprintArchive(artifact)) {
 172           fileDataList.add(createBaseFileData(FileData.Type.CONTROLLER_BLUEPRINT_ARCHIVE, artifact));
 173         } else if (isHelm(artifact)) {
 174           fileDataList.add(createBaseFileData(FileData.Type.HELM, artifact));
 175         }
 176         else {
 177           fileDataList.add(createBaseFileData(FileData.Type.OTHER, artifact));
 178         }
 179       }
 180     }
 181   }
 182
 183   private void addModulesToManifestFileDataList(
 184       FilesDataStructure filesDataStructure, List<FileData> fileDataList) {
 185     if (CollectionUtils.isNotEmpty(filesDataStructure.getModules())) {
 186       for (Module module : filesDataStructure.getModules()) {
 187         FileData fileData = createBaseFileData(FileData.Type.HEAT, module.getYaml());
 188         fileData.setBase(module.getIsBase());
 189         addEnv(module, fileData);
 190         addVolume(module, fileData);
 191         fileDataList.add(fileData);
 192       }
 193     }
 194   }
 195
 196   private void addEnv(Module module, FileData fileData) {
 197     if (Objects.nonNull(module.getEnv())) {
 198       FileData env = createBaseFileData(FileData.Type.HEAT_ENV, module.getEnv());
 199       fileData.addFileData(env);
 200     }
 201   }
 202
 203   private void addVolume(Module module, FileData fileData) {
 204     String volModule = module.getVol();
 205     if (Objects.nonNull(volModule)) {
 206       FileData vol = createBaseFileData(FileData.Type.HEAT_VOL, volModule);
 207       if (Objects.nonNull(module.getVolEnv())) {
 208         vol.addFileData(createBaseFileData(FileData.Type.HEAT_ENV, module.getVolEnv()));
 209       }
 210       fileData.addFileData(vol);
 211     }
 212   }
 213
 214   private FileData createBaseFileData(FileData.Type heat, String yaml) {
 215     FileData fileData = new FileData();
 216     fileData.setType(heat);
 217     fileData.setFile(yaml);
 218     return fileData;
 219   }
 220
 221   private FileData createModuleFileData(
 222       String moduleFileName, boolean isBase, Set<String> processedFiles,
 223       Set<String> fileNames, List<FileData> fileDataList) {
 224     FileData moduleFileData = createBasicFileData(moduleFileName, FileData.Type.HEAT, isBase);
 225     Optional<String> volFile = fetchRelatedVolume(moduleFileName, fileNames);
 226     volFile.ifPresent(vol -> {
 227       markFileAsProcessed(vol, processedFiles);
 228       removeFromFileDataListIfAlreadyProcessed(fileDataList, vol);
 229       FileData volFileData = createBasicFileData(vol, FileData.Type.HEAT_VOL, null);
 230       Optional<String> envFile = fetchRelatedEnv(vol, fileNames);
 231       envFile.ifPresent(env -> {
 232         markFileAsProcessed(env, processedFiles);
 233         removeFromFileDataListIfAlreadyProcessed(fileDataList, env);
 234         FileData envFileData = createBasicFileData(env, FileData.Type.HEAT_ENV, null);
 235         volFileData.addFileData(envFileData);
 236       });
 237       moduleFileData.addFileData(volFileData);
 238     });
 239     Optional<String> envFile = fetchRelatedEnv(moduleFileName, fileNames);
 240     envFile.ifPresent(env -> {
 241       markFileAsProcessed(env, processedFiles);
 242       FileData envFileData = createBasicFileData(env, FileData.Type.HEAT_ENV, null);
 243       moduleFileData.addFileData(envFileData);
 244     });
 245     return moduleFileData;
 246   }
 247
 248   private void removeFromFileDataListIfAlreadyProcessed(List<FileData> fileDataList, String vol) {
 249     fileDataList.removeIf(fileData -> fileData.getFile().equals(vol));
 250   }
 251
 252   private FileData createBasicFileData(String fileName, FileData.Type type, Boolean isBase) {
 253     FileData fileData = new FileData();
 254     if (isBase != null) {
 255       fileData.setBase(isBase);
 256     }
 257     fileData.setType(type);
 258     fileData.setFile(fileName);
 259     return fileData;
 260   }
 261
 262   private Optional<String> fetchRelatedEnv(String fileName, Set<String> fileNames) {
 263     String envFileName
 264         = fileName.substring(0, fileName.lastIndexOf(".")) + Constants.ENV_FILE_EXTENSION;
 265     return fileNames.contains(envFileName) ? Optional.of(envFileName) : Optional.empty();
 266   }
 267
 268   private Optional<String> fetchRelatedVolume(String fileName, Set<String> fileNames) {
 269
 270     String volFile1stExt =
 271         extractVolFileName(fileName, ".yaml");
 272     String volFile2ndExt =
 273         extractVolFileName(fileName, ".yml");
 274
 275     if (fileNames.contains(volFile1stExt)) {
 276       return Optional.of(volFile1stExt);
 277     }
 278     if (fileNames.contains(volFile2ndExt)) {
 279       return Optional.of(volFile2ndExt);
 280     }
 281     return Optional.empty();
 282   }
 283
 284   private String extractVolFileName(String fileName, String fileExt) {
 285     return fileName.substring(
 286         0, fileName.lastIndexOf("."))
 287         + Constants.VOL_FILE_NAME_SUFFIX + fileExt;
 288   }
 289
 290
 291   private boolean isVolFile(String fileName) {
 292     return fileName
 293         .endsWith(
 294             Constants.VOL_FILE_NAME_SUFFIX + ".yaml")
 295         || fileName.endsWith(Constants.VOL_FILE_NAME_SUFFIX + ".yml");
 296   }
 297
 298
 299   private void markFileAsProcessed(String fileName, Set<String> processedFiles) {
 300     processedFiles.add(fileName);
 301   }
 302 }