restconf/restconf-nb-bierman02/src/test/java/org/opendaylight/controller/md/sal/rest/common/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
   9 package org.opendaylight.controller.md.sal.rest.common;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.mock;
  14
  15 import com.google.common.base.Optional;
  16 import com.google.common.base.Preconditions;
  17 import java.io.File;
  18 import java.io.FileNotFoundException;
  19 import java.io.IOException;
  20 import java.io.InputStream;
  21 import java.net.URISyntaxException;
  22 import java.util.ArrayList;
  23 import java.util.Collection;
  24 import java.util.List;
  25 import javax.xml.parsers.ParserConfigurationException;
  26 import javax.xml.stream.XMLStreamException;
  27 import javax.xml.transform.dom.DOMSource;
  28 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  29 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  30 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  31 import org.opendaylight.controller.sal.rest.impl.test.providers.TestJsonBodyWriter;
  32 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  33 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  34 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  35 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  36 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  40 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  43 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  45 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  50 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53 import org.w3c.dom.Document;
  54 import org.xml.sax.SAXException;
  55
  56 public final class TestRestconfUtils {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(TestRestconfUtils.class);
  59
  60     private TestRestconfUtils() {
  61         throw new UnsupportedOperationException("Test utility class");
  62     }
  63
  64     public static ControllerContext newControllerContext(SchemaContext schemaContext) {
  65         return newControllerContext(schemaContext, null);
  66     }
  67
  68     public static ControllerContext newControllerContext(SchemaContext schemaContext, DOMMountPoint mountInstance) {
  69         if (mountInstance != null) {
  70             doReturn(schemaContext).when(mountInstance).getSchemaContext();
  71         }
  72
  73         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
  74         doReturn(Optional.fromNullable(mountInstance)).when(mockMountService)
  75             .getMountPoint(any(YangInstanceIdentifier.class));
  76
  77         SchemaService mockSchemaService = mock(SchemaService.class);
  78         doReturn(schemaContext).when(mockSchemaService).getGlobalContext();
  79
  80         DOMSchemaService mockDomSchemaService = mock(DOMSchemaService.class);
  81
  82         return ControllerContext.newInstance(mockSchemaService, mockMountService, mockDomSchemaService);
  83     }
  84
  85     @SuppressWarnings("checkstyle:IllegalCatch")
  86     public static SchemaContext loadSchemaContext(final String yangPath, final SchemaContext schemaContext) {
  87         try {
  88             Preconditions.checkArgument(yangPath != null, "Path can not be null.");
  89             Preconditions.checkArgument(!yangPath.isEmpty(), "Path can not be empty.");
  90             if (schemaContext == null) {
  91                 return YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(yangPath));
  92             } else {
  93                 throw new UnsupportedOperationException("Unable to add new yang sources to existing schema context.");
  94             }
  95         } catch (final Exception e) {
  96             LOG.error("Yang files at path: " + yangPath + " weren't loaded.", e);
  97         }
  98         return schemaContext;
  99     }
 100
 101     public static NormalizedNodeContext loadNormalizedContextFromJsonFile() {
 102         throw new AbstractMethodError("Not implemented yet");
 103     }
 104
 105     @SuppressWarnings("checkstyle:IllegalCatch")
 106     public static NormalizedNodeContext loadNormalizedContextFromXmlFile(final String pathToInputFile,
 107             final String uri, final ControllerContext controllerContext) {
 108         final InstanceIdentifierContext<?> iiContext = controllerContext.toInstanceIdentifier(uri);
 109         final InputStream inputStream = TestJsonBodyWriter.class.getResourceAsStream(pathToInputFile);
 110         try {
 111             final Document doc = UntrustedXML.newDocumentBuilder().parse(inputStream);
 112             final NormalizedNode<?, ?> nn = parse(iiContext, doc);
 113             return new NormalizedNodeContext(iiContext, nn);
 114         } catch (final Exception e) {
 115             LOG.error("Load xml file " + pathToInputFile + " fail.", e);
 116         }
 117         return null;
 118     }
 119
 120     private static NormalizedNode<?, ?> parse(final InstanceIdentifierContext<?> iiContext, final Document doc)
 121             throws XMLStreamException, IOException, ParserConfigurationException, SAXException, URISyntaxException {
 122         final SchemaNode schemaNodeContext = iiContext.getSchemaNode();
 123         DataSchemaNode schemaNode = null;
 124         if (schemaNodeContext instanceof RpcDefinition) {
 125             if ("input".equalsIgnoreCase(doc.getDocumentElement().getLocalName())) {
 126                 schemaNode = ((RpcDefinition) schemaNodeContext).getInput();
 127             } else if ("output".equalsIgnoreCase(doc.getDocumentElement().getLocalName())) {
 128                 schemaNode = ((RpcDefinition) schemaNodeContext).getOutput();
 129             } else {
 130                 throw new IllegalStateException("Unknown Rpc input node");
 131             }
 132
 133         } else if (schemaNodeContext instanceof DataSchemaNode) {
 134             schemaNode = (DataSchemaNode) schemaNodeContext;
 135         } else {
 136             throw new IllegalStateException("Unknow SchemaNode");
 137         }
 138
 139         final String docRootElm = doc.getDocumentElement().getLocalName();
 140         final String schemaNodeName = iiContext.getSchemaNode().getQName().getLocalName();
 141
 142         if (!schemaNodeName.equalsIgnoreCase(docRootElm)) {
 143             final Collection<DataSchemaNode> children = ((DataNodeContainer) schemaNode).getChildNodes();
 144             for (final DataSchemaNode child : children) {
 145                 if (child.getQName().getLocalName().equalsIgnoreCase(docRootElm)) {
 146                     schemaNode = child;
 147                     break;
 148                 }
 149             }
 150         }
 151
 152         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 153         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 154         final XmlParserStream xmlParser = XmlParserStream.create(writer, iiContext.getSchemaContext(), schemaNode);
 155
 156         if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode) {
 157             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
 158             return resultHolder.getResult();
 159         }
 160         // FIXME : add another DataSchemaNode extensions e.g. LeafSchemaNode
 161         return null;
 162     }
 163
 164     public static Collection<File> loadFiles(final String resourceDirectory) throws FileNotFoundException {
 165         final String path = TestRestconfUtils.class.getResource(resourceDirectory).getPath();
 166         final File testDir = new File(path);
 167         final String[] fileList = testDir.list();
 168         final List<File> testFiles = new ArrayList<>();
 169         if (fileList == null) {
 170             throw new FileNotFoundException(resourceDirectory);
 171         }
 172         for (final String fileName : fileList) {
 173             if (new File(testDir, fileName).isDirectory() == false) {
 174                 testFiles.add(new File(testDir, fileName));
 175             }
 176         }
 177         return testFiles;
 178     }
 179 }