Add a CSAR test file containing an InstanceGroup
[aai/babel.git] / src / test / java / org / onap / aai / babel / service / CsarToXmlConverterTest.java
index 5c1e213..8d10412 100644 (file)
@@ -2,8 +2,8 @@
  * ============LICENSE_START=======================================================
  * org.onap.aai
  * ================================================================================
- * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
- * Copyright © 2017 European Software Marketing Ltd.
+ * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * Copyright © 2017-2018 European Software Marketing Ltd.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * ============LICENSE_END=========================================================
- *
- * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  */
+
 package org.onap.aai.babel.service;
 
-import java.io.BufferedReader;
-import java.io.ByteArrayInputStream;
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.not;
+import static org.hamcrest.CoreMatchers.nullValue;
+import static org.junit.Assert.assertThat;
+
 import java.io.IOException;
-import java.io.InputStreamReader;
-import java.net.URL;
-import java.util.Base64;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.stream.Collectors;
-import org.custommonkey.xmlunit.XMLTestCase;
+import org.hamcrest.BaseMatcher;
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
-import org.junit.runner.RunWith;
 import org.onap.aai.babel.csar.CsarConverterException;
 import org.onap.aai.babel.csar.CsarToXmlConverter;
+import org.onap.aai.babel.parser.ArtifactGeneratorToscaParser;
 import org.onap.aai.babel.service.data.BabelArtifact;
+import org.onap.aai.babel.testdata.CsarTest;
 import org.onap.aai.babel.util.ArtifactTestUtils;
-import org.onap.aai.babel.xml.generator.ModelGenerator;
 import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
-import org.powermock.core.classloader.annotations.PrepareForTest;
-import org.powermock.modules.junit4.PowerMockRunner;
-import org.xml.sax.SAXException;
 
 /**
- * Tests {@link CsarToXmlConverter}
+ * Tests {@link CsarToXmlConverter}.
  */
-@RunWith(PowerMockRunner.class)
-@PrepareForTest(ModelGenerator.class)
-public class CsarToXmlConverterTest extends XMLTestCase {
+public class CsarToXmlConverterTest {
 
-    private static final String NAME = "the_name_of_the_csar_file.csar";
-    private static final String VERSION = "v1";
+    private static final String ARTIFACT_GENERATOR_CONFIG = "artifact-generator.properties";
+    private static final String FILTER_TYPES_CONFIG = "filter-types.properties";
 
+    private static final String INCORRECT_CSAR_NAME = "the_name_of_the_csar_file.csar";
+    private static final String SERVICE_VERSION = "1.0";
+
+    static {
+        if (System.getProperty("APP_HOME") == null) {
+            System.setProperty("APP_HOME", ".");
+        }
+    }
+
+    // The class to be tested.
     private CsarToXmlConverter converter;
 
     @Rule
     public ExpectedException exception = ExpectedException.none();
 
     @Before
-    public void setUp() {
+    public void setup() {
+        System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE,
+                new ArtifactTestUtils().getResourcePath(ARTIFACT_GENERATOR_CONFIG));
+
+        System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_GROUP_FILTERS_CONFIG_FILE,
+                new ArtifactTestUtils().getResourcePath(FILTER_TYPES_CONFIG));
+
         converter = new CsarToXmlConverter();
-        URL url = CsarToXmlConverterTest.class.getClassLoader().getResource("artifact-generator.properties");
-        System.setProperty("artifactgenerator.config", url.getPath());
     }
 
     @After
@@ -77,94 +88,142 @@ public class CsarToXmlConverterTest extends XMLTestCase {
     }
 
     @Test(expected = NullPointerException.class)
-    public void generateXmlFromCsar_nullArtifactSupplied() throws CsarConverterException {
+    public void testNullArtifactSupplied() throws CsarConverterException {
         converter.generateXmlFromCsar(null, null, null);
     }
 
     @Test(expected = NullPointerException.class)
-    public void generateXmlFromCsar_missingName() throws CsarConverterException, IOException {
-        byte[] csarArchive = new ArtifactTestUtils().loadResource("compressedArtifacts/service-VscpaasTest-csar.csar");
-        converter.generateXmlFromCsar(csarArchive, null, null);
+    public void testMissingName() throws CsarConverterException, IOException {
+        converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), null, null);
     }
 
     @Test(expected = NullPointerException.class)
-    public void generateXmlFromCsar_missingVersion() throws CsarConverterException, IOException {
-        byte[] csarArchive = new ArtifactTestUtils().loadResource("compressedArtifacts/service-VscpaasTest-csar.csar");
-        converter.generateXmlFromCsar(csarArchive, NAME, null);
+    public void testMissingVersion() throws CsarConverterException, IOException {
+        converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), INCORRECT_CSAR_NAME, null);
     }
 
     @Test(expected = CsarConverterException.class)
