2 * ============LICENSE_START=======================================================
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
22 package org.onap.aai.babel.util;
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;
30 import java.io.IOException;
31 import java.io.InputStream;
32 import java.net.URISyntaxException;
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;
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;
51 * This class provides some utilities to assist with running local unit tests.
53 public class ArtifactTestUtils {
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/";
60 * Initialize System Properties for test configuration files.
62 public void setGeneratorSystemProperties() {
63 System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_ARTIFACT_GENERATOR_CONFIG_FILE,
64 getResourcePath(Resources.ARTIFACT_GENERATOR_CONFIG));
66 System.setProperty(ArtifactGeneratorToscaParser.PROPERTY_TOSCA_MAPPING_FILE,
67 getResourcePath(Resources.TOSCA_MAPPING_CONFIG));
71 * Load the Widget to UUID mappings from the Artifact Generator Properties (resource).
74 * if the properties file is not loaded
76 public void loadWidgetToUuidMappings() throws IOException {
77 WidgetConfigurationUtil.setConfig(getResourceAsProperties(Resources.ARTIFACT_GENERATOR_CONFIG));
81 * Load the Widget type mappings (resource).
84 * if the configuration file is not loaded
86 public void loadWidgetMappings() throws IOException {
87 ArtifactGeneratorToscaParser.initToscaMappingsConfiguration(getResourcePath(Resources.TOSCA_MAPPING_CONFIG));
91 * Specific test method for the YAML Extractor test.
94 * files extracted by the YamlExtractor
95 * @param ymlPayloadsToLoad
96 * the expected YAML files
98 * if an I/O exception occurs
100 public void performYmlAsserts(List<Artifact> toscaFiles, List<String> ymlPayloadsToLoad) throws IOException {
101 assertThat("An incorrect number of YAML files have been extracted", toscaFiles.size(),
102 is(equalTo(ymlPayloadsToLoad.size())));
104 Map<String, String> ymlMap = new HashMap<>();
105 for (String filename : ymlPayloadsToLoad) {
106 ymlMap.put(filename, loadResourceAsString(filename));
109 for (Artifact artifact : toscaFiles) {
110 String fileName = artifact.getName().replaceFirst("Definitions/", "ymlFiles/");
111 String expectedYaml = ymlMap.get(fileName);
112 assertThat("Missing expected content for " + fileName, expectedYaml, is(not(nullValue())));
113 assertThat("The content of " + fileName + " must match the expected content",
114 convertToString(artifact.getPayload()).replaceAll("\\r\\n?", "\n"), is(equalTo(expectedYaml)));
119 * Compare two XML strings to see if they have the same content.
125 * @return true if XML content is similar
126 * @throws IOException
127 * if an I/O exception occurs
128 * @throws SAXException
129 * if the XML parsing fails
131 public boolean compareXmlStrings(String string1, String string2) throws SAXException, IOException {
132 return new Diff(string1, string2).similar();
135 public byte[] getCompressedArtifact(String resourceName) throws IOException {
136 return loadResourceBytes(CSAR_INPUTS_FOLDER + resourceName);
139 public byte[] loadResourceBytes(String resourceName) throws IOException {
140 return IOUtils.toByteArray(getResource(resourceName));
143 public String loadResourceAsString(String resourceName) throws IOException {
144 return IOUtils.toString(getResource(resourceName), Charset.defaultCharset());
147 public String getRequestJson(String resource) throws IOException {
148 return loadResourceAsString(JSON_REQUESTS_FOLDER + resource);
151 public String getResponseJson(String jsonResponse) throws IOException, URISyntaxException {
152 return readstringFromFile(JSON_RESPONSES_FOLDER + jsonResponse);
155 public String readstringFromFile(String resourceFile) throws IOException, URISyntaxException {
156 return Files.lines(Paths.get(getResource(resourceFile).toURI())).collect(Collectors.joining());
160 * Create Properties from the content of the named resource (e.g. a file on the classpath).
162 * @param resourceName
164 * @return Properties loaded from the named resource
165 * @throws IOException
166 * if an error occurred when reading from the named resource
168 public Properties getResourceAsProperties(String resourceName) throws IOException {
169 final Properties properties = new Properties();
170 InputStream in = ArtifactTestUtils.class.getClassLoader().getResourceAsStream(resourceName);
176 public String getResourcePath(String resourceName) {
177 return getResource(resourceName).getPath();
180 private URL getResource(String resourceName) {
181 return ArtifactTestUtils.class.getClassLoader().getResource(resourceName);
184 private String convertToString(byte[] byteArray) {
185 return new String(Base64.getDecoder().decode(byteArray), Charset.defaultCharset());