restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/TestUtils.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040;
   9
  10 import static org.junit.Assert.assertNotNull;
  11 import static org.mockito.ArgumentMatchers.any;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.mock;
  14
  15 import com.google.common.base.Preconditions;
  16 import java.io.BufferedReader;
  17 import java.io.ByteArrayOutputStream;
  18 import java.io.File;
  19 import java.io.FileNotFoundException;
  20 import java.io.FileReader;
  21 import java.io.IOException;
  22 import java.io.InputStream;
  23 import java.io.OutputStreamWriter;
  24 import java.net.URI;
  25 import java.net.URISyntaxException;
  26 import java.nio.charset.StandardCharsets;
  27 import java.text.ParseException;
  28 import java.util.ArrayList;
  29 import java.util.HashMap;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Set;
  33 import java.util.regex.Matcher;
  34 import java.util.regex.Pattern;
  35 import javax.xml.transform.OutputKeys;
  36 import javax.xml.transform.Transformer;
  37 import javax.xml.transform.TransformerException;
  38 import javax.xml.transform.TransformerFactory;
  39 import javax.xml.transform.dom.DOMSource;
  40 import javax.xml.transform.stream.StreamResult;
  41 import org.mockito.Mockito;
  42 import org.opendaylight.mdsal.common.api.CommitInfo;
  43 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  44 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  45 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  46 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  47 import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
  48 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
  49 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  50 import org.opendaylight.yangtools.yang.common.QName;
  51 import org.opendaylight.yangtools.yang.common.Revision;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  54 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  59 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  60 import org.opendaylight.yangtools.yang.model.api.Module;
  61 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  62 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  63 import org.slf4j.Logger;
  64 import org.slf4j.LoggerFactory;
  65 import org.w3c.dom.Document;
  66 import org.xml.sax.SAXException;
  67
  68 public final class TestUtils {
  69
  70     private static final Logger LOG = LoggerFactory.getLogger(TestUtils.class);
  71
  72     private TestUtils() {
  73
  74     }
  75
  76     public static SchemaContext loadSchemaContext(final String... yangPath)
  77             throws FileNotFoundException {
  78         final List<File> files = new ArrayList<>();
  79         for (final String path : yangPath) {
  80             final String pathToFile = TestUtils.class.getResource(path).getPath();
  81             final File testDir = new File(pathToFile);
  82             final String[] fileList = testDir.list();
  83             if (fileList == null) {
  84                 throw new FileNotFoundException(pathToFile);
  85             }
  86
  87             for (final String fileName : fileList) {
  88                 final File file = new File(testDir, fileName);
  89                 if (file.isDirectory() == false) {
  90                     files.add(file);
  91                 }
  92             }
  93         }
  94
  95         return YangParserTestUtils.parseYangFiles(files);
  96     }
  97
  98     public static Module findModule(final Set<Module> modules, final String moduleName) {
  99         for (final Module module : modules) {
 100             if (module.getName().equals(moduleName)) {
 101                 return module;
 102             }
 103         }
 104         return null;
 105     }
 106
 107     public static Document loadDocumentFrom(final InputStream inputStream) {
 108         try {
 109             return UntrustedXML.newDocumentBuilder().parse(inputStream);
 110         } catch (SAXException | IOException e) {
 111             LOG.error("Error during loading Document from XML", e);
 112             return null;
 113         }
 114     }
 115
 116     public static String getDocumentInPrintableForm(final Document doc) {
 117         Preconditions.checkNotNull(doc);
 118         try {
 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");
 127
 128             transformer.transform(new DOMSource(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";
 134             LOG.error(msg, e);
 135             return msg;
 136         }
 137
 138     }
 139
 140     /**
 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.
 143      *
 144      */
 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)) {
 150                     return m;
 151                 }
 152             }
 153         } else if (modules.size() == 1) {
 154             return modules.iterator().next();
 155         }
 156         return null;
 157     }
 158
 159     public static DataSchemaNode resolveDataSchemaNode(final String searchedDataSchemaName, final Module module) {
 160         assertNotNull("Module can't be null", module);
 161
 162         if (searchedDataSchemaName != null) {
 163             for (final DataSchemaNode dsn : module.getChildNodes()) {
 164                 if (dsn.getQName().getLocalName().equals(searchedDataSchemaName)) {
 165                     return dsn;
 166                 }
 167             }
 168         } else if (module.getChildNodes().size() == 1) {
 169             return module.getChildNodes().iterator().next();
 170         }
 171         return null;
 172     }
 173
 174     public static QName buildQName(final String name, final String uri, final String date, final String prefix) {
 175         try {
 176             final URI u = new URI(uri);
 177             return QName.create(u, Revision.ofNullable(date), name);
 178         } catch (final URISyntaxException e) {
 179             return null;
 180         }
 181     }
 182
 183     public static QName buildQName(final String name, final String uri, final String date) {
 184         return buildQName(name, uri, date, null);
 185     }
 186
 187     public static QName buildQName(final String name) {
 188         return buildQName(name, "", null);
 189     }
 190
 191     public static String loadTextFile(final String filePath) throws IOException {
 192         final FileReader fileReader = new FileReader(filePath);
 193         final BufferedReader bufReader = new BufferedReader(fileReader);
 194
 195         String line = null;
 196         final StringBuilder result = new StringBuilder();
 197         while ((line = bufReader.readLine()) != null) {
 198             result.append(line);
 199         }
 200         bufReader.close();
 201         return result.toString();
 202     }
 203
 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*");
 210         }
 211         pattern.append(".*");
 212         return Pattern.compile(pattern.toString(), Pattern.DOTALL);
 213     }
 214
 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();
 219     }
 220
 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));
 224     }
 225
 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));
 231         }
 232
 233         return new NodeIdentifierWithPredicates(QName.create(namespace, revision, localName), predicate);
 234     }
 235
 236     public static NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName,
 237             final String namespace, final String revision, final String... keysAndValues) throws ParseException {
 238         Preconditions.checkArgument(keysAndValues.length % 2 == 0,
 239                 "number of keys argument have to be divisible by 2 (map)");
 240         final Map<QName, Object> predicate = new HashMap<>();
 241
 242         int index = 0;
 243         while (index < keysAndValues.length) {
 244             predicate.put(QName.create(namespace, revision, keysAndValues[index++]), keysAndValues[index++]);
 245         }
 246
 247         return new NodeIdentifierWithPredicates(QName.create(namespace, revision, localName), predicate);
 248     }
 249
 250     public static NormalizedNode<?, ?> prepareNormalizedNodeWithIetfInterfacesInterfacesData() throws ParseException {
 251         final String ietfInterfacesDate = "2013-07-04";
 252         final String namespace = "urn:ietf:params:xml:ns:yang:ietf-interfaces";
 253         final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryNode =
 254                 ImmutableMapEntryNodeBuilder.create();
 255
 256         final Map<String, Object> predicates = new HashMap<>();
 257         predicates.put("name", "eth0");
 258
 259         mapEntryNode.withNodeIdentifier(getNodeIdentifierPredicate("interface", namespace, ietfInterfacesDate,
 260                 predicates));
 261         mapEntryNode
 262                 .withChild(new ImmutableLeafNodeBuilder<String>()
 263                         .withNodeIdentifier(getNodeIdentifier("name", namespace, ietfInterfacesDate)).withValue("eth0")
 264                         .build());
 265         mapEntryNode.withChild(new ImmutableLeafNodeBuilder<String>()
 266                 .withNodeIdentifier(getNodeIdentifier("type", namespace, ietfInterfacesDate))
 267                 .withValue("ethernetCsmacd").build());
 268         mapEntryNode.withChild(new ImmutableLeafNodeBuilder<Boolean>()
 269                 .withNodeIdentifier(getNodeIdentifier("enabled", namespace, ietfInterfacesDate))
 270                 .withValue(Boolean.FALSE).build());
 271         mapEntryNode.withChild(new ImmutableLeafNodeBuilder<String>()
 272                 .withNodeIdentifier(getNodeIdentifier("description", namespace, ietfInterfacesDate))
 273                 .withValue("some interface").build());
 274
 275         return mapEntryNode.build();
 276     }
 277
 278     public static SchemaContextHandler newSchemaContextHandler(final SchemaContext schemaContext) {
 279         DOMDataBroker mockDataBroker = mock(DOMDataBroker.class);
 280         DOMTransactionChain mockChain = mock(DOMTransactionChain.class);
 281         DOMDataTreeWriteTransaction mockTx = mock(DOMDataTreeWriteTransaction.class);
 282         doReturn(CommitInfo.emptyFluentFuture()).when(mockTx).commit();
 283         doReturn(mockTx).when(mockChain).newWriteOnlyTransaction();
 284
 285         doReturn(mockChain).when(mockDataBroker).createTransactionChain(any());
 286         SchemaContextHandler schemaContextHandler = SchemaContextHandler.newInstance(
 287                 new TransactionChainHandler(mockDataBroker), Mockito.mock(DOMSchemaService.class));
 288         schemaContextHandler.onGlobalContextUpdated(schemaContext);
 289         return schemaContextHandler;
 290     }
 291 }