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.restconf.nb.rfc8040;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
12 import static org.junit.Assert.assertNotNull;
13 import static org.mockito.ArgumentMatchers.any;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.mock;
17 import java.io.BufferedReader;
18 import java.io.ByteArrayOutputStream;
20 import java.io.FileNotFoundException;
21 import java.io.FileReader;
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.io.OutputStreamWriter;
26 import java.net.URISyntaxException;
27 import java.nio.charset.StandardCharsets;
28 import java.text.ParseException;
29 import java.util.ArrayList;
30 import java.util.HashMap;
31 import java.util.List;
34 import java.util.regex.Matcher;
35 import java.util.regex.Pattern;
36 import javax.xml.transform.OutputKeys;
37 import javax.xml.transform.Transformer;
38 import javax.xml.transform.TransformerException;
39 import javax.xml.transform.TransformerFactory;
40 import javax.xml.transform.dom.DOMSource;
41 import javax.xml.transform.stream.StreamResult;
42 import org.mockito.Mockito;
43 import org.opendaylight.mdsal.common.api.CommitInfo;
44 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
45 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
46 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
47 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
48 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
49 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
50 import org.opendaylight.yangtools.util.xml.UntrustedXML;
51 import org.opendaylight.yangtools.yang.common.QName;
52 import org.opendaylight.yangtools.yang.common.Revision;
53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
55 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
59 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
60 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
61 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
62 import org.opendaylight.yangtools.yang.model.api.Module;
63 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
64 import org.slf4j.Logger;
65 import org.slf4j.LoggerFactory;
66 import org.w3c.dom.Document;
67 import org.xml.sax.SAXException;
69 public final class TestUtils {
71 private static final Logger LOG = LoggerFactory.getLogger(TestUtils.class);
77 public static EffectiveModelContext loadSchemaContext(final String... yangPath)
78 throws FileNotFoundException {
79 final List<File> files = new ArrayList<>();
80 for (final String path : yangPath) {
81 final String pathToFile = TestUtils.class.getResource(path).getPath();
82 final File testDir = new File(pathToFile);
83 final String[] fileList = testDir.list();
84 if (fileList == null) {
85 throw new FileNotFoundException(pathToFile);
88 for (final String fileName : fileList) {
89 final File file = new File(testDir, fileName);
90 if (file.isDirectory() == false) {
96 return YangParserTestUtils.parseYangFiles(files);
99 public static Module findModule(final Set<Module> modules, final String moduleName) {
100 for (final Module module : modules) {
101 if (module.getName().equals(moduleName)) {
108 public static Document loadDocumentFrom(final InputStream inputStream) {
110 return UntrustedXML.newDocumentBuilder().parse(inputStream);
111 } catch (SAXException | IOException e) {
112 LOG.error("Error during loading Document from XML", e);
117 public static String getDocumentInPrintableForm(final Document doc) {
119 final ByteArrayOutputStream out = new ByteArrayOutputStream();
120 final TransformerFactory tf = TransformerFactory.newInstance();
121 final Transformer transformer = tf.newTransformer();
122 transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no");
123 transformer.setOutputProperty(OutputKeys.METHOD, "xml");
124 transformer.setOutputProperty(OutputKeys.INDENT, "yes");
125 transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
126 transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4");
128 transformer.transform(new DOMSource(requireNonNull(doc)), new StreamResult(new OutputStreamWriter(out,
129 StandardCharsets.UTF_8)));
130 final byte[] charData = out.toByteArray();
131 return new String(charData, StandardCharsets.UTF_8);
132 } catch (final TransformerException e) {
133 final String msg = "Error during transformation of Document into String";
141 * Searches module with name {@code searchedModuleName} in {@code modules}. If module name isn't specified and
142 * module set has only one element then this element is returned.
145 public static Module resolveModule(final String searchedModuleName, final Set<Module> modules) {
146 assertNotNull("Modules can't be null.", modules);
147 if (searchedModuleName != null) {
148 for (final Module m : modules) {
149 if (m.getName().equals(searchedModuleName)) {
153 } else if (modules.size() == 1) {
154 return modules.iterator().next();
159 public static DataSchemaNode resolveDataSchemaNode(final String searchedDataSchemaName, final Module module) {
160 assertNotNull("Module can't be null", module);
162 if (searchedDataSchemaName != null) {
163 for (final DataSchemaNode dsn : module.getChildNodes()) {
164 if (dsn.getQName().getLocalName().equals(searchedDataSchemaName)) {
168 } else if (module.getChildNodes().size() == 1) {
169 return module.getChildNodes().iterator().next();
174 public static QName buildQName(final String name, final String uri, final String date, final String prefix) {
176 final URI u = new URI(uri);
177 return QName.create(u, Revision.ofNullable(date), name);
178 } catch (final URISyntaxException e) {
183 public static QName buildQName(final String name, final String uri, final String date) {
184 return buildQName(name, uri, date, null);
187 public static QName buildQName(final String name) {
188 return buildQName(name, "", null);
191 public static String loadTextFile(final String filePath) throws IOException {
192 final FileReader fileReader = new FileReader(filePath);
193 final BufferedReader bufReader = new BufferedReader(fileReader);
196 final StringBuilder result = new StringBuilder();
197 while ((line = bufReader.readLine()) != null) {
201 return result.toString();
204 private static Pattern patternForStringsSeparatedByWhiteChars(final String... substrings) {
205 final StringBuilder pattern = new StringBuilder();
206 pattern.append(".*");
207 for (final String substring : substrings) {
208 pattern.append(substring);
209 pattern.append("\\s*");
211 pattern.append(".*");
212 return Pattern.compile(pattern.toString(), Pattern.DOTALL);
215 public static boolean containsStringData(final String jsonOutput, final String... substrings) {
216 final Pattern pattern = patternForStringsSeparatedByWhiteChars(substrings);
217 final Matcher matcher = pattern.matcher(jsonOutput);
218 return matcher.matches();
221 public static NodeIdentifier getNodeIdentifier(final String localName, final String namespace,
222 final String revision) throws ParseException {
223 return new NodeIdentifier(QName.create(namespace, revision, localName));
226 public static NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName,
227 final String namespace, final String revision, final Map<String, Object> keys) throws ParseException {
228 final Map<QName, Object> predicate = new HashMap<>();
229 for (final String key : keys.keySet()) {
230 predicate.put(QName.create(namespace, revision, key), keys.get(key));
233 return NodeIdentifierWithPredicates.of(QName.create(namespace, revision, localName), predicate);
236 public static NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName,
237 final String namespace, final String revision, final String... keysAndValues) throws ParseException {
238 checkArgument(keysAndValues.length % 2 == 0, "number of keys argument have to be divisible by 2 (map)");
239 final Map<QName, Object> predicate = new HashMap<>();
242 while (index < keysAndValues.length) {
243 predicate.put(QName.create(namespace, revision, keysAndValues[index++]), keysAndValues[index++]);
246 return NodeIdentifierWithPredicates.of(QName.create(namespace, revision, localName), predicate);
249 public static NormalizedNode<?, ?> prepareNormalizedNodeWithIetfInterfacesInterfacesData() throws ParseException {
250 final String ietfInterfacesDate = "2013-07-04";
251 final String namespace = "urn:ietf:params:xml:ns:yang:ietf-interfaces";
252 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryNode =
253 ImmutableMapEntryNodeBuilder.create();
255 final Map<String, Object> predicates = new HashMap<>();
256 predicates.put("name", "eth0");
258 mapEntryNode.withNodeIdentifier(getNodeIdentifierPredicate("interface", namespace, ietfInterfacesDate,
261 .withChild(new ImmutableLeafNodeBuilder<String>()
262 .withNodeIdentifier(getNodeIdentifier("name", namespace, ietfInterfacesDate)).withValue("eth0")
264 mapEntryNode.withChild(new ImmutableLeafNodeBuilder<String>()
265 .withNodeIdentifier(getNodeIdentifier("type", namespace, ietfInterfacesDate))
266 .withValue("ethernetCsmacd").build());
267 mapEntryNode.withChild(new ImmutableLeafNodeBuilder<Boolean>()
268 .withNodeIdentifier(getNodeIdentifier("enabled", namespace, ietfInterfacesDate))
269 .withValue(Boolean.FALSE).build());
270 mapEntryNode.withChild(new ImmutableLeafNodeBuilder<String>()
271 .withNodeIdentifier(getNodeIdentifier("description", namespace, ietfInterfacesDate))
272 .withValue("some interface").build());
274 return mapEntryNode.build();
277 public static SchemaContextHandler newSchemaContextHandler(final EffectiveModelContext schemaContext) {
278 DOMDataBroker mockDataBroker = mock(DOMDataBroker.class);
279 DOMTransactionChain mockChain = mock(DOMTransactionChain.class);
280 DOMDataTreeWriteTransaction mockTx = mock(DOMDataTreeWriteTransaction.class);
281 doReturn(CommitInfo.emptyFluentFuture()).when(mockTx).commit();
282 doReturn(mockTx).when(mockChain).newWriteOnlyTransaction();
284 doReturn(mockChain).when(mockDataBroker).createTransactionChain(any());
285 SchemaContextHandler schemaContextHandler = new SchemaContextHandler(
286 new TransactionChainHandler(mockDataBroker), Mockito.mock(DOMSchemaService.class));
287 schemaContextHandler.onModelContextUpdated(schemaContext);
288 return schemaContextHandler;