2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.sal.restconf.impl.test;
10 import static org.junit.Assert.assertNotNull;
12 import com.google.common.base.Preconditions;
13 import java.io.BufferedReader;
14 import java.io.ByteArrayOutputStream;
16 import java.io.FileNotFoundException;
17 import java.io.FileReader;
18 import java.io.IOException;
19 import java.io.InputStream;
20 import java.io.OutputStreamWriter;
22 import java.net.URISyntaxException;
23 import java.nio.charset.StandardCharsets;
24 import java.text.ParseException;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.HashMap;
28 import java.util.List;
30 import java.util.regex.Matcher;
31 import java.util.regex.Pattern;
32 import javax.xml.transform.OutputKeys;
33 import javax.xml.transform.Transformer;
34 import javax.xml.transform.TransformerException;
35 import javax.xml.transform.TransformerFactory;
36 import javax.xml.transform.dom.DOMSource;
37 import javax.xml.transform.stream.StreamResult;
38 import org.opendaylight.yangtools.util.xml.UntrustedXML;
39 import org.opendaylight.yangtools.yang.common.QName;
40 import org.opendaylight.yangtools.yang.common.Revision;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
43 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
48 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
50 import org.opendaylight.yangtools.yang.model.api.Module;
51 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
54 import org.w3c.dom.Document;
55 import org.xml.sax.SAXException;
57 public final class TestUtils {
59 private static final Logger LOG = LoggerFactory.getLogger(TestUtils.class);
65 public static EffectiveModelContext loadSchemaContext(final String... yangPath) throws FileNotFoundException {
66 final List<File> files = new ArrayList<>();
67 for (final String path : yangPath) {
68 final String pathToFile = TestUtils.class.getResource(path).getPath();
69 final File testDir = new File(pathToFile);
70 final String[] fileList = testDir.list();
71 if (fileList == null) {
72 throw new FileNotFoundException(pathToFile);
75 for (final String fileName : fileList) {
76 final File file = new File(testDir, fileName);
77 if (file.isDirectory() == false) {
83 return YangParserTestUtils.parseYangFiles(files);
86 public static Module findModule(final Collection<? extends Module> modules, final String moduleName) {
87 for (final Module module : modules) {
88 if (module.getName().equals(moduleName)) {
95 public static Document loadDocumentFrom(final InputStream inputStream) {
97 return UntrustedXML.newDocumentBuilder().parse(inputStream);
98 } catch (SAXException | IOException e) {
99 LOG.error("Error during loading Document from XML", e);
104 public static String getDocumentInPrintableForm(final Document doc) {
105 Preconditions.checkNotNull(doc);
107 final ByteArrayOutputStream out = new ByteArrayOutputStream();
108 final TransformerFactory tf = TransformerFactory.newInstance();
109 final Transformer transformer = tf.newTransformer();
110 transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no");
111 transformer.setOutputProperty(OutputKeys.METHOD, "xml");
112 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
113 transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
114 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
116 transformer.transform(new DOMSource(doc), new StreamResult(new OutputStreamWriter(out,
117 StandardCharsets.UTF_8)));
118 final byte[] charData = out.toByteArray();
119 return new String(charData, StandardCharsets.UTF_8);
120 } catch (final TransformerException e) {
121 final String msg = "Error during transformation of Document into String";
129 * Searches module with name {@code searchedModuleName} in {@code modules}. If module name isn't specified and
130 * module set has only one element then this element is returned.
133 public static Module resolveModule(final String searchedModuleName, final Collection<? extends Module> modules) {
134 assertNotNull("Modules can't be null.", modules);
135 if (searchedModuleName != null) {
136 for (final Module m : modules) {
137 if (m.getName().equals(searchedModuleName)) {
141 } else if (modules.size() == 1) {
142 return modules.iterator().next();
147 public static DataSchemaNode resolveDataSchemaNode(final String searchedDataSchemaName, final Module module) {
148 assertNotNull("Module can't be null", module);
150 if (searchedDataSchemaName != null) {
151 for (final DataSchemaNode dsn : module.getChildNodes()) {
152 if (dsn.getQName().getLocalName().equals(searchedDataSchemaName)) {
156 } else if (module.getChildNodes().size() == 1) {
157 return module.getChildNodes().iterator().next();
162 public static QName buildQName(final String name, final String uri, final String date, final String prefix) {
164 return QName.create(new URI(uri), Revision.ofNullable(date), name);
165 } catch (final URISyntaxException e) {
170 public static QName buildQName(final String name, final String uri, final String date) {
171 return buildQName(name, uri, date, null);
174 public static QName buildQName(final String name) {
175 return buildQName(name, "", null);
178 public static String loadTextFile(final String filePath) throws IOException {
179 final FileReader fileReader = new FileReader(filePath);
180 final BufferedReader bufReader = new BufferedReader(fileReader);
183 final StringBuilder result = new StringBuilder();
184 while ((line = bufReader.readLine()) != null) {
188 return result.toString();
191 private static Pattern patternForStringsSeparatedByWhiteChars(final String... substrings) {
192 final StringBuilder pattern = new StringBuilder();
193 pattern.append(".*");
194 for (final String substring : substrings) {
195 pattern.append(substring);
196 pattern.append("\\s*");
198 pattern.append(".*");
199 return Pattern.compile(pattern.toString(), Pattern.DOTALL);
202 public static boolean containsStringData(final String jsonOutput, final String... substrings) {
203 final Pattern pattern = patternForStringsSeparatedByWhiteChars(substrings);
204 final Matcher matcher = pattern.matcher(jsonOutput);
205 return matcher.matches();
208 public static NodeIdentifier getNodeIdentifier(final String localName, final String namespace,
209 final String revision) throws ParseException {
210 return new NodeIdentifier(QName.create(namespace, revision, localName));
213 public static NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName,
214 final String namespace, final String revision, final Map<String, Object> keys) throws ParseException {
215 final Map<QName, Object> predicate = new HashMap<>();
216 for (final String key : keys.keySet()) {
217 predicate.put(QName.create(namespace, revision, key), keys.get(key));
220 return NodeIdentifierWithPredicates.of(QName.create(namespace, revision, localName), predicate);
223 public static NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName,
224 final String namespace, final String revision, final String... keysAndValues) throws ParseException {
225 Preconditions.checkArgument(keysAndValues.length % 2 == 0,
226 "number of keys argument have to be divisible by 2 (map)");
227 final Map<QName, Object> predicate = new HashMap<>();
230 while (index < keysAndValues.length) {
231 predicate.put(QName.create(namespace, revision, keysAndValues[index++]), keysAndValues[index++]);
234 return NodeIdentifierWithPredicates.of(QName.create(namespace, revision, localName), predicate);
237 public static NormalizedNode<?, ?> prepareNormalizedNodeWithIetfInterfacesInterfacesData() throws ParseException {
238 final String ietfInterfacesDate = "2013-07-04";
239 final String namespace = "urn:ietf:params:xml:ns:yang:ietf-interfaces";
240 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryNode =
241 ImmutableMapEntryNodeBuilder.create();
243 final Map<String, Object> predicates = new HashMap<>();
244 predicates.put("name", "eth0");
246 mapEntryNode.withNodeIdentifier(getNodeIdentifierPredicate("interface", namespace, ietfInterfacesDate,
249 .withChild(new ImmutableLeafNodeBuilder<String>()
250 .withNodeIdentifier(getNodeIdentifier("name", namespace, ietfInterfacesDate)).withValue("eth0")
252 mapEntryNode.withChild(new ImmutableLeafNodeBuilder<String>()
253 .withNodeIdentifier(getNodeIdentifier("type", namespace, ietfInterfacesDate))
254 .withValue("ethernetCsmacd").build());
255 mapEntryNode.withChild(new ImmutableLeafNodeBuilder<Boolean>()
256 .withNodeIdentifier(getNodeIdentifier("enabled", namespace, ietfInterfacesDate))
257 .withValue(Boolean.FALSE).build());
258 mapEntryNode.withChild(new ImmutableLeafNodeBuilder<String>()
259 .withNodeIdentifier(getNodeIdentifier("description", namespace, ietfInterfacesDate))
260 .withValue("some interface").build());
262 return mapEntryNode.build();