-    public void generateXmlFromCsar_noPayloadExists() throws CsarConverterException {
-        converter.generateXmlFromCsar(new byte[0], NAME, VERSION);
+    public void testNoPayloadExists() throws CsarConverterException {
+        converter.generateXmlFromCsar(new byte[0], INCORRECT_CSAR_NAME, SERVICE_VERSION);
     }
 
     @Test(expected = CsarConverterException.class)
-    public void generateXmlFromCsar_csarFileHasNoYmlFiles() throws CsarConverterException, IOException {
-        byte[] csarArchive = new ArtifactTestUtils().loadResource("compressedArtifacts/noYmlFilesArchive.zip");
-        converter.generateXmlFromCsar(csarArchive, "noYmlFilesArchive.zip", VERSION);
+    public void testCsarFileHasNoYmlFiles() throws CsarConverterException, IOException {
+        converter.generateXmlFromCsar(CsarTest.NO_YAML_FILES.getContent(), CsarTest.NO_YAML_FILES.getName(),
+                SERVICE_VERSION);
     }
 
+    /**
+     * Test that an Exception is thrown when the Artifact Generator properties are not present.
+     *
+     * @throws CsarConverterException if there is an error either extracting the YAML files or generating XML artifacts
+     * @throws IOException if an I/O exception occurs loading the test CSAR file
+     * @throws IOException
+     * @throws XmlArtifactGenerationException
+     * @throws CsarConverterException
+     */
     @Test
-    public void generateXmlFromCsar_artifactgenerator_config_systemPropertyNotSet()
-            throws IOException, XmlArtifactGenerationException, CsarConverterException {
+    public void testArtifactGeneratorConfigMissing() throws CsarConverterException, IOException {
         exception.expect(CsarConverterException.class);
-        exception.expectMessage("Cannot generate artifacts. artifactgenerator.config system property not configured");
-
-        byte[] csarArchive =
-                new ArtifactTestUtils().loadResource("compressedArtifacts/service-SdWanServiceTest-csar.csar");
+        exception.expectMessage("Cannot generate artifacts. System property artifactgenerator.config not configured");
 
         // Unset the required system property
-        System.clearProperty("artifactgenerator.config");
-        converter.generateXmlFromCsar(csarArchive, VERSION, "service-SdWanServiceTest-csar.csar");
+        System.clearProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE);
+        converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), CsarTest.SD_WAN_CSAR_FILE.getName(),
+                SERVICE_VERSION);
     }
 
+    /**
+     * Test that an Exception is thrown when the Artifact Generator's Group Filter properties are not present.
+     *
+     * @throws IOException
+     * @throws XmlArtifactGenerationException
+     * @throws CsarConverterException
+     */
     @Test
-    public void generateXmlFromCsar() throws CsarConverterException, IOException, XmlArtifactGenerationException {
-        byte[] csarArchive =
-                new ArtifactTestUtils().loadResource("compressedArtifacts/service-SdWanServiceTest-csar.csar");
-
-        Map<String, String> expectedXmlFiles = createExpectedXmlFiles();
-        List<BabelArtifact> generatedArtifacts =
-                converter.generateXmlFromCsar(csarArchive, VERSION, "service-SdWanServiceTest-csar.csar");
-
-        generatedArtifacts.forEach(ga -> {
-            try {
-
-                String x1 = expectedXmlFiles.get(ga.getName());
-
-                String x2 = bytesToString(ga.getPayload());
-
-                assertXMLEqual("The content of " + ga.getName() + " must match the expected content", x1, x2);
+    public void generateXmlFromCsarFilterTypesSystemPropertyNotSet()
+            throws IOException, XmlArtifactGenerationException, CsarConverterException {
+        exception.expect(CsarConverterException.class);
+        exception.expectMessage("Cannot generate artifacts. System property groupfilter.config not configured");
 
-            } catch (SAXException | IOException e) {
-                fail("There was an Exception parsing the XML: "+e.getMessage());
-            }
-        });
+        // Unset the required system property
+        System.clearProperty(ArtifactGeneratorToscaParser.PROPERTY_GROUP_FILTERS_CONFIG_FILE);
+        converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), CsarTest.SD_WAN_CSAR_FILE.getName(),
+                SERVICE_VERSION);
     }
 
