openecomp-be/backend/openecomp-sdc-vendor-software-product-manager/src/test/java/org/openecomp/sdc/vendorsoftwareproduct/services/impl/CandidateServiceImplTest.java

   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.vendorsoftwareproduct.services.impl;
  22
  23 import org.apache.commons.collections4.CollectionUtils;
  24 import org.mockito.InjectMocks;
  25 import org.mockito.Mock;
  26 import org.mockito.MockitoAnnotations;
  27 import org.openecomp.core.utilities.json.JsonUtil;
  28 import org.openecomp.sdc.common.errors.Messages;
  29 import org.openecomp.sdc.datatypes.error.ErrorMessage;
  30 import org.openecomp.sdc.heat.datatypes.manifest.FileData;
  31 import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
  32 import org.openecomp.sdc.heat.datatypes.structure.HeatStructureTree;
  33 import org.openecomp.sdc.vendorsoftwareproduct.dao.VendorSoftwareProductDao;
  34 import org.openecomp.sdc.vendorsoftwareproduct.dao.type.VspDetails;
  35 import org.openecomp.sdc.vendorsoftwareproduct.services.filedatastructuremodule.ManifestCreator;
  36 import org.openecomp.sdc.vendorsoftwareproduct.services.impl.filedatastructuremodule.CandidateServiceImpl;
  37 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.FilesDataStructure;
  38 import org.openecomp.sdc.vendorsoftwareproduct.types.candidateheat.Module;
  39 import org.openecomp.sdc.versioning.dao.types.Version;
  40 import org.testng.Assert;
  41 import org.testng.annotations.BeforeMethod;
  42 import org.testng.annotations.Test;
  43
  44 import java.util.ArrayList;
  45 import java.util.Collections;
  46 import java.util.List;
  47 import java.util.Optional;
  48
  49 import static org.mockito.Mockito.doReturn;
  50 import static org.testng.Assert.assertEquals;
  51 import static org.testng.Assert.assertTrue;
  52
  53 /**
  54  * @author Avrahamg
  55  * @since November 09, 2016
  56  */
  57 public class CandidateServiceImplTest {
  58   @Mock
  59   private ManifestCreator manifestCreatorMock;
  60   @Mock
  61   private VendorSoftwareProductDao vendorSoftwareProductDaoMock;
  62   @InjectMocks
  63   private CandidateServiceImpl candidateService;
  64
  65   @BeforeMethod
  66   public void setUp() throws Exception {
  67     MockitoAnnotations.initMocks(this);
  68   }
  69
  70   @Test
  71   public void shouldReturnOptionalPresentIfInputStreamIsNull() {
  72     assertTrue(candidateService.validateNonEmptyFileToUpload(null).isPresent());
  73   }
  74
  75   // end validateNonEmptyFileToUpload tests
  76   // start validateNonEmptyFileToUpload tests
  77   @Test
  78   public void shouldReturnOptionalEmptyIfUploadedFileDataIsNotNull() {
  79     assertEquals(candidateService.validateRawZipData(new byte[]{}), Optional.empty());
  80   }
  81
  82   @Test
  83   public void shouldReturnOptionalPresentIfUploadedFileDataIsNull() {
  84     assertTrue(candidateService.validateRawZipData(null).isPresent());
  85   }
  86   // end validateNonEmptyFileToUpload tests
  87   // start heatStructureTreeToFileDataStructure tests
  88
  89   @Test
  90   public void shouldValidateManifestInZipMatchesFileDataStructureFromDB() {
  91     VspDetails vspDetails = new VspDetails("vspTest", null);
  92     vspDetails.setName("vspTest");
  93     vspDetails.setDescription("Test description");
  94     vspDetails.setVersion(new Version(0, 1));
  95
  96     FilesDataStructure structure = JsonUtil.json2Object(getExpectedJson(), FilesDataStructure.class);
  97
  98     Optional<ManifestContent> expectedManifest = getExpectedManifestJson();
  99     doReturn(expectedManifest)
 100         .when(manifestCreatorMock).createManifest(vspDetails, structure);
 101
 102     String expectedManifestJson = JsonUtil.object2Json(expectedManifest.get());
 103     String actualManifest = candidateService.createManifest(vspDetails, structure);
 104     Assert.assertEquals(actualManifest, expectedManifestJson);
 105   }
 106
 107   @Test
 108   public void shouldReturnValidationErrorOnMissingfModule() {
 109     FilesDataStructure filesDataStructure = new FilesDataStructure();
 110     filesDataStructure.setArtifacts(Collections.singletonList("artifact.sh"));
 111
 112     Optional<List<ErrorMessage>> validateErrors =
 113         candidateService.validateFileDataStructure(filesDataStructure);
 114     assertValidationErrorIsAsExpected(validateErrors, 1, Messages.NO_MODULES_IN_MANIFEST
 115         .getErrorMessage());
 116   }
 117
 118   @Test
 119   public void shouldReturnValidationErrorOnVolumeEnvWithoutVolumeYaml() {
 120     FilesDataStructure filesDataStructure = new FilesDataStructure();
 121     Module module = new Module();
 122     module.setName("test");
 123     module.setYaml("base_file.yml");
 124     module.setVolEnv("vol_env.env");
 125     filesDataStructure.setModules(Collections.singletonList(module));
 126
 127     Optional<List<ErrorMessage>> validateErrors =
 128         candidateService.validateFileDataStructure(filesDataStructure);
 129     assertValidationErrorIsAsExpected(validateErrors, 1, String.format(Messages
 130         .MODULE_IN_MANIFEST_VOL_ENV_NO_VOL.getErrorMessage(), module.getName()));
 131   }
 132
 133   @Test
 134   public void shouldReturnValidationErrorOnModuleWithoutYaml() {
 135     FilesDataStructure filesDataStructure = new FilesDataStructure();
 136     Module module = new Module();
 137     module.setName("test");
 138     filesDataStructure.setModules(Collections.singletonList(module));
 139
 140     Optional<List<ErrorMessage>> validateErrors =
 141         candidateService.validateFileDataStructure(filesDataStructure);
 142     assertValidationErrorIsAsExpected(validateErrors, 1, String.format(Messages
 143         .MODULE_IN_MANIFEST_NO_YAML.getErrorMessage(), module.getName()));
 144   }
 145
 146   private void assertValidationErrorIsAsExpected(Optional<List<ErrorMessage>> validateErrors,
 147                                                  int errorListSize, String expectedErrorMessage) {
 148     if (validateErrors.isPresent()) {
 149       List<ErrorMessage> errorMessages = validateErrors.get();
 150       Assert.assertEquals(errorMessages.size(), errorListSize);
 151       Assert.assertEquals(errorMessages.get(0).getMessage(), expectedErrorMessage);
 152     }
 153   }
 154
 155   private String getExpectedJson() {
 156     return "{\n" +
 157         "  \"modules\": [\n" +
 158         "    {\n" +
 159         "      \"isBase\": false,\n" +
 160         "      \"yaml\": \"file2.yaml\"\n" +
 161         "    },\n" +
 162         "    {\n" +
 163         "      \"isBase\": true,\n" +
 164         "      \"yaml\": \"file1.yaml\",\n" +
 165         "      \"vol\": \"file1_vol.yaml\",\n" +
 166         "      \"volEnv\": \"file1.env\"\n" +
 167         "    }\n" +
 168         "  ],\n" +
 169         "  \"unassigned\": [\n" +
 170         "    \"file3.yml\"\n" +
 171         "  ],\n" +
 172         "  \"artifacts\": [\n" +
 173         "    \"file2.sh\"\n" +
 174         "  ],\n" +
 175         "  \"nested\": []\n" +
 176         "}";
 177   }
 178
 179   private Optional<ManifestContent> getExpectedManifestJson() {
 180     ManifestContent mock = new ManifestContent();
 181     mock.setDescription("Test description");
 182     mock.setName("vspTest");
 183     mock.setVersion("0.1");
 184
 185
 186     List<FileData> mockFileData = new ArrayList<>();
 187     FileData fileData = createFileData("file2.yaml", false, FileData.Type.HEAT, null);
 188     mockFileData.add(fileData);
 189     fileData = createFileData("file1.yaml", true, FileData.Type.HEAT, null);
 190     mockFileData.add(fileData);
 191     fileData = createFileData("file1_vol.yaml", null, FileData.Type.HEAT_VOL, fileData);
 192     fileData = createFileData("file1.env", null, FileData.Type.HEAT_ENV, mockFileData.get(1).getData().get(0));
 193     mockFileData.add(createFileData("file2.sh", null, FileData.Type.OTHER, null));
 194     mockFileData.add(createFileData("file3.yml", null, FileData.Type.OTHER, null));
 195     mock.setData(mockFileData);
 196     return Optional.of(mock);
 197   }
 198
 199   private FileData createFileData(String fileName, Boolean isBase, FileData.Type fileType,
 200                                   FileData fileDataToAddTo) {
 201     FileData fileData = new FileData();
 202     fileData.setFile(fileName);
 203     if(isBase != null) {
 204       fileData.setBase(isBase);
 205     }
 206     fileData.setType(fileType);
 207     addFileDataToList(fileDataToAddTo, fileData);
 208     return fileData;
 209   }
 210
 211   private void addFileDataToList(FileData fileDataToAddTo, FileData fileData) {
 212     if(fileDataToAddTo != null)
 213     {
 214       List<FileData> list = fileDataToAddTo.getData();
 215       if(CollectionUtils.isEmpty(list))
 216       {
 217         list = new ArrayList<>();
 218       }
 219       list.add(fileData);
 220       fileDataToAddTo.setData(list);
 221
 222     }
 223   }
 224
 225   private HeatStructureTree createHeatWithEnvAndVolIncludeVolEnv() {
 226     HeatStructureTree heat1 = createBasicHeatTree("file1.yaml", true, FileData.Type.HEAT);
 227     addEnvToHeat(heat1, "file1.env");
 228     HeatStructureTree heat1Vol =
 229         createBasicHeatTree("file1_vol.yaml", false, FileData.Type.HEAT_VOL);
 230     addEnvToHeat(heat1Vol, "file1_vol.env");
 231     heat1.addVolumeFileToVolumeList(heat1Vol);
 232     return heat1;
 233   }
 234
 235   private void addEnvToHeat(HeatStructureTree toAddHeat, String envFileName) {
 236     HeatStructureTree heat1Env = createBasicHeatTree(envFileName, false, FileData.Type.HEAT_ENV);
 237     toAddHeat.setEnv(heat1Env);
 238   }
 239
 240   private HeatStructureTree createBasicHeatTree(String fileName, boolean isBase,
 241                                                 FileData.Type type) {
 242     HeatStructureTree heat = new HeatStructureTree();
 243     heat.setFileName(fileName);
 244     heat.setBase(isBase);
 245     heat.setType(type);
 246     return heat;
 247   }
 248
 249 }