gerrit.onap Code Review - sdc.git/blob

   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.translator.services.heattotosca.impl.resourcetranslation;
  22
  23 import org.apache.commons.collections4.MapUtils;
  24 import org.junit.AfterClass;
  25 import org.junit.Assert;
  26 import org.junit.Before;
  27 import org.junit.BeforeClass;
  28 import org.openecomp.core.translator.datatypes.TranslatorOutput;
  29 import org.openecomp.core.utilities.file.FileUtils;
  30 import org.openecomp.core.utilities.json.JsonUtil;
  31 import org.openecomp.core.validation.util.MessageContainerUtil;
  32 import org.openecomp.sdc.common.errors.CoreException;
  33 import org.openecomp.sdc.common.errors.ErrorCategory;
  34 import org.openecomp.sdc.common.errors.ErrorCode;
  35 import org.openecomp.sdc.common.togglz.ToggleableFeature;
  36 import org.openecomp.sdc.common.utils.SdcCommon;
  37 import org.openecomp.sdc.datatypes.error.ErrorLevel;
  38 import org.openecomp.sdc.datatypes.error.ErrorMessage;
  39 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  40 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
  41 import org.openecomp.sdc.heat.datatypes.manifest.ManifestFile;
  42 import org.openecomp.sdc.logging.types.LoggerConstants;
  43 import org.openecomp.sdc.logging.types.LoggerErrorCode;
  44 import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
  45 import org.openecomp.sdc.tosca.datatypes.model.ServiceTemplate;
  46 import org.openecomp.sdc.tosca.services.ToscaFileOutputService;
  47 import org.openecomp.sdc.tosca.services.impl.ToscaFileOutputServiceCsarImpl;
  48 import org.openecomp.sdc.translator.TestUtils;
  49 import org.openecomp.sdc.translator.datatypes.heattotosca.TranslationContext;
  50 import org.openecomp.sdc.translator.datatypes.heattotosca.unifiedmodel.consolidation.ComputeTemplateConsolidationData;
  51 import org.openecomp.sdc.translator.datatypes.heattotosca.unifiedmodel.consolidation.ConsolidationData;
  52 import org.openecomp.sdc.translator.datatypes.heattotosca.unifiedmodel.consolidation.FileComputeConsolidationData;
  53 import org.openecomp.sdc.translator.datatypes.heattotosca.unifiedmodel.consolidation.FilePortConsolidationData;
  54 import org.openecomp.sdc.translator.datatypes.heattotosca.unifiedmodel.consolidation.PortTemplateConsolidationData;
  55 import org.openecomp.sdc.translator.datatypes.heattotosca.unifiedmodel.consolidation.TypeComputeConsolidationData;
  56 import org.openecomp.sdc.translator.services.heattotosca.TranslationService;
  57 import org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataValidationType;
  58 import org.togglz.testing.TestFeatureManager;
  59 import org.togglz.testing.TestFeatureManagerProvider;
  60
  61 import java.io.BufferedInputStream;
  62 import java.io.File;
  63 import java.io.FileInputStream;
  64 import java.io.FileOutputStream;
  65 import java.io.IOException;
  66 import java.net.URL;
  67 import java.util.Collection;
  68 import java.util.HashMap;
  69 import java.util.HashSet;
  70 import java.util.List;
  71 import java.util.Map;
  72 import java.util.Set;
  73 import java.util.zip.ZipEntry;
  74 import java.util.zip.ZipInputStream;
  75
  76 import static org.junit.Assert.assertEquals;
  77 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateComputeConnectivityIn;
  78 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateComputeConnectivityOut;
  79 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateDependsOnInConsolidationData;
  80 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateGetAttr;
  81 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateGroupsInConsolidationData;
  82 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateNestedConsolidationData;
  83 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateNestedConsolidationDataNodeTemplateIds;
  84 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validatePortConnectivityIn;
  85 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validatePortConnectivityOut;
  86 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validatePortsInConsolidationData;
  87 import static org.openecomp.sdc.translator.services.heattotosca.buildconsolidationdata.ConsolidationDataTestUtil.validateVolumeInConsolidationData;
  88
  89
  90 public class BaseResourceTranslationTest {
  91
  92   protected String inputFilesPath;
  93   protected String outputFilesPath;
  94   protected TranslationContext translationContext;
  95
  96   private String zipFilename = "VSP.zip";
  97   private TranslationService translationService;
  98   private File translatedZipFile;
  99
 100   private Map<String, byte[]> expectedResultMap = new HashMap<>();
 101   private Set<String> expectedResultFileNameSet = new HashSet<>();
 102
 103   private final String MANIFEST_NAME = SdcCommon.MANIFEST_NAME;
 104   private String validationFilename = "validationOutput.json";
 105
 106   protected static TestFeatureManager manager;
 107
 108   @BeforeClass
 109   public static void enableForwarderFeature(){
 110     manager = new TestFeatureManager(ToggleableFeature.class);
 111     if (!ToggleableFeature.FORWARDER_CAPABILITY.isActive()) {
 112       manager.enable(ToggleableFeature.FORWARDER_CAPABILITY);
 113     }
 114   }
 115
 116
 117   @AfterClass
 118   public static void disableForwarderFeature() {
 119     manager.disable(ToggleableFeature.FORWARDER_CAPABILITY);
 120     manager = null;
 121     TestFeatureManagerProvider.setFeatureManager(null);
 122   }
 123
 124   @Before
 125   public void setUp() throws IOException {
 126     initTranslatorAndTranslate();
 127   }
 128
 129   protected void initTranslatorAndTranslate() throws IOException {
 130     translationService = new TranslationService();
 131     translationContext = new TranslationContext();
 132     translatedZipFile = translateZipFile();
 133   }
 134
 135   protected void testTranslation() throws IOException {
 136
 137     URL url = BaseResourceTranslationTest.class.getResource(outputFilesPath);
 138
 139     String path = url.getPath();
 140     File pathFile = new File(path);
 141     File[] files = pathFile.listFiles();
 142     Assert.assertNotNull("manifest files is empty", files);
 143     for (File expectedFile : files) {
 144       expectedResultFileNameSet.add(expectedFile.getName());
 145       try (FileInputStream input = new FileInputStream(expectedFile)) {
 146         expectedResultMap.put(expectedFile.getName(), FileUtils.toByteArray(input));
 147       }
 148     }
 149
 150     try (FileInputStream fis = new FileInputStream(translatedZipFile);
 151          ZipInputStream zis = new ZipInputStream(new BufferedInputStream(fis))) {
 152       ZipEntry entry;
 153       String name;
 154       String expected;
 155       String actual;
 156
 157       while ((entry = zis.getNextEntry()) != null) {
 158
 159         name = entry.getName()
 160             .substring(entry.getName().lastIndexOf(File.separator) + 1, entry.getName().length());
 161         if (expectedResultFileNameSet.contains(name)) {
 162           expected = new String(expectedResultMap.get(name)).trim().replace("\r", "");
 163           actual = new String(FileUtils.toByteArray(zis)).trim().replace("\r", "");
 164           assertEquals("difference in file: " + name, expected, actual);
 165
 166           expectedResultFileNameSet.remove(name);
 167         }
 168       }
 169       if (expectedResultFileNameSet.isEmpty()) {
 170         expectedResultFileNameSet.forEach(System.out::println);
 171       }
 172     }
 173     assertEquals(0, expectedResultFileNameSet.size());
 174   }
 175
 176   private File translateZipFile() throws IOException {
 177     URL inputFilesUrl = this.getClass().getResource(inputFilesPath);
 178     String path = inputFilesUrl.getPath();
 179     addFilesToTranslator(translationContext, path);
 180     TranslatorOutput translatorOutput = translationService.translateHeatFiles(translationContext);
 181     Assert.assertNotNull(translatorOutput);
 182     if (MapUtils.isNotEmpty(translatorOutput.getErrorMessages()) && MapUtils.isNotEmpty(
 183         MessageContainerUtil
 184             .getMessageByLevel(ErrorLevel.ERROR, translatorOutput.getErrorMessages()))) {
 185       throw new CoreException((new ErrorCode.ErrorCodeBuilder()).withMessage(
 186           "Error in validation " + getErrorAsString(translatorOutput.getErrorMessages()))
 187           .withId("Validation Error").withCategory(ErrorCategory.APPLICATION).build());
 188     }
 189     File file = new File(path + "/" + zipFilename);
 190     file.createNewFile();
 191
 192     try (FileOutputStream fos = new FileOutputStream(file)) {
 193       ToscaFileOutputService toscaFileOutputService = new ToscaFileOutputServiceCsarImpl();
 194       fos.write(
 195           toscaFileOutputService.createOutputFile(translatorOutput.getToscaServiceModel(), null));
 196     }
 197
 198     return file;
 199   }
 200
 201   private String getErrorAsString(Map<String, List<ErrorMessage>> errorMessages) {
 202     StringBuilder sb = new StringBuilder();
 203     errorMessages.entrySet().forEach(
 204         entry -> sb.append("File:").append(entry.getKey()).append(System.lineSeparator())
 205             .append(getErrorList(entry.getValue())));
 206
 207     return sb.toString();
 208   }
 209
 210   private String getErrorList(List<ErrorMessage> errors) {
 211     StringBuilder sb = new StringBuilder();
 212     errors.forEach(
 213         error -> sb.append(error.getMessage()).append("[").append(error.getLevel()).append("]")
 214             .append(System.lineSeparator()));
 215     return sb.toString();
 216   }
 217
 218   public void addFilesToTranslator(TranslationContext translationContext, String path)
 219       throws IOException {
 220     File manifestFile = new File(path);
 221     File[] files = manifestFile.listFiles();
 222     byte[] fileContent;
 223
 224     Assert.assertNotNull("manifest files is empty", files);
 225
 226     for (File file : files) {
 227
 228       try (FileInputStream fis = new FileInputStream(file)) {
 229
 230         fileContent = FileUtils.toByteArray(fis);
 231
 232         if (file.getName().equals(MANIFEST_NAME)) {
 233           addManifest(translationContext, MANIFEST_NAME, fileContent);
 234         } else {
 235           if (!file.getName().equals(zipFilename) && (!file.getName().equals(validationFilename))) {
 236             addFile(translationContext, file.getName(), fileContent);
 237           }
 238         }
 239       }
 240     }
 241   }
 242
 243   public static void addManifest(TranslationContext translationContext,
 244                                  String name, byte[] content) {
 245     ManifestContent manifestData = JsonUtil.json2Object(new String(content), ManifestContent.class);
 246     ManifestFile manifest = new ManifestFile();
 247     manifest.setName(name);
 248     manifest.setContent(manifestData);
 249     translationContext.setManifest(manifest);
 250     translationContext.addFile(name, content);
 251     addFilesFromManifestToTranslationContextManifestFilesMap(translationContext, manifestData
 252         .getData());
 253   }
 254
 255   public static void addFile(TranslationContext translationContext,
 256                              String name, byte[] content) {
 257     translationContext.addFile(name, content);
 258   }
 259
 260   private static void addFilesFromManifestToTranslationContextManifestFilesMap(TranslationContext
 261                                                                                    translationContext, List<FileData> fileDataListFromManifest) {
 262     for (FileData fileFromManfiest : fileDataListFromManifest) {
 263       translationContext.addManifestFile(fileFromManfiest.getFile(), fileFromManfiest.getType());
 264     }
 265   }
 266
 267   public void validateNodeTemplateIdInNestedConsolidationData(){
 268     ConsolidationData consolidationData = translationContext.getConsolidationData();
 269     Map<String, ServiceTemplate> expectedServiceTemplateModels = TestUtils.getServiceTemplates
 270         (expectedResultMap);
 271     Assert.assertNotNull(consolidationData);
 272     validateNestedConsolidationDataNodeTemplateIds(consolidationData,expectedServiceTemplateModels);
 273   }
 274
 275   public void validateComputeTemplateConsolidationData(ConsolidationDataValidationType
 276                                                            validationType,
 277                                                        String testName) {
 278     ConsolidationData consolidationData = translationContext.getConsolidationData();
 279     Map<String, ServiceTemplate> expectedServiceTemplateModels = TestUtils.getServiceTemplates
 280         (expectedResultMap);
 281     Assert.assertNotNull(consolidationData);
 282     Assert.assertNotNull(consolidationData.getComputeConsolidationData());
 283     Set<String> serviceTemplateFileNames = consolidationData.getComputeConsolidationData()
 284         .getAllServiceTemplateFileNames();
 285     Assert.assertNotNull(serviceTemplateFileNames);
 286     for(String serviceTemplateName : serviceTemplateFileNames){
 287       Assert.assertTrue(expectedServiceTemplateModels.containsKey(serviceTemplateName));
 288       ServiceTemplate expectedServiceTemplate = expectedServiceTemplateModels.get
 289           (serviceTemplateName);
 290       FileComputeConsolidationData fileComputeConsolidationData = consolidationData
 291           .getComputeConsolidationData().getFileComputeConsolidationData(serviceTemplateName);
 292       Assert.assertNotNull(fileComputeConsolidationData);
 293       Set<String> computeTypes = fileComputeConsolidationData.getAllComputeTypes();
 294       Assert.assertNotNull(computeTypes);
 295       for(String computeType : computeTypes) {
 296         TypeComputeConsolidationData typeComputeConsolidationData = fileComputeConsolidationData
 297             .getTypeComputeConsolidationData(computeType);
 298         Assert.assertNotNull(typeComputeConsolidationData);
 299
 300         Collection<String> computeNodeTemplateIds = typeComputeConsolidationData
 301             .getAllComputeNodeTemplateIds();
 302         Assert.assertNotNull(computeNodeTemplateIds);
 303         Assert.assertNotEquals(computeNodeTemplateIds.size(), 0);
 304
 305         for(String computeNodeTemplateId : computeNodeTemplateIds) {
 306           ComputeTemplateConsolidationData computeTemplateConsolidationData =
 307               typeComputeConsolidationData.getComputeTemplateConsolidationData
 308                   (computeNodeTemplateId);
 309           switch(validationType){
 310             case VALIDATE_GROUP:
 311               validateGroupsInConsolidationData(computeNodeTemplateId,
 312                   computeTemplateConsolidationData, expectedServiceTemplate);
 313               break;
 314             case VALIDATE_PORT:
 315               validatePortsInConsolidationData(computeNodeTemplateId,
 316                   computeTemplateConsolidationData,
 317                   expectedServiceTemplate);
 318               break;
 319             case VALIDATE_VOLUME:
 320               validateVolumeInConsolidationData(computeNodeTemplateId,
 321                   computeTemplateConsolidationData, expectedServiceTemplate, testName);
 322               break;
 323             case VALIDATE_CONNECTIVITY:
 324               validateComputeConnectivityIn(computeTemplateConsolidationData,
 325                   expectedServiceTemplate);
 326               validateComputeConnectivityOut(computeNodeTemplateId,computeTemplateConsolidationData,
 327                   expectedServiceTemplate);
 328               break;
 329             case VALIDATE_DEPENDS_ON:
 330               validateDependsOnInConsolidationData(computeNodeTemplateId,
 331                   computeTemplateConsolidationData,
 332                   expectedServiceTemplate, testName);
 333               break;
 334           }
 335         }
 336       }
 337     }
 338   }
 339
 340   public void validateGetAttribute(String testName){
 341     Map<String, ServiceTemplate> expectedServiceTemplateModels = TestUtils.getServiceTemplates
 342         (expectedResultMap);
 343     validateGetAttr(translationContext,expectedServiceTemplateModels,testName);
 344   }
 345
 346   public void validateNestedTemplateConsolidationData(String testName){
 347     validateNestedConsolidationData(translationContext, testName);
 348   }
 349
 350   public void validatePortTemplateConsolidationData(ConsolidationDataValidationType
 351                                                         validationType,
 352                                                     String testName) {
 353     ConsolidationData consolidationData = translationContext.getConsolidationData();
 354     Map<String, ServiceTemplate> expectedServiceTemplateModels = TestUtils.getServiceTemplates
 355         (expectedResultMap);
 356     Assert.assertNotNull(consolidationData);
 357     Assert.assertNotNull(consolidationData.getPortConsolidationData());
 358     Set<String> serviceTemplateFileNames = consolidationData.getPortConsolidationData()
 359         .getAllServiceTemplateFileNames();
 360     Assert.assertNotNull(serviceTemplateFileNames);
 361     for(String serviceTemplateName : serviceTemplateFileNames){
 362       Assert.assertTrue(expectedServiceTemplateModels.containsKey(serviceTemplateName));
 363       ServiceTemplate expectedServiceTemplate = expectedServiceTemplateModels.get
 364           (serviceTemplateName);
 365       FilePortConsolidationData filePortConsolidationData = consolidationData
 366           .getPortConsolidationData().getFilePortConsolidationData(serviceTemplateName);
 367       Assert.assertNotNull(filePortConsolidationData);
 368
 369       Set<String> portNodeTemplateIds = filePortConsolidationData.getAllPortNodeTemplateIds();
 370       Assert.assertNotNull(portNodeTemplateIds);
 371       Assert.assertNotEquals(portNodeTemplateIds.size(), 0);
 372
 373       for(String portNodeTemplateId : portNodeTemplateIds) {
 374         PortTemplateConsolidationData portTemplateConsolidationData =
 375             filePortConsolidationData.getPortTemplateConsolidationData(portNodeTemplateId);
 376         switch(validationType){
 377           case VALIDATE_CONNECTIVITY:
 378             validatePortConnectivityIn(portTemplateConsolidationData,expectedServiceTemplate);
 379             validatePortConnectivityOut(portNodeTemplateId, portTemplateConsolidationData,
 380                 expectedServiceTemplate);
 381             break;
 382         }
 383       }
 384     }
 385   }
 386 }