2 * Copyright (c) 2014, 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.netconf.sal.connect.netconf.schema.mapping;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertNull;
14 import static org.junit.Assert.assertThat;
15 import static org.junit.Assert.assertTrue;
16 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_CONTENT;
17 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME;
18 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_SCHEMA_QNAME;
19 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME;
20 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME;
21 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME;
22 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME;
23 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME;
24 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
25 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
26 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME;
27 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
28 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.createEditConfigStructure;
29 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
30 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
31 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
33 import com.google.common.base.Optional;
34 import com.google.common.collect.Iterables;
35 import com.google.common.collect.Lists;
36 import com.google.common.collect.Maps;
37 import java.io.IOException;
38 import java.util.Collections;
39 import java.util.List;
41 import javax.xml.transform.dom.DOMSource;
42 import org.custommonkey.xmlunit.Diff;
43 import org.custommonkey.xmlunit.ElementNameAndAttributeQualifier;
44 import org.custommonkey.xmlunit.XMLUnit;
45 import org.hamcrest.CoreMatchers;
46 import org.junit.Before;
47 import org.junit.Test;
48 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
49 import org.opendaylight.mdsal.binding.generator.impl.ModuleInfoBackedContext;
50 import org.opendaylight.netconf.api.NetconfMessage;
51 import org.opendaylight.netconf.api.xml.XmlUtil;
52 import org.opendaylight.netconf.sal.connect.netconf.schema.NetconfRemoteSchemaYangSourceProvider;
53 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
54 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.$YangModuleInfoImpl;
56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
60 import org.opendaylight.yangtools.yang.common.QName;
61 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
63 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
64 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
66 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
67 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
68 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
69 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
70 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
71 import org.w3c.dom.Element;
72 import org.xml.sax.SAXException;
74 public class NetconfMessageTransformerTest {
76 private NetconfMessageTransformer netconfMessageTransformer;
77 private SchemaContext schema;
80 public void setUp() throws Exception {
81 XMLUnit.setIgnoreWhitespace(true);
82 XMLUnit.setIgnoreAttributeOrder(true);
83 XMLUnit.setIgnoreComments(true);
85 schema = getSchema(true);
86 netconfMessageTransformer = getTransformer(schema);
91 public void testLockRequestBaseSchemaNotPresent() throws Exception {
92 final SchemaContext partialSchema = getSchema(false);
93 final NetconfMessageTransformer transformer = getTransformer(partialSchema);
94 final NetconfMessage netconfMessage = transformer.toRpcRequest(toPath(NETCONF_LOCK_QNAME),
95 NetconfBaseOps.getLockContent(NETCONF_CANDIDATE_QNAME));
97 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<lock"));
98 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<rpc"));
102 public void testCreateSubscriberNotificationSchemaNotPresent() throws Exception {
103 final SchemaContext partialSchema = getSchema(true);
104 final NetconfMessageTransformer transformer = new NetconfMessageTransformer(
107 BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS
109 NetconfMessage netconfMessage = transformer.toRpcRequest(
110 toPath(CREATE_SUBSCRIPTION_RPC_QNAME),
111 CREATE_SUBSCRIPTION_RPC_CONTENT
113 String documentString = XmlUtil.toString(netconfMessage.getDocument());
114 assertThat(documentString, CoreMatchers.containsString("<create-subscription"));
115 assertThat(documentString, CoreMatchers.containsString("<rpc"));
119 public void tesLockSchemaRequest() throws Exception {
120 final SchemaContext partialSchema = getSchema(false);
121 final NetconfMessageTransformer transformer = getTransformer(partialSchema);
122 final String result = "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>";
124 transformer.toRpcResult(new NetconfMessage(XmlUtil.readXmlToDocument(result)), toPath(NETCONF_LOCK_QNAME));
128 public void testDiscardChangesRequest() throws Exception {
129 final NetconfMessage netconfMessage =
130 netconfMessageTransformer.toRpcRequest(toPath(NETCONF_DISCARD_CHANGES_QNAME), null);
131 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<discard"));
132 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("<rpc"));
133 assertThat(XmlUtil.toString(netconfMessage.getDocument()), CoreMatchers.containsString("message-id"));
137 public void tesGetSchemaRequest() throws Exception {
138 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(GET_SCHEMA_QNAME),
139 NetconfRemoteSchemaYangSourceProvider.createGetSchemaRequest("module", Optional.of("2012-12-12")));
140 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
141 + "<get-schema xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
142 + "<format>yang</format>\n"
143 + "<identifier>module</identifier>\n"
144 + "<version>2012-12-12</version>\n"
150 public void tesGetSchemaResponse() throws Exception {
151 final NetconfMessageTransformer transformer = getTransformer(getSchema(true));
152 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument(
153 "<rpc-reply message-id=\"101\"\n"
154 + "xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
156 + "xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
157 + "<xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n"
158 + "Random YANG SCHEMA\n"
163 final DOMRpcResult compositeNodeRpcResult = transformer.toRpcResult(response, toPath(GET_SCHEMA_QNAME));
164 assertTrue(compositeNodeRpcResult.getErrors().isEmpty());
165 assertNotNull(compositeNodeRpcResult.getResult());
166 final DOMSource schemaContent =
167 ((AnyXmlNode) ((ContainerNode) compositeNodeRpcResult.getResult()).getValue().iterator().next()).getValue();
168 assertThat(((Element) schemaContent.getNode()).getTextContent(),
169 CoreMatchers.containsString("Random YANG SCHEMA"));
173 public void testGetConfigResponse() throws Exception {
174 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument("<rpc-reply message-id=\"101\"\n"
175 + "xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
177 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
180 + "<identifier>module</identifier>\n"
181 + "<version>2012-12-12</version>\n"
182 + "<format xmlns:x=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">x:yang</format>\n"
185 + "</netconf-state>\n"
189 final NetconfMessageTransformer transformer = getTransformer(getSchema(true));
190 final DOMRpcResult compositeNodeRpcResult =
191 transformer.toRpcResult(response, toPath(NETCONF_GET_CONFIG_QNAME));
192 assertTrue(compositeNodeRpcResult.getErrors().isEmpty());
193 assertNotNull(compositeNodeRpcResult.getResult());
195 final List<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> values = Lists.newArrayList(
196 NetconfRemoteSchemaYangSourceProvider
197 .createGetSchemaRequest("module", Optional.of("2012-12-12")).getValue());
199 final Map<QName, Object> keys = Maps.newHashMap();
200 for (final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> value : values) {
201 keys.put(value.getNodeType(), value.getValue());
204 final YangInstanceIdentifier.NodeIdentifierWithPredicates identifierWithPredicates =
205 new YangInstanceIdentifier.NodeIdentifierWithPredicates(Schema.QNAME, keys);
206 final MapEntryNode schemaNode =
207 Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build();
209 final ContainerNode data = (ContainerNode) ((ContainerNode) compositeNodeRpcResult
210 .getResult()).getChild(toId(NETCONF_DATA_QNAME)).get();
211 final ContainerNode state = (ContainerNode) data.getChild(toId(NetconfState.QNAME)).get();
212 final ContainerNode schemas = (ContainerNode) state.getChild(toId(Schemas.QNAME)).get();
213 final MapNode schemaParent = (MapNode) schemas.getChild(toId(Schema.QNAME)).get();
214 assertEquals(1, Iterables.size(schemaParent.getValue()));
216 assertEquals(schemaNode, schemaParent.getValue().iterator().next());
220 public void testGetConfigRequest() throws Exception {
221 final DataContainerChild<?, ?> filter = toFilterStructure(
222 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Schemas.QNAME)), schema);
224 final DataContainerChild<?, ?> source = NetconfBaseOps.getSourceNode(NETCONF_RUNNING_QNAME);
226 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(NETCONF_GET_CONFIG_QNAME),
227 NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_QNAME, source, filter));
229 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
230 + "<get-config xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
231 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
232 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
244 public void testEditConfigRequest() throws Exception {
245 final List<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> values = Lists.newArrayList(
246 NetconfRemoteSchemaYangSourceProvider
247 .createGetSchemaRequest("module", Optional.of("2012-12-12")).getValue());
249 final Map<QName, Object> keys = Maps.newHashMap();
250 for (final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> value : values) {
251 keys.put(value.getNodeType(), value.getValue());
254 final YangInstanceIdentifier.NodeIdentifierWithPredicates identifierWithPredicates =
255 new YangInstanceIdentifier.NodeIdentifierWithPredicates(Schema.QNAME, keys);
256 final MapEntryNode schemaNode =
257 Builders.mapEntryBuilder().withNodeIdentifier(identifierWithPredicates).withValue(values).build();
259 final YangInstanceIdentifier id = YangInstanceIdentifier.builder()
260 .node(NetconfState.QNAME).node(Schemas.QNAME).node(Schema.QNAME)
261 .nodeWithKey(Schema.QNAME, keys).build();
262 final DataContainerChild<?, ?> editConfigStructure =
263 createEditConfigStructure(BaseSchema.BASE_NETCONF_CTX_WITH_NOTIFICATIONS.getSchemaContext(), id,
264 Optional.<ModifyAction>absent(), Optional.<NormalizedNode<?, ?>>fromNullable(schemaNode));
266 final DataContainerChild<?, ?> target = NetconfBaseOps.getTargetNode(NETCONF_CANDIDATE_QNAME);
268 final ContainerNode wrap =
269 NetconfMessageTransformUtil.wrap(NETCONF_EDIT_CONFIG_QNAME, editConfigStructure, target);
270 final NetconfMessage netconfMessage =
271 netconfMessageTransformer.toRpcRequest(toPath(NETCONF_EDIT_CONFIG_QNAME), wrap);
273 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
279 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
282 + "<identifier>module</identifier>\n"
283 + "<version>2012-12-12</version>\n"
284 + "<format>yang</format>\n"
287 + "</netconf-state>\n"
293 private static void assertSimilarXml(final NetconfMessage netconfMessage, final String xmlContent)
294 throws SAXException, IOException {
295 final Diff diff = XMLUnit.compareXML(netconfMessage.getDocument(), XmlUtil.readXmlToDocument(xmlContent));
296 diff.overrideElementQualifier(new ElementNameAndAttributeQualifier());
297 assertTrue(diff.toString(), diff.similar());
301 public void testGetRequest() throws Exception {
303 final QName capability = QName.create(Capabilities.QNAME, "capability");
304 final DataContainerChild<?, ?> filter = toFilterStructure(
305 YangInstanceIdentifier.create(toId(NetconfState.QNAME), toId(Capabilities.QNAME), toId(capability),
306 new YangInstanceIdentifier.NodeWithValue<>(capability, "a:b:c")), schema);
308 final NetconfMessage netconfMessage = netconfMessageTransformer.toRpcRequest(toPath(NETCONF_GET_QNAME),
309 NetconfMessageTransformUtil.wrap(NETCONF_GET_QNAME, filter));
311 assertSimilarXml(netconfMessage, "<rpc message-id=\"m-0\" xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">"
312 + "<get xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\">\n"
313 + "<filter xmlns:ns0=\"urn:ietf:params:xml:ns:netconf:base:1.0\" ns0:type=\"subtree\">\n"
314 + "<netconf-state xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring\">\n"
316 + "<capability>a:b:c</capability>\n"
317 + "</capabilities>\n"
324 private static NetconfMessageTransformer getTransformer(final SchemaContext schema) {
325 return new NetconfMessageTransformer(schema, true);
329 public void testCommitResponse() throws Exception {
330 final NetconfMessage response = new NetconfMessage(XmlUtil.readXmlToDocument(
331 "<rpc-reply xmlns=\"urn:ietf:params:xml:ns:netconf:base:1.0\"><ok/></rpc-reply>"
333 final DOMRpcResult compositeNodeRpcResult =
334 netconfMessageTransformer.toRpcResult(response, toPath(NETCONF_COMMIT_QNAME));
335 assertTrue(compositeNodeRpcResult.getErrors().isEmpty());
336 assertNull(compositeNodeRpcResult.getResult());
339 public SchemaContext getSchema(final boolean addBase) {
340 final ModuleInfoBackedContext moduleInfoBackedContext = ModuleInfoBackedContext.create();
342 moduleInfoBackedContext.addModuleInfos(Collections.singleton($YangModuleInfoImpl.getInstance()));
344 moduleInfoBackedContext
345 .addModuleInfos(Collections.singleton(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf
346 .netconf.monitoring.rev101004.$YangModuleInfoImpl.getInstance()));
347 return moduleInfoBackedContext.tryToCreateSchemaContext().get();