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
  22 package org.onap.aai.babel.service;
  23
  24 import static org.hamcrest.CoreMatchers.equalTo;
  25 import static org.hamcrest.CoreMatchers.is;
  26 import static org.hamcrest.CoreMatchers.not;
  27 import static org.hamcrest.CoreMatchers.nullValue;
  28 import static org.junit.Assert.assertThat;
  29
  30 import java.io.IOException;
  31 import java.util.ArrayList;
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import org.hamcrest.BaseMatcher;
  36 import org.hamcrest.Description;
  37 import org.hamcrest.Matcher;
  38 import org.junit.After;
  39 import org.junit.Before;
  40 import org.junit.Rule;
  41 import org.junit.Test;
  42 import org.junit.rules.ExpectedException;
  43 import org.onap.aai.babel.csar.CsarConverterException;
  44 import org.onap.aai.babel.csar.CsarToXmlConverter;
  45 import org.onap.aai.babel.parser.ArtifactGeneratorToscaParser;
  46 import org.onap.aai.babel.service.data.BabelArtifact;
  47 import org.onap.aai.babel.testdata.CsarTest;
  48 import org.onap.aai.babel.util.ArtifactTestUtils;
  49 import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
  50
  51 /**
  52  * Tests {@link CsarToXmlConverter}.
  53  */
  54 public class CsarToXmlConverterTest {
  55
  56     private static final String ARTIFACT_GENERATOR_CONFIG = "artifact-generator.properties";
  57     private static final String FILTER_TYPES_CONFIG = "filter-types.properties";
  58
  59     private static final String INCORRECT_CSAR_NAME = "the_name_of_the_csar_file.csar";
  60     private static final String SERVICE_VERSION = "1.0";
  61
  62     static {
  63         if (System.getProperty("APP_HOME") == null) {
  64             System.setProperty("APP_HOME", ".");
  65         }
  66     }
  67
  68     // The class to be tested.
  69     private CsarToXmlConverter converter;
  70
  71     @Rule
  72     public ExpectedException exception = ExpectedException.none();
  73
  74     @Before
  75     public void setup() {
  76         System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE,
  77                 new ArtifactTestUtils().getResourcePath(ARTIFACT_GENERATOR_CONFIG));
  78
  79         System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_GROUP_FILTERS_CONFIG_FILE,
  80                 new ArtifactTestUtils().getResourcePath(FILTER_TYPES_CONFIG));
  81
  82         converter = new CsarToXmlConverter();
  83     }
  84
  85     @After
  86     public void tearDown() {
  87         converter = null;
  88     }
  89
  90     @Test(expected = NullPointerException.class)
  91     public void testNullArtifactSupplied() throws CsarConverterException {
  92         converter.generateXmlFromCsar(null, null, null);
  93     }
  94
  95     @Test(expected = NullPointerException.class)
  96     public void testMissingName() throws CsarConverterException, IOException {
  97         converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), null, null);
  98     }
  99
 100     @Test(expected = NullPointerException.class)
 101     public void testMissingVersion() throws CsarConverterException, IOException {
 102         converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), INCORRECT_CSAR_NAME, null);
 103     }
 104
 105     @Test(expected = CsarConverterException.class)
 106     public void testNoPayloadExists() throws CsarConverterException {
 107         converter.generateXmlFromCsar(new byte[0], INCORRECT_CSAR_NAME, SERVICE_VERSION);
 108     }
 109
 110     @Test(expected = CsarConverterException.class)
 111     public void testCsarFileHasNoYmlFiles() throws CsarConverterException, IOException {
 112         converter.generateXmlFromCsar(CsarTest.NO_YAML_FILES.getContent(), CsarTest.NO_YAML_FILES.getName(),
 113                 SERVICE_VERSION);
 114     }
 115
 116     /**
 117      * Test that an Exception is thrown when the Artifact Generator properties are not present.
 118      *
 119      * @throws CsarConverterException if there is an error either extracting the YAML files or generating XML artifacts
 120      * @throws IOException if an I/O exception occurs loading the test CSAR file
 121      * @throws IOException
 122      * @throws XmlArtifactGenerationException
 123      * @throws CsarConverterException
 124      */
 125     @Test
 126     public void testArtifactGeneratorConfigMissing() throws CsarConverterException, IOException {
 127         exception.expect(CsarConverterException.class);
 128         exception.expectMessage("Cannot generate artifacts. System property artifactgenerator.config not configured");
 129
 130         // Unset the required system property
 131         System.clearProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE);
 132         converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), CsarTest.SD_WAN_CSAR_FILE.getName(),
 133                 SERVICE_VERSION);
 134     }
 135
 136     /**
 137      * Test that an Exception is thrown when the Artifact Generator's Group Filter properties are not present.
 138      *
 139      * @throws IOException
 140      * @throws XmlArtifactGenerationException
 141      * @throws CsarConverterException
 142      */
 143     @Test
 144     public void generateXmlFromCsarFilterTypesSystemPropertyNotSet()
 145             throws IOException, XmlArtifactGenerationException, CsarConverterException {
 146         exception.expect(CsarConverterException.class);
 147         exception.expectMessage("Cannot generate artifacts. System property groupfilter.config not configured");
 148
 149         // Unset the required system property
 150         System.clearProperty(ArtifactGeneratorToscaParser.PROPERTY_GROUP_FILTERS_CONFIG_FILE);
 151         converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), CsarTest.SD_WAN_CSAR_FILE.getName(),
 152                 SERVICE_VERSION);
 153     }
 154
 155     @Test
 156     public void testServiceMetadataMissing()
 157             throws IOException, XmlArtifactGenerationException, CsarConverterException {
 158         converter.generateXmlFromCsar(CsarTest.MISSING_METADATA_CSAR.getContent(),
 159                 CsarTest.MISSING_METADATA_CSAR.getName(), SERVICE_VERSION);
 160     }
 161
 162     @Test
 163     public void generateXmlFromSdWanCsar() throws IOException, CsarConverterException {
 164         List<String> filesToLoad = new ArrayList<>();
 165         filesToLoad.add("AAI-SD-WAN-Service-Test-service-1.0.xml");
 166         filesToLoad.add("AAI-SdWanTestVsp..DUMMY..module-0-resource-2.xml");
 167         filesToLoad.add("AAI-Tunnel_XConnTest-resource-2.0.xml");
 168         filesToLoad.add("AAI-SD-WAN-Test-VSP-resource-1.0.xml");
 169         assertThatGeneratedFilesMatchExpected(createExpectedXmlFiles(filesToLoad), CsarTest.SD_WAN_CSAR_FILE);
 170     }
 171
 172     @Test
 173     public void generateXmlFromNetworkCollectionCsar() throws IOException, CsarConverterException {
 174         List<String> filesToLoad = new ArrayList<>();
 175         filesToLoad.add("AAI-TEST SVC_1-service-1.0.xml");
 176         filesToLoad.add("AAI-TEST CR_1-resource-7.0.xml");
 177         filesToLoad.add("AAI-testcr_1..NetworkCollection..0-resource-1.xml");
 178         filesToLoad.add("AAI-ExtVL-resource-40.0.xml");
 179         assertThatGeneratedFilesMatchExpected(createExpectedXmlFiles(filesToLoad), CsarTest.NETWORK_COLLECTION_CSAR_FILE);
 180     }
 181
 182     @Test
 183     public void generatePortMirrorConfigurationModel()
 184             throws CsarConverterException, IOException, XmlArtifactGenerationException {
 185         List<String> filesToLoad = new ArrayList<>();
 186         filesToLoad.add("AAI-Port Mirror_Test-service-1.0.xml");
 187         filesToLoad.add("AAI-Port Mirroring Configuration-resource-35.0.xml");
 188         assertThatGeneratedFilesMatchExpected(createExpectedXmlFiles(filesToLoad), CsarTest.PORT_MIRROR_CSAR);
 189     }
 190
 191     public Matcher<String> matches(final String expected) {
 192         return new BaseMatcher<String>() {
 193             protected String theExpected = expected;
 194
 195             @Override
 196             public boolean matches(Object item) {
 197                 return new ArtifactTestUtils().compareXmlStrings((String) item, theExpected);
 198             }
 199
 200             @Override
 201             public void describeTo(Description description) {
 202                 description.appendText(theExpected.toString());
 203             }
 204         };
 205     }
 206
 207     private Map<String, String> createExpectedXmlFiles(List<String> filesToLoad) throws IOException {
 208         Map<String, String> xmlMap = new HashMap<>();
 209         for (String filename : filesToLoad) {
 210             xmlMap.put(filename, new ArtifactTestUtils().loadResourceAsString("generatedXml/" + filename));
 211         }
 212         return xmlMap;
 213     }
 214
 215     private void assertThatGeneratedFilesMatchExpected(Map<String, String> expectedXmlFiles, CsarTest csarFile)
 216             throws CsarConverterException, IOException {
 217         List<BabelArtifact> generatedArtifacts =
 218                 converter.generateXmlFromCsar(csarFile.getContent(), csarFile.getName(), SERVICE_VERSION);
 219         assertThat("Incorrect number of files generated", //
 220                 generatedArtifacts.size(), is(equalTo(expectedXmlFiles.size())));
 221         for (BabelArtifact generated : generatedArtifacts) {
 222             String fileName = generated.getName();
 223             String expectedXml = expectedXmlFiles.get(fileName);
 224             assertThat("Missing expected content for " + generated.getName(), expectedXml, is(not(nullValue())));
 225             assertThat("The content of " + generated.getName() + " must match the expected content",
 226                     generated.getPayload(), matches(expectedXml));
 227         }
 228     }
 229 }