2 * Copyright (c) 2015 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
9 package org.opendaylight.controller.md.sal.rest.common;
11 import static org.mockito.ArgumentMatchers.any;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.mock;
15 import com.google.common.base.Optional;
16 import com.google.common.base.Preconditions;
17 import com.google.common.collect.ImmutableClassToInstanceMap;
19 import java.io.FileNotFoundException;
20 import java.io.IOException;
21 import java.io.InputStream;
22 import java.net.URISyntaxException;
23 import java.util.ArrayList;
24 import java.util.Collection;
25 import java.util.List;
26 import javax.xml.parsers.ParserConfigurationException;
27 import javax.xml.stream.XMLStreamException;
28 import javax.xml.transform.dom.DOMSource;
29 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
30 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
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;
56 public final class TestRestconfUtils {
58 private static final Logger LOG = LoggerFactory.getLogger(TestRestconfUtils.class);
60 private TestRestconfUtils() {
61 throw new UnsupportedOperationException("Test utility class");
64 public static ControllerContext newControllerContext(SchemaContext schemaContext) {
65 return newControllerContext(schemaContext, null);
68 public static ControllerContext newControllerContext(SchemaContext schemaContext, DOMMountPoint mountInstance) {
69 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
71 if (mountInstance != null) {
72 doReturn(schemaContext).when(mountInstance).getSchemaContext();
73 doReturn(Optional.fromNullable(mountInstance)).when(mockMountService)
74 .getMountPoint(any(YangInstanceIdentifier.class));
77 DOMSchemaService mockSchemaService = mock(DOMSchemaService.class);
78 doReturn(schemaContext).when(mockSchemaService).getGlobalContext();
80 DOMSchemaService mockDomSchemaService = mock(DOMSchemaService.class);
81 doReturn(ImmutableClassToInstanceMap.of()).when(mockDomSchemaService).getExtensions();
83 return ControllerContext.newInstance(mockSchemaService, mockMountService, mockDomSchemaService);
86 @SuppressWarnings("checkstyle:IllegalCatch")
87 public static SchemaContext loadSchemaContext(final String yangPath, final SchemaContext schemaContext) {
89 Preconditions.checkArgument(yangPath != null, "Path can not be null.");
90 Preconditions.checkArgument(!yangPath.isEmpty(), "Path can not be empty.");
91 if (schemaContext == null) {
92 return YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(yangPath));
94 throw new UnsupportedOperationException("Unable to add new yang sources to existing schema context.");
96 } catch (final Exception e) {
97 LOG.error("Yang files at path: " + yangPath + " weren't loaded.", e);
102 public static NormalizedNodeContext loadNormalizedContextFromJsonFile() {
103 throw new AbstractMethodError("Not implemented yet");
106 @SuppressWarnings("checkstyle:IllegalCatch")
107 public static NormalizedNodeContext loadNormalizedContextFromXmlFile(final String pathToInputFile,
108 final String uri, final ControllerContext controllerContext) {
109 final InstanceIdentifierContext<?> iiContext = controllerContext.toInstanceIdentifier(uri);
110 final InputStream inputStream = TestJsonBodyWriter.class.getResourceAsStream(pathToInputFile);
112 final Document doc = UntrustedXML.newDocumentBuilder().parse(inputStream);
113 final NormalizedNode<?, ?> nn = parse(iiContext, doc);
114 return new NormalizedNodeContext(iiContext, nn);
115 } catch (final Exception e) {
116 LOG.error("Load xml file " + pathToInputFile + " fail.", e);
121 private static NormalizedNode<?, ?> parse(final InstanceIdentifierContext<?> iiContext, final Document doc)
122 throws XMLStreamException, IOException, ParserConfigurationException, SAXException, URISyntaxException {
123 final SchemaNode schemaNodeContext = iiContext.getSchemaNode();
124 DataSchemaNode schemaNode = null;
125 if (schemaNodeContext instanceof RpcDefinition) {
126 if ("input".equalsIgnoreCase(doc.getDocumentElement().getLocalName())) {
127 schemaNode = ((RpcDefinition) schemaNodeContext).getInput();
128 } else if ("output".equalsIgnoreCase(doc.getDocumentElement().getLocalName())) {
129 schemaNode = ((RpcDefinition) schemaNodeContext).getOutput();
131 throw new IllegalStateException("Unknown Rpc input node");
134 } else if (schemaNodeContext instanceof DataSchemaNode) {
135 schemaNode = (DataSchemaNode) schemaNodeContext;
137 throw new IllegalStateException("Unknow SchemaNode");
140 final String docRootElm = doc.getDocumentElement().getLocalName();
141 final String schemaNodeName = iiContext.getSchemaNode().getQName().getLocalName();
143 if (!schemaNodeName.equalsIgnoreCase(docRootElm)) {
144 final Collection<DataSchemaNode> children = ((DataNodeContainer) schemaNode).getChildNodes();
145 for (final DataSchemaNode child : children) {
146 if (child.getQName().getLocalName().equalsIgnoreCase(docRootElm)) {
153 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
154 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
155 final XmlParserStream xmlParser = XmlParserStream.create(writer, iiContext.getSchemaContext(), schemaNode);
157 if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode) {
158 xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
159 return resultHolder.getResult();
161 // FIXME : add another DataSchemaNode extensions e.g. LeafSchemaNode
165 public static Collection<File> loadFiles(final String resourceDirectory) throws FileNotFoundException {
166 final String path = TestRestconfUtils.class.getResource(resourceDirectory).getPath();
167 final File testDir = new File(path);
168 final String[] fileList = testDir.list();
169 final List<File> testFiles = new ArrayList<>();
170 if (fileList == null) {
171 throw new FileNotFoundException(resourceDirectory);
173 for (final String fileName : fileList) {
174 if (new File(testDir, fileName).isDirectory() == false) {
175 testFiles.add(new File(testDir, fileName));