-    public String bytesToString(byte[] source) {
-        ByteArrayInputStream bis = new ByteArrayInputStream(Base64.getDecoder().decode(source));
-
-        String result = new BufferedReader(new InputStreamReader(bis)).lines().collect(Collectors.joining("\n"));
+    @Test
+    public void testServiceMetadataMissing()
+            throws IOException, XmlArtifactGenerationException, CsarConverterException {
+        converter.generateXmlFromCsar(CsarTest.MISSING_METADATA_CSAR.getContent(),
+                CsarTest.MISSING_METADATA_CSAR.getName(), SERVICE_VERSION);
+    }
 
-        return result;
+    @Test
+    public void generateXmlFromSdWanCsar() throws IOException, CsarConverterException {
+        List<String> filesToLoad = new ArrayList<>();
+        filesToLoad.add("AAI-SD-WAN-Service-Test-service-1.0.xml");
+        filesToLoad.add("AAI-SdWanTestVsp..DUMMY..module-0-resource-2.xml");
+        filesToLoad.add("AAI-Tunnel_XConnTest-resource-2.0.xml");
+        filesToLoad.add("AAI-SD-WAN-Test-VSP-resource-1.0.xml");
+        assertThatGeneratedFilesMatchExpected(createExpectedXmlFiles(filesToLoad), CsarTest.SD_WAN_CSAR_FILE);
+    }
 
+    @Test
+    public void generateXmlFromNetworkCollectionCsar() throws IOException, CsarConverterException {
+        List<String> filesToLoad = new ArrayList<>();
+        filesToLoad.add("AAI-TEST SVC_1-service-1.0.xml");
+        filesToLoad.add("AAI-TEST CR_1-resource-7.0.xml");
+        filesToLoad.add("AAI-testcr_1..NetworkCollection..0-resource-1.xml");
+        filesToLoad.add("AAI-ExtVL-resource-40.0.xml");
+        assertThatGeneratedFilesMatchExpected(createExpectedXmlFiles(filesToLoad), CsarTest.NETWORK_COLLECTION_CSAR_FILE);
     }
 
-    private Map<String, String> createExpectedXmlFiles() throws IOException {
-        Map<String, String> xml = new HashMap<>();
+    @Test
+    public void generatePortMirrorConfigurationModel()
+            throws CsarConverterException, IOException, XmlArtifactGenerationException {
+        List<String> filesToLoad = new ArrayList<>();
+        filesToLoad.add("AAI-Port Mirror_Test-service-1.0.xml");
+        filesToLoad.add("AAI-Port Mirroring Configuration-resource-35.0.xml");
+        assertThatGeneratedFilesMatchExpected(createExpectedXmlFiles(filesToLoad), CsarTest.PORT_MIRROR_CSAR);
+    }
 
-        ArtifactTestUtils utils = new ArtifactTestUtils();
+    public Matcher<String> matches(final String expected) {
+        return new BaseMatcher<String>() {
+            protected String theExpected = expected;
 
-        String[] filesToLoad =
-                {"AAI-SD-WAN-Service-Test-service-1.0.xml", "AAI-SdWanTestVsp..DUMMY..module-0-resource-2.xml",
-                        "AAI-Tunnel_XConnTest-resource-2.0.xml", "AAI-SD-WAN-Test-VSP-resource-1.0.xml"};
+            @Override
+            public boolean matches(Object item) {
+                return new ArtifactTestUtils().compareXmlStrings((String) item, theExpected);
+            }
 
-        for (String s : filesToLoad) {
-            xml.put(s, utils.loadResourceAsString("generatedXml/" + s));
+            @Override
+            public void describeTo(Description description) {
+                description.appendText(theExpected.toString());
+            }
+        };
+    }
 
+    private Map<String, String> createExpectedXmlFiles(List<String> filesToLoad) throws IOException {
+        Map<String, String> xmlMap = new HashMap<>();
+        for (String filename : filesToLoad) {
+            xmlMap.put(filename, new ArtifactTestUtils().loadResourceAsString("generatedXml/" + filename));
         }
+        return xmlMap;
+    }
 
-        return xml;
+    private void assertThatGeneratedFilesMatchExpected(Map<String, String> expectedXmlFiles, CsarTest csarFile)
+            throws CsarConverterException, IOException {
+        List<BabelArtifact> generatedArtifacts =
+                converter.generateXmlFromCsar(csarFile.getContent(), csarFile.getName(), SERVICE_VERSION);
+        assertThat("Incorrect number of files generated", //
+                generatedArtifacts.size(), is(equalTo(expectedXmlFiles.size())));
+        for (BabelArtifact generated : generatedArtifacts) {
+            String fileName = generated.getName();
+            String expectedXml = expectedXmlFiles.get(fileName);
+            assertThat("Missing expected content for " + generated.getName(), expectedXml, is(not(nullValue())));
+            assertThat("The content of " + generated.getName() + " must match the expected content",
+                    generated.getPayload(), matches(expectedXml));
+        }
     }
 }