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

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