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

   1 /*
   2  * Copyright (c) 2015 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 com.google.common.base.Preconditions;
  11 import java.io.File;
  12 import java.io.FileNotFoundException;
  13 import java.io.IOException;
  14 import java.io.InputStream;
  15 import java.net.URISyntaxException;
  16 import java.util.ArrayList;
  17 import java.util.List;
  18 import java.util.Optional;
  19 import javax.xml.parsers.ParserConfigurationException;
  20 import javax.xml.stream.XMLStreamException;
  21 import javax.xml.transform.dom.DOMSource;
  22 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  23 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  24 import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier;
  25 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  26 import org.opendaylight.yangtools.yang.common.YangConstants;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  29 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  32 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  36 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  38 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  39 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  40 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43 import org.w3c.dom.Document;
  44 import org.xml.sax.SAXException;
  45
  46 public final class TestRestconfUtils {
  47
  48     private static final Logger LOG = LoggerFactory.getLogger(TestRestconfUtils.class);
  49
  50     private TestRestconfUtils() {
  51         throw new UnsupportedOperationException("Test utility class");
  52     }
  53
  54     @SuppressWarnings("checkstyle:IllegalCatch")
  55     public static EffectiveModelContext loadSchemaContext(final String yangPath,
  56             final EffectiveModelContext schemaContext) {
  57         try {
  58             Preconditions.checkArgument(yangPath != null, "Path can not be null.");
  59             Preconditions.checkArgument(!yangPath.isEmpty(), "Path can not be empty.");
  60             if (schemaContext == null) {
  61                 return YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(yangPath));
  62             } else {
  63                 throw new UnsupportedOperationException("Unable to add new yang sources to existing schema context.");
  64             }
  65         } catch (final Exception e) {
  66             LOG.error("Yang files at path: " + yangPath + " weren't loaded.", e);
  67         }
  68         return schemaContext;
  69     }
  70
  71     @SuppressWarnings("checkstyle:IllegalCatch")
  72     public static NormalizedNodePayload loadNormalizedContextFromXmlFile(final String pathToInputFile,
  73             final String uri, final EffectiveModelContext schemaContext) {
  74         final InstanceIdentifierContext<?> iiContext =
  75                 ParserIdentifier.toInstanceIdentifier(uri, schemaContext, Optional.empty());
  76         final InputStream inputStream = TestRestconfUtils.class.getResourceAsStream(pathToInputFile);
  77         try {
  78             final Document doc = UntrustedXML.newDocumentBuilder().parse(inputStream);
  79             final NormalizedNode nn = parse(iiContext, doc);
  80             return NormalizedNodePayload.of(iiContext, nn);
  81         } catch (final Exception e) {
  82             LOG.error("Load xml file " + pathToInputFile + " fail.", e);
  83         }
  84         return null;
  85     }
  86
  87     private static NormalizedNode parse(final InstanceIdentifierContext<?> iiContext, final Document doc)
  88             throws XMLStreamException, IOException, ParserConfigurationException, SAXException, URISyntaxException {
  89         final SchemaNode schemaNodeContext = iiContext.getSchemaNode();
  90         DataSchemaNode schemaNode = null;
  91         if (schemaNodeContext instanceof RpcDefinition) {
  92             if ("input".equalsIgnoreCase(doc.getDocumentElement().getLocalName())) {
  93                 schemaNode = ((RpcDefinition) schemaNodeContext).getInput();
  94             } else if ("output".equalsIgnoreCase(doc.getDocumentElement().getLocalName())) {
  95                 schemaNode = ((RpcDefinition) schemaNodeContext).getOutput();
  96             } else {
  97                 throw new IllegalStateException("Unknown Rpc input node");
  98             }
  99
 100         } else if (schemaNodeContext instanceof DataSchemaNode) {
 101             schemaNode = (DataSchemaNode) schemaNodeContext;
 102         } else {
 103             throw new IllegalStateException("Unknow SchemaNode");
 104         }
 105
 106         final String docRootElm = doc.getDocumentElement().getLocalName();
 107         final String schemaNodeName = iiContext.getSchemaNode().getQName().getLocalName();
 108
 109         if (!schemaNodeName.equalsIgnoreCase(docRootElm)) {
 110             for (final DataSchemaNode child : ((DataNodeContainer) schemaNode).getChildNodes()) {
 111                 if (child.getQName().getLocalName().equalsIgnoreCase(docRootElm)) {
 112                     schemaNode = child;
 113                     break;
 114                 }
 115             }
 116         }
 117
 118         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 119         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 120         final XmlParserStream xmlParser = XmlParserStream.create(writer,
 121             SchemaInferenceStack.ofInstantiatedPath(iiContext.getSchemaContext(), schemaNode.getPath()).toInference());
 122
 123         if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode) {
 124             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
 125             return resultHolder.getResult();
 126         }
 127         // FIXME : add another DataSchemaNode extensions e.g. LeafSchemaNode
 128         return null;
 129     }
 130
 131     public static List<File> loadFiles(final String resourceDirectory) throws FileNotFoundException {
 132         final String path = TestRestconfUtils.class.getResource(resourceDirectory).getPath();
 133         final File testDir = new File(path);
 134         final String[] fileList = testDir.list();
 135         final List<File> testFiles = new ArrayList<>();
 136         if (fileList == null) {
 137             throw new FileNotFoundException(resourceDirectory);
 138         }
 139         for (final String fileName : fileList) {
 140             if (fileName.endsWith(YangConstants.RFC6020_YANG_FILE_EXTENSION)
 141                 && !new File(testDir, fileName).isDirectory()) {
 142                 testFiles.add(new File(testDir, fileName));
 143             }
 144         }
 145         return testFiles;
 146     }
 147 }