/**
- * ============LICENSE_START=======================================================
+ * ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.babel.service;
+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.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import org.junit.rules.ExpectedException;
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.XmlArtifactGenerationException;
-import org.onap.aai.babel.xml.generator.data.GeneratorConstants;
/**
- * Tests {@link CsarToXmlConverter}
+ * Tests {@link CsarToXmlConverter}.
*/
public class CsarToXmlConverterTest {
- private static final String ARTIFACT_GENERATOR_CONFIG = "artifact-generator.properties";
- private static final String CSAR_FOLDER = "compressedArtifacts";
- private static final String VALID_CSAR_FILE = "service-SdWanServiceTest-csar.csar";
- private static final String INCORRECT_CSAR_NAME = "the_name_of_the_csar_file.csar";
- private static final String SERVICE_VERSION = "1.0";
-
- private CsarToXmlConverter converter;
-
- static {
- if (System.getProperty("APP_HOME") == null) {
- System.setProperty("APP_HOME", ".");
- }
- }
-
- @Rule
- public ExpectedException exception = ExpectedException.none();
- private ArtifactTestUtils artifactTestUtils;
-
- @Before
- public void setup() {
- System.setProperty(GeneratorConstants.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE,
- CsarToXmlConverterTest.class.getClassLoader().getResource(ARTIFACT_GENERATOR_CONFIG).getPath());
- converter = new CsarToXmlConverter();
- artifactTestUtils = new ArtifactTestUtils();
- }
-
- @After
- public void tearDown() {
- converter = null;
- }
-
- @Test(expected = NullPointerException.class)
- public void generateXmlFromCsar_nullArtifactSupplied() throws CsarConverterException {
- converter.generateXmlFromCsar(null, null, null);
- }
-
- @Test(expected = NullPointerException.class)
- public void generateXmlFromCsar_missingName() throws CsarConverterException, IOException {
- converter.generateXmlFromCsar(getCsar(VALID_CSAR_FILE), null, null);
- }
-
- @Test(expected = NullPointerException.class)
- public void generateXmlFromCsar_missingVersion() throws CsarConverterException, IOException {
- converter.generateXmlFromCsar(getCsar(VALID_CSAR_FILE), INCORRECT_CSAR_NAME, null);
- }
-
- @Test(expected = CsarConverterException.class)
- public void generateXmlFromCsar_noPayloadExists() throws CsarConverterException {
- converter.generateXmlFromCsar(new byte[0], INCORRECT_CSAR_NAME, SERVICE_VERSION);
- }
-
- @Test(expected = CsarConverterException.class)
- public void generateXmlFromCsar_csarFileHasNoYmlFiles() throws CsarConverterException, IOException {
- converter.generateXmlFromCsar(getCsar("noYmlFilesArchive.zip"), "noYmlFilesArchive.zip", SERVICE_VERSION);
- }
-
- @Test
- public void generateXmlFromCsar_artifactgenerator_config_systemPropertyNotSet()
- throws IOException, XmlArtifactGenerationException, CsarConverterException {
- exception.expect(CsarConverterException.class);
- exception.expectMessage("Cannot generate artifacts. artifactgenerator.config system property not configured");
-
- // Unset the required system property
- System.clearProperty(GeneratorConstants.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE);
- converter.generateXmlFromCsar(getCsar(VALID_CSAR_FILE), VALID_CSAR_FILE, SERVICE_VERSION);
- }
-
- @Test
- public void generateXmlFromCsar() throws CsarConverterException, IOException, XmlArtifactGenerationException {
- Map<String, String> expectedXmlFiles = createExpectedXmlFiles();
- List<BabelArtifact> generatedArtifacts =
- converter.generateXmlFromCsar(getCsar(VALID_CSAR_FILE), VALID_CSAR_FILE, SERVICE_VERSION);
-
- generatedArtifacts
- .forEach(ga -> assertThat("The content of " + ga.getName() + " must match the expected content",
- ga.getPayload(), matches(expectedXmlFiles.get(ga.getName()))));
- }
-
- public Matcher<String> matches(final String expected) {
- return new BaseMatcher<String>() {
- protected String theExpected = expected;
-
- @Override
- public boolean matches(Object o) {
- return artifactTestUtils.compareXMLStrings((String) o, theExpected);
- }
-
- @Override
- public void describeTo(Description description) {
- description.appendText(theExpected.toString());
- }
- };
- }
-
- private byte[] getCsar(String csarFileName) throws IOException {
- return artifactTestUtils.loadResource(CSAR_FOLDER + File.separator + csarFileName);
- }
-
- private Map<String, String> createExpectedXmlFiles() throws IOException {
- Map<String, String> xmlMap = new HashMap<>();
-
- 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");
-
- for (String filename : filesToLoad) {
- xmlMap.put(filename, artifactTestUtils.loadResourceAsString("generatedXml" + File.separator + filename));
- }
-
- return xmlMap;
- }
+ 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() {
+ 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();
+ }
+
+ @After
+ public void tearDown() {
+ converter = null;
+ }
+
+ @Test(expected = NullPointerException.class)
+ public void testNullArtifactSupplied() throws CsarConverterException {
+ converter.generateXmlFromCsar(null, null, null);
+ }
+
+ @Test(expected = NullPointerException.class)
+ public void testMissingName() throws CsarConverterException, IOException {
+ converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), null, null);
+ }
+
+ @Test(expected = NullPointerException.class)
+ public void testMissingVersion() throws CsarConverterException, IOException {
+ converter.generateXmlFromCsar(CsarTest.SD_WAN_CSAR_FILE.getContent(), INCORRECT_CSAR_NAME, null);
+ }
+
+ @Test(expected = CsarConverterException.class)
+ public void testNoPayloadExists() throws CsarConverterException {
+ converter.generateXmlFromCsar(new byte[0], INCORRECT_CSAR_NAME, SERVICE_VERSION);
+ }
+
+ @Test(expected = CsarConverterException.class)
+ 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 testArtifactGeneratorConfigMissing() throws CsarConverterException, IOException {
+ exception.expect(CsarConverterException.class);
+ exception.expectMessage("Cannot generate artifacts. System property artifactgenerator.config not configured");
+
+ // Unset the required system property
+ 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 generateXmlFromCsarFilterTypesSystemPropertyNotSet()
+ throws IOException, XmlArtifactGenerationException, CsarConverterException {
+ exception.expect(CsarConverterException.class);
+ exception.expectMessage("Cannot generate artifacts. System property groupfilter.config not configured");
+
+ // 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);
+ }
+
+ @Test
+ public void testServiceMetadataMissing()
+ throws IOException, XmlArtifactGenerationException, CsarConverterException {
+ converter.generateXmlFromCsar(CsarTest.MISSING_METADATA_CSAR.getContent(),
+ CsarTest.MISSING_METADATA_CSAR.getName(), SERVICE_VERSION);
+ }
+
+ @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);
+ }
+
+ @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);
+ }
+
+ public Matcher<String> matches(final String expected) {
+ return new BaseMatcher<String>() {
+ protected String theExpected = expected;
+
+ @Override
+ public boolean matches(Object item) {
+ return new ArtifactTestUtils().compareXmlStrings((String) item, theExpected);
+ }
+
+ @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;
+ }
+
+ 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));
+ }
+ }
}
Code Review / aai / babel.git / blobdiff