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