src/test/java/org/onap/aai/babel/service/CsarToXmlConverterTest.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 European Software Marketing Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.babel.service;
  22
  23 import static org.junit.Assert.assertThat;
  24
  25 import java.io.IOException;
  26 import java.util.ArrayList;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import org.hamcrest.BaseMatcher;
  31 import org.hamcrest.Description;
  32 import org.hamcrest.Matcher;
  33 import org.junit.After;
  34 import org.junit.Before;
  35 import org.junit.Rule;
  36 import org.junit.Test;
  37 import org.junit.rules.ExpectedException;
  38 import org.onap.aai.babel.csar.CsarConverterException;
  39 import org.onap.aai.babel.csar.CsarToXmlConverter;
  40 import org.onap.aai.babel.parser.ArtifactGeneratorToscaParser;
  41 import org.onap.aai.babel.service.data.BabelArtifact;
  42 import org.onap.aai.babel.util.ArtifactTestUtils;
  43 import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
  44
  45 /**
  46  * Tests {@link CsarToXmlConverter}
  47  */
  48 public class CsarToXmlConverterTest {
  49
  50     private static final String ARTIFACT_GENERATOR_CONFIG = "artifact-generator.properties";
  51     private static final String INCORRECT_CSAR_NAME = "the_name_of_the_csar_file.csar";
  52     private static final String SERVICE_VERSION = "1.0";
  53
  54     static {
  55         if (System.getProperty("APP_HOME") == null) {
  56             System.setProperty("APP_HOME", ".");
  57         }
  58     }
  59
  60     private enum CsarTest {
  61         VALID_CSAR_FILE(
  62                 "service-SdWanServiceTest-csar.csar"
  63         ),
  64         NO_YAML_FILES(
  65                 "noYmlFilesArchive.zip"
  66         ),
  67         PORT_MIRROR_CSAR(
  68                 "service_PortMirror.csar"
  69         );
  70
  71         private String filename;
  72         private ArtifactTestUtils artifactTestUtils = new ArtifactTestUtils();
  73
  74         CsarTest(String filename) {
  75             this.filename = filename;
  76         }
  77
  78         public String getName() {
  79             return filename;
  80         }
  81
  82         public byte[] getContent() throws IOException {
  83             return artifactTestUtils.getCompressedArtifact(filename);
  84         }
  85     }
  86
  87     // The class to be tested.
  88     private CsarToXmlConverter converter;
  89
  90     @Rule
  91     public ExpectedException exception = ExpectedException.none();
  92
  93     @Before
  94     public void setup() {
  95         System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE,
  96                 new ArtifactTestUtils().getResourcePath(ARTIFACT_GENERATOR_CONFIG));
  97         converter = new CsarToXmlConverter();
  98     }
  99
 100     @After
 101     public void tearDown() {
 102         converter = null;
 103     }
 104
 105     @Test(expected = NullPointerException.class)
 106     public void testNullArtifactSupplied() throws CsarConverterException {
 107         converter.generateXmlFromCsar(null, null, null);
 108     }
 109
 110     @Test(expected = NullPointerException.class)
 111     public void testMissingName() throws CsarConverterException, IOException {
 112         converter.generateXmlFromCsar(CsarTest.VALID_CSAR_FILE.getContent(), null, null);
 113     }
 114
 115     @Test(expected = NullPointerException.class)
 116     public void testMissingVersion() throws CsarConverterException, IOException {
 117         converter.generateXmlFromCsar(CsarTest.VALID_CSAR_FILE.getContent(), INCORRECT_CSAR_NAME, null);
 118     }
 119
 120     @Test(expected = CsarConverterException.class)
 121     public void testNoPayloadExists() throws CsarConverterException {
 122         converter.generateXmlFromCsar(new byte[0], INCORRECT_CSAR_NAME, SERVICE_VERSION);
 123     }
 124
 125     @Test(expected = CsarConverterException.class)
 126     public void testCsarFileHasNoYmlFiles() throws CsarConverterException, IOException {
 127         converter.generateXmlFromCsar(CsarTest.NO_YAML_FILES.getContent(), "noYmlFilesArchive.zip", SERVICE_VERSION);
 128     }
 129
 130     @Test
 131     public void testArtifactGeneratorConfigMissing()
 132             throws IOException, XmlArtifactGenerationException, CsarConverterException {
 133         exception.expect(CsarConverterException.class);
 134         exception.expectMessage("Cannot generate artifacts. artifactgenerator.config system property not configured");
 135
 136         // Unset the required system property
 137         System.clearProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE);
 138         converter.generateXmlFromCsar(CsarTest.VALID_CSAR_FILE.getContent(), CsarTest.VALID_CSAR_FILE.getName(),
 139                 SERVICE_VERSION);
 140     }
 141
 142     @Test
 143     public void generateXmlFromCsar() throws CsarConverterException, IOException, XmlArtifactGenerationException {
 144         Map<String, String> expectedXmlFiles = createExpectedXmlFiles();
 145         List<BabelArtifact> generatedArtifacts = converter.generateXmlFromCsar(CsarTest.VALID_CSAR_FILE.getContent(),
 146                 CsarTest.VALID_CSAR_FILE.getName(), SERVICE_VERSION);
 147
 148         generatedArtifacts
 149                 .forEach(ga -> assertThat("The content of " + ga.getName() + " must match the expected content",
 150                         ga.getPayload(), matches(expectedXmlFiles.get(ga.getName()))));
 151     }
 152
 153     @Test
 154     public void generatePortMirrorConfigurationModel()
 155             throws CsarConverterException, IOException, XmlArtifactGenerationException {
 156         Map<String, String> expectedXmlFiles = createExpectedXmlFiles();
 157         List<BabelArtifact> generatedArtifacts = converter.generateXmlFromCsar(CsarTest.PORT_MIRROR_CSAR.getContent(),
 158                 CsarTest.PORT_MIRROR_CSAR.getName(), SERVICE_VERSION);
 159
 160         generatedArtifacts
 161                 .forEach(ga -> assertThat("The content of " + ga.getName() + " must match the expected content",
 162                         ga.getPayload(), matches(expectedXmlFiles.get(ga.getName()))));
 163     }
 164
 165     public Matcher<String> matches(final String expected) {
 166         return new BaseMatcher<String>() {
 167             protected String theExpected = expected;
 168
 169             @Override
 170             public boolean matches(Object item) {
 171                 return new ArtifactTestUtils().compareXmlStrings((String) item, theExpected);
 172             }
 173
 174             @Override
 175             public void describeTo(Description description) {
 176                 description.appendText(theExpected.toString());
 177             }
 178         };
 179     }
 180
 181     private Map<String, String> createExpectedXmlFiles() throws IOException {
 182         Map<String, String> xmlMap = new HashMap<>();
 183
 184         List<String> filesToLoad = new ArrayList<>();
 185         filesToLoad.add("AAI-SD-WAN-Service-Test-service-1.0.xml");
 186         filesToLoad.add("AAI-SdWanTestVsp..DUMMY..module-0-resource-2.xml");
 187         filesToLoad.add("AAI-Tunnel_XConnTest-resource-2.0.xml");
 188         filesToLoad.add("AAI-SD-WAN-Test-VSP-resource-1.0.xml");
 189         filesToLoad.add("AAI-Port Mirror_Test-service-1.0.xml");
 190         filesToLoad.add("AAI-Port Mirroring Configuration-resource-35.0.xml");
 191
 192         for (String filename : filesToLoad) {
 193             xmlMap.put(filename, new ArtifactTestUtils().loadResourceAsString("generatedXml/" + filename));
 194         }
 195
 196         return xmlMap;
 197     }
 198 }