src/test/java/org/onap/aai/babel/util/ArtifactTestUtils.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2019 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2019 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.util;
  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.io.InputStream;
  32 import java.net.URISyntaxException;
  33 import java.net.URL;
  34 import java.nio.charset.Charset;
  35 import java.nio.file.Files;
  36 import java.nio.file.Paths;
  37 import java.util.Base64;
  38 import java.util.HashMap;
  39 import java.util.List;
  40 import java.util.Map;
  41 import java.util.Properties;
  42 import java.util.stream.Collectors;
  43 import org.apache.commons.io.IOUtils;
  44 import org.custommonkey.xmlunit.Diff;
  45 import org.onap.aai.babel.parser.ArtifactGeneratorToscaParser;
  46 import org.onap.aai.babel.xml.generator.data.Artifact;
  47 import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
  48 import org.xml.sax.SAXException;
  49
  50 /**
  51  * This class provides some utilities to assist with running local unit tests.
  52  */
  53 public class ArtifactTestUtils {
  54
  55     private static final String JSON_REQUESTS_FOLDER = "jsonFiles/";
  56     private static final String JSON_RESPONSES_FOLDER = "response/";
  57     private static final String CSAR_INPUTS_FOLDER = "compressedArtifacts/";
  58
  59     /**
  60      * Initialise System Properties for test configuration files.
  61      */
  62     public void setGeneratorSystemProperties() {
  63         System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE,
  64                 getResourcePath(Resources.ARTIFACT_GENERATOR_CONFIG));
  65
  66         System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE,
  67                 getResourcePath(Resources.TOSCA_MAPPING_CONFIG));
  68     }
  69
  70     /**
  71      * Load the Widget to UUID mappings from the Artifact Generator Properties (resource).
  72      *
  73      * @throws IOException
  74      *             if the properties file is not loaded
  75      */
  76     public void loadWidgetToUuidMappings() throws IOException {
  77         WidgetConfigurationUtil.setConfig(getResourceAsProperties(Resources.ARTIFACT_GENERATOR_CONFIG));
  78     }
  79
  80     /**
  81      * Load the Widget to UUID mappings from the Artifact Generator Properties (resource).
  82      *
  83      * @throws IOException
  84      *             if the properties file is not loaded
  85      */
  86     public void loadWidgetMappings() throws IOException {
  87         ArtifactGeneratorToscaParser.initToscaMappingsConfiguration(getResourcePath(Resources.TOSCA_MAPPING_CONFIG));
  88     }
  89
  90
  91     /**
  92      * Specific test method for the YAML Extractor test.
  93      *
  94      * @param toscaFiles
  95      *            files extracted by the YamlExtractor
  96      * @param ymlPayloadsToLoad
  97      *            the expected YAML files
  98      * @throws IOException
  99      *             if an I/O exception occurs
 100      */
 101     public void performYmlAsserts(List<Artifact> toscaFiles, List<String> ymlPayloadsToLoad) throws IOException {
 102         assertThat("An incorrect number of YAML files have been extracted", toscaFiles.size(),
 103                 is(equalTo(ymlPayloadsToLoad.size())));
 104
 105         Map<String, String> ymlMap = new HashMap<>();
 106         for (String filename : ymlPayloadsToLoad) {
 107             ymlMap.put(filename, loadResourceAsString(filename));
 108         }
 109
 110         for (Artifact artifact : toscaFiles) {
 111             String fileName = artifact.getName().replaceFirst("Definitions/", "ymlFiles/");
 112             String expectedYaml = ymlMap.get(fileName);
 113             assertThat("Missing expected content for " + fileName, expectedYaml, is(not(nullValue())));
 114             assertThat("The content of " + fileName + " must match the expected content",
 115                     convertToString(artifact.getPayload()).replaceAll("\\r\\n?", "\n"), is(equalTo(expectedYaml)));
 116         }
 117     }
 118
 119     /**
 120      * Compare two XML strings to see if they have the same content.
 121      *
 122      * @param string1
 123      *            XML content
 124      * @param string2
 125      *            XML content
 126      * @return true if XML content is similar
 127      * @throws IOException
 128      *             if an I/O exception occurs
 129      * @throws SAXException
 130      *             if the XML parsing fails
 131      */
 132     public boolean compareXmlStrings(String string1, String string2) throws SAXException, IOException {
 133         return new Diff(string1, string2).similar();
 134     }
 135
 136     public byte[] getCompressedArtifact(String resourceName) throws IOException {
 137         return loadResourceBytes(CSAR_INPUTS_FOLDER + resourceName);
 138     }
 139
 140     public byte[] loadResourceBytes(String resourceName) throws IOException {
 141         return IOUtils.toByteArray(getResource(resourceName));
 142     }
 143
 144     public String loadResourceAsString(String resourceName) throws IOException {
 145         return IOUtils.toString(getResource(resourceName), Charset.defaultCharset());
 146     }
 147
 148     public String getRequestJson(String resource) throws IOException {
 149         return loadResourceAsString(JSON_REQUESTS_FOLDER + resource);
 150     }
 151
 152     public String getResponseJson(String jsonResponse) throws IOException, URISyntaxException {
 153         return readstringFromFile(JSON_RESPONSES_FOLDER + jsonResponse);
 154     }
 155
 156     public String readstringFromFile(String resourceFile) throws IOException, URISyntaxException {
 157         return Files.lines(Paths.get(getResource(resourceFile).toURI())).collect(Collectors.joining());
 158     }
 159
 160     /**
 161      * Create Properties from the content of the named resource (e.g. a file on the classpath).
 162      *
 163      * @param resourceName
 164      *            the resource name
 165      * @return Properties loaded from the named resource
 166      * @throws IOException
 167      *             if an error occurred when reading from the named resource
 168      */
 169     public Properties getResourceAsProperties(String resourceName) throws IOException {
 170         final Properties properties = new Properties();
 171         InputStream in = ArtifactTestUtils.class.getClassLoader().getResourceAsStream(resourceName);
 172         properties.load(in);
 173         in.close();
 174         return properties;
 175     }
 176
 177     public String getResourcePath(String resourceName) {
 178         return getResource(resourceName).getPath();
 179     }
 180
 181     private URL getResource(String resourceName) {
 182         return ArtifactTestUtils.class.getClassLoader().getResource(resourceName);
 183     }
 184
 185     private String convertToString(byte[] byteArray) {
 186         return new String(Base64.getDecoder().decode(byteArray), Charset.defaultCharset());
 187     }
 188
 189